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?: {
          documentDetectionStatus?: null | DocumentDetectionStatus;
          documentImagePreviewURI?: null | string;
          documentImageURI?: null | string;
          documentQuality?: null | DocumentQuality;
          filters?: null | ({
              filterType?: number;
              serialize?(config?): {
                  _type?: (...) | (...);
                  filterType?: (...) | (...);
                  serialize?(config?): { readonly _type?: "LegacyFilter" | undefined; filterType?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
              };
          } & {
              _type: "LegacyFilter";
          } | {
              outputMode?: OutputMode;
              serialize?(config?): {
                  _type?: (...) | (...);
                  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?: (...) | (...);
                  denoise?: (...) | (...);
                  outputMode?: (...) | (...);
                  preset?: (...) | (...);
                  radius?: (...) | (...);
                  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?: (...) | (...);
                  colorEnhancement?: (...) | (...);
                  contrastEnhancement?: (...) | (...);
                  paperWhitening?: (...) | (...);
                  paperWhiteningBias?: (...) | (...);
                  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?: (...) | (...);
                  brightness?: (...) | (...);
                  serialize?(config?): { readonly _type?: "BrightnessFilter" | undefined; brightness?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
              };
          } & {
              _type: "BrightnessFilter";
          } | {
              contrast?: number;
              serialize?(config?): {
                  _type?: (...) | (...);
                  contrast?: (...) | (...);
                  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?: (...) | (...);
                  blackOutliersFraction?: (...) | (...);
                  borderWidthFraction?: (...) | (...);
                  whiteOutliersFraction?: (...) | (...);
                  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?: (...) | (...);
                  blackPoint?: (...) | (...);
                  whitePoint?: (...) | (...);
                  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 ... | ({ ......;
      }[];
      pdfURI?: string;
      tiffURI?: string;
      uuid?: string;
      serialize?(config?): { readonly uuid?: string | undefined; readonly creationTimestamp?: number | undefined; readonly pages?: { readonly uuid?: string | undefined; readonly filters?: (({ filterType?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => { ...; }) | undefined; } & { ...; }) | ... 6 more ... | ({ ....;
  }

• Parameters

  • Optional config: ToJsonConfiguration

  Returns {
      creationTimestamp?: number;
      documentImageSizeLimit?: number;
      pages?: {
          documentDetectionStatus?: null | DocumentDetectionStatus;
          documentImagePreviewURI?: null | string;
          documentImageURI?: null | string;
          documentQuality?: null | DocumentQuality;
          filters?: null | ({
              filterType?: number;
              serialize?(config?): {
                  _type?: (...) | (...);
                  filterType?: (...) | (...);
                  serialize?(config?): { readonly _type?: "LegacyFilter" | undefined; filterType?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
              };
          } & {
              _type: "LegacyFilter";
          } | {
              outputMode?: OutputMode;
              serialize?(config?): {
                  _type?: (...) | (...);
                  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?: (...) | (...);
                  denoise?: (...) | (...);
                  outputMode?: (...) | (...);
                  preset?: (...) | (...);
                  radius?: (...) | (...);
                  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?: (...) | (...);
                  colorEnhancement?: (...) | (...);
                  contrastEnhancement?: (...) | (...);
                  paperWhitening?: (...) | (...);
                  paperWhiteningBias?: (...) | (...);
                  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?: (...) | (...);
                  brightness?: (...) | (...);
                  serialize?(config?): { readonly _type?: "BrightnessFilter" | undefined; brightness?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
              };
          } & {
              _type: "BrightnessFilter";
          } | {
              contrast?: number;
              serialize?(config?): {
                  _type?: (...) | (...);
                  contrast?: (...) | (...);
                  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?: (...) | (...);
                  blackOutliersFraction?: (...) | (...);
                  borderWidthFraction?: (...) | (...);
                  whiteOutliersFraction?: (...) | (...);
                  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?: (...) | (...);
                  blackPoint?: (...) | (...);
                  whitePoint?: (...) | (...);
                  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 ... | ({ ......;
      }[];
      pdfURI?: string;
      tiffURI?: string;
      uuid?: string;
      serialize?(config?): { readonly uuid?: string | undefined; readonly creationTimestamp?: number | undefined; readonly pages?: { readonly uuid?: string | undefined; readonly filters?: (({ filterType?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => { ...; }) | undefined; } & { ...; }) | ... 6 more ... | ({ ....;
  }

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

    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.

  • serialize?:function

    • serialize(config?): { readonly uuid?: string | undefined; readonly creationTimestamp?: number | undefined; readonly pages?: { readonly uuid?: string | undefined; readonly filters?: (({ filterType?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => { ...; }) | undefined; } & { ...; }) | ... 6 more ... | ({ ....

    • Parameters

      • Optional config: ToJsonConfiguration

      Returns { readonly uuid?: string | undefined; readonly creationTimestamp?: number | undefined; readonly pages?: { readonly uuid?: string | undefined; readonly filters?: (({ filterType?: number | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => { ...; }) | undefined; } & { ...; }) | ... 6 more ... | ({ ....