Interface ConnectionTypeDescriptor

Definition of a connection type.

interface ConnectionTypeDescriptor {
    anchor?: AnchorSpec;
    anchors?: [AnchorSpec, AnchorSpec];
    connector?: ConnectorSpec;
    connectorClass?: string;
    connectorHoverStyle?: PaintStyle;
    connectorStyle?: PaintStyle;
    cssClass?: string;
    detachable?: boolean;
    endpoint?: EndpointSpec;
    endpoints?: [EndpointSpec, EndpointSpec];
    hoverPaintStyle?: PaintStyle;
    mergeStrategy?: string;
    overlays?: OverlaySpec[];
    paintStyle?: PaintStyle;
    parameters?: Record<string, any>;
    reattach?: boolean;
    scope?: string;
}

Hierarchy (view full)

Properties

anchor? anchors? connector? connectorClass? connectorHoverStyle? connectorStyle? cssClass? detachable? endpoint? endpoints? hoverPaintStyle? mergeStrategy? overlays? paintStyle? parameters? reattach? scope?

Properties

Optional anchor

anchor?: AnchorSpec

Spec for the anchor to use for both source and target.

Optional anchors

anchors?: [AnchorSpec, AnchorSpec]

[source, target] anchor specs for edges.

Optional connector

connector?: ConnectorSpec

Spec for connectors created for this type.

Optional connectorClass

connectorClass?: string

Class to add to any connectors created for this type.

Optional connectorHoverStyle

connectorHoverStyle?: PaintStyle

Paint style for connectors created for this type when pointer is hovering over the component.

Optional connectorStyle

connectorStyle?: PaintStyle

Paint style for connectors created for this type.

Optional cssClass

cssClass?: string

CSS class to add to the given component's representation in the UI

Optional detachable

detachable?: boolean

Whether or not connections of this type should be detachable with the mouse. Defaults to true.

Optional endpoint

endpoint?: EndpointSpec

Spec for an endpoint created for this type.

Optional endpoints

endpoints?: [EndpointSpec, EndpointSpec]

Specs for the [source, target] endpoints for connections of this type.

Optional hoverPaintStyle

hoverPaintStyle?: PaintStyle

Paint style to use for the component when the pointer is hovering over it.

Optional mergeStrategy

mergeStrategy?: string

When merging a type description into its parent(s), values in the child for connector, anchor and anchors will always overwrite any such values in the parent. But other values, such as overlays, will be merged with their parent's entry for that key. You can force a child's type to override every corresponding value in its parent by setting mergeStrategy:'override'.

Optional overlays

overlays?: OverlaySpec[]

Array of overlays to add.

Optional paintStyle

paintStyle?: PaintStyle

Paint style to use for the component.

Optional parameters

parameters?: Record<string, any>

Optional set of parameters to store on the component that is generated from this type.

Optional reattach

reattach?: boolean

Whether or not when a user detaches a connection of this type it should be automatically reattached. Defaults to false.

Optional scope

scope?: string

Provides a simple means for controlling connectivity in the UI.

Settings

Member Visibility

Theme

On This Page

anchoranchorsconnectorconnectorClassconnectorHoverStyleconnectorStylecssClassdetachableendpointendpointshoverPaintStylemergeStrategyoverlayspaintStyleparametersreattachscope