Class TextLayer

Hierarchy (view full)

BaseLayer
- TextLayer

Constructors

constructor

new TextLayer(id, width, height, options, loadedListener?, updatedListener?): TextLayer
Parameters
- id: string
- width: number
- height: number
- options: Options<OptionsObject> | Partial<TextLayerOptions>
- Optional loadedListener: ((layer) => void | Promise<void>)
  - - (layer): void | Promise<void>
    - Parameters
      layer: TextLayer
      Returns void | Promise<void>
- Optional updatedListener: ((layer) => void | Promise<void>)
  - - (layer): void | Promise<void>
    - Parameters
      layer: TextLayer
      Returns void | Promise<void>
Returns TextLayer
Overrides BaseLayer.constructor
- Defined in src/layers/text-layer.ts:25

Accessors

backgroundColor

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

backgroundOpacity

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

borderColor

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

borderWidth

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

opacity

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

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

id

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

width

get width(): number
Get layer width

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

height

get height(): number
Get layer height

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

canvas

get canvas(): HTMLCanvasElement
Get output canvas

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

options

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

text

get text(): string
Current layer text

Returns string
- Defined in src/layers/text-layer.ts:504

outlineWidth

get outlineWidth(): number
Current outline width in pixels.

Returns number
- Defined in src/layers/text-layer.ts:518

outlineColor

get outlineColor(): string
Current outline colour as a CSS hex string (e.g. '#FF0000').

Returns string
- Defined in src/layers/text-layer.ts:532

fontFamily

get fontFamily(): string
Current font family.

Returns string
- Defined in src/layers/text-layer.ts:566

adjustDirection

get adjustDirection(): "both" | "shrink" | "expand"
Current adjustWidth direction mode.

Returns "both" | "shrink" | "expand"
- Defined in src/layers/text-layer.ts:656

adjustWidth

get adjustWidth(): boolean
Whether automatic font shrinking to fit the layer width is enabled.

Returns boolean
- Defined in src/layers/text-layer.ts:663

Methods

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

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

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

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

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

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

haveRenderer

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

toggleVisibility

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

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

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

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

isVisible

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

isLoaded

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

destroy

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

setText

setText(text, options?): void
Set layer text
Parameters
- text: string
- Optional options: Options<OptionsObject>
  (if options is not an object drawText will use this._options)
Returns void
- Defined in src/layers/text-layer.ts:487

setOutlineWidth

setOutlineWidth(width): void
Set the outline width in pixels and redraw. Set to 0 to disable the outline.
Parameters
- width: number
Returns void
- Defined in src/layers/text-layer.ts:512

setOutlineColor

setOutlineColor(color): void
Set the outline colour and redraw.
Parameters
- color: string
  CSS color string (e.g. '#FF0000')
Returns void
- Defined in src/layers/text-layer.ts:526

setBackgroundColor

setBackgroundColor(color): void
Set the background fill color and redraw. Pass undefined to clear.
Parameters
- color: string
Returns void
Overrides BaseLayer.setBackgroundColor
- Defined in src/layers/text-layer.ts:537

setBorderColor

setBorderColor(color): void
Set the border stroke color and redraw.
Parameters
- color: string
Returns void
Overrides BaseLayer.setBorderColor
- Defined in src/layers/text-layer.ts:543

setBorderWidth

setBorderWidth(width): void
Set the border stroke width in pixels and redraw.
Parameters
- width: number
Returns void
Overrides BaseLayer.setBorderWidth
- Defined in src/layers/text-layer.ts:549

setFontFamily

setFontFamily(family): void
Set the font family and redraw.
Parameters
- family: string
  CSS font-family string (e.g. 'Arial', 'monospace')
Returns void
- Defined in src/layers/text-layer.ts:558

setFontSize

setFontSize(size): void
Set the font size and redraw.
Parameters
- size: number
  Font size value (interpreted according to the layer's fontUnit).
Returns void
- Defined in src/layers/text-layer.ts:574

resetFontSize

resetFontSize(): void
Reset the font size back to the value originally configured when this layer was created, undoing any setFontSize() calls and any adjustWidth shrink/grow memory, then redraw.

Returns void
- Defined in src/layers/text-layer.ts:589

setTextColor

setTextColor(color): void
Set the text fill color and redraw the current text.
Parameters
- color: string
  CSS color string (e.g. '#FF0000' or a Colors value)
Returns void
- Defined in src/layers/text-layer.ts:607

setAdjustWidth

setAdjustWidth(enabled): void
Enable or disable automatic font shrinking so the text fits the layer width, then redraw.
Parameters
- enabled: boolean
Returns void
- Defined in src/layers/text-layer.ts:621

setAdjustDirection

setAdjustDirection(direction): void
Set how the adjustWidth-computed font size can change across setText() calls, then redraw. See TextLayerOptions.adjustDirection for the meaning of each value. Resets any previously remembered shrink/grow size.
Parameters
- direction: "both" | "shrink" | "expand"
Returns void
- Defined in src/layers/text-layer.ts:644

setVisibility

setVisibility(isVisible): void
Parameters
- isVisible: boolean
Returns void
Overrides BaseLayer.setVisibility
- Defined in src/layers/text-layer.ts:667

Class TextLayer

Hierarchy (view full)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Parameters

Returns void | Promise<void>

Parameters

Returns void | Promise<void>

Returns TextLayer

Accessors

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>

text

Returns string

outlineWidth

Returns number

outlineColor

Returns string

fontFamily

Returns string

fontSize

Returns number

adjustDirection

Returns "both" | "shrink" | "expand"

adjustWidth

Returns boolean

Methods

addRenderer

Type Parameters

Parameters

Parameters

Returns T

Returns Promise<T>

Example

removeRenderer

Parameters

Returns void

deactivateRenderer

Parameters

Returns void

activateRenderer

Parameters

Returns void

Throws

isRendererActive

Parameters

Returns boolean

setBackgroundOpacity

Parameters

Returns void

haveRenderer

Returns boolean

toggleVisibility

Returns boolean

setOpacity

Parameters

Returns void