Accessors is get isDraft( ) : boolean Returns boolean page get pageCount( ) : number Returns number Methods add add ( result , quality , source , position ? ) : Promise < void > Parameters Optional position : number Returns Promise < void > create create ( generatorOptions ) : Promise < ArrayBuffer > Parameters generatorOptions : { attributes ?: { author?: string; creator?: string; title?: string; subject?: string; keywords?: string; _marker?: () => void; }; dpi ?: number ; 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 ?: ( { readonly _type?: "ScanbotBinarizationFilter"; outputMode?: OutputMode; _marker?: () => void; }) | ( { readonly _type?: "CustomBinarizationFilter"; outputMode?: OutputMode; denoise?: number; radius?: number; preset?: BinarizationFilterPreset; _marker?: () => void; }) | ( { readonly _type?: "ColorDocumentFilter"; _marker?: () => void; }) | ( { readonly _type?: "BrightnessFilter"; brightness?: number; _marker?: () => void; }) | ( { readonly _type?: "ContrastFilter"; contrast?: number; _marker?: () => void; }) | ( { readonly _type?: "GrayscaleFilter"; borderWidthFraction?: number; blackOutliersFraction?: number; whiteOutliersFraction?: number; _marker?: () => void; }) | ( { readonly _type?: "LegacyFilter"; filterType?: number; _marker?: () => void; }) | ( { readonly _type?: "WhiteBlackPointFilter"; blackPoint?: number; whitePoint?: number; _marker?: () => void; }) ; compression ?: CompressionMode ; dpi ?: number ; jpegQuality ?: number ; userFields ?: ( { tag?: number; name?: string; value?: { readonly _type?: "UserFieldDoubleValue"; value?: number; _marker?: () => void; } | { readonly _type?: "UserFieldStringValue"; value?: string; _marker?: () => void; } | { ...; }; _marker?: () => void; }) [] ; zipCompressionLevel ?: number ; } Optional binarization ?: ( { readonly _type?: "ScanbotBinarizationFilter"; outputMode?: OutputMode; _marker?: () => void; }) | ( { readonly _type?: "CustomBinarizationFilter"; outputMode?: OutputMode; denoise?: number; radius?: number; preset?: BinarizationFilterPreset; _marker?: () => void; }) | ( { readonly _type?: "ColorDocumentFilter"; _marker?: () => void; }) | ( { readonly _type?: "BrightnessFilter"; brightness?: number; _marker?: () => void; }) | ( { readonly _type?: "ContrastFilter"; contrast?: number; _marker?: () => void; }) | ( { readonly _type?: "GrayscaleFilter"; borderWidthFraction?: number; blackOutliersFraction?: number; whiteOutliersFraction?: number; _marker?: () => void; }) | ( { readonly _type?: "LegacyFilter"; filterType?: number; _marker?: () => void; }) | ( { readonly _type?: "WhiteBlackPointFilter"; blackPoint?: number; whitePoint?: number; _marker?: () => void; }) Optional dpi ?: number Optional jpeg ?: number Optional user ?: ( { tag?: number; name?: string; value?: { readonly _type?: "UserFieldDoubleValue"; value?: number; _marker?: () => void; } | { readonly _type?: "UserFieldStringValue"; value?: string; _marker?: () => void; } | { ...; }; _marker?: () => void; }) [] 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 > 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.