@joint/react
    Preparing search index...

    Interface ElementPort

    Declarative port description for elementPort and elementPorts. Captures the common port styling and label options in a flat shape, which the presets expand into a full dia.Element.Port.

    interface ElementPort {
        className?: string;
        color?: string;
        cx?: string | number;
        cy?: string | number;
        height?: number;
        label?: string;
        labelClassName?: string;
        labelColor?: string;
        labelFontFamily?: string;
        labelFontSize?: number;
        labelOffsetX?: number;
        labelOffsetY?: number;
        labelPosition?: string;
        outline?: string;
        outlineWidth?: number;
        passive?: boolean;
        shape?: ElementPortShape;
        width?: number;
    }
    Index

    Properties

    className? color? cx? cy? height? label? labelClassName? labelColor? labelFontFamily? labelFontSize? labelOffsetX? labelOffsetY? labelPosition? outline? outlineWidth? passive? shape? width?

    Properties

    className?: string

    Extra CSS class added to the port shape alongside the built-in jj-port class.

    ''
    color?: string

    Fill color of the port shape. Any CSS color; when empty the port inherits the jj-port stylesheet fill.

    ''
    cx?: string | number

    Horizontal position of the port, relative to the element, for absolute placement. Accepts a number or a calc() expression such as 'calc(w)'. Omit to let the port group position the port instead.

    cy?: string | number

    Vertical position of the port, relative to the element, for absolute placement. Accepts a number or a calc() expression such as 'calc(h)'. Omit to let the port group position the port instead.

    height?: number

    Height of the port shape, in pixels.

    8
    label?: string

    Text label rendered next to the port. Omit for an unlabeled port.

    labelClassName?: string

    Extra CSS class added to the label alongside the built-in jj-port-label class.

    ''
    labelColor?: string

    Color of the label text. Any CSS color; when empty the color comes from the stylesheet.

    ''
    labelFontFamily?: string

    Font family of the label text. When empty the family comes from the stylesheet.

    ''
    labelFontSize?: number

    Font size of the label text, in pixels. When empty the size comes from the stylesheet.

    ''
    labelOffsetX?: number

    Horizontal offset of the label from its computed position, in pixels.

    labelOffsetY?: number

    Vertical offset of the label from its computed position, in pixels.

    labelPosition?: string

    Placement of the label relative to the port, e.g. 'outside', 'inside', or a side name.

    'outside'
    outline?: string

    Outline (stroke) color of the port shape. Any CSS color; when empty the stroke comes from the stylesheet.

    ''
    outlineWidth?: number

    Outline (stroke) width of the port shape, in pixels. Empty leaves the stroke width unset.

    ''
    passive?: boolean

    Restricts the port to being a link target only; links cannot be started from it.

    false
    shape?: ElementPortShape

    Shape of the port body.

    'ellipse'
    width?: number

    Width of the port shape, in pixels.

    8

    Settings

    Member Visibility

    On This Page

    Properties