Documentation / @ripl/core / ContextText

Class: ContextText

Defined in: packages/core/src/context/text.ts:11

A virtual text element capturing position, content, and optional path-based text layout.

Extended by

• SVGText

Implements

• ContextElement

Constructors

Constructor

new ContextText(__namedParameters): ContextText

Defined in: packages/core/src/context/text.ts:29

Parameters

Parameter	Type
__namedParameters	TextOptions

Returns

ContextText

Properties

Property	Modifier	Type	Description	Defined in
content	public	string	The text string to render.	packages/core/src/context/text.ts:21
id	readonly	string	Unique identifier for this text element.	packages/core/src/context/text.ts:14
maxWidth?	public	number	Maximum width, in pixels, the text is scaled to fit within.	packages/core/src/context/text.ts:23
pathData?	public	string	SVG path data along which the text is laid out, for text-on-a-path.	packages/core/src/context/text.ts:25
startOffset?	public	number	Offset along the text path at which rendering begins.	packages/core/src/context/text.ts:27
x	public	number	X coordinate of the text's anchor position.	packages/core/src/context/text.ts:17
y	public	number	Y coordinate of the text's anchor position.	packages/core/src/context/text.ts:19