Skip to content
lamina

TextBoxOptions

Options of Surface.textBox.

Properties

Section titled “Properties”

align?

Section titled “align?”

readonly optional align?: any

Line alignment (default start).

box

Section titled “box”

readonly box: Rect

The box the lines are broken into.

direction?

Section titled “direction?”

readonly optional direction?: any

Paragraph direction.

features?

Section titled “features?”

readonly optional features?: readonly string[]

OpenType features.

font

Section titled “font”

readonly font: Font

The font (needs the text module).

language?

Section titled “language?”

readonly optional language?: string

Language (BCP 47).

lineHeight?

Section titled “lineHeight?”

readonly optional lineHeight?: number

Line height as a factor of the size (default 1.2).

overflow?

Section titled “overflow?”

readonly optional overflow?: any

What happens to text that doesn’t fit (default clip; error throws text-overflow).

size

Section titled “size”

readonly size: number

Size in points.

tag?

Section titled “tag?”

readonly optional tag?: Tag

The structure element the box is (as drawing it inside Surface.tag).