Class: TextBoxOperator

TextBoxOperator(viewer, textBoxManager)

This class represents an operator for creating and manipulating textboxmarkup items.

Constructor

new TextBoxOperator(viewer, textBoxManager)

Creates a new TextBoxOperator object

Parameters:
Name Type Default Description
viewer WebViewer

Webviewer Object

textBoxManager TextBoxManager null

If null, the operator will create a new TextBoxManager object

Classes

TextBoxOperator

Methods

getAutoHide() → {boolean}

Retrieves if markup is automatically hidden when mouse clicked outside of markup

Returns:
  • Autohide State
Type
boolean

getMarkupConfig() → {Object}

Retrieves current Markup Configuration Object

Returns:
  • Markup Configuration Object
Type
Object

getTextBoxManager() → {TextBoxManager}

Retrieves the TextBoxManager object

Returns:
  • TextBoxManager object
Type
TextBoxManager

setAllowCreation(creationMode)

Sets one of the three markup creation modes.
0 - No text box creation is allowed.
1 - The textbox is inserted on the next click, after that creation is disabled
2 - A new textbox is inserted on every click on the model (default)

Parameters:
Name Type Description
creationMode number

Creation Mode

setAutoHide(autoHide)

Sets if markup is automatically hidden when mouse clicked outside of markup

Parameters:
Name Type Description
autoHide boolean

If true, markup is automatically hidden when mouse clicked outside of markup

setCreateMarkupItemCallback(callback)

Sets callback for markup creation

Parameters:
Name Type Description
callback callback

Callback to use for markup creation

setMarkupConfig(config)

Sets markup configuration object for creating new markup

Parameters:
Name Type Description
config Object

Markup Configuration Object

setMouseActivationCallback(callback)

Sets callback for mouse button/keyboard combo for markup creation

Parameters:
Name Type Description
callback callback

Callback