Interface

TextComp

The text component.

group Components

subgroup Component Types

draw

: Comp["draw"]

: string

The text to render.

: string | BitmapFontData

The font to use.

: number

Width of text.

: number

Height of text.

: TextAlign

Text alignment ("left", "center" or "right", default "left").

since v3000.0

: number

The gap between each line.

since v2000.2

: number

The gap between each character.

since v2000.2

: CharTransform | CharTransformFunc

Transform the pos, scale, rotation or color for each character based on the index or char.

since v2000.1

: Record<string, CharTransform | CharTransformFunc>

Stylesheet for styled chunks, in the syntax of "this is a [style]text[/style] word".

since v2000.2

(): Rect

since v3000.0

: number

(): FormattedText

The text data object after formatting, that contains the renering info as well as the parse data of the formatting tags.

(): SerializedTextComp