Home > @jsplumbtoolkit/browser-ui > EndpointOptions

EndpointOptions interface

Signature:

export interface EndpointOptions<E = any> 

Properties

Property	Modifiers	Type	Description
anchor?		AnchorSpec	(Optional) 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) 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) Optional cost to set for connections that have this endpoint as their source. Defaults to 1.
connectionsDetachable?		boolean	(Optional) Whether or not connections that have this endpoint as their source are configured to be detachable with the mouse. Defaults to true.
connectionsDirected?		boolean	(Optional) Whether or not connections that have this endpoint as their source are considered "directed".
connector?		ConnectorSpec	(Optional) Optional connector definition for connections that are created with this endpoint as their source.
connectorClass?		string	(Optional) Optional class to assign to connections that have this endpoint as their source.
connectorHoverClass?		string	(Optional) Optional class to assign, on mouse hover, to connections that have this endpoint as their source.
connectorHoverStyle?		PaintStyle	(Optional) Optional paint style to assign, on hover, to a connection that is created with this endpoint as its source.
connectorOverlays?		Array<OverlaySpec>	(Optional) Optional list of overlays to add to a connection that is created with this endpoint as its source.
connectorStyle?		PaintStyle	(Optional) Optional paint style to assign to a connection that is created with this endpoint as its source.
cssClass?		string	(Optional)
data?		any	(Optional)
deleteOnEmpty?		boolean	(Optional) 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	(Optional) 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) Optional 'type' for connections that have this endpoint as their source.
enabled?		boolean	(Optional) Whether or not the endpoint is initially enabled. Defaults to true.
endpoint?		EndpointSpec	(Optional) Optional endpoint definition. If you do not supply this, the default endpoint definition for the jsPlumb instance will be used
hoverClass?		string	(Optional)
hoverPaintStyle?		PaintStyle	(Optional) Optional paint style to assign, on hover, to the endpoint.
maxConnections?		number	(Optional) Maximum number of connections this endpoint supports. Defaults to 1. Use a value of -1 to indicate there is no limit.
paintStyle?		PaintStyle	(Optional) Optional paint style to assign to the endpoint
parameters?		Record<string, any>	(Optional)
portId?		string	(Optional) Optional "port id" for this endpoint - a logical mapping of the endpoint to some name.
reattachConnections?		boolean	(Optional) Whether or not to set reattach:true on connections that have this endpoint as their source. Defaults to false.
scope?		string	(Optional)
source?		boolean	(Optional) Whether or not this Endpoint acts as a source for connections dragged with the mouse. Defaults to false.
target?		boolean	(Optional) Whether or not this Endpoint acts as a target for connections dragged with the mouse. Defaults to false.
uuid?		string	(Optional) Optional user-supplied ID for this endpoint.