On this page

Draw

Drawing tool.

This tool is responsible for the draw of layer group structure.

drawLayer
|_ positionGroup: {name="position-group", id="#2-0#_#3-1"}
   |_ shapeGroup: {name="{shape name}-group", id="#"}
      |_ shape: {name="shape"},
      |_ label: {name="label"},
      |_ extra: line tick, protractor arc...

Discussion:

posGroup > shapeGroup: (pro) slice/frame display: 1 loop - (cons) multi-slice shape splitted in positionGroups.
shapeGroup > posGroup: (pros) more logical - (cons) slice/frame display: 2 loops.

Constructor

new Draw(app)

Parameters:

Name	Type	Description
`app`	App	The associated application.

Source: src/tools/draw.js, line 53

Classes

Draw

Members

dblclick

Handle double click event: some tools use it to finish interaction.

Source: src/tools/draw.js, line 433

keydown

Handle key down event.

Source: src/tools/draw.js, line 550

mousedown

Handle mouse down event.

Source: src/tools/draw.js, line 389

mousemove

Handle mouse move event.

Source: src/tools/draw.js, line 404

mouseout

Handle mouse out event.

Source: src/tools/draw.js, line 461

mouseup

Handle mouse up event.

Source: src/tools/draw.js, line 419

touchend

Handle touch end event.

Source: src/tools/draw.js, line 530

touchmove

Handle touch move event.

Source: src/tools/draw.js, line 490

touchstart

Handle touch start event.

Source: src/tools/draw.js, line 475

wheel

Handle mouse wheel event.

Source: src/tools/draw.js, line 539

Methods

activate(flag)

Activate the tool.

Parameters:

Name	Type	Description
`flag`	boolean	The flag to activate or not.

Source: src/tools/draw.js, line 740

addEventListener(type, listener)

Add an event listener on the app.

Parameters:

Name	Type	Description
`type`	string	The event type.
`listener`	function	The function associated with the provided event type.

Source: src/tools/draw.js, line 841

getEventNames() → {Array.<string>}

Get the list of event names that this tool can fire.

Source: src/tools/draw.js, line 828

Returns:

The list of event names.

Type:: Array.<string>

getOptionsType() → {string}

Get the type of tool options: here 'factory' since the shape list contains factories to create each possible shape.

Source: src/tools/draw.js, line 781

Returns:

The type.

Type:: string

hasShape(name) → {boolean}

Check if the shape is in the shape list.

Parameters:

Name	Type	Description
`name`	string	The name of the shape.

Source: src/tools/draw.js, line 888

Returns:

True if there is a factory for the shape.

Type:: boolean

init()

Initialise the tool.

Source: src/tools/draw.js, line 819

removeEventListener(type, listener)

Remove an event listener from the app.

Parameters:

Name	Type	Description
`type`	string	The event type.
`listener`	function	The function associated with the provided event type.

Source: src/tools/draw.js, line 855

setFeatures(features)

Set the tool live features: shape colour and shape name.

Parameters:

Name	Type	Description
`features`	object	The list of features.

Source: src/tools/draw.js, line 790

setOptions(options)

Set the tool configuration options.

Parameters:

Name	Type	Description
`options`	object	The list of shape names amd classes.

Source: src/tools/draw.js, line 770

Events

annotationselect

Annotation select event.

Type:

object

Properties

Name	Type	Description
`type`	string	The event type.
`annotationid`	string	The annotation id.
`dataid`	string	The data id.

Source: src/tools/draw.js, line 313

warn

Warn event.

Type:

object

Properties

Name	Type	Description
`type`	string	The event type.
`message`	string	The warning message.

Source: src/tools/draw.js, line 202