Nutrient Web SDK
    Preparing search index...

    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.

    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);
    type RedactionAnnotationPreset = {
        color?: NutrientViewer.Color;
        creatorName?: string;
        fillColor?: NutrientViewer.Color;
        outlineColor?: NutrientViewer.Color;
        overlayText?: string;
        repeatOverlayText?: boolean;
    }
    Index

    Properties

    color? creatorName? fillColor? outlineColor? overlayText? repeatOverlayText?

    Properties

    color?: NutrientViewer.Color

    Color of the overlay text.

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

    NutrientViewer.Color.RED
    creatorName?: string

    Name of the creator

    fillColor?: NutrientViewer.Color

    Background color of the redacted area.

    NutrientViewer.Color.BLACK
    outlineColor?: NutrientViewer.Color

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

    NutrientViewer.Color.RED
    overlayText?: string

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

    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.

    false

    Settings

    Member Visibility

    On This Page

    Properties