Nutrient Web SDK
    Preparing search index...

    Enumeration InteractionMode

    Controls the current interaction mode in the viewer.

    Index

    Enumeration Members

    ATTACHMENT_PREVIEW: "ATTACHMENT_PREVIEW"

    When this mode is activated, the attachment preview mode will be activated.

    BUTTON_WIDGET: "BUTTON_WIDGET"

    When this mode is activated, the creation of button widget annotations is enabled.

    CALLOUT: "CALLOUT"

    When this mode is activated, the creation of new callout annotations will be enabled. This transforms the page to a clickable area where the annotation will be created at the position of the click.

    CHECKBOX_WIDGET: "CHECKBOX_WIDGET"

    When this mode is activated, the creation of checkbox widget annotations is enabled.

    COMBO_BOX_WIDGET: "COMBO_BOX_WIDGET"

    When this mode is activated, the creation of combo box widget annotations is enabled.

    COMMENT_MARKER: "COMMENT_MARKER"

    When this mode is activated, the creation of new comment marker annotations will be enabled. This transforms the page to a clickable area where the annotation will be created at the position of the click.

    CONTENT_EDITOR: "CONTENT_EDITOR"

    Available only in Standalone mode with the content editor license: when this mode is activated, you will be able to edit the page contents.

    DATE_WIDGET: "DATE_WIDGET"

    When this mode is activated, the creation of date widget annotations is enabled.

    DISTANCE: "DISTANCE"

    When this mode is activated, you will be able to create distance annotations. This transforms the page to a drawable canvas and an annotation is created while drawing on it.

    DOCUMENT_CROP: "DOCUMENT_CROP"

    When this mode is activated, the creation of cropping area selection is enabled.

    DOCUMENT_EDITOR: "DOCUMENT_EDITOR"

    This shows the document editor modal.

    ELLIPSE_AREA: "ELLIPSE_AREA"

    When this mode is activated, you will be able to create Ellipse Area annotations. This transforms the page to a drawable canvas and an annotation is created while drawing on it.

    FORM_CREATOR: "FORM_CREATOR"

    When this mode is activated, you will be able to edit and create widget annotations.

    INK: "INK"

    When this mode is activated, the creation of new ink annotations will be enabled. This transforms the page to a drawable canvas and an annotation is created while drawing on it. If properties (e.g. color) or the page index changes, a new annotation is created.

    INK_ERASER: "INK_ERASER"

    When this mode is activated, removing of current ink annotation points will be enabled. This transforms the page to a canvas where the cursor can remove ink annotation points by hand, as well as choose the cursor width.

    INK_SIGNATURE: "INK_SIGNATURE"

    When this mode is activated, the creation of new ink signatures will be enabled. This shows a dialog where it is possible to select an existing ink signature or create a new one and store it.

    LINK: "LINK"

    When this mode is activated, you will be able to create link annotations.

    LIST_BOX_WIDGET: "LIST_BOX_WIDGET"

    When this mode is activated, the creation of list box widget annotations is enabled.

    MARQUEE_ZOOM: "MARQUEE_ZOOM"

    This enables the Marquee Zoom tool. When enabled, you can draw a rectangle on the screen which is zoomed into and scrolled to, once the pointer is released.

    MEASUREMENT: "MEASUREMENT"

    Available only with the measurement license: when this mode is activated, the measurement annotations mode will be activated.

    MEASUREMENT_SETTINGS: "MEASUREMENT_SETTINGS"

    Available only with the measurement license: when this mode is activated, the measurement settings mode will be activated.

    MULTI_ANNOTATIONS_SELECTION: "MULTI_ANNOTATIONS_SELECTION"

    When this mode is activated, multiple annotations can be selected with the UI.

    NOTE: "NOTE"

    When this mode is activated, the creation of new note annotations will be enabled. This transforms the page to a clickable area where the annotation will be created at the position of the click.

    PAN: "PAN"

    This enables the pan tool to allow the user to navigate on a desktop browser using mouse dragging. This will disable text selection.

    PERIMETER: "PERIMETER"

    When this mode is activated, you will be able to create perimeter annotations. This transforms the page to a drawable canvas and an annotation is created while drawing on it.

    POLYGON_AREA: "POLYGON_AREA"

    When this mode is activated, you will be able to create Polygon Area annotations. This transforms the page to a drawable canvas and an annotation is created while drawing on it.

    RADIO_BUTTON_WIDGET: "RADIO_BUTTON_WIDGET"

    When this mode is activated, the creation of radio button widget annotations is enabled.

    RECTANGLE_AREA: "RECTANGLE_AREA"

    When this mode is activated, you will be able to create Rectangle Area annotations. This transforms the page to a drawable canvas and an annotation is created while drawing on it.

    REDACT_SHAPE_RECTANGLE: "REDACT_SHAPE_RECTANGLE"

    When this mode is activated, the creation of new redaction annotations will be enabled by drawing rectangles on the pages. This transforms the page to a drawable canvas and annotations are created while drawing on it.

    REDACT_TEXT_HIGHLIGHTER: "REDACT_TEXT_HIGHLIGHTER"

    When this mode is activated, the creation of new redaction annotations will be enabled by highlighting regions of text and the text will be marked for redaction as it's selected.

    SEARCH: "SEARCH"

    Enables the search mode and focuses the search input field.

    SHAPE_ELLIPSE: "SHAPE_ELLIPSE"

    When this mode is activated, the creation of new ellipse annotations will be enabled. This transforms the page to a drawable canvas and an annotation is created while drawing on it. If properties (e.g. color) or the page index changes, a new annotation is created.

    SHAPE_LINE: "SHAPE_LINE"

    When this mode is activated, the creation of new line annotations will be enabled. This transforms the page to a drawable canvas and an annotation is created while drawing on it.

    SHAPE_POLYGON: "SHAPE_POLYGON"

    When this mode is activated, the creation of new polygon annotations will be enabled. This transforms the page to a drawable canvas and an annotation is created while drawing on it. If properties (e.g. color) or the page index changes, a new annotation is created.

    SHAPE_POLYLINE: "SHAPE_POLYLINE"

    When this mode is activated, the creation of new polyline annotations will be enabled. This transforms the page to a drawable canvas and an annotation is created while drawing on it. If properties (e.g. color) or the page index changes, a new annotation is created.

    SHAPE_RECTANGLE: "SHAPE_RECTANGLE"

    When this mode is activated, the creation of new rectangle annotations will be enabled. This transforms the page to a drawable canvas and an annotation is created while drawing on it.

    SIGNATURE: "SIGNATURE"

    When this mode is activated, the creation of new signatures will be enabled. This shows a dialog where it is possible to select an existing signature or create a new one and potentially save it.

    SIGNATURE_WIDGET: "SIGNATURE_WIDGET"

    When this mode is activated, the creation of signature widget annotations is enabled.

    STAMP_CUSTOM: "STAMP_CUSTOM"

    When this mode is activated, the custom stamp annotation template editor modal UI will be shown. Once a the custom template is edited, the new custom stamp annotation will be created in the document.

    STAMP_PICKER: "STAMP_PICKER"

    When this mode is activated, the stamp annotation templates picker modal UI will be shown. Once a template is selected, the new annotation is configured and created\ in the document.

    TEXT: "TEXT"

    When this mode is activated, the creation of new text annotations will be enabled. This transforms the page to a clickable area where the annotation will be created at the position of the click.

    TEXT_HIGHLIGHTER: "TEXT_HIGHLIGHTER"

    When this mode is activated, the creation of new highlight annotations will be enabled and the text will be highlighted as it's selected.

    TEXT_WIDGET: "TEXT_WIDGET"

    When this mode is activated, the creation of text widget annotations is enabled.