Class DocumentData

constructor

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

  Parameters

  • Optionalsource: DeepPartial<DocumentData>

  Returns DocumentData

ReadonlycreationTimestamp

ReadonlydocumentImageSizeLimit

Readonlypages

ReadonlypdfURI

ReadonlytiffURI

Readonlyuuid

serialize

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

  Parameters

  • Optionalconfig: ToJsonConfiguration

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

  • Optional ReadonlycreationTimestamp?: number

    The creation timestamp of the document.

  • Optional ReadonlydocumentImageSizeLimit?: number

    The maximum size of the document image.

    Default is 0

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

    The list of pages.

  • Optional ReadonlypdfURI?: string

    The URI of the default destination location for PDF rendering.

  • Optionalserialize?: (
        config?: ToJsonConfiguration,
    ) => { 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 ReadonlytiffURI?: string

    The URI of the default destination location for TIFF rendering.

  • Optional Readonlyuuid?: string

    The unique identifier of the document.