OpenLIME Class: LayerAnnotation

new LayerAnnotation( [options])

Instantiates a LayerAnnotation object.

Parameters:

Name Type Argument Description

options

Object

An object literal with options that inherits from Layer.

Properties

Name	Type	Description
`style`	string	Properties to style annotations.
`annotations`	string \| Array	The URL of the annotation data (JSON file or HTTP GET Request to an annotation server) or an array of annotations.

Source:

LayerAnnotation.js, line 58

Fires:

LayerAnnotation#selected - Fired when annotation selection changes,event: with selected annotation as parameter
LayerAnnotation#event:loaded - Fired when annotations are loaded
Layer#update - Inherited from Layer,event: fired when redraw needed
Layer#ready - Inherited from Layer,event: fired when layer is ready

Example

```javascript
// Create annotation layer from remote JSON
const annoLayer = new OpenLIME.LayerAnnotation({
  annotations: 'https://example.com/annotations.json',
  style: '.annotation { color: red; }',
  overlay: true
});

// Listen for selection changes
annoLayer.addEvent('selected', (annotation) => {
  console.log('Selected annotation:', annotation.label);
});

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

Extends

Layer

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:

Layer#addControl

Source:

Layer.js, line 437

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:

Layer#addShaderFilter

Source:

Layer.js, line 170

Throws:

If no shader is set
Type Error

boundingBox()

Gets layer bounding box in scene coordinates

Inherited From:

Layer#boundingBox

Overrides:

Layer#boundingBox

Source:

Layer.js, line 381

Returns:

Bounding box

Type: BoundingBox

clearShaderFilters(name)

Removes all filters from the current shader

Parameters:

Name	Type	Description
`name`	Object	Filter name

Inherited From:

Layer#clearShaderFilters

Overrides:

Layer#clearShaderFilters

Source:

Layer.js, line 190

Throws:

If no shader is set
Type Error

getAnnotationById(id)

Retrieves an annotation by its ID

Parameters:

Name	Type	Description
`id`	string	Annotation identifier

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:

Layer#getControl

Source:

Layer.js, line 422

getMode()

Gets the current shader visualization mode

Inherited From:

Layer#getMode

Overrides:

Layer#getMode

Source:

Layer.js, line 289

Returns:

Current mode or null if no shader

Type: string | null

getModes()

Gets available shader modes

Inherited From:

Layer#getModes

Overrides:

Layer#getModes

Source:

Layer.js, line 299

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:

Layer#getState

Source:

Layer.js, line 216

Returns:

Current state object

Type: Object

interpolateControls()

Updates control interpolation

Inherited From:

Layer#interpolateControls

Overrides:

Layer#interpolateControls

Source:

Layer.js, line 472

Returns:

Whether all interpolations are complete

Type: boolean

pixelSizePerMM()

Gets pixel size in millimeters

Inherited From:

Layer#pixelSizePerMM

Overrides:

Layer#pixelSizePerMM

Source:

Layer.js, line 372

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:

Layer#removeShaderFilter

Source:

Layer.js, line 180

Throws:

If no shader is set
Type Error

scale()

Gets layer scale

Inherited From:

Layer#scale

Overrides:

Layer#scale

Source:

Layer.js, line 362

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:

Layer#setControl

Source:

Layer.js, line 452

Fires:

Layer#event:update

setMode(mode)

Sets shader visualization mode

Parameters:

Name	Type	Description
`mode`	string	Mode to set

Inherited From:

Layer#setMode

Overrides:

Layer#setMode

Source:

Layer.js, line 310

Fires:

Layer#event:update

setSelected(anno [, on])

Sets the 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)

Source:

LayerAnnotation.js, line 236

Fires:

LayerAnnotation#event:selected

setShader(id)

Sets the active shader

Parameters:

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

Inherited From:

Layer#setShader

Overrides:

Layer#setShader

Source:

Layer.js, line 277

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')