Class PageData

constructor

• new PageData(source?: DeepPartial<PageData>): PageData

  Parameters

  • Optionalsource: DeepPartial<PageData>

  Returns PageData

ReadonlydocumentDetectionStatus

ReadonlydocumentImagePreviewURI

ReadonlydocumentImageURI

ReadonlydocumentQuality

Readonlyfilters

ReadonlyoriginalImageURI

Readonlypolygon

Readonlysource

ReadonlyunfilteredDocumentImageURI

Readonlyuuid

serialize

• serialize(
      config?: ToJsonConfiguration,
  ): {
      documentDetectionStatus?: DocumentDetectionStatus | null;
      documentImagePreviewURI?: string | null;
      documentImageURI?: string | null;
      documentQuality?: DocumentQuality | null;
      filters?:
          | (
              | {
                  filterType?: number;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => {
                      _type?: "LegacyFilter";
                      filterType?: number;
                      serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "LegacyFilter" | undefined; filterType?: number | undefined; serialize?: ... | undefined; }) | undefined;
                  };
              } & { _type: "LegacyFilter" }
              | {
                  outputMode?: OutputMode;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => {
                      _type?: "ScanbotBinarizationFilter";
                      outputMode?: OutputMode;
                      serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "ScanbotBinarizationFilter" | undefined; outputMode?: OutputMode | undefined; serialize?: ... | undefined; }) | undefined;
                  };
              } & { _type: "ScanbotBinarizationFilter" }
              | {
                  denoise?: number;
                  outputMode?: OutputMode;
                  preset?: BinarizationFilterPreset;
                  radius?: number;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => {
                      _type?: "CustomBinarizationFilter";
                      denoise?: number;
                      outputMode?: OutputMode;
                      preset?: BinarizationFilterPreset;
                      radius?: number;
                      serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "CustomBinarizationFilter" | undefined; outputMode?: OutputMode | undefined; denoise?: number | undefined; radius?: number | undefined; preset?: BinarizationFilterPreset | undefined; serialize?: ... | undefined; }) | undefined;
                  };
              } & { _type: "CustomBinarizationFilter" }
              | {
                  colorEnhancement?: number;
                  contrastEnhancement?: number;
                  paperWhitening?: number;
                  paperWhiteningBias?: number;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => {
                      _type?: "ColorDocumentFilter";
                      colorEnhancement?: number;
                      contrastEnhancement?: number;
                      paperWhitening?: number;
                      paperWhiteningBias?: number;
                      serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "ColorDocumentFilter" | undefined; contrastEnhancement?: number | undefined; colorEnhancement?: number | undefined; paperWhitening?: number | undefined; paperWhiteningBias?: number | undefined; serialize?: ... | undefined; }) | undefined;
                  };
              } & { _type: "ColorDocumentFilter" }
              | {
                  brightness?: number;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => {
                      _type?: "BrightnessFilter";
                      brightness?: number;
                      serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "BrightnessFilter" | undefined; brightness?: number | undefined; serialize?: ... | undefined; }) | undefined;
                  };
              } & { _type: "BrightnessFilter" }
              | {
                  contrast?: number;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => {
                      _type?: "ContrastFilter";
                      contrast?: number;
                      serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "ContrastFilter" | undefined; contrast?: number | undefined; serialize?: ... | undefined; }) | undefined;
                  };
              } & { _type: "ContrastFilter" }
              | {
                  blackOutliersFraction?: number;
                  borderWidthFraction?: number;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => {
                      _type?: "GrayscaleFilter";
                      blackOutliersFraction?: number;
                      borderWidthFraction?: number;
                      serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "GrayscaleFilter" | undefined; borderWidthFraction?: number | undefined; blackOutliersFraction?: number | undefined; whiteOutliersFraction?: number | undefined; serialize?: ... | undefined; }) | undefined;
                      whiteOutliersFraction?: number;
                  };
                  whiteOutliersFraction?: number;
              } & { _type: "GrayscaleFilter" }
              | {
                  blackPoint?: number;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => {
                      _type?: "WhiteBlackPointFilter";
                      blackPoint?: number;
                      serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "WhiteBlackPointFilter" | undefined; blackPoint?: number | undefined; whitePoint?: number | undefined; serialize?: ... | undefined; }) | undefined;
                      whitePoint?: number;
                  };
                  whitePoint?: number;
              } & { _type: "WhiteBlackPointFilter" }
          )[]
          | null;
      originalImageURI?: string;
      polygon?: Point[];
      serialize?: (
          config?: ToJsonConfiguration,
      ) => { readonly uuid?: string | undefined; readonly filters?: (({ filterType?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "LegacyFilter" | undefined; filterType?: number | undefined; serialize?: ... | undefined; }) | undefined; } & { ...; }) | ... 6 more ... | ({ ......;
      source?: PageImageSource | null;
      unfilteredDocumentImageURI?: string | null;
      uuid?: string;
  }

  Parameters

  • Optionalconfig: ToJsonConfiguration

  Returns {
      documentDetectionStatus?: DocumentDetectionStatus | null;
      documentImagePreviewURI?: string | null;
      documentImageURI?: string | null;
      documentQuality?: DocumentQuality | null;
      filters?:
          | (
              | {
                  filterType?: number;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => {
                      _type?: "LegacyFilter";
                      filterType?: number;
                      serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "LegacyFilter" | undefined; filterType?: number | undefined; serialize?: ... | undefined; }) | undefined;
                  };
              } & { _type: "LegacyFilter" }
              | {
                  outputMode?: OutputMode;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => {
                      _type?: "ScanbotBinarizationFilter";
                      outputMode?: OutputMode;
                      serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "ScanbotBinarizationFilter" | undefined; outputMode?: OutputMode | undefined; serialize?: ... | undefined; }) | undefined;
                  };
              } & { _type: "ScanbotBinarizationFilter" }
              | {
                  denoise?: number;
                  outputMode?: OutputMode;
                  preset?: BinarizationFilterPreset;
                  radius?: number;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => {
                      _type?: "CustomBinarizationFilter";
                      denoise?: number;
                      outputMode?: OutputMode;
                      preset?: BinarizationFilterPreset;
                      radius?: number;
                      serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "CustomBinarizationFilter" | undefined; outputMode?: OutputMode | undefined; denoise?: number | undefined; radius?: number | undefined; preset?: BinarizationFilterPreset | undefined; serialize?: ... | undefined; }) | undefined;
                  };
              } & { _type: "CustomBinarizationFilter" }
              | {
                  colorEnhancement?: number;
                  contrastEnhancement?: number;
                  paperWhitening?: number;
                  paperWhiteningBias?: number;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => {
                      _type?: "ColorDocumentFilter";
                      colorEnhancement?: number;
                      contrastEnhancement?: number;
                      paperWhitening?: number;
                      paperWhiteningBias?: number;
                      serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "ColorDocumentFilter" | undefined; contrastEnhancement?: number | undefined; colorEnhancement?: number | undefined; paperWhitening?: number | undefined; paperWhiteningBias?: number | undefined; serialize?: ... | undefined; }) | undefined;
                  };
              } & { _type: "ColorDocumentFilter" }
              | {
                  brightness?: number;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => {
                      _type?: "BrightnessFilter";
                      brightness?: number;
                      serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "BrightnessFilter" | undefined; brightness?: number | undefined; serialize?: ... | undefined; }) | undefined;
                  };
              } & { _type: "BrightnessFilter" }
              | {
                  contrast?: number;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => {
                      _type?: "ContrastFilter";
                      contrast?: number;
                      serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "ContrastFilter" | undefined; contrast?: number | undefined; serialize?: ... | undefined; }) | undefined;
                  };
              } & { _type: "ContrastFilter" }
              | {
                  blackOutliersFraction?: number;
                  borderWidthFraction?: number;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => {
                      _type?: "GrayscaleFilter";
                      blackOutliersFraction?: number;
                      borderWidthFraction?: number;
                      serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "GrayscaleFilter" | undefined; borderWidthFraction?: number | undefined; blackOutliersFraction?: number | undefined; whiteOutliersFraction?: number | undefined; serialize?: ... | undefined; }) | undefined;
                      whiteOutliersFraction?: number;
                  };
                  whiteOutliersFraction?: number;
              } & { _type: "GrayscaleFilter" }
              | {
                  blackPoint?: number;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => {
                      _type?: "WhiteBlackPointFilter";
                      blackPoint?: number;
                      serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "WhiteBlackPointFilter" | undefined; blackPoint?: number | undefined; whitePoint?: number | undefined; serialize?: ... | undefined; }) | undefined;
                      whitePoint?: number;
                  };
                  whitePoint?: number;
              } & { _type: "WhiteBlackPointFilter" }
          )[]
          | null;
      originalImageURI?: string;
      polygon?: Point[];
      serialize?: (
          config?: ToJsonConfiguration,
      ) => { readonly uuid?: string | undefined; readonly filters?: (({ filterType?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "LegacyFilter" | undefined; filterType?: number | undefined; serialize?: ... | undefined; }) | undefined; } & { ...; }) | ... 6 more ... | ({ ......;
      source?: PageImageSource | null;
      unfilteredDocumentImageURI?: string | null;
      uuid?: string;
  }

  • Optional ReadonlydocumentDetectionStatus?: DocumentDetectionStatus | null

    The detection status of the page.

  • Optional ReadonlydocumentImagePreviewURI?: string | null

    The URI of the document image preview.

  • Optional ReadonlydocumentImageURI?: string | null

    The URI of the document image.

  • Optional ReadonlydocumentQuality?: DocumentQuality | null

    The quality score of the page.

  • Optional Readonlyfilters?:
        | (
            | {
                filterType?: number;
                serialize?: (
                    config?: ToJsonConfiguration,
                ) => {
                    _type?: "LegacyFilter";
                    filterType?: number;
                    serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "LegacyFilter" | undefined; filterType?: number | undefined; serialize?: ... | undefined; }) | undefined;
                };
            } & { _type: "LegacyFilter" }
            | {
                outputMode?: OutputMode;
                serialize?: (
                    config?: ToJsonConfiguration,
                ) => {
                    _type?: "ScanbotBinarizationFilter";
                    outputMode?: OutputMode;
                    serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "ScanbotBinarizationFilter" | undefined; outputMode?: OutputMode | undefined; serialize?: ... | undefined; }) | undefined;
                };
            } & { _type: "ScanbotBinarizationFilter" }
            | {
                denoise?: number;
                outputMode?: OutputMode;
                preset?: BinarizationFilterPreset;
                radius?: number;
                serialize?: (
                    config?: ToJsonConfiguration,
                ) => {
                    _type?: "CustomBinarizationFilter";
                    denoise?: number;
                    outputMode?: OutputMode;
                    preset?: BinarizationFilterPreset;
                    radius?: number;
                    serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "CustomBinarizationFilter" | undefined; outputMode?: OutputMode | undefined; denoise?: number | undefined; radius?: number | undefined; preset?: BinarizationFilterPreset | undefined; serialize?: ... | undefined; }) | undefined;
                };
            } & { _type: "CustomBinarizationFilter" }
            | {
                colorEnhancement?: number;
                contrastEnhancement?: number;
                paperWhitening?: number;
                paperWhiteningBias?: number;
                serialize?: (
                    config?: ToJsonConfiguration,
                ) => {
                    _type?: "ColorDocumentFilter";
                    colorEnhancement?: number;
                    contrastEnhancement?: number;
                    paperWhitening?: number;
                    paperWhiteningBias?: number;
                    serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "ColorDocumentFilter" | undefined; contrastEnhancement?: number | undefined; colorEnhancement?: number | undefined; paperWhitening?: number | undefined; paperWhiteningBias?: number | undefined; serialize?: ... | undefined; }) | undefined;
                };
            } & { _type: "ColorDocumentFilter" }
            | {
                brightness?: number;
                serialize?: (
                    config?: ToJsonConfiguration,
                ) => {
                    _type?: "BrightnessFilter";
                    brightness?: number;
                    serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "BrightnessFilter" | undefined; brightness?: number | undefined; serialize?: ... | undefined; }) | undefined;
                };
            } & { _type: "BrightnessFilter" }
            | {
                contrast?: number;
                serialize?: (
                    config?: ToJsonConfiguration,
                ) => {
                    _type?: "ContrastFilter";
                    contrast?: number;
                    serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "ContrastFilter" | undefined; contrast?: number | undefined; serialize?: ... | undefined; }) | undefined;
                };
            } & { _type: "ContrastFilter" }
            | {
                blackOutliersFraction?: number;
                borderWidthFraction?: number;
                serialize?: (
                    config?: ToJsonConfiguration,
                ) => {
                    _type?: "GrayscaleFilter";
                    blackOutliersFraction?: number;
                    borderWidthFraction?: number;
                    serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "GrayscaleFilter" | undefined; borderWidthFraction?: number | undefined; blackOutliersFraction?: number | undefined; whiteOutliersFraction?: number | undefined; serialize?: ... | undefined; }) | undefined;
                    whiteOutliersFraction?: number;
                };
                whiteOutliersFraction?: number;
            } & { _type: "GrayscaleFilter" }
            | {
                blackPoint?: number;
                serialize?: (
                    config?: ToJsonConfiguration,
                ) => {
                    _type?: "WhiteBlackPointFilter";
                    blackPoint?: number;
                    serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "WhiteBlackPointFilter" | undefined; blackPoint?: number | undefined; whitePoint?: number | undefined; serialize?: ... | undefined; }) | undefined;
                    whitePoint?: number;
                };
                whitePoint?: number;
            } & { _type: "WhiteBlackPointFilter" }
        )[]
        | null

    The list of filters applied to the page.

  • Optional ReadonlyoriginalImageURI?: string

    The URI of the original image.

  • Optional Readonlypolygon?: Point[]

    The polygon of the page.

  • Optionalserialize?: (
        config?: ToJsonConfiguration,
    ) => { readonly uuid?: string | undefined; readonly filters?: (({ filterType?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => { readonly _type?: "LegacyFilter" | undefined; filterType?: number | undefined; serialize?: ... | undefined; }) | undefined; } & { ...; }) | ... 6 more ... | ({ ......

  • Optional Readonlysource?: PageImageSource | null

    The source of the page image.

  • Optional ReadonlyunfilteredDocumentImageURI?: string | null

    The URI of the unfiltered document image.

  • Optional Readonlyuuid?: string

    The unique identifier of the page.