Class: DrawLayer

Constructor

new DrawLayer(containerDiv)

Parameters:

Name	Type	Description
`containerDiv`	HTMLDivElement	The layer div, its id will be used as this layer id.

Source: src/gui/drawLayer.js, line 62

Classes

DrawLayer

Methods

activateCurrentPositionShapes(flag)

Activate shapes at current position.

Parameters:

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

Source: src/gui/drawLayer.js, line 616

addEventListener(type, callback)

Add an event listener to this class.

Parameters:

Name	Type	Description
`type`	string	The event type.
`callback`	function	The function associated with the provided event type, will be called with the fired event.

Source: src/gui/drawLayer.js, line 1199

addFlipOffsetX()

Add a flip offset along the layer X axis.

Source: src/gui/drawLayer.js, line 319

addFlipOffsetY()

Add a flip offset along the layer Y axis.

Source: src/gui/drawLayer.js, line 333

bindInteraction()

Enable and listen to container interaction events.

Source: src/gui/drawLayer.js, line 1057

deleteDraw(_id, _exeCallback)

Delete a Draw from the stage.

Parameters:

Name	Type	Description
`_id`	string	The id of the group to delete.
`_exeCallback`	function	The callback to call once the DeleteCommand has been executed.

Deprecated: Since v0.34, please switch to `annotationGroup.remove`.
Source: src/gui/drawLayer.js, line 1022

deleteDraws(_exeCallback)

Delete all Draws from the stage.

Parameters:

Name	Type	Description
`_exeCallback`	function	The callback to call once the DeleteCommand has been executed.

Deprecated: Since v0.34, please switch to `annotationGroup.remove`.
Source: src/gui/drawLayer.js, line 1033

display(flag)

Display the layer.

Parameters:

Name	Type	Description
`flag`	boolean	Whether to display the layer or not.

Source: src/gui/drawLayer.js, line 508

draw()

Draw the content (imageData) of the layer. The imageData variable needs to be set.

Source: src/gui/drawLayer.js, line 525

fitToContainer(containerSize, divToWorldSizeRatio, fitOffset)

Fit the layer to its parent container.

Parameters:

Name	Type	Description
`containerSize`	Scalar2D	The container size as {x,y}.
`divToWorldSizeRatio`	number	The div to world size ratio.
`fitOffset`	Scalar2D	The fit offset as {x,y}.

Source: src/gui/drawLayer.js, line 830

flipScaleX()

Flip the scale along the layer X axis.

Source: src/gui/drawLayer.js, line 347

flipScaleY()

Flip the scale along the layer Y axis.

Source: src/gui/drawLayer.js, line 354

flipScaleZ()

Flip the scale along the layer Z axis.

Source: src/gui/drawLayer.js, line 361

getBaseSize() → {Scalar2D}

Get the layer base size (without scale).

Source: src/gui/drawLayer.js, line 294

Returns:

The size as {x,y}.

Type:: Scalar2D

getDataId() → {string}

Get the associated data id.

Source: src/gui/drawLayer.js, line 214

Returns:

The id.

Type:: string

getDrawController() → {DrawController}

Get the draw controller.

Source: src/gui/drawLayer.js, line 258

Returns:

The controller.

Type:: DrawController

getId() → {string}

Get the id of the layer.

Source: src/gui/drawLayer.js, line 278

Returns:

The string id.

Type:: string

getKonvaLayer() → {Konva.Layer}

Get the Konva layer.

Source: src/gui/drawLayer.js, line 248

Returns:

The layer.

Type:: Konva.Layer

getKonvaStage() → {Konva.Stage}

Get the Konva stage.

Source: src/gui/drawLayer.js, line 239

Returns:

The stage.

Type:: Konva.Stage

getNumberOfDraws() → {number|undefined}

Get the total number of draws of this layer (at all positions).

Source: src/gui/drawLayer.js, line 1043

Returns:

The total number of draws.

Type:: number | undefined

getOpacity() → {number}

Get the layer opacity.

Source: src/gui/drawLayer.js, line 303

Returns:

The opacity ([0:1] range).

Type:: number

getReferenceLayerId() → {string}

Get the reference layer id.

Source: src/gui/drawLayer.js, line 223

Returns:

The id.

Type:: string

initScale(newScale, absoluteZoomOffset)

Initialise the layer scale.

Parameters:

Name	Type	Description
`newScale`	Scalar3D	The scale as {x,y,z}.
`absoluteZoomOffset`	Scalar2D	The zoom offset as {x,y} without the fit scale (as provided by getAbsoluteZoomOffset).

Source: src/gui/drawLayer.js, line 436

initialise(size, spacing, refLayerId)

Initialise the layer: set the canvas and context.

Parameters:

Name	Type	Description
`size`	Scalar2D	The image size as {x,y}.
`spacing`	Scalar2D	The image spacing as {x,y}.
`refLayerId`	string	The reference image dataId.

Source: src/gui/drawLayer.js, line 536

isAnnotationVisible(id) → {boolean}

Check the visibility of an annotation.

Parameters:

Name	Type	Description
`id`	string	The id of the annotation.

Source: src/gui/drawLayer.js, line 918

Returns:

True if the annotation is visible.

Type:: boolean

isVisible() → {boolean}

Check if the layer is visible.

Source: src/gui/drawLayer.js, line 517

Returns:

True if the layer is visible.

Type:: boolean

removeEventListener(type, callback)

Remove an event listener from this class.

Parameters:

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

Source: src/gui/drawLayer.js, line 1210

removeFromDOM()

Remove the HTML element from the DOM.

Source: src/gui/drawLayer.js, line 285

setAnnotationGroup(annotationGroup, dataId, exeCallback)

Set the annotation group.

Parameters:

Name	Type	Description
`annotationGroup`	AnnotationGroup	The annotation group.
`dataId`	string	The associated data id.
`exeCallback`	object	The undo stack callback.

Source: src/gui/drawLayer.js, line 568

setAnnotationVisibility(id, visibleopt) → {boolean}

Set the visibility of an annotation.

Parameters:

Name	Type	Attributes	Description
`id`	string		The id of the annotation.
`visible`	boolean	<optional>	True to set to visible, will toggle visibility if not defined.

Source: src/gui/drawLayer.js, line 936

Returns:

False if the annotation shape cannot be found.

Type:: boolean

setBaseOffset(scrollOffset, planeOffset) → {boolean}

Set the base layer offset. Updates the layer offset.

Parameters:

Name	Type	Description
`scrollOffset`	Vector3D	The scroll offset vector.
`planeOffset`	Vector3D	The plane offset vector.

Source: src/gui/drawLayer.js, line 482

Returns:

True if the offset was updated.

Type:: boolean

setCurrentPosition(position, indexopt) → {boolean}

Set the current position.

Parameters:

Name	Type	Attributes	Description
`position`	Point		The new position.
`index`	Index	<optional>	Optional coresponding index.

Source: src/gui/drawLayer.js, line 1089

Returns:

True if the position was updated.

Type:: boolean

setLabelVisibility(shapeGroup)

Set a shape group label visibility according to this layer setting.

Parameters:

Name	Type	Description
`shapeGroup`	Konva.Group	The shape group.

Source: src/gui/drawLayer.js, line 1010

setLabelsVisibility(visibleopt)

Set the visibility of all labels.

Parameters:

Name	Type	Attributes	Description
`visible`	boolean	<optional>	True to set to visible, will toggle visibility if not defined.

Source: src/gui/drawLayer.js, line 960

setOffset(newOffset)

Set the layer offset.

Parameters:

Name	Type	Description
`newOffset`	Scalar3D	The offset as {x,y,z}.

Source: src/gui/drawLayer.js, line 464

setOpacity(alpha)

Set the layer opacity.

Parameters:

Name	Type	Description
`alpha`	number	The opacity ([0:1] range).

Source: src/gui/drawLayer.js, line 312

setPlaneHelper(helper)

Set the plane helper.

Parameters:

Name	Type	Description
`helper`	PlaneHelper	The helper.

Source: src/gui/drawLayer.js, line 267

setScale(newScale, centeropt)

Set the layer scale.

Parameters:

Name	Type	Attributes	Description
`newScale`	Scalar3D		The scale as {x,y,z}.
`center`	Point3D	<optional>	The scale center.

Source: src/gui/drawLayer.js, line 371

setShapeHandler(handler)

Set the draw shape handler.

Parameters:

Name	Type	Description
`handler`	DrawShapeHandler \| undefined	The shape handler.

Source: src/gui/drawLayer.js, line 205

unbindInteraction()

Disable and stop listening to container interaction events.

Source: src/gui/drawLayer.js, line 1071