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 | (undefined | {
          _type?: "ScanbotBinarizationFilter";
          outputMode?: OutputMode;
      } | {
          _type?: "CustomBinarizationFilter";
          denoise?: number;
          outputMode?: OutputMode;
          preset?: BinarizationFilterPreset;
          radius?: number;
      } | {
          _type?: "ColorDocumentFilter";
      } | {
          _type?: "BrightnessFilter";
          brightness?: number;
      } | {
          _type?: "ContrastFilter";
          contrast?: number;
      } | {
          _type?: "GrayscaleFilter";
          blackOutliersFraction?: number;
          borderWidthFraction?: number;
          whiteOutliersFraction?: number;
      } | {
          _type?: "LegacyFilter";
          filterType?: number;
      } | {
          _type?: "WhiteBlackPointFilter";
          blackPoint?: number;
          whitePoint?: number;
      })[];
      originalImageURI?: string;
      polygon?: (undefined | {
          x?: number;
          y?: number;
      })[];
      source?: null | PageImageSource;
      unfilteredDocumentImageURI?: null | string;
      uuid?: string;
      serialize?: any;
  }

• Parameters

  • Optional config: ToJsonConfiguration

  Returns {
      documentDetectionStatus?: null | DocumentDetectionStatus;
      documentImagePreviewURI?: null | string;
      documentImageURI?: null | string;
      documentQuality?: null | DocumentQuality;
      filters?: null | (undefined | {
          _type?: "ScanbotBinarizationFilter";
          outputMode?: OutputMode;
      } | {
          _type?: "CustomBinarizationFilter";
          denoise?: number;
          outputMode?: OutputMode;
          preset?: BinarizationFilterPreset;
          radius?: number;
      } | {
          _type?: "ColorDocumentFilter";
      } | {
          _type?: "BrightnessFilter";
          brightness?: number;
      } | {
          _type?: "ContrastFilter";
          contrast?: number;
      } | {
          _type?: "GrayscaleFilter";
          blackOutliersFraction?: number;
          borderWidthFraction?: number;
          whiteOutliersFraction?: number;
      } | {
          _type?: "LegacyFilter";
          filterType?: number;
      } | {
          _type?: "WhiteBlackPointFilter";
          blackPoint?: number;
          whitePoint?: number;
      })[];
      originalImageURI?: string;
      polygon?: (undefined | {
          x?: number;
          y?: number;
      })[];
      source?: null | PageImageSource;
      unfilteredDocumentImageURI?: null | string;
      uuid?: string;
      serialize?: any;
  }

  • 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 | (undefined | {
        _type?: "ScanbotBinarizationFilter";
        outputMode?: OutputMode;
    } | {
        _type?: "CustomBinarizationFilter";
        denoise?: number;
        outputMode?: OutputMode;
        preset?: BinarizationFilterPreset;
        radius?: number;
    } | {
        _type?: "ColorDocumentFilter";
    } | {
        _type?: "BrightnessFilter";
        brightness?: number;
    } | {
        _type?: "ContrastFilter";
        contrast?: number;
    } | {
        _type?: "GrayscaleFilter";
        blackOutliersFraction?: number;
        borderWidthFraction?: number;
        whiteOutliersFraction?: number;
    } | {
        _type?: "LegacyFilter";
        filterType?: number;
    } | {
        _type?: "WhiteBlackPointFilter";
        blackPoint?: number;
        whitePoint?: number;
    })[]

    The list of filters applied to the page.

  • Optional Readonly originalImageURI?: string

    The URI of the original image.

  • Optional Readonly polygon?: (undefined | {
        x?: number;
        y?: number;
    })[]

    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.