RedactionModel Data Type

Redaction is used to specify the text to redact along with the properties of the redaction annotation before it is flattened and the resulting redaction.

Properties
name data type description
searchText string The text to search for and redact.
wholeWords boolean Search for whole words only. The default value is false.
caseSensitive boolean Search for only words that match the case of the searchText. The default value is false.
outlineColor string The annotation outline color. The default color is red. This can be in the format of an html predefined color name (ie Aquamarine), a hex string (ie #7FFFD4), an rgb string (ie rgb(127,255,212)), or as an int string (ie 8388564).
fillColor string The annotation fill color. There is no fill by default.
transparency number The annotation transparency as a value between 0 and 1 with 0 being opaque and 1 being completely transparent. The default value is 0.
overlayFillColor string The overlay fill color. The default color is black.
overlayTextColor string The overlay text color. The default color is white.
overlayText string The overlay text that should be drawn over the redacted region.
overlayFontName string The name of the overlay text Font.

The supported fonts are Helvetica, Helvetica-Bold, Helvetica-Oblique, Helvetica-BoldOblique, Courier, Courier-Bold, Courier-Oblique, Courier-BoldOblique, Times-Roman, Times-Bold, Times-Italic, Times-BoldItalic.

The default font is Helvetica.

overlayFontSize number The size of the overlay font. If the size is 0, then the text will be resized to fill the redacted region. The default font size is 12.
overlayAlignment number The overlay text horizontal alignment. Must be one of 0 (left), 1 (center), or 2 (right). 0 is the default value.
overlayRepeat boolean The flag that determines if the overlay text will repeat to fill the redacted region. The default value is false.

Example

{
  "searchText" : "...",
  "wholeWords" : true,
  "caseSensitive" : true,
  "outlineColor" : "...",
  "fillColor" : "...",
  "transparency" : 12345.0,
  "overlayFillColor" : "...",
  "overlayTextColor" : "...",
  "overlayText" : "...",
  "overlayFontName" : "...",
  "overlayFontSize" : 12345.0,
  "overlayAlignment" : 12345,
  "overlayRepeat" : true
}