core package#
This package is the core of the jsPlumb Community Edition.
Classes#
| Class | Description |
|---|---|
| ArrowOverlay | |
| BlankEndpoint | |
| Component | Base class for Endpoint and Connection. |
| Connection | |
| ConnectionDragSelector | |
| ConnectionSelection | |
| CustomOverlay | |
| DiamondOverlay | |
| DotEndpoint | |
| Endpoint | |
| EndpointRepresentation | Superclass for all types of Endpoint. This class is renderer agnostic, as are any subclasses of it. |
| EndpointSelection | |
| GroupManager | |
| JsPlumbInstance | |
| LabelOverlay | |
| LightweightFloatingAnchor | |
| LightweightRouter | |
| Overlay | |
| PlainArrowOverlay | |
| RectangleEndpoint | |
| StraightConnector | |
| UIGroup | |
| UINode | |
| Viewport | Models the positions of the elements a given jsPlumb instance is tracking. Users of the API should not need to interact directly with a Viewport. |
Functions#
| Function | Description |
|---|---|
| _createPerimeterAnchor(params) | |
| _removeTypeCssHelper(component, typeId) | |
| _updateHoverStyle(component) | |
| att(attName) | |
| classList(className) | |
| cls(className) | |
| convertToFullOverlaySpec(spec) | Convert the given input into an object in the form of a FullOverlaySpec |
| createFloatingAnchor(instance, element) | |
| isArrowOverlay(o) | |
| isContinuous(a) | |
| isCustomOverlay(o) | |
| isDiamondOverlay(o) | |
| isDynamic(a) | |
| isFloating(a) | |
| isFullOverlaySpec(o) | Returns whether or not the given overlay spec is a 'full' overlay spec, ie. has a type and some options, or is just an overlay name. |
| isLabelOverlay(o) | |
| isPlainArrowOverlay(o) | |
| makeLightweightAnchorFromSpec(spec) |
Interfaces#
| Interface | Description |
|---|---|
| AbstractSelectOptions | |
| AddGroupOptions | |
| BeforeDragParams | The parameters passed to a beforeDrag interceptor. |
| BeforeDropParams | Definition of the parameters passed to the beforeDrop interceptor. |
| BeforeStartDetachParams | The parameters passed to a beforeStartDetach interceptor. |
| BehaviouralTypeDescriptor | Extends EndpointTypeDescriptor to add the options supported by an addSourceSelector or addTargetSelector call. |
| ComponentOptions | |
| ConnectionDetachedParams | Definition of the parameters passed to a listener for the connection:detach event. |
| ConnectionEstablishedParams | Definition of the parameters passed to a listener for the connection event. |
| ConnectionMovedParams | Definition of the parameters passed to a listener for the connection:move event. |
| ConnectionTypeDescriptor | Definition of a connection type. |
| ConnectParams | Options for the connect call on a JsPlumbInstance |
| CustomOverlayOptions | |
| EndpointHandler | |
| EndpointOptions | |
| EndpointTypeDescriptor | Definition of an endpoint type. |
| GroupCollapsedParams | |
| GroupExpandedParams | |
| GroupOptions | |
| InternalConnectParams | Internal extension of ConnectParams containing a few extra things needed to establish a connection. |
| InternalEndpointOptions | |
| JsPlumbDefaults | |
| jsPlumbElement | |
| LightweightAnchor | |
| LightweightContinuousAnchor | |
| LightweightPerimeterAnchor | |
| ListSpec | |
| ManageElementParams | Payload for an element managed event |
| OverlayMouseEventParams | |
| RedrawResult | |
| Router | |
| SelectEndpointOptions | |
| SelectOptions | |
| SourceDefinition | Defines the supported options on an addSourceSelector call. |
| SourceOrTargetDefinition | Base interface for source/target definitions |
| StraightConnectorGeometry | |
| TargetDefinition | Defines the supported options on an addTargetSelector call. |
| TypeDescriptor | Base interface for type descriptors for public methods. |
| UnmanageElementParams | Payload for an element unmanaged event. |
| UpdateOffsetOptions | Options for the UpdateOffset method |
| ViewportPosition | Definition of some element's location and rotation in the viewport. |
Variables#
Type Aliases#
| Type Alias | Description |
|---|---|
| AnchorOrientationHint | |
| Axis | |
| BeforeDetachInterceptor | Defines the method signature for the callback to the beforeDetach interceptor. Returning false from this method prevents the connection from being detached. The interceptor is fired by the core, meaning that it will be invoked regardless of whether the detach occurred programmatically, or via the mouse. |
| BeforeDragInterceptor | Defines the method signature for the callback to the beforeDrag interceptor. This method can return boolean false to abort the connection drag, or it can return an object containing values that will be used as the data for the connection that is created. |
| BeforeDropInterceptor | Defines the method signature for the callback to the beforeDrop interceptor. |
| BeforeStartDetachInterceptor | Defines the method signature for the callback to the beforeStartDetach interceptor. |
| ClassAction | |
| ComponentParameters | |
| ComputedBlankEndpoint | |
| ComputedDotEndpoint | |
| ComputedRectangleEndpoint | |
| ConnectorComputeParams | |
| DeleteConnectionOptions | Optional parameters to the DeleteConnection method. |
| ElementSelectionSpecifier | |
| EndpointComputeFunction | |
| Face | |
| ManagedElement | |
| Orientation | |
| RedropPolicy | Defines how redrop of source endpoints can be done. |
| SelectionList | |
| TranslatedViewportElement | |
| UUID |