Interface OrthogonalConnectorOptions

Options for an orthogonal connector.

interface OrthogonalConnectorOptions {
    alwaysRespectStubs?: boolean;
    cornerRadius?: number;
    cssClass?: string;
    gap?: number;
    hoverClass?: string;
    loopbackRadius?: number;
    midpoint?: number;
    slightlyWonky?: boolean;
    stub?: number;
    supportLegacyConnectorData?: boolean;
    vertexAvoidance?: boolean;
}

Hierarchy (view full)

Properties

alwaysRespectStubs? cornerRadius? cssClass? gap? hoverClass? loopbackRadius? midpoint? slightlyWonky? stub? supportLegacyConnectorData? vertexAvoidance?

Properties

Optional alwaysRespectStubs

alwaysRespectStubs?: boolean

Defaults to true, meaning always draw a stub of the desired length, even when the source and target elements are very close together.

Optional cornerRadius

cornerRadius?: number

Optional curvature of the corners in the connector. Defaults to 0.

Optional cssClass

cssClass?: string

Optional class to set on the element used to render the connector.

Optional gap

gap?: number

Defines a number of pixels between the end of the connector and its anchor point. Defaults to zero.

Optional hoverClass

hoverClass?: string

Optional class to set on the element used to render the connector when the mouse is hovering over the connector.

Optional loopbackRadius

loopbackRadius?: number

For a loopback connection, the size of the loop.

Optional midpoint

midpoint?: number

The point to use as the halfway point between the source and target. Defaults to 0.5.

Optional slightlyWonky

slightlyWonky?: boolean

If true, and a cornerRadius is set, the lines are drawn in such a way that they look slightly hand drawn. This effect was something we stumbled across, ie. a mistake, but it was charming in its own way so we decided to leave it in as an option.

Optional stub

stub?: number

Stub defines a number of pixels that the connector travels away from its element before the connector's actual path begins.

Optional supportLegacyConnectorData

supportLegacyConnectorData?: boolean

Defaults to false. Use this flag if you are migrating from 2.x to 5.x and you have connector data stored in the 2.x format that you wish to load.

Optional vertexAvoidance

vertexAvoidance?: boolean

Whether or not to avoid vertices during path edits and when dragging vertices connected to an edited path. Defaults to true.

Settings

Member Visibility

Theme

On This Page

alwaysRespectStubscornerRadiuscssClassgaphoverClassloopbackRadiusmidpointslightlyWonkystubsupportLegacyConnectorDatavertexAvoidance