Interface TextLayerOptions

Options for TextLayer. Required properties are always initialised with defaults by the TextLayer constructor.

interface TextLayerOptions {
    width?: number;
    height?: number;
    position?: LayerPosition;
    visible: boolean;
    opacity: number;
    renderers: RendererEntry[];
    backgroundColor?: string;
    backgroundOpacity?: number;
    borderColor?: string;
    borderWidth?: number;
    top?: string | number;
    left?: string | number;
    color: string;
    fontSize: string | number;
    fontUnit: string;
    fontFamily: string;
    fontStyle: string;
    textBaseline: CanvasTextBaseline;
    hOffset: number;
    vOffset: number;
    strokeWidth: number;
    strokeColor: string;
    adjustWidth: boolean;
    adjustDirection?: "both" | "shrink" | "expand";
    outlineWidth: number;
    outlineColor: string;
    antialiasing: boolean;
    text?: string;
    hAlign?: HAlign;
    vAlign?: VAlign;
}

Hierarchy (view full)

Properties

width? height? position? visible opacity renderers backgroundColor? backgroundOpacity? borderColor? borderWidth? top? left? color fontSize fontUnit fontFamily fontStyle textBaseline hOffset vOffset strokeWidth strokeColor adjustWidth adjustDirection? outlineWidth outlineColor antialiasing text? hAlign? vAlign?

Properties

Optional width

width?: number

Layer canvas width in pixels. Defaults to DMD width.

Optional height

height?: number

Layer canvas height in pixels. Defaults to DMD height.

Optional position

position?: LayerPosition

Layer position within the DMD frame.

visible

visible: boolean

Whether the layer is visible. Default: true.

opacity

opacity: number

Layer opacity between 0 (transparent) and 1 (opaque). Default: 1.

renderers

renderers: RendererEntry[]

Renderers to register (and optionally activate) on this layer. Each entry is either a RendererInstanceEntry (pre-created instance) or a RendererClassEntry (class instantiated by the layer with the correct dimensions). Set active: false to register without activating. Default: [].

Optional backgroundColor

backgroundColor?: string

Background fill color drawn behind the layer content. Transparent if omitted.

Optional backgroundOpacity

backgroundOpacity?: number

Background fill opacity 0–1. Default: 1.

Optional borderColor

borderColor?: string

Border stroke color drawn around the layer edge. No border if omitted.

Optional borderWidth

borderWidth?: number

Border stroke width in pixels. Default: 0.

Optional top

top?: string | number

Top position of the text within the layer, in pixels or as a percentage string (e.g. '50%'). Overrides vAlign when set. The value is the y passed to fillText, so textBaseline decides what it anchors (with the default 'top' baseline, the top of the em square - which sits slightly above the glyph ink). Unset by default, so vAlign places the text.

Optional left

left?: string | number

Left position of the text within the layer, in pixels or as a percentage string (e.g. '50%'). Overrides hAlign when set. Unset by default, so hAlign places the text.

color

color: string

Text fill colour. Default: Colors.White.

fontSize

fontSize: string | number

Font size value. Default: '10'.

fontUnit

fontUnit: string

Font size unit (e.g. '%', 'px'). Default: '%'.

fontFamily

fontFamily: string

Font family name. Default: 'Arial'.

fontStyle

fontStyle: string

Font style (e.g. 'normal', 'italic'). Default: 'normal'.

textBaseline

textBaseline: CanvasTextBaseline

Canvas text baseline. Default: 'top'.

hOffset

hOffset: number

Horizontal pixel offset. Default: 0.

vOffset

vOffset: number

Vertical pixel offset. Default: 0.

strokeWidth

strokeWidth: number

Stroke width in pixels. Default: 0.

strokeColor

strokeColor: string

Stroke colour. Default: Colors.Black.

adjustWidth

adjustWidth: boolean

Shrink font until text fits the layer width. Default: false.

Optional adjustDirection

adjustDirection?: "both" | "shrink" | "expand"

Controls how the adjustWidth-computed size can change across setText() calls:

  • 'both': recompute freely each time - size can grow or shrink between calls.
  • 'shrink': size only ever shrinks across calls - a later, narrower text won't grow it back above a previous, wider text's shrunk size.
  • 'expand': size only ever grows across calls - a later, wider text won't shrink it below a previous size (may overflow instead). Default: 'both'.

outlineWidth

outlineWidth: number

Outline width in pixels. Default: 0.

outlineColor

outlineColor: string

Outline colour. Default: Colors.Black.

antialiasing

antialiasing: boolean

Enable sub-pixel antialiasing. Default: true.

Optional text

text?: string

Text content.

Optional hAlign

hAlign?: HAlign

Horizontal alignment of the text within the layer. Ignored when left is set. Default: 'center'.

Optional vAlign

vAlign?: VAlign

Vertical alignment of the text within the layer. Ignored when top is set. Default: 'middle'.

Settings

Member Visibility

Theme

On This Page

widthheightpositionvisibleopacityrenderersbackgroundColorbackgroundOpacityborderColorborderWidthtopleftcolorfontSizefontUnitfontFamilyfontStyletextBaselinehOffsetvOffsetstrokeWidthstrokeColoradjustWidthadjustDirectionoutlineWidthoutlineColorantialiasingtexthAlignvAlign