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)


anchor?: AnchorSpec

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

anchors?: [AnchorSpec, AnchorSpec]

[source, target] anchor specs for edges.

connector?: ConnectorSpec

Spec for connectors created for this type.

connectorClass?: string

Class to add to any connectors created for this type.

connectorHoverStyle?: PaintStyle

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

connectorStyle?: PaintStyle

Paint style for connectors created for this type.

cssClass?: string

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

detachable?: boolean

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

endpoint?: EndpointSpec

Spec for an endpoint created for this type.

endpoints?: [EndpointSpec, EndpointSpec]

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

hoverPaintStyle?: PaintStyle

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

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

overlays?: OverlaySpec[]

Array of overlays to add.

paintStyle?: PaintStyle

Paint style to use for the component.

parameters?: Record<string, any>

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

reattach?: boolean

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

scope?: string

Provides a simple means for controlling connectivity in the UI.