SplitTextComponentOptions

Defined in: packages/renderer/src/SplitTextComponent.ts:46

Options for creating a SplitTextComponent.

Properties

alpha?

optional alpha?: number

Defined in: packages/renderer/src/SplitTextComponent.ts:75

Alpha (opacity). Default: 1.

---

autoSplit?

optional autoSplit?: boolean

Defined in: packages/renderer/src/SplitTextComponent.ts:67

Re-split automatically when text / style change. Default true. Set false and call SplitTextComponent.resplit to batch updates.

---

bitmap?

optional bitmap?: boolean

Defined in: packages/renderer/src/SplitTextComponent.ts:56

Render the segments with a bitmap font (SplitBitmapText) instead of canvas Text (SplitText). Pass the installed/baked font name as style.fontFamily (and glyph size as style.fontSize).

---

charAnchor?

optional charAnchor?: SegmentAnchor

Defined in: packages/renderer/src/SplitTextComponent.ts:58

Transform origin for each character. Default 0 (top-left).

---

layer?

optional layer?: string

Defined in: packages/renderer/src/SplitTextComponent.ts:69

Render layer name. Default: “default”.

---

lineAnchor?

optional lineAnchor?: SegmentAnchor

Defined in: packages/renderer/src/SplitTextComponent.ts:62

Transform origin for each line. Default 0 (top-left).

---

style?

optional style?: TextStyleOptions

Defined in: packages/renderer/src/SplitTextComponent.ts:50

Text style — forwards to PixiJS TextStyleOptions (CSS-like font properties).

---

text

text: string

Defined in: packages/renderer/src/SplitTextComponent.ts:48

The text string to render and segment.

---

tint?

optional tint?: number

Defined in: packages/renderer/src/SplitTextComponent.ts:73

Tint color applied to the whole text (cascades to every segment).

---

visible?

optional visible?: boolean

Defined in: packages/renderer/src/SplitTextComponent.ts:71

Initial visibility. Default: true.

---

wordAnchor?

optional wordAnchor?: SegmentAnchor

Defined in: packages/renderer/src/SplitTextComponent.ts:60

Transform origin for each word. Default 0 (top-left).