Interface: TextOnPathOptions

Defined in: src/mobjects/text/TextOnPath.ts:51

Options for TextOnPath.

Properties

alignment?

optional alignment: TextOnPathAlignment

Defined in: src/mobjects/text/TextOnPath.ts:71

Vertical placement relative to the curve. Default 'center'.

---

color?

optional color: string

Defined in: src/mobjects/text/TextOnPath.ts:63

Glyph color. Default '#ffffff'.

---

fontSize?

optional fontSize: number

Defined in: src/mobjects/text/TextOnPath.ts:61

Font size in pixels. Default 48.

---

fontUrl?

optional fontUrl: string

Defined in: src/mobjects/text/TextOnPath.ts:59

URL of the font file (OTF/TTF) for font mode.

---

glyphs?

optional glyphs: TextOnPathGlyph[]

Defined in: src/mobjects/text/TextOnPath.ts:55

Pre-built glyphs (synchronous mode).

---

overflow?

optional overflow: TextOnPathOverflow

Defined in: src/mobjects/text/TextOnPath.ts:73

Clamp to the ends or wrap around the path. Default 'clamp'.

---

path

path: TextOnPathSource

Defined in: src/mobjects/text/TextOnPath.ts:53

The path to lay the glyphs on.

---

rotateWithTangent?

optional rotateWithTangent: boolean

Defined in: src/mobjects/text/TextOnPath.ts:69

Rotate each glyph to the path tangent. Default true.

---

startOffset?

optional startOffset: number

Defined in: src/mobjects/text/TextOnPath.ts:65

Arc-length distance where the run starts. Default 0.

---

text?

optional text: string

Defined in: src/mobjects/text/TextOnPath.ts:57

Text to render (asynchronous font mode; needs fontUrl).

---

tracking?

optional tracking: number

Defined in: src/mobjects/text/TextOnPath.ts:67

Extra spacing added after every glyph (world units). Default 0.