Skip to main content

Home > @jsplumbtoolkit/browser-ui > ConnectParams

ConnectParams interface

Options for the connect call on a JsPlumbInstance

Signature:

export interface ConnectParams<E> 

Properties

PropertyModifiersTypeDescription
anchor?AnchorSpec(Optional) Spec for the anchor to use for both source and target endpoints.
anchors?[AnchorSpec, AnchorSpec](Optional) Individual anchor specs for the source/target endpoints.
color?string(Optional)
connector?ConnectorSpec(Optional) Spec for the connector used to paint the connection.
cost?number(Optional) Cost of the connection. Defaults to 1.
cssClass?string(Optional)
data?any(Optional)
deleteEndpointsOnDetach?boolean(Optional) 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(Optional) 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(Optional) Whether or not the connection is detachable. Defaults to true.
directed?boolean(Optional) Whether or not the connection is considered to be 'directed'
endpoint?EndpointSpec(Optional) Spec for the endpoint to use for both source and target endpoints.
endpointHoverStyle?EndpointStyle(Optional) Spec for the styles to use on both source and target endpoints when they are in hover state
endpointHoverStyles?[EndpointStyle, EndpointStyle](Optional) Individual specs for the source/target endpoint styles when they are in hover state.
endpoints?[EndpointSpec, EndpointSpec](Optional) Individual endpoint specs for the source/target endpoints.
endpointStyle?EndpointStyle(Optional) Spec for the styles to use on both source and target endpoints
endpointStyles?[EndpointStyle, EndpointStyle](Optional) Individual specs for the source/target endpoint styles.
hoverClass?string(Optional)
hoverPaintStyle?PaintStyle(Optional) Paint style for the connector when in hover mode.
id?string(Optional)
label?string(Optional) 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.
labelLocation?number(Optional)
lineWidth?number(Optional)
outlineColor?string(Optional)
outlineWidth?number(Optional)
overlays?Array<OverlaySpec>(Optional) Optional list of overlays to attach to the connection.
paintStyle?PaintStyle(Optional) Paint style for the connector.
parameters?Record<string, any>(Optional) Optional extra parameters to associate with the connection
ports?[string, string](Optional) Optional port IDs for the source and target endpoints
reattach?boolean(Optional) Whether or not to reattach this connection automatically should it be detached via user intervention. Defaults to false.
scope?string(Optional)
source?Element | Endpoint(Optional) Source for the connection - an Endpoint, or an element
target?Element | Endpoint(Optional) Source for the connection - an Endpoint, or an element
type?string(Optional) Type of the connection. Used in conjunction with the registerConnectionType method.
useHTMLLabel?boolean(Optional)
uuids?[UUID, UUID](Optional) Optional UUIDs to assign to the source and target endpoints.