Accessors is get isDraft( ) : boolean Returns boolean page get pageCount( ) : number Returns number Methods add add ( response , position ? ) : Promise < void > Parameters Optional position : number Returns Promise < void > apply apply ( page , data ) : Promise < void > Parameters data : { filters ?: ParametricFilter [] ; polygon ?: Point [] ; rotations ?: number ; } Optional polygon ?: Point [] Optional rotations ?: number Returns Promise < void > create create ( generatorOptions ) : Promise < ArrayBuffer > Parameters generatorOptions : { attributes ?: { author?: string; creator?: string; title?: string; subject?: string; keywords?: string; }; binarizationFilter ?: { filterType ?: number ; } & { _type : "LegacyFilter" ; } | { outputMode ?: OutputMode ; } & { _type : "ScanbotBinarizationFilter" ; } | { denoise ?: number ; outputMode ?: OutputMode ; preset ?: BinarizationFilterPreset ; radius ?: number ; } & { _type : "CustomBinarizationFilter" ; } | { colorEnhancement ?: number ; contrastEnhancement ?: number ; paperWhitening ?: number ; paperWhiteningBias ?: number ; } & { _type : "ColorDocumentFilter" ; } | { colorEnhancement ?: number ; contrastEnhancement ?: number ; paperLightness ?: number ; paperSaturation ?: number ; } & { _type : "ColorDocumentShadowRemovalFilter" ; } | { brightness ?: number ; } & { _type : "BrightnessFilter" ; } | { contrast ?: number ; } & { _type : "ContrastFilter" ; } | { blackOutliersFraction ?: number ; borderWidthFraction ?: number ; whiteOutliersFraction ?: number ; } & { _type : "GrayscaleFilter" ; } | { blackPoint ?: number ; whitePoint ?: number ; } & { _type : "WhiteBlackPointFilter" ; } ; dpi ?: number ; jpegOptimize ?: boolean ; jpegQuality ?: number ; pageDirection ?: PageDirection ; pageFit ?: PageFit ; pageSize ?: PageSize ; resamplingMethod ?: ResamplingMethod ; } & { runOcr ?: boolean ; } Returns Promise < ArrayBuffer > create create ( generatorOptions ? , pageOptions ? ) : Promise < ArrayBuffer > Parameters Optional generatorOptions : { binarizationFilter ?: { filterType ?: number ; } & { _type : "LegacyFilter" ; } | { outputMode ?: OutputMode ; } & { _type : "ScanbotBinarizationFilter" ; } | { denoise ?: number ; outputMode ?: OutputMode ; preset ?: BinarizationFilterPreset ; radius ?: number ; } & { _type : "CustomBinarizationFilter" ; } | { colorEnhancement ?: number ; contrastEnhancement ?: number ; paperWhitening ?: number ; paperWhiteningBias ?: number ; } & { _type : "ColorDocumentFilter" ; } | { colorEnhancement ?: number ; contrastEnhancement ?: number ; paperLightness ?: number ; paperSaturation ?: number ; } & { _type : "ColorDocumentShadowRemovalFilter" ; } | { brightness ?: number ; } & { _type : "BrightnessFilter" ; } | { contrast ?: number ; } & { _type : "ContrastFilter" ; } | { blackOutliersFraction ?: number ; borderWidthFraction ?: number ; whiteOutliersFraction ?: number ; } & { _type : "GrayscaleFilter" ; } | { blackPoint ?: number ; whitePoint ?: number ; } & { _type : "WhiteBlackPointFilter" ; } ; compression ?: CompressionMode ; dpi ?: number ; jpegQuality ?: number ; userFields ?: ( { tag?: number; name?: string; value?: ({ value?: number; } & { readonly _type: "UserFieldDoubleValue"; }) | ({ value?: string; } & { readonly _type: "UserFieldStringValue"; }) | ({ value?: number; } & { ...; }); }) [] ; zipCompressionLevel ?: number ; } Optional binarization ?: { filterType ?: number ; } & { _type : "LegacyFilter" ; } | { outputMode ?: OutputMode ; } & { _type : "ScanbotBinarizationFilter" ; } | { denoise ?: number ; outputMode ?: OutputMode ; preset ?: BinarizationFilterPreset ; radius ?: number ; } & { _type : "CustomBinarizationFilter" ; } | { colorEnhancement ?: number ; contrastEnhancement ?: number ; paperWhitening ?: number ; paperWhiteningBias ?: number ; } & { _type : "ColorDocumentFilter" ; } | { colorEnhancement ?: number ; contrastEnhancement ?: number ; paperLightness ?: number ; paperSaturation ?: number ; } & { _type : "ColorDocumentShadowRemovalFilter" ; } | { brightness ?: number ; } & { _type : "BrightnessFilter" ; } | { contrast ?: number ; } & { _type : "ContrastFilter" ; } | { blackOutliersFraction ?: number ; borderWidthFraction ?: number ; whiteOutliersFraction ?: number ; } & { _type : "GrayscaleFilter" ; } | { blackPoint ?: number ; whitePoint ?: number ; } & { _type : "WhiteBlackPointFilter" ; } Optional dpi ?: number Optional jpeg ?: number Optional user ?: ( { tag?: number; name?: string; value?: ({ value?: number; } & { readonly _type: "UserFieldDoubleValue"; }) | ({ value?: string; } & { readonly _type: "UserFieldStringValue"; }) | ({ value?: number; } & { ...; }); }) [] Optional zip ?: number Optional pageOptions : Omit < TiffPageOptions , "consumeImage" > Returns Promise < ArrayBuffer > crop crop ( index , polygon , rotations ) : Promise < void > Parameters index : number polygon : Point [] rotations : number Returns Promise < void > crop crop ( page , polygon , rotations ) : Promise < void > Parameters polygon : Point [] rotations : number Returns Promise < void > delete delete ( ) : Promise < void > Returns Promise < void > delete delete ( ) : Promise < void > Returns Promise < void > delete delete ( position ) : Promise < void > Returns Promise < void > delete delete ( page ) : Promise < void > Returns Promise < void > delete delete ( ) : Promise < boolean > Returns Promise < boolean > delete delete ( ) : Promise < boolean > Returns Promise < boolean > load load ( ) : Promise < ArrayBuffer > Returns Promise < ArrayBuffer > load load ( ) : Promise < ArrayBuffer > Returns Promise < ArrayBuffer > move move ( from , to ) : Promise < void > Returns Promise < void > straighten straighten ( page , params ? ) : Promise < Image > Parameters Optional params : { aspectRatios ?: ( { readonly width?: number; readonly height?: number; }) [] ; straighteningMode ?: DocumentStraighteningMode ; } Optional aspect ?: ( { readonly width?: number; readonly height?: number; }) [] Returns Promise < Image > update update ( ) : Promise < number > Returns Promise < number >
Filter to apply to the input image when adding pages with binarization. If set, the filter is applied to the input image and the resulting image is stored as a 1-bit TIFF. When storing documents it's typically best to use the BINARY_DOCUMENT_OPTIMIZED_COMPRESSION compression mode (CCITT_T6) instead of the default, as it tends to produce the smallest file sizes. If not set, simple thresholding is applied to the image, instead.