Skip to main content

Home > @jsplumb/core

core package#

This package is the core of the jsPlumb Community Edition.

Classes#

ClassDescription
ArrowOverlay
BlankEndpoint
Component
Connection
ConnectionDragSelector
ConnectionSelection
CustomOverlay
DiamondOverlay
DotEndpoint
Endpoint
EndpointRepresentationSuperclass 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
SourceSelector
StraightConnector
TargetSelector
UIGroup
UINode
ViewportModels 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#

FunctionDescription
_createPerimeterAnchor(params)
_removeTypeCssHelper(component, typeIndex)
_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#

InterfaceDescription
AbstractSelectOptions
AddGroupOptions
BeforeDragParamsThe parameters passed to a beforeDrag interceptor.
BeforeDropParamsDefinition of the parameters passed to the beforeDrop interceptor.
BeforeStartDetachParamsThe parameters passed to a beforeStartDetach interceptor.
BehaviouralTypeDescriptorExtends EndpointTypeDescriptor to add the options supported by an addSourceSelector or addTargetSelector call.
ComponentOptions
ConnectionDetachedParamsDefinition of the parameters passed to a listener for the connection:detach event.
ConnectionEstablishedParamsDefinition of the parameters passed to a listener for the connection event.
ConnectionMovedParamsDefinition of the parameters passed to a listener for the connection:move event.
ConnectionTypeDescriptorDefinition of a connection type.
ConnectParamsOptions for the connect call on a JsPlumbInstance
EndpointHandler
EndpointOptions
EndpointTypeDescriptorDefinition of an endpoint type.
GroupCollapsedParams
GroupExpandedParams
GroupOptions
InternalConnectParamsInternal extension of ConnectParams containing a few extra things needed to establish a connection.
InternalEndpointOptions
JsPlumbDefaults
jsPlumbElement
LightweightAnchor
LightweightContinuousAnchor
LightweightPerimeterAnchor
ListSpec
ManageElementParamsPayload for an element managed event
OverlayMouseEventParams
RedrawResult
Router
SelectEndpointOptions
SelectOptions
SourceDefinitionDefines the supported options on an addSourceSelector call.
SourceOrTargetDefinitionBase interface for source/target definitions
TargetDefinitionDefines the supported options on an addTargetSelector call.
TypeDescriptorBase interface for type descriptors for public methods.
UnmanageElementParamsPayload for an element unmanaged event.
UpdateOffsetOptionsOptions for the UpdateOffset method
ViewportPositionDefinition of some element's location and rotation in the viewport.

Variables#

VariableDescription
ABSOLUTE
ATTRIBUTE_GROUP
ATTRIBUTE_MANAGED
ATTRIBUTE_NOT_DRAGGABLE
ATTRIBUTE_SCOPE_PREFIX
ATTRIBUTE_SCOPE
ATTRIBUTE_TABINDEX
BlankEndpointHandler
BLOCK
BOTTOM
CHECK_CONDITION
CHECK_DROP_ALLOWED
CLASS_CONNECTED
CLASS_CONNECTOR_OUTLINE
CLASS_CONNECTOR
CLASS_ENDPOINT_ANCHOR_PREFIX
CLASS_ENDPOINT_CONNECTED
CLASS_ENDPOINT_DROP_ALLOWED
CLASS_ENDPOINT_DROP_FORBIDDEN
CLASS_ENDPOINT_FULL
CLASS_ENDPOINT
CLASS_GROUP_COLLAPSED
CLASS_GROUP_EXPANDED
CLASS_OVERLAY
Connectors
DotEndpointHandler
EndpointFactory
ERROR_SOURCE_DOES_NOT_EXIST
ERROR_SOURCE_ENDPOINT_FULL
ERROR_TARGET_DOES_NOT_EXIST
ERROR_TARGET_ENDPOINT_FULL
EVENT_ANCHOR_CHANGED
EVENT_CONNECTION_DETACHED
EVENT_CONNECTION_MOVED
EVENT_CONNECTION
EVENT_CONTAINER_CHANGE
EVENT_ENDPOINT_REPLACED
EVENT_GROUP_ADDED
EVENT_GROUP_COLLAPSE
EVENT_GROUP_EXPAND
EVENT_GROUP_MEMBER_ADDED
EVENT_GROUP_MEMBER_REMOVED
EVENT_GROUP_REMOVED
EVENT_INTERNAL_CONNECTION_DETACHED
EVENT_INTERNAL_CONNECTION
EVENT_INTERNAL_ENDPOINT_UNREGISTERED
EVENT_MANAGE_ELEMENT
EVENT_MAX_CONNECTIONS
EVENT_NESTED_GROUP_ADDED
EVENT_NESTED_GROUP_REMOVED
EVENT_UNMANAGE_ELEMENT
EVENT_ZOOM
FIXED
INTERCEPT_BEFORE_DETACH
INTERCEPT_BEFORE_DRAG
INTERCEPT_BEFORE_DROP
INTERCEPT_BEFORE_START_DETACH
IS_DETACH_ALLOWED
KEY_CONNECTION_OVERLAYS
LEFT
NONE
OverlayFactory
RectangleEndpointHandler
REDROP_POLICY_ANYIndicates that when dragging an existing connection by its source endpoint, it can be relocated onto some other source element by dropping it anywhere on that element.
REDROP_POLICY_STRICTIndicates that when dragging an existing connection by its source endpoint, it can only be relocated onto some other source element by dropping it on the part of that element defined by its source selector.
RIGHT
SELECTOR_MANAGED_ELEMENT
SOURCE_INDEX
SOURCE
STATIC
TARGET_INDEX
TARGET
TOP
X_AXIS_FACES
Y_AXIS_FACES

Type Aliases#

Type AliasDescription
AnchorOrientationHint
Axis
BeforeDetachInterceptorDefines 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.
BeforeDragInterceptorDefines 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.
BeforeDropInterceptorDefines the method signature for the callback to the beforeDrop interceptor.
BeforeStartDetachInterceptorDefines the method signature for the callback to the beforeStartDetach interceptor.
ClassAction
ComponentParameters
ComputedBlankEndpoint
ComputedDotEndpoint
ComputedRectangleEndpoint
ConnectorComputeParams
DeleteConnectionOptionsOptional parameters to the DeleteConnection method.
ElementSelectionSpecifier
EndpointComputeFunction
Face
ManagedElement
Orientation
RedropPolicyDefines how redrop of source endpoints can be done.
SelectionList
TranslatedViewportElement
UUID