sesaparcours
    Preparing search index...

    Class Endpoint<E>

    Base class for Endpoint and Connection.

    Type Parameters

    • E = any

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _anchor _defaultType _hover _typeCache _types beforeDetach beforeDrop clone connectionCost connections connectionsDetachable connectionsDirected connector connectorClass connectorHoverClass connectorHoverStyle connectorOverlays connectorStyle cssClass currentAnchorClass data defaultLabelLocation deleted deleteOnEmpty dragAllowedWhenFull edgeType element elementId enabled endpoint events finalEndpoint h hoverClass hoverPaintStyle id instance isSource isTarget isTemporarySource lastPaintedAt maxConnections overlayPlacements overlayPositions overlays paintStyle paintStyleInUse parameters params portId proxiedBy reattachConnections referenceEndpoint scope segment timestamp typeId uuid visible w x y

    Methods

    _anchorLocationChanged addClass addConnection bind connectorSelector deleteEveryConnection detachFrom detachFromConnection fire getClass getData getDefaultOverlayKey getIdPrefix getLabel getListener getOverlay getOverlays getTypeDescriptor getUuid getXY hideOverlay hideOverlays isConnectedTo isFloating isFull isSuspendEvents mergeData removeAllOverlays removeClass removeOverlays setAnchor setData setDragAllowedWhenFull setEndpoint setLabel setSuspendEvents showOverlay showOverlays silently unbind

    Constructors

    Properties

    _anchor

    _anchor: LightweightAnchor

    _defaultType

    _defaultType: ComponentTypeDescriptor

    _hover

    _hover: boolean

    _typeCache

    _typeCache: {}

    _types

    _types: Set<string>
    beforeDetach: BeforeDetachInterceptor
    beforeDrop: BeforeDropInterceptor
    clone: () => Component
    connectionCost: number
    connections: Connection<E>[]
    connectionsDetachable: boolean
    connectionsDirected: boolean
    connector: ConnectorSpec
    connectorClass: string
    connectorHoverClass: string
    connectorHoverStyle: PaintStyle
    connectorOverlays: OverlaySpec[]
    connectorStyle: PaintStyle
    cssClass: string
    currentAnchorClass: string
    data: Record<string, any>
    defaultLabelLocation: [number, number]
    deleted: boolean
    deleteOnEmpty: boolean
    dragAllowedWhenFull: boolean
    edgeType: string
    element: E
    elementId: string
    enabled: boolean
    endpoint: EndpointRepresentation<any>
    events: any
    finalEndpoint: Endpoint<E>
    h: number
    hoverClass: string
    hoverPaintStyle: PaintStyle
    id: string
    instance: JsPlumbInstance
    isSource: boolean
    isTarget: boolean
    isTemporarySource: boolean
    lastPaintedAt: string
    maxConnections: number
    overlayPlacements: Record<string, Extents>
    overlayPositions: Record<string, PointXY>
    overlays: Record<string, Overlay>
    paintStyle: PaintStyle
    paintStyleInUse: PaintStyle
    parameters: ComponentParameters
    params: Record<string, any>
    portId: string
    proxiedBy: Endpoint<E>
    reattachConnections: boolean
    referenceEndpoint: Endpoint<E>
    scope: string
    segment: number
    timestamp: string
    typeId: string
    uuid: string
    visible: boolean
    w: number
    x: number
    y: number

    Methods

    _anchorLocationChanged

    • _anchorLocationChanged(currentAnchor: LightweightAnchor): void

      Called by the router when a dynamic anchor has changed its current location.

      Parameters

      Returns void

    • Adds a css class to the component

      Parameters

      • clazz: string

        Class to add. May be a space separated list.

      • Optionalcascade: boolean

        This is for subclasses to use, if they wish to. For instance, a Connection might want to optionally cascade a css class down to its endpoints.

      Returns void

    • Parameters

      Returns void

    • Bind an event listener. This method can be used with a type parameter by call sites; although it's not necessary it can be helpful to use this to ensure you've thought about what the payload to your event handler is going to be.

      Type Parameters

      • T = any

      Parameters

      • event: string | String[]

        Name of the event(s) to bind to.

      • listener: (a: T, e?: any) => any

        Function to bind to the given event(s)

      • OptionalinsertAtStart: boolean

        Whether or not to insert this listener at the head of the listener queue. Defaults to false.

      Returns EventGenerator

    • Returns Connection

    • Delete every connection in the instance.

      Parameters

      Returns void

    • Removes all connections from this endpoint to the given other endpoint.

      Parameters

      Returns Endpoint

    • Detaches this Endpoint from the given Connection. If deleteOnEmpty is set to true and there are no Connections after this one is detached, the Endpoint is deleted.

      Parameters

      • connection: Connection

        Connection from which to detach.

      • Optionalidx: number

        Optional, used internally to identify if this is the source (0) or target endpoint (1). Sometimes we already know this when we call this method.

      • OptionaltransientDetach: boolean

        For internal use only.

      Returns void

    • Fire the named event.

      Type Parameters

      • T

      Parameters

      • event: string

        Event to fire

      • Optionalvalue: T

        Value to pass to event handlers

      • OptionaloriginalEvent: Event

        Optional original event that caused this event to be fired.

      Returns any

    • Returns a space-separated list of the current classes assigned to this component.

      Returns string

    • Gets any backing data stored against the given component.

      Returns Record<string, any>

    • Returns string

    • Returns string

    • Return this component's label, if one is set.

      Returns string

    • Gets all listeners for the given named event.

      Parameters

      • forEvent: string

      Returns any[]

    • Get the Overlay with the given ID. You can optionally provide a type parameter for this method in order to get a typed return value (such as LabelOverlay, ArrowOverlay, etc), since some overlays have methods that others do not.

      Type Parameters

      Parameters

      • id: string

        ID of the overlay to retrieve.

      Returns T

    • Gets all the overlays registered on this component.

      Returns Record<string, Overlay>

    • Returns string

    • Returns string

    • Returns { x: number; y: number }

    • Hide the overlay with the given id.

      Parameters

      • id: string

      Returns void

    • Hide all overlays, or a specific set of overlays.

      Parameters

      • ...ids: string[]

        optional list of ids to hide.

      Returns void

    • Test if this Endpoint is connected to the given Endpoint.

      Parameters

      Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns whether not event firing is currently suspended

      Returns boolean

    • Merges the given backing data into any current backing data.

      Parameters

      • d: any

      Returns void

    • Remove all overlays from this component.

      Returns void

    • Removes a css class from the component

      Parameters

      • clazz: string

        Class to remove. May be a space separated list.

      • Optionalcascade: boolean

        This is for subclasses to use, if they wish to. For instance, a Connection might want to optionally cascade a css class removal down to its endpoints.

      Returns void

    • Remove the given set of overlays, specified by their ids.

      Parameters

      • ...overlays: string[]

      Returns void

    • Sets backing data stored against the given component, overwriting any current value.

      Parameters

      • d: any

      Returns void

    • Parameters

      • allowed: boolean

      Returns void

    • Set this component's label.

      Parameters

      • l: string | Function | LabelOverlay

        Either some text, or a function which returns some text, or an existing label overlay.

      Returns void

    • Sets whether not event firing is currently suspended

      Parameters

      • val: boolean

      Returns void

    • Show a specific overlay (set it to be visible)

      Parameters

      • id: string

      Returns void

    • Show all overlays, or a specific set of overlays.

      Parameters

      • ...ids: string[]

        optional list of ids to show.

      Returns void

    • Run the given function without firing any events.

      Parameters

      Returns void

    • Unbind the given event listener, or all listeners. If you call this method with no arguments then all event listeners are unbound.

      Parameters

      • OptionaleventOrListener: string | Function

        Either an event name, or an event handler function

      • Optionallistener: Function

        If eventOrListener is defined, this is the event handler to unbind.

      Returns EventGenerator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods