Skip to main content
Version: 4.3

SVGTextProps

Props for SVGText: native SVG <text> attributes plus the JointJS Vectorizer text options (end-of-line marker, vertical anchor, line height, text-on-path, annotations) and opt-in word wrapping.

Extends​

  • SVGTextElementAttributes<SVGTextElement>.TextOptions

Properties​

annotations?​

optional annotations?: TextAnnotation[];

displayEmpty?​

optional displayEmpty?: boolean;

eol?​

optional eol?: string;

height?​

readonly optional height?: number;

Maximum height in pixels for the textWrap pass; lines that overflow it are dropped.

includeAnnotationIndices?​

optional includeAnnotationIndices?: boolean;

lineHeight?​

optional lineHeight?: string | number;

textPath?​

optional textPath?: 
| string
| {
[key: string]: any;
};

textVerticalAnchor?​

optional textVerticalAnchor?: string | number;

textWrap?​

readonly optional textWrap?: boolean | BreakTextOptions;

Wrap the text to the available width using the JointJS util.breakText algorithm. Pass true for the defaults, or an options object to fine-tune wrapping (ellipsis, max line count, hyphenation, …).

Default​

false

useNoBreakSpace?​

optional useNoBreakSpace?: boolean;

width?​

readonly optional width?: number;

Wrapping width in pixels for the textWrap pass. Falls back to the graph element's current width when omitted.