Class BaseLayerAbstract

Current layer opacity (0 to 1)

Get layer width

Get layer height

Get output canvas

Add a renderer to this layer. It's constructed with the layer's own width/height, so callers pass only the class and its config - never dimensions.

Example

const shaky = await layer.addRenderer('shaky', ShakyRenderer, { mode: 'decay' })
  shaky.triggerShake()
Copy

Remove a renderer from this layer. If it was in the render queue, it will be removed from there too.

Pause a renderer without destroying it. The instance is kept and can be re-enabled with activateRenderer. Order in the queue is preserved.

Re-enable a previously deactivated renderer, restoring it at its original position in the queue. The renderer must have been registered via the constructor renderers dict or addRenderer.

Throws

if the renderer is not registered on this layer.

Returns true if the renderer is registered and currently active.

Set the background fill color for this layer and trigger a redraw. Pass undefined to clear.

Set the background fill opacity (0–1) and trigger a redraw.

Set the border stroke color and trigger a redraw.

Set the border stroke width in pixels and trigger a redraw.

Set the layer opacity.

Animate layer opacity from its current value to 1 (fully opaque).

Animate layer opacity from its current value to 0 (fully transparent).