Render2DTextOptions

Defined in: client/api.d.ts:240

Native text-region options.

Extends

• Render2DNodeOptions

Properties

clipping?

optional clipping?: boolean

Defined in: client/api.d.ts:204

Whether clipping is enabled.

Inherited from

Render2DNodeOptions.clipping

---

clipRect?

optional clipRect?: Render2DRect

Defined in: client/api.d.ts:209

Normalized clipping rectangle.

Inherited from

Render2DNodeOptions.clipRect

---

color?

optional color?: Color

Defined in: client/api.d.ts:249

Normalized RGBA text color.

---

font?

optional font?: string

Defined in: client/api.d.ts:254

Native font hash name.

---

fontHeight?

optional fontHeight?: number

Defined in: client/api.d.ts:259

Normalized font height.

---

fontScale?

optional fontScale?: number

Defined in: client/api.d.ts:264

Font scale multiplier.

---

horizontalAlign?

optional horizontalAlign?: "left" | "center" | "right"

Defined in: client/api.d.ts:284

Horizontal alignment.

---

kerning?

optional kerning?: boolean

Defined in: client/api.d.ts:279

Whether kerning is enabled.

---

nonOverlapGroup?

optional nonOverlapGroup?: number

Defined in: client/api.d.ts:224

Native non-overlap group.

Inherited from

Render2DNodeOptions.nonOverlapGroup

---

offset?

optional offset?: Vector2

Defined in: client/api.d.ts:269

Text cursor offset.

---

parent?

optional parent?: Render2DContainer | null

Defined in: client/api.d.ts:184

Optional container parent; null or omitted means the canvas root.

Inherited from

Render2DNodeOptions.parent

---

pixelClipping?

optional pixelClipping?: boolean

Defined in: client/api.d.ts:214

Whether pixel clipping is enabled.

Inherited from

Render2DNodeOptions.pixelClipping

---

position?

optional position?: Vector2

Defined in: client/api.d.ts:189

Normalized position local to the parent.

Inherited from

Render2DNodeOptions.position

---

size?

optional size?: Vector2

Defined in: client/api.d.ts:194

Normalized size.

Inherited from

Render2DNodeOptions.size

---

text

text: string

Defined in: client/api.d.ts:244

Initial text.

---

useAllMonitors?

optional useAllMonitors?: boolean

Defined in: client/api.d.ts:219

Whether the node spans all monitors.

Inherited from

Render2DNodeOptions.useAllMonitors

---

verticalAlign?

optional verticalAlign?: "center" | "top" | "bottom"

Defined in: client/api.d.ts:289

Vertical alignment.

---

visible?

optional visible?: boolean

Defined in: client/api.d.ts:199

Initial visibility.

Inherited from

Render2DNodeOptions.visible

---

widthLimit?

optional widthLimit?: number

Defined in: client/api.d.ts:274

Optional normalized width limit.