DsPdfJS API v9.1.0

DsPdfJS API / RedactAnnotationProperties

Type Alias: RedactAnnotationProperties

RedactAnnotationProperties = MarkupAnnotationProperties & object

Defines properties of a redact annotation used to mark areas containing information that needs to be erased from the document. Note that redact annotations must be explicitly applied (with a call to the PdfDocument#redact method or one of its overloads) to actually remove the information marked for redaction from the document.

Type Declaration

area?

optional area: Quadrilateral[]

The list of Quadrilateral structures defining the annotation area. The coordinates of the quadrilaterals' points are relative to the upper left corner of the page's media box, with the Y (vertical) coordinates increasing from top to bottom.

Note that if the annotation is associated with more than one page, the media box of the first of those pages is used to calculate the coordinates.

If not empty, these quadrilaterals denote the content region that is intended to be redacted. If this list is empty, the AnnotationBase#rect entry denotes the content region that is intended to be redacted.

justification?

optional justification: VariableTextJustification

The justification to be used in displaying the overlay text. See PDF specification for details.

markBorderColor?

optional markBorderColor: Color

The outline color used to highlight the annotation rectangle.

markFillColor?

optional markFillColor: Color

The color used to fill the annotation rectangle.

overlayAppearance?

optional overlayAppearance: DefaultAppearanceProperties | string

The appearance that specifies the visual properties (font, font size etc.) used to format the overlay text. The apperance can be specified as DefaultAppearanceProperties with set of properties like font, fontSize, foreColor or as a string as it will be stored in a PDF stream: "/DF0 10 Tf 0 0 0 rg".

overlayFillColor?

optional overlayFillColor: Color

The overlay fill color with which to fill the redacted region after the affected content has been removed.

overlayText?

optional overlayText: string

The overlay text that should be drawn over the redacted region after the affected content has been removed.

overlayTextRepeat?

optional overlayTextRepeat: boolean

The overlay text that should be drawn over the redacted region after the affected content has been removed.

type

type: "redact"

See

RedactAnnotation