@joint/react
    Preparing search index...

    Interface 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.

    interface SVGTextProps {
        annotations?: TextAnnotation[];
        displayEmpty?: boolean;
        eol?: string;
        height?: number;
        includeAnnotationIndices?: boolean;
        lineHeight?: string | number;
        textPath?: string | { [key: string]: any };
        textVerticalAnchor?: string | number;
        textWrap?: boolean | BreakTextOptions;
        useNoBreakSpace?: boolean;
        width?: number;
    }

    Hierarchy

    • SVGTextElementAttributes<SVGTextElement>
    • TextOptions
      • SVGTextProps
    Index

    Properties

    annotations? displayEmpty? eol? height? includeAnnotationIndices? lineHeight? textPath? textVerticalAnchor? textWrap? useNoBreakSpace? width?

    Properties

    annotations?: TextAnnotation[]
    displayEmpty?: boolean
    eol?: string
    height?: number

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

    includeAnnotationIndices?: boolean
    lineHeight?: string | number
    textPath?: string | { [key: string]: any }
    textVerticalAnchor?: string | number
    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, …).

    false
    useNoBreakSpace?: boolean
    width?: number

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

    Settings

    Member Visibility

    On This Page

    Properties