sesaparcours
    Preparing search index...

    Interface ConnectParams<E>

    Options for the connect call on a JsPlumbInstance

    interface ConnectParams<E> {
        anchor?: AnchorSpec;
        anchors?: [AnchorSpec, AnchorSpec];
        color?: string;
        connector?: ConnectorSpec;
        cost?: number;
        cssClass?: string;
        data?: any;
        deleteEndpointsOnDetach?: boolean;
        deleteEndpointsOnEmpty?: boolean;
        detachable?: boolean;
        directed?: boolean;
        endpoint?: EndpointSpec;
        endpointHoverStyle?: EndpointStyle;
        endpointHoverStyles?: [EndpointStyle, EndpointStyle];
        endpoints?: [EndpointSpec, EndpointSpec];
        endpointStyle?: EndpointStyle;
        endpointStyles?: [EndpointStyle, EndpointStyle];
        hoverClass?: string;
        hoverPaintStyle?: PaintStyle;
        id?: string;
        label?: string;
        lineWidth?: number;
        outlineColor?: string;
        outlineWidth?: number;
        overlays?: OverlaySpec[];
        paintStyle?: PaintStyle;
        parameters?: Record<string, any>;
        ports?: [string, string];
        reattach?: boolean;
        scope?: string;
        source?: Element | Endpoint<any>;
        target?: Element | Endpoint<any>;
        type?: string;
        uuids?: [string, string];
    }

    Type Parameters

    • E
    Index

    Properties

    anchor? anchors? color? connector? cost? cssClass? data? deleteEndpointsOnDetach? deleteEndpointsOnEmpty? detachable? directed? endpoint? endpointHoverStyle? endpointHoverStyles? endpoints? endpointStyle? endpointStyles? hoverClass? hoverPaintStyle? id? label? lineWidth? outlineColor? outlineWidth? overlays? paintStyle? parameters? ports? reattach? scope? source? target? type? uuids?

    Properties

    anchor?: AnchorSpec

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

    anchors?: [AnchorSpec, AnchorSpec]

    Individual anchor specs for the source/target endpoints.

    color?: string
    connector?: ConnectorSpec

    Spec for the connector used to paint the connection.

    cost?: number

    Cost of the connection. Defaults to 1.

    cssClass?: string
    data?: any
    deleteEndpointsOnDetach?: boolean

    Whether or not to delete the connection's endpoints when this connection is detached. Defaults to false. Does not delete endpoints if they have other connections.

    deleteEndpointsOnEmpty?: boolean

    Whether or not to delete any endpoints that were created by this connect call if at some point in the future the endpoint has no remaining connections. Defaults to false.

    detachable?: boolean

    Whether or not the connection is detachable. Defaults to true.

    directed?: boolean

    Whether or not the connection is considered to be 'directed'

    endpoint?: EndpointSpec

    Spec for the endpoint to use for both source and target endpoints.

    endpointHoverStyle?: EndpointStyle

    Spec for the styles to use on both source and target endpoints when they are in hover state

    endpointHoverStyles?: [EndpointStyle, EndpointStyle]

    Individual specs for the source/target endpoint styles when they are in hover state.

    endpoints?: [EndpointSpec, EndpointSpec]

    Individual endpoint specs for the source/target endpoints.

    endpointStyle?: EndpointStyle

    Spec for the styles to use on both source and target endpoints

    endpointStyles?: [EndpointStyle, EndpointStyle]

    Individual specs for the source/target endpoint styles.

    hoverClass?: string
    hoverPaintStyle?: PaintStyle

    Paint style for the connector when in hover mode.

    id?: string
    label?: string

    Optional label to set on the connection. In the default browser UI implementation this is rendered as a label attribute on the SVG element representing the connection.

    lineWidth?: number
    outlineColor?: string
    outlineWidth?: number
    overlays?: OverlaySpec[]

    Optional list of overlays to attach to the connection.

    paintStyle?: PaintStyle

    Paint style for the connector.

    parameters?: Record<string, any>

    Optional extra parameters to associate with the connection

    ports?: [string, string]

    Optional port IDs for the source and target endpoints

    reattach?: boolean

    Whether or not to reattach this connection automatically should it be detached via user intervention. Defaults to false.

    scope?: string
    source?: Element | Endpoint<any>

    Source for the connection - an Endpoint, or an element

    target?: Element | Endpoint<any>

    Source for the connection - an Endpoint, or an element

    type?: string

    Type of the connection. Used in conjunction with the registerConnectionType method.

    uuids?: [string, string]

    Optional UUIDs to assign to the source and target endpoints.

    Settings

    Member Visibility

    On This Page

    Properties