Skip to main content

Home > @jsplumb/core > Endpoint

Endpoint class#

Signature:

export declare class Endpoint<E = any> extends Component 

Extends: Component

Constructors#

ConstructorModifiersDescription
(constructor)(instance, params)Constructs a new instance of the Endpoint class

Properties#

PropertyModifiersTypeDescription
_anchorLightweightAnchor
connectionCostnumber
connectionsArray<Connection<E>>
connectionsDetachableboolean
connectionsDirectedboolean
connectorConnectorSpec
connectorClassstring
connectorHoverClassstring
connectorHoverStylePaintStyle
connectorOverlaysArray<OverlaySpec>
connectorStylePaintStyle
currentAnchorClassstring
defaultLabelLocation[number, number]
deleteOnEmptyboolean
dragAllowedWhenFullboolean
edgeTypestring
elementE
elementIdstring
enabledboolean
endpointEndpointRepresentation<any>
finalEndpointEndpoint<E>
instanceJsPlumbInstance
isSourceboolean
isTargetboolean
isTemporarySourceboolean
maxConnectionsnumber
portIdstring
proxiedByEndpoint<E>
reattachConnectionsboolean
referenceEndpointEndpoint<E>
scopestring
timestampstring
uuidstring

Methods#

MethodModifiersDescription
_anchorLocationChanged(currentAnchor)Called by the router when a dynamic anchor has changed its current location.
addClass(clazz, cascade)
addConnection(conn)
applyType(t, typeMap)
connectorSelector()
deleteEveryConnection(params)Delete every connection in the instance.
destroy()
detachFrom(otherEndpoint)Removes all connections from this endpoint to the given other endpoint.
detachFromConnection(connection, idx, transientDetach)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.
getDefaultOverlayKey()
getIdPrefix()
getTypeDescriptor()
getUuid()
getXY()
isConnectedTo(otherEndpoint)Test if this Endpoint is connected to the given Endpoint.
isFloating()
isFull()
removeClass(clazz, cascade)
setAnchor(anchorParams)
setDragAllowedWhenFull(allowed)
setEndpoint(ep)
setVisible(v, doNotChangeConnections, doNotNotifyOtherEndpoint)