OpenLIME Class: LayerCombiner

new LayerCombiner(options)

Creates a new LayerCombiner instance

Parameters:

Name	Type	Description
`options`	LayerCombinerOptions	Configuration options

Source:

LayerCombiner.js, line 71

Throws:

If rasters option is not empty (rasters should be defined in source layers)
Type Error

Example

```javascript
// Create two base layers
const baseLayer = new OpenLIME.Layer({
  type: 'image',
  url: 'base.jpg'
});

const overlayLayer = new OpenLIME.Layer({
  type: 'image',
  url: 'overlay.jpg'
});

// Create combiner with custom shader
const combiner = new OpenLIME.Layer({
  type: 'combiner',
  layers: [baseLayer, overlayLayer],
  visible: true
});

// Set up blend shader
const shader = new OpenLIME.ShaderCombiner();
shader.mode = 'blend';
combiner.shaders = { 'standard': shader };
combiner.setShader('standard');

// Add to viewer
viewer.addLayer('combined', combiner);
```

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 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:

Layer#addShaderFilter

Source:

Layer.js, line 171

Throws:

If no shader is set
Type Error

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 191

Throws:

If no shader is set
Type Error

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 423

getMode()

Gets the current shader visualization mode

Inherited From:

Layer#getMode

Overrides:

Layer#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:

Layer#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:

Layer#getState

Source:

Layer.js, line 217

Returns:

Current state object

Type: Object

interpolateControls()

Updates control interpolation

Inherited From:

Layer#interpolateControls

Overrides:

Layer#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:

Layer#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:

Layer#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:

Layer#removeShaderFilter

Source:

Layer.js, line 181

Throws:

If no shader is set
Type Error

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 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:

Layer#setMode

Source:

Layer.js, line 311

Fires:

Layer#event:update

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