Class DocumentData

constructor

• new DocumentData(source?): DocumentData

• Parameters

  • Optional source: DeepPartial<DocumentData>

  Returns DocumentData

Readonly creationTimestamp

Readonly documentImageSizeLimit

Readonly pages

Readonly pdfURI

Readonly tiffURI

Readonly uuid

serialize

• serialize(config?): {
      creationTimestamp?: number;
      documentImageSizeLimit?: number;
      pages?: (undefined | {
          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;
      })[];
      pdfURI?: string;
      tiffURI?: string;
      uuid?: string;
      serialize?: any;
  }

• Parameters

  • Optional config: ToJsonConfiguration

  Returns {
      creationTimestamp?: number;
      documentImageSizeLimit?: number;
      pages?: (undefined | {
          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;
      })[];
      pdfURI?: string;
      tiffURI?: string;
      uuid?: string;
      serialize?: any;
  }

  • Optional Readonly creationTimestamp?: number

    The creation timestamp of the document.

  • Optional Readonly documentImageSizeLimit?: number

    The maximum size of the document image.

    Default is 0

  • Optional Readonly pages?: (undefined | {
        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;
    })[]

    The list of pages.

  • Optional Readonly pdfURI?: string

    The URI of the default destination location for PDF rendering.

  • Optional Readonly tiffURI?: string

    The URI of the default destination location for TIFF rendering.

  • Optional Readonly uuid?: string

    The unique identifier of the document.