Class: RedactionAnnotation

PSPDFKit.Annotations.RedactionAnnotation

Redaction annotations are used to mark regions of content or text of the document to eventually redact (i.e. remove the content from the document in an irreversible way).

You can customize how a redaction annotation looks in its marked state, which is when the redaction hasn't been applied yet, and the redacted state, that is the final appearance that the redacted region will have.

The fillColor, overlayText, color and repeatOverlayText influence the redacted appearance, while outlineColor influences the marked appearance.

Constructor

new PSPDFKit.Annotations.RedactionAnnotation(args)

Mark a region for redaction.

Parameters:
Name Type Description
args Object

An object of the members.

Extends

  • PSPDFKit.Annotation.MarkupAnnotation

Members



Members

(nullable) color: PSPDFKit.Color

Color of the overlay text.

It has no effect if there is no overlay text specified.

Type:
Default Value:
  • PSPDFKit.Color.RED

(nullable) fillColor: PSPDFKit.Color

Background color of the redacted area.

Type:
Default Value:
  • PSPDFKit.Color.BLACK

(nullable) outlineColor: PSPDFKit.Color

Color used for the redaction's border in its marked state.

Type:
Default Value:
  • PSPDFKit.Color.RED

(nullable) overlayText: string

Text to be displayed at the specified region when a redaction has been applied.

Type:
  • string

(nullable) repeatOverlayText: boolean

Whether the overlay text should be repeated to fill the entire redaction area or just be drawn once.

It has no effect if there is no overlay text specified.

Type:
  • boolean
Default Value:
  • false