sesaparcours
    Preparing search index...

    Interface InternalEndpointOptions<E>

    interface InternalEndpointOptions<E> {
        _transient?: boolean;
        anchor?: AnchorSpec;
        anchors?: [AnchorSpec, AnchorSpec];
        connectionCost?: number;
        connections?: Connection<any>[];
        connectionsDetachable?: boolean;
        connectionsDirected?: boolean;
        connector?: ConnectorSpec;
        connectorClass?: string;
        connectorHoverClass?: string;
        connectorHoverStyle?: PaintStyle;
        connectorOverlays?: OverlaySpec[];
        connectorStyle?: PaintStyle;
        cssClass?: string;
        data?: any;
        deleteOnEmpty?: boolean;
        dragAllowedWhenFull?: boolean;
        edgeType?: string;
        element?: E;
        elementId?: string;
        enabled?: boolean;
        endpoint?: EndpointSpec;
        existingEndpoint?: EndpointRepresentation<E>;
        hoverClass?: string;
        hoverPaintStyle?: PaintStyle;
        id?: string;
        isTemporarySource?: boolean;
        maxConnections?: number;
        onMaxConnections?: (value: any, event?: any) => any;
        paintStyle?: PaintStyle;
        parameters?: Record<string, any>;
        portId?: string;
        preparedAnchor?: LightweightAnchor;
        reattachConnections?: boolean;
        scope?: string;
        source?: boolean;
        target?: boolean;
        type?: string;
        uuid?: string;
    }

    Type Parameters

    • E

    Hierarchy (View Summary)

    Index

    Properties

    _transient? anchor? anchors? connectionCost? connections? connectionsDetachable? connectionsDirected? connector? connectorClass? connectorHoverClass? connectorHoverStyle? connectorOverlays? connectorStyle? cssClass? data? deleteOnEmpty? dragAllowedWhenFull? edgeType? element? elementId? enabled? endpoint? existingEndpoint? hoverClass? hoverPaintStyle? id? isTemporarySource? maxConnections? onMaxConnections? paintStyle? parameters? portId? preparedAnchor? reattachConnections? scope? source? target? type? uuid?

    Properties

    Optional_transient

    _transient?: boolean
    anchor?: AnchorSpec

    Optional definition for both the source and target anchors for any connection created with this endpoint as its source. If you do not supply this, the default anchors definition for the jsPlumb instance will be used

    anchors?: [AnchorSpec, AnchorSpec]

    Optional definition for the source and target anchors for any connection created with this endpoint as its source. If you do not supply this, the default anchors definition for the jsPlumb instance will be used

    connectionCost?: number

    Optional cost to set for connections that have this endpoint as their source. Defaults to 1.

    connections?: Connection<any>[]
    connectionsDetachable?: boolean

    Whether or not connections that have this endpoint as their source are configured to be detachable with the mouse. Defaults to true.

    connectionsDirected?: boolean

    Whether or not connections that have this endpoint as their source are considered "directed".

    connector?: ConnectorSpec

    Optional connector definition for connections that are created with this endpoint as their source.

    connectorClass?: string

    Optional class to assign to connections that have this endpoint as their source.

    connectorHoverClass?: string

    Optional class to assign, on mouse hover, to connections that have this endpoint as their source.

    connectorHoverStyle?: PaintStyle

    Optional paint style to assign, on hover, to a connection that is created with this endpoint as its source.

    connectorOverlays?: OverlaySpec[]

    Optional list of overlays to add to a connection that is created with this endpoint as its source.

    connectorStyle?: PaintStyle

    Optional paint style to assign to a connection that is created with this endpoint as its source.

    cssClass?: string
    data?: any
    deleteOnEmpty?: boolean

    Whether or not to delete the Endpoint if it transitions to the state that it has no connections. Defaults to false. Note that this only applies if the endpoint previously had one or more connections and now has none: a newly created endpoint with this flag set is not immediately deleted.

    dragAllowedWhenFull?: boolean

    Whether or not connections can be dragged from the endpoint when it is full. Since no new connection could be dragged from an endpoint that is full, in a practical sense this means whether or not existing connections can be dragged off an endpoint that is full. Defaults to true.

    edgeType?: string

    Optional 'type' for connections that have this endpoint as their source.

    element?: E
    elementId?: string
    enabled?: boolean

    Whether or not the endpoint is initially enabled. Defaults to true.

    endpoint?: EndpointSpec

    Optional endpoint definition. If you do not supply this, the default endpoint definition for the jsPlumb instance will be used

    existingEndpoint?: EndpointRepresentation<E>
    hoverClass?: string
    hoverPaintStyle?: PaintStyle

    Optional paint style to assign, on hover, to the endpoint.

    id?: string
    isTemporarySource?: boolean
    maxConnections?: number

    Maximum number of connections this endpoint supports. Defaults to 1. Use a value of -1 to indicate there is no limit.

    onMaxConnections?: (value: any, event?: any) => any

    Optional callback to fire when the endpoint transitions to the state that it is now full.

    paintStyle?: PaintStyle

    Optional paint style to assign to the endpoint

    parameters?: Record<string, any>
    portId?: string

    Optional "port id" for this endpoint - a logical mapping of the endpoint to some name.

    preparedAnchor?: LightweightAnchor
    reattachConnections?: boolean

    Whether or not to set reattach:true on connections that have this endpoint as their source. Defaults to false.

    scope?: string
    source?: boolean

    Whether or not this Endpoint acts as a source for connections dragged with the mouse. Defaults to false.

    target?: boolean

    Whether or not this Endpoint acts as a target for connections dragged with the mouse. Defaults to false.

    type?: string
    uuid?: string

    Optional user-supplied ID for this endpoint.

    Settings

    Member Visibility

    On This Page

    Properties