RedactOptions

Type Alias: RedactOptions

RedactOptions = object

Represents additional options to use when a document is being redacted.

Properties

copyImagesOnRedact?

optional copyImagesOnRedact: boolean

Indicates whether images within the redacted area that also appear in other locations will be copied before applying the redact. If this property is true, only the appearance of the redacted area will be affected. If this property is false, if an image within the redacted area also appears in other locations, all these locations will be affected. The default is false.

ignoreUnreadableObjects?

optional ignoreUnreadableObjects: boolean

Indicates whether to completely remove objects that need to be partially redacted but which are unreadable or unknown to DsPdfJS.

If true (the default), such objects will be silently removed. Otherwise an exception will be thrown.

precision?

optional precision: number

The maximum distance (in points) between a PDF object's boundary that is outside a redact area, and the redact area's edge, at which the object is still considered to be inside the redact.

The default value is 2 points.

renderOptions?

optional renderOptions: object

The additional options used when a redact action requires that some PDF content is rendered as an image.

allowFontSbits?

optional allowFontSbits: boolean

Indicating whether bitmaps embedded in an OpenType font should be rendered. The default is true. This property is ignored if either 'UseRenderingCache' or 'UseGlyphBitmapCache' is false.

backColor?

optional backColor: Color

The background color. The default is "White".

interpolationMode?

optional interpolationMode: InterpolationMode

The sampling mode to use when drawing images with resizing. Default is "NearestNeighbor".

useGlyphBitmapCache?

optional useGlyphBitmapCache: boolean

Indicates whether glyphs are cached as bitmaps rather than as glyph paths. The default is true. This property is ignored if 'UseRenderingCache' is false.

useRenderingCache?

optional useRenderingCache: boolean

Indicates whether to use the rendering cache.

This property is true by default. Setting this property to false reduces memory consumption, at the cost of slower rendering speed.

zoom?

optional zoom: number

The zoom factor. The default is 1.