Nutrient Web SDK

ReferenceRedactionAnnotationPreset

Type Alias RedactionAnnotationPreset

Redaction Annotation presets are sets of property-value pairs for annotations that can be applied as default annotations settings for Redaction Annotations. When a property of a Redaction Annotation is changed by the user, the annotation preset of the redaction annotations gets updated. This means that all the Redaction annotations created after this action will use that preset unless a different preset is specified.

For properties not included in the annotation preset, the default values of those properties are used.

Type Alias

Example

Creating an annotation preset and adding it to the available annotation presets

const myAnnotationPresets = instance.annotationPresets
myAnnotationPresets['redaction'] = {
color: NutrientViewer.Color.BLACK,
}
instance.setAnnotationPresets(myAnnotationPresets);

Properties

color

Optional

Color of the overlay text.

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

Default Value

NutrientViewer.Color.RED

creatorName

Optional
string

Name of the creator

fillColor

Optional

Background color of the redacted area.

Default Value

NutrientViewer.Color.BLACK

outlineColor

Optional

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

Default Value

NutrientViewer.Color.RED

overlayText

Optional
string

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

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.

Default Value

false