RedactAnnotation

DsPdfJS API / RedactAnnotation

Class: RedactAnnotation

Represents 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.

Extends

MarkupAnnotation

Constructors

Constructor

new RedactAnnotation(om): RedactAnnotation

Creates a new RedactAnnotation.

Parameters

om

ObjectManager

ObjectManager that controls the lifetime of the RedactAnnotation.

Returns

RedactAnnotation

Overrides

MarkupAnnotation.constructor

Constructor

new RedactAnnotation(): RedactAnnotation

Creates a new RedactAnnotation.

Returns

RedactAnnotation

Overrides

MarkupAnnotation.constructor

Accessors

area

Get Signature

get area(): Quadrilateral[] | null

Gets or sets 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.

Returns

Quadrilateral[] | null

Set Signature

set area(value): void

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.

Parameters

value

(Rect | Quadrilateral)[] | null

Returns

void

color

Get Signature

get color(): Color

Gets or sets the annotation color, it used as color of popup window, lines color etc.

Returns

Color

Set Signature

set color(value): void

Gets or sets the annotation color, it used as color of popup window, lines color etc.

Parameters

value

Color

Returns

void

Inherited from

MarkupAnnotation.color

Get Signature

get contents(): string | null

Gets or sets the text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form. In either case, this text is useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes.

Returns

string | null

Set Signature

set contents(value): void

Parameters

value

string | null

Returns

void

Inherited from

MarkupAnnotation.contents

creationDate

Get Signature

get creationDate(): PdfDateTime | null

Gets or sets the date and time when the annotation was created.

Returns

PdfDateTime | null

Set Signature

set creationDate(value): void

Gets or sets the date and time when the annotation was created.

Parameters

value

PdfDateTime | null

Returns

void

Inherited from

MarkupAnnotation.creationDate

doc

Get Signature

get doc(): PdfDocument | null

Gets the PdfDocument owning this annotation.

Returns

PdfDocument | null

Inherited from

MarkupAnnotation.doc

flags

Get Signature

get flags(): AnnotationFlags

Gets or sets the flags specifying various characteristics of the annotation.

Returns

AnnotationFlags

Set Signature

set flags(value): void

Gets or sets the flags specifying various characteristics of the annotation.

Parameters

value

AnnotationFlags

Returns

void

Inherited from

MarkupAnnotation.flags

id

Get Signature

get id(): number

Gets the reference to the object.

Returns

number

Inherited from

MarkupAnnotation.id

justification

Get Signature

get justification(): VariableTextJustification

Gets or sets the justification to be used in displaying the overlay text. See PDF specification for details.

Returns

VariableTextJustification

Set Signature

set justification(value): void

Gets or sets the justification to be used in displaying the overlay text. See PDF specification for details.

Parameters

value

VariableTextJustification

Returns

void

locked

Get Signature

get locked(): boolean

Gets or sets a value indicating whether the annotation can be deleted or its properties (including position and size) can be modified by the user. However, this flag does not restrict changes to the annotation's contents, such as the value of a form field.

Returns

boolean

Set Signature

set locked(value): void

Parameters

value

boolean

Returns

void

Inherited from

MarkupAnnotation.locked

lockedContents

Get Signature

get lockedContents(): boolean

Gets or sets a value indicating whether the contents of the annotation can be modified by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size.

Returns

boolean

Set Signature

set lockedContents(value): void

Parameters

value

boolean

Returns

void

Inherited from

MarkupAnnotation.lockedContents

markBorderColor

Get Signature

get markBorderColor(): Color | null

Gets or sets the outline color used to highlight the annotation rectangle.

Returns

Color | null

Set Signature

set markBorderColor(value): void

Gets or sets the outline color used to highlight the annotation rectangle.

Parameters

value

Color | null

Returns

void

markFillColor

Get Signature

get markFillColor(): Color | null

Gets or sets the color used to fill the annotation rectangle.

Returns

Color | null

Set Signature

set markFillColor(value): void

Gets or sets the color used to fill the annotation rectangle.

Parameters

value

Color | null

Returns

void

modifiedDate

Get Signature

get modifiedDate(): PdfDateTime | null

Gets or sets the date and time when the annotation was modified.

Returns

PdfDateTime | null

Set Signature

set modifiedDate(value): void

Gets or sets the date and time when the annotation was modified.

Parameters

value

PdfDateTime | null

Returns

void

Inherited from

MarkupAnnotation.modifiedDate

name

Get Signature

get name(): string | null

Gets or sets the annotation name, a text string uniquely identifying it among all annotations on its page.

Returns

string | null

Set Signature

set name(value): void

Gets or sets the annotation name, a text string uniquely identifying it among all annotations on its page.

Parameters

value

string | null

Returns

void

Inherited from

MarkupAnnotation.name

om

Get Signature

get om(): ObjectManager

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

MarkupAnnotation.om

opacity

Get Signature

get opacity(): number

Gets or sets the opacity value to be used in painting the annotation. This value applies to all visible elements of the annotation in its closed state (including its background and border) but not to the pop-up window that appears when the annotation is opened.

Returns

number

Set Signature

set opacity(value): void

Parameters

value

number

Returns

void

Inherited from

MarkupAnnotation.opacity

overlayAppearance

Get Signature

get overlayAppearance(): DefaultAppearance

Gets the DefaultAppearance object that specifies the visual properties (font, font size etc.) used to format the overlay text.

Returns

DefaultAppearance

overlayFillColor

Get Signature

get overlayFillColor(): Color

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

Returns

Color

Set Signature

set overlayFillColor(value): void

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

Parameters

value

Color

Returns

void

overlayText

Get Signature

get overlayText(): string | null

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

Returns

string | null

Set Signature

set overlayText(value): void

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

Parameters

value

string | null

Returns

void

overlayTextRepeat

Get Signature

get overlayTextRepeat(): boolean

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

Returns

boolean

Set Signature

set overlayTextRepeat(value): void

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

Parameters

value

boolean

Returns

void

page

Get Signature

get page(): PdfPage | null

Gets or sets the PdfPage that contains this annotation. Note that an annotation may be referenced by several pages. In that case this property returns the first element in the pages collection. When setting this property, the following applies: If the new value is null, this annotation is removed from all pages. Otherwise, this annotation is assigned exclusively to the specified page.

Returns

PdfPage | null

Set Signature

set page(value): void

Parameters

value

PdfPage | null

Returns

void

Inherited from

UnknownAnnotation.page

pdfArea

Get Signature

get pdfArea(): Quadrilateral[] | null

Gets or sets the list of Quadrilateral structures defining the annotation area. The coordinates of the quadrilaterals' points are in PDF user space coordinates. The positive X axis extends horizontally to the right, and the positive Y axis extends vertically upward, with the origin usually in the lower left corner of the page.

Returns

Quadrilateral[] | null

Set Signature

set pdfArea(value): void

Parameters

value

(Rect | Quadrilateral)[] | null

Returns

void

pdfRect

Get Signature

get pdfRect(): Rect

Gets or sets the rectangle that defines the location and size of the annotation on a page in PDF user space coordinates. The positive X axis extends horizontally to the right, and the positive Y axis extends vertically upward, with the origin usually in the lower left corner of the page.

See

rect

Returns

Rect

Set Signature

set pdfRect(value): void

See

rect

Parameters

value

Rect

Returns

void

Inherited from

MarkupAnnotation.pdfRect

Get Signature

get popup(): PopupAnnotation | null

Gets or sets the PopupAnnotation annotation for entering or editing text associated with this annotation. Setting this property changes the PopupAnnotation#parent property. A separate PopupAnnotation allows defining additional properties of the popup window: color, position etc.

Returns

PopupAnnotation | null

Set Signature

set popup(value): void

Parameters

value

PopupAnnotation | null

Returns

void

Inherited from

MarkupAnnotation.popup

rect

Get Signature

get rect(): Rect

Gets or sets the rectangle that defines the location and size of the annotation on a page. The coordinates of the rectangle 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 rectangle's location.

Returns

Rect

Set Signature

set rect(value): void

Parameters

value

Rect

Returns

void

Inherited from

UnknownAnnotation.rect

referenceAnnotation

Get Signature

get referenceAnnotation(): MarkupAnnotation | null

Gets or sets the annotation referenced by this annotation.

Returns

MarkupAnnotation | null

Set Signature

set referenceAnnotation(value): void

Gets or sets the annotation referenced by this annotation.

Parameters

value

MarkupAnnotation | null

Returns

void

Inherited from

MarkupAnnotation.referenceAnnotation

referenceType

Get Signature

get referenceType(): string

Gets or sets the relationship (reference type) between this annotation and the annotation specified by the 'referenceAnnotation' property. The referenced annotation should be on the same page with the current annotation. The valid values: "R" (reply), "Group"

Returns

string

Set Signature

set referenceType(value): void

Parameters

value

AnnotationReferenceType

Returns

void

Inherited from

MarkupAnnotation.referenceType

richText

Get Signature

get richText(): string

Gets or sets the text to be displayed in the pop-up window when the annotation is opened. This text can be formatted using HTML tags, see PDF specification for details.

Returns

string

Set Signature

set richText(value): void

Gets or sets the text to be displayed in the pop-up window when the annotation is opened. This text can be formatted using HTML tags, see PDF specification for details.

Parameters

value

string | null

Returns

void

Inherited from

MarkupAnnotation.richText

subject

Get Signature

get subject(): string | null

Gets or sets the text representing a short description of the subject being addressed by the annotation.

Returns

string | null

Set Signature

set subject(value): void

Gets or sets the text representing a short description of the subject being addressed by the annotation.

Parameters

value

string | null

Returns

void

Inherited from

MarkupAnnotation.subject

userName

Get Signature

get userName(): string | null

Gets or sets the text label to be displayed in the title bar of the annotation's pop-up window when open and active. By convention, this entry identifies the user who added the annotation.

Returns

string | null

Set Signature

set userName(value): void

Gets or sets the text label to be displayed in the title bar of the annotation's pop-up window when open and active. By convention, this entry identifies the user who added the annotation.

Parameters

value

string | null

Returns

void

Inherited from

MarkupAnnotation.userName

Methods

free()

free(): void

Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns

void

Inherited from

MarkupAnnotation.free

rebind()

rebind(omTo): void

Rebinds the object from the current ObjectManager to the specified one.

Parameters

omTo

ObjectManager

The new ObjectManager for the object.

Returns

void

Inherited from

MarkupAnnotation.rebind

removeAppearance()

removeAppearance(): void

Removes all appearance streams associated with the current annotation, and disables generation of appearance steams for this annotation when the document is saved.

Note that if any property affecting the annotation's appearance 'rect' is then changed, the appearance streams will be regenerated. So this method would usually be called after initializing all annotation's properties.

Returns

void

Inherited from

MarkupAnnotation.removeAppearance

resetAppearance()

resetAppearance(): void

Forces regeneration of the annotation's appearance streams next time the document is saved.

Returns

void

Inherited from

MarkupAnnotation.resetAppearance