Class PageData

constructor

• new PageData(source?): PageData

• Parameters

  • Optional source: DeepPartial<PageData>

  Returns PageData

Readonly documentDetectionStatus

Readonly documentImagePreviewURI

Readonly documentImageURI

Readonly documentQuality

Readonly filters

Readonly originalImageURI

Readonly polygon

Readonly source

Readonly unfilteredDocumentImageURI

Readonly uuid

serialize

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

• Parameters

  • Optional config: ToJsonConfiguration

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

    The detection status of the page.

  • Optional Readonly documentImagePreviewURI?: null | string

    The URI of the document image preview.

  • Optional Readonly documentImageURI?: null | string

    The URI of the document image.

  • Optional Readonly documentQuality?: null | DocumentQuality

    The quality score of the page.

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

    The list of filters applied to the page.

  • Optional Readonly originalImageURI?: string

    The URI of the original image.

  • Optional Readonly polygon?: Point[]

    The polygon of the page.

  • Optional Readonly source?: null | PageImageSource

    The source of the page image.

  • Optional Readonly unfilteredDocumentImageURI?: null | string

    The URI of the unfiltered document image.

  • Optional Readonly uuid?: string

    The unique identifier of the page.

  • serialize?:function

    • serialize(config?): { 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 ... | ({ ......

    • Parameters

      • Optional config: ToJsonConfiguration

      Returns { 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 ... | ({ ......