Class: AnnotationUIToolbarBase

OSDPaperjsAnnotation.AnnotationUITool.AnnotationUIToolbarBase(tool)

Base class for annotation toolbar controls.

Constructor

new AnnotationUIToolbarBase(tool)

Create a new instance of AnnotationUIToolbarBase associated with an annotation tool.
Parameters:
Name Type Description
tool AnnotationUITool The annotation tool linked to the toolbar control.
Source:

Methods

activate()

Activate the toolbar control, making it visually active.
Source:

deactivate(shouldFinish)

Deactivate the toolbar control, making it visually inactive.
Parameters:
Name Type Description
shouldFinish boolean Whether the action associated with the control should be completed.
Source:

isEnabledForMode(mode) → {boolean}

Check whether the toolbar control is enabled for a specific mode.
Parameters:
Name Type Description
mode string The mode to check for enabling.
Source:
Returns:
True if the toolbar control is enabled for the mode, otherwise false.
Type
boolean