Class AnimationLayer

Hierarchy (view full)

BaseLayer
- AnimationLayer

Constructors

constructor

new AnimationLayer(id, width, height, options?, listeners?): AnimationLayer
Parameters
- id: string
- width: number
- height: number
- Optional options: Options<OptionsObject> | Partial<AnimationLayerOptions>
- Optional listeners: AnimationLayerListeners
Returns AnimationLayer
Overrides BaseLayer.constructor
- Defined in src/layers/animation-layer.ts:23

Accessors

isPlaying

get isPlaying(): boolean
return state of animation

Returns boolean
- Defined in src/layers/animation-layer.ts:281

isPaused

get isPaused(): boolean
return state of animation

Returns boolean
- Defined in src/layers/animation-layer.ts:288

backgroundColor

get backgroundColor(): string
Returns string
Inherited from BaseLayer.backgroundColor
- Defined in src/layers/base-layer.ts:547

backgroundOpacity

get backgroundOpacity(): number
Returns number
Inherited from BaseLayer.backgroundOpacity
- Defined in src/layers/base-layer.ts:556

borderColor

get borderColor(): string
Returns string
Inherited from BaseLayer.borderColor
- Defined in src/layers/base-layer.ts:565

borderWidth

get borderWidth(): number
Returns number
Inherited from BaseLayer.borderWidth
- Defined in src/layers/base-layer.ts:574

opacity

get opacity(): number
Current layer opacity (0 to 1)

Returns number
Inherited from BaseLayer.opacity
- Defined in src/layers/base-layer.ts:654

id

get id(): string
Returns string
Inherited from BaseLayer.id
- Defined in src/layers/base-layer.ts:726

width

get width(): number
Get layer width

Returns number
Inherited from BaseLayer.width
- Defined in src/layers/base-layer.ts:733

height

get height(): number
Get layer height

Returns number
Inherited from BaseLayer.height
- Defined in src/layers/base-layer.ts:740

canvas

get canvas(): HTMLCanvasElement
Get output canvas

Returns HTMLCanvasElement
Inherited from BaseLayer.canvas
- Defined in src/layers/base-layer.ts:747

options

get options(): Options<OptionsObject>
Returns Options<OptionsObject>
Inherited from BaseLayer.options
- Defined in src/layers/base-layer.ts:751

Methods

setAnimationData

setAnimationData(data): void
Parameters
- data: ImageBitmap[]
Returns void
- Defined in src/layers/animation-layer.ts:72

play

play(loop?): void
Play animation with current images array
Parameters
- Optional loop: boolean
Returns void
- Defined in src/layers/animation-layer.ts:143

stop

stop(): void
Stop animation (frame index goes back to 0)

Returns void
- Defined in src/layers/animation-layer.ts:168

pause

pause(): void
Pause animation to current frame index (if started with loop=true otherwise duration will be wrong) TODO : Maybe it is still possible to finish the animation

Returns void
- Defined in src/layers/animation-layer.ts:184

resume

resume(): void
Resumed a paused animation

Returns void
- Defined in src/layers/animation-layer.ts:202

nextFrame

nextFrame(): void
Returns void
- Defined in src/layers/animation-layer.ts:210

previousFrame

previousFrame(): void
Returns void
- Defined in src/layers/animation-layer.ts:222

on

on(event, handler): this
Register a handler for a layer lifecycle event. Multiple handlers may be registered for the same event; they fire in registration order. Returns this for chaining.
Parameters
- event: LayerLifecycleEvent
- handler: LayerLifecycleListener<AnimationLayer>
Returns this
Overrides BaseLayer.on
- Defined in src/layers/animation-layer.ts:234
on(event, handler): this
Parameters
- event: "pause" | "play" | "stop"
- handler: ((layer) => void)
  - - (layer): void
    - Parameters
      layer: this
      Returns void
Returns this
Overrides BaseLayer.on
- Defined in src/layers/animation-layer.ts:235

off

off(event, handler): this
Remove a previously registered event handler. No-op if the handler was not registered for that event.
Parameters
- event: LayerLifecycleEvent
- handler: LayerLifecycleListener<AnimationLayer>
Returns this
Overrides BaseLayer.off
- Defined in src/layers/animation-layer.ts:252
off(event, handler): this
Parameters
- event: "pause" | "play" | "stop"
- handler: ((layer) => void)
  - - (layer): void
    - Parameters
      layer: this
      Returns void
Returns this
Overrides BaseLayer.off
- Defined in src/layers/animation-layer.ts:253

addRenderer

addRenderer<T, P>(id, rendererClass, params?, active?): Promise<T>
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.
Type Parameters
- T extends LayerRenderer<never>
- P = unknown
Parameters
- id: string
  unique id for this renderer within the layer
- rendererClass: (new (width, height, params?) => T)
  the renderer class (not an instance)
  - - new (width, height, params?): T
    - Parameters
      width: number
      height: number
      Optional params: P
      Returns T
- Optional params: P
  optional config forwarded to the renderer constructor
- active: boolean = true
  if true (default) the renderer is added to the render queue
Returns Promise<T>
the constructed, initialised renderer instance
Example
```
const shaky = await layer.addRenderer('shaky', ShakyRenderer, { mode: 'decay' })
  shaky.triggerShake()
```
Inherited from BaseLayer.addRenderer
- Defined in src/layers/base-layer.ts:148

removeRenderer

removeRenderer(id): void
Remove a renderer from this layer. If it was in the render queue, it will be removed from there too.
Parameters
- id: string
  Renderer id to remove. If not found, this is a no-op.
Returns void
Inherited from BaseLayer.removeRenderer
- Defined in src/layers/base-layer.ts:196

deactivateRenderer

deactivateRenderer(id): void
Pause a renderer without destroying it. The instance is kept and can be re-enabled with activateRenderer. Order in the queue is preserved.
Parameters
- id: string
  Renderer id to deactivate. No-op if not found or already inactive.
Returns void
Inherited from BaseLayer.deactivateRenderer
- Defined in src/layers/base-layer.ts:209

activateRenderer

activateRenderer(id): void
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.
Parameters
- id: string
  Renderer id to activate.
Returns void
Throws
if the renderer is not registered on this layer.
Inherited from BaseLayer.activateRenderer
- Defined in src/layers/base-layer.ts:221

isRendererActive

isRendererActive(id): boolean
Returns true if the renderer is registered and currently active.
Parameters
- id: string
Returns boolean
Inherited from BaseLayer.isRendererActive
- Defined in src/layers/base-layer.ts:241

setBackgroundColor

setBackgroundColor(color): void
Set the background fill color for this layer and trigger a redraw. Pass undefined to clear.
Parameters
- color: string
Returns void
Inherited from BaseLayer.setBackgroundColor
- Defined in src/layers/base-layer.ts:543

setBackgroundOpacity

setBackgroundOpacity(opacity): void
Set the background fill opacity (0–1) and trigger a redraw.
Parameters
- opacity: number
Returns void
Inherited from BaseLayer.setBackgroundOpacity
- Defined in src/layers/base-layer.ts:552

setBorderColor

setBorderColor(color): void
Set the border stroke color and trigger a redraw.
Parameters
- color: string
Returns void
Inherited from BaseLayer.setBorderColor
- Defined in src/layers/base-layer.ts:561

setBorderWidth

setBorderWidth(width): void
Set the border stroke width in pixels and trigger a redraw.
Parameters
- width: number
Returns void
Inherited from BaseLayer.setBorderWidth
- Defined in src/layers/base-layer.ts:570

haveRenderer

haveRenderer(): boolean
Returns boolean
Inherited from BaseLayer.haveRenderer
- Defined in src/layers/base-layer.ts:578

setVisibility

setVisibility(isVisible): void
Parameters
- isVisible: boolean
Returns void
Inherited from BaseLayer.setVisibility
- Defined in src/layers/base-layer.ts:603

toggleVisibility

toggleVisibility(): boolean
Returns boolean
Inherited from BaseLayer.toggleVisibility
- Defined in src/layers/base-layer.ts:627

setOpacity

setOpacity(opacity): void
Set the layer opacity.
Parameters
- opacity: number
  value between 0 (transparent) and 1 (opaque)
Returns void
Inherited from BaseLayer.setOpacity
- Defined in src/layers/base-layer.ts:637

fadeIn

fadeIn(duration, easing?): Promise<void>
Animate layer opacity from its current value to 1 (fully opaque).
Parameters
- duration: number
  fade duration in ms
- easing: EasingFunction = Easing.easeOutSine
  easing function (defaults to easeOutSine)
Returns Promise<void>
resolves when the fade completes
Inherited from BaseLayer.fadeIn
- Defined in src/layers/base-layer.ts:664

fadeOut

fadeOut(duration, easing?): Promise<void>
Animate layer opacity from its current value to 0 (fully transparent).
Parameters
- duration: number
  fade duration in ms
- easing: EasingFunction = Easing.easeOutSine
  easing function (defaults to easeOutSine)
Returns Promise<void>
resolves when the fade completes
Inherited from BaseLayer.fadeOut
- Defined in src/layers/base-layer.ts:691

isVisible

isVisible(): boolean
Returns boolean
Inherited from BaseLayer.isVisible
- Defined in src/layers/base-layer.ts:712

isLoaded

isLoaded(): boolean
Returns boolean
Inherited from BaseLayer.isLoaded
- Defined in src/layers/base-layer.ts:716

destroy

destroy(): void
Returns void
Inherited from BaseLayer.destroy
- Defined in src/layers/base-layer.ts:720

Class AnimationLayer

Hierarchy (view full)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns AnimationLayer

Accessors

isPlaying

Returns boolean

isPaused

Returns boolean

backgroundColor

Returns string

backgroundOpacity

Returns number

borderColor

Returns string

borderWidth

Returns number

opacity

Returns number

id

Returns string

width

Returns number

height

Returns number

canvas

Returns HTMLCanvasElement

options

Returns Options<OptionsObject>

Methods

setAnimationData

Parameters

Returns void

play

Parameters

Returns void

stop

Returns void

pause

Returns void

resume

Returns void

nextFrame

Returns void

previousFrame

Returns void

on

Parameters

Returns this

Parameters

Parameters

Returns void

Returns this

off

Parameters

Returns this

Parameters

Parameters

Returns void

Returns this

addRenderer

Type Parameters

Parameters

Parameters

Returns T

Returns Promise<T>

Example

removeRenderer

Parameters

Returns void

deactivateRenderer

Parameters

Returns void

activateRenderer