RedactOptions

Overview

RedactOptions is a interface in Aspose.PDF FOSS for TypeScript.

Options for {@link redactPage} / page.Redact / doc.Redact.

Properties: color, keepAnnotations, region, scrubMetadata.

Properties

NameTypeAccessDescription
region: RectReadRestrict the search to this page-space rectangle (redactText only — redactPage takes explicit rects and never sees this).
color: [number, number, number]ReadFill colour of the redaction marker box as [r, g, b] in 0..1 (default black).
scrubMetadata: booleanReadAlso clear document metadata (/Info + XMP) when true.
keepAnnotations: booleanReadKeep annotations overlapping a redacted region instead of removing them.