OpenLIME Class: LayerSvgAnnotation

new LayerSvgAnnotation( [options])

Creates a new LayerSvgAnnotation instance

Parameters:

Name	Type	Argument	Description
`options`	LayerSvgAnnotationOptions	<optional>	Configuration options

Source:

LayerSvgAnnotation.js, line 72

Example

```javascript
// Create SVG annotation layer with custom classes
const annotationLayer = new OpenLIME.Layer({
  type: 'svg_annotations',
  classes: {
    'highlight': { stroke: '#ff0', label: 'Highlight' },
    'comment': { stroke: '#0f0', label: 'Comment' }
  },
  onClick: (annotation) => {
    console.log('Clicked:', annotation.label);
  },
  shadow: true
});

// Add to viewer
viewer.addLayer('annotations', annotationLayer);
```

Extends

LayerAnnotation

Methods

addControl(name, value)

Adds a shader parameter control

Parameters:

Name	Type	Description
`name`	string	Control identifier
`value`	*	Initial value

Inherited From:

Layer#addControl

Overrides:

LayerAnnotation#addControl

Source:

Layer.js, line 438

Throws:

If control already exists
Type Error

addShaderFilter(filter)

Adds a filter to the current shader

Parameters:

Name	Type	Description
`filter`	Object	Filter specification

Inherited From:

Layer#addShaderFilter

Overrides:

LayerAnnotation#addShaderFilter

Source:

Layer.js, line 171

Throws:

If no shader is set
Type Error

boundingBox()

Gets layer bounding box in scene coordinates

Inherited From:

Layer#boundingBox

Overrides:

LayerAnnotation#boundingBox

Source:

Layer.js, line 382

Returns:

Bounding box

Type: BoundingBox

clearSelected()

Clears all annotation selections

Overrides:

LayerAnnotation#clearSelected

Source:

LayerSvgAnnotation.js, line 156

clearShaderFilters(name)

Removes all filters from the current shader

Parameters:

Name	Type	Description
`name`	Object	Filter name

Inherited From:

Layer#clearShaderFilters

Overrides:

LayerAnnotation#clearShaderFilters

Source:

Layer.js, line 191

Throws:

If no shader is set
Type Error

getAnnotationById(id)

Retrieves an annotation by its ID

Parameters:

Name	Type	Description
`id`	string	Annotation identifier

Inherited From:

LayerAnnotation#getAnnotationById

Overrides:

LayerAnnotation#getAnnotationById

Source:

LayerAnnotation.js, line 214

Returns:

The found annotation or null if not found

Type: Annotation | null

getControl(name)

Gets the shader parameter control corresponding to name

Parameters:

Name	Type	Description
`name`	*	The name of the control. return {*} The control

Inherited From:

Layer#getControl

Overrides:

LayerAnnotation#getControl

Source:

Layer.js, line 423

getMode()

Gets the current shader visualization mode

Inherited From:

Layer#getMode

Overrides:

LayerAnnotation#getMode

Source:

Layer.js, line 290

Returns:

Current mode or null if no shader

Type: string | null

getModes()

Gets available shader modes

Inherited From:

Layer#getModes

Overrides:

LayerAnnotation#getModes

Source:

Layer.js, line 300

Returns:

Array of available modes

Type: Array.<string>

getState( [stateMask])

Gets the current layer state

Parameters:

Name	Type	Argument	Default	Description
`stateMask`	Object	<optional>	null	Optional mask to filter returned state properties

Inherited From:

Layer#getState

Overrides:

LayerAnnotation#getState

Source:

Layer.js, line 217

Returns:

Current state object

Type: Object

getSvgGroupTransform(transform [, inverse])

Calculates SVG group transform string

Parameters:

Name	Type	Argument	Default	Description
`transform`	Transform			Current view transform
`inverse`	boolean	<optional>	false	Whether to return inverse transform

Source:

LayerSvgAnnotation.js, line 212

Returns:

SVG transform attribute value

Type: string

interpolateControls()

Updates control interpolation

Inherited From:

Layer#interpolateControls

Overrides:

LayerAnnotation#interpolateControls

Source:

Layer.js, line 473

Returns:

Whether all interpolations are complete

Type: boolean

<async> loadTile(tile, callback)

Loads and processes a single image tile with optimized resource management. Implements request batching, concurrent loading, and proper error handling.

Parameters:

Name Type Description

tile

Object

Tile specification object

Properties

Name	Type	Argument	Description
`index`	string		Unique tile identifier
`url`	string		Base URL for tile resource
`start`	number	<optional>	Start byte for partial content (for tarzoom)
`end`	number	<optional>	End byte for partial content (for tarzoom)
`offsets`	Array.<Object>	<optional>	Byte offsets for interleaved formats

callback

function

Completion callback(error, size)

Inherited From:

Layer#loadTile

Overrides:

LayerAnnotation#loadTile

Source:

Layer.js, line 875

Throws:

If tile is already in processing queue
Type Error

Returns:

Type: Promise.<void>

pixelSizePerMM()

Gets pixel size in millimeters

Inherited From:

Layer#pixelSizePerMM

Overrides:

LayerAnnotation#pixelSizePerMM

Source:

Layer.js, line 373

Returns:

Size of one pixel in mm

Type: number

removeShaderFilter(name)

Removes a filter from the current shader

Parameters:

Name	Type	Description
`name`	Object	Filter name

Inherited From:

Layer#removeShaderFilter

Overrides:

LayerAnnotation#removeShaderFilter

Source:

Layer.js, line 181

Throws:

If no shader is set
Type Error

scale()

Gets layer scale

Inherited From:

Layer#scale

Overrides:

LayerAnnotation#scale

Source:

Layer.js, line 363

Returns:

Current scale value

Type: number

setControl(name, value [, dt] [, easing])

Sets a shader control value with optional animation

Parameters:

Name	Type	Argument	Default	Description
`name`	string			Control identifier
`value`	*			New value
`dt`	number	<optional>		Animation duration in ms
`easing`	string	<optional>	'linear'	Easing function

Inherited From:

Layer#setControl

Overrides:

LayerAnnotation#setControl

Source:

Layer.js, line 453

Fires:

Layer#event:update

setMode(mode)

Sets shader visualization mode

Parameters:

Name	Type	Description
`mode`	string	Mode to set

Inherited From:

Layer#setMode

Overrides:

LayerAnnotation#setMode

Source:

Layer.js, line 311

Fires:

Layer#event:update

setSelected(anno [, on])

Sets selection state of an annotation

Parameters:

Name	Type	Argument	Default	Description
`anno`	Annotation			The annotation to select/deselect
`on`	boolean	<optional>	true	Whether to select (true) or deselect (false)

Overrides:

LayerAnnotation#setSelected

Source:

LayerSvgAnnotation.js, line 168

setShader(id)

Sets the active shader

Parameters:

Name	Type	Description
`id`	string	Shader identifier from registered shaders

Inherited From:

Layer#setShader

Overrides:

LayerAnnotation#setShader

Source:

Layer.js, line 278

Fires:

Layer#event:update

Throws:

If shader ID is not found
Type Error

setState(state [, dt] [, easing])

Sets the layer state with optional animation

Parameters:

Name	Type	Argument	Default	Description
`state`	Object			State object with controls and mode
`dt`	number	<optional>		Animation duration in ms
`easing`	string	<optional>	'linear'	Easing function ('linear'\|'ease-out'\|'ease-in-out')