Skip to main content

Home > @jsplumb/common

common package#

This package contains common declarations and definitions for use by both jsPlumb Community and Toolkit editions.

Enumerations#

EnumerationDescription
AnchorLocationsDefault anchor locations.
PerimeterAnchorShapesSupported shapes for a Perimeter anchor.

Interfaces#

InterfaceDescription
AnchorOptionsCommon options for anchors.
ArrowOverlayOptions
BlankEndpointParams
ConnectorHigh level definition of a Connector.
ConnectorOptionsCommon options for connectors.
CustomOverlayOptions
DotEndpointParams
EndpointRepresentationParams
EndpointStyle
GeometryGeometry defines the path along which a connector travels. The internal contents of a Geometry vary widely between connectors.
LabelOverlayOptions
OverlayOptions
PaintStyle
PerimeterAnchorOptionsConstructor options for a Perimeter Anchor.
RectangleEndpointParams

Variables#

VariableDescription
DEFAULTConstant used im various places internally, and in the Toolkit edition used as the key for default node, edge, port and group definitions.
FALSEConstant for the term "false"
TRUEConstant for the term "true"
UNDEFINEDConstant for matching JS 'undefined'.
WILDCARDConstant representing the wildcard used in several places in the API.

Type Aliases#

Type AliasDescription
AnchorIdList of entries in the AnchorLocations enum
AnchorSpecModels the specification of anchor - which may be a SingleAnchorSpec, or an array of SingleAnchorSpec objects.
ConnectorIdAlias for the use case that a Connector is referenced just by its type.
ConnectorSpecSpecification of a connector - either the type id of some Connector, a type+options object.
ConnectorWithOptionsConnector spec in the form {type:.., options:{.. }}
EndpointId
EndpointParams
EndpointSpec
FullAnchorSpecAn anchor spec in the form {type:..., options:{ ... }}
FullEndpointSpec
FullOverlaySpec
OverlaySpec
SingleAnchorSpecModels the specification of a single anchor.
UserDefinedEndpointId