@joint/react
    Preparing search index...

    Interface LinkLabel

    A simplified link label, text plus optional styling, that linkLabel expands into the raw dia.Link.Label markup and attrs JointJS expects.

    interface LinkLabel {
        backgroundBorderRadius?: number;
        backgroundClassName?: string;
        backgroundColor?: string;
        backgroundOpacity?: number;
        backgroundOutline?: string;
        backgroundOutlineWidth?: number;
        backgroundPadding?: number | { horizontal?: number; vertical?: number };
        backgroundShape?: LiteralUnion<"rect" | "ellipse">;
        className?: string;
        color?: string;
        fontFamily?: string;
        fontSize?: number;
        offset?: number | { x: number; y: number };
        position?: number;
        text: string;
    }
    Index

    Properties

    backgroundBorderRadius? backgroundClassName? backgroundColor? backgroundOpacity? backgroundOutline? backgroundOutlineWidth? backgroundPadding? backgroundShape? className? color? fontFamily? fontSize? offset? position? text

    Properties

    backgroundBorderRadius?: number

    Corner radius of the label background, in px. Applies to the 'rect' shape.

    4
    backgroundClassName?: string

    Extra CSS class added to the label background element.

    ''
    backgroundColor?: string

    Fill color of the label background. Empty inherits the theme default.

    ''
    backgroundOpacity?: number

    Opacity of the label background, from 0 (transparent) to 1 (opaque).

    backgroundOutline?: string

    Outline (stroke) color of the label background. Empty for no outline.

    ''
    backgroundOutlineWidth?: number

    Outline (stroke) width of the label background, in px.

    ''
    backgroundPadding?: number | { horizontal?: number; vertical?: number }

    Padding between the text and the edge of its background. A number applies to both axes; an object sets each axis.

    { horizontal: 4, vertical: 2 }

    backgroundShape?: LiteralUnion<"rect" | "ellipse">

    Background outline shape: 'rect', 'ellipse', or a raw SVG path d string.

    'rect'
    className?: string

    Extra CSS class added to the label text element.

    ''
    color?: string

    Text color. Empty inherits the theme default.

    ''
    fontFamily?: string

    Font family of the label text. Empty inherits the theme default.

    ''
    fontSize?: number

    Font size of the label text, in px. Empty inherits the theme default.

    ''
    offset?: number | { x: number; y: number }

    Shift the label off the path. A number nudges it perpendicular to the line; { x, y } moves it freely.

    position?: number

    Where the label sits along the link: 0–1 is a fraction of the path, values above 1 are an absolute distance in px.

    0.5

    text

    text: string

    The text shown on the link.

    Settings

    Member Visibility

    On This Page

    Properties