common package#
This package contains common declarations and definitions for use by both jsPlumb Community and Toolkit editions.
Enumerations#
| Enumeration | Description |
|---|---|
| AnchorLocations | Default anchor locations. |
| PerimeterAnchorShapes | Supported shapes for a Perimeter anchor. |
Interfaces#
| Interface | Description |
|---|---|
| AnchorOptions | Common options for anchors. |
| ArrowOverlayOptions | |
| BlankEndpointParams | |
| Connector | High level definition of a Connector. |
| ConnectorOptions | Common options for connectors. |
| CustomOverlayOptions | |
| DotEndpointParams | |
| EndpointRepresentationParams | |
| EndpointStyle | |
| Geometry | Geometry defines the path along which a connector travels. The internal contents of a Geometry vary widely between connectors. |
| LabelOverlayOptions | |
| OverlayOptions | |
| PaintStyle | |
| PerimeterAnchorOptions | Constructor options for a Perimeter Anchor. |
| RectangleEndpointParams |
Variables#
| Variable | Description |
|---|---|
| DEFAULT | Constant used im various places internally, and in the Toolkit edition used as the key for default node, edge, port and group definitions. |
| FALSE | Constant for the term "false" |
| TRUE | Constant for the term "true" |
| UNDEFINED | Constant for matching JS 'undefined'. |
| WILDCARD | Constant representing the wildcard used in several places in the API. |
Type Aliases#
| Type Alias | Description |
|---|---|
| AnchorId | List of entries in the AnchorLocations enum |
| AnchorSpec | Models the specification of anchor - which may be a SingleAnchorSpec, or an array of SingleAnchorSpec objects. |
| ArrayAnchorSpec | An anchor spec in the form [ x, y, ox, oy ] |
| ConnectorId | Alias for the use case that a Connector is referenced just by its type. |
| ConnectorSpec | Specification of a connector - either the type id of some Connector, a type+options object. |
| ConnectorWithOptions | Connector spec in the form {type:.., options:{.. }} |
| EndpointId | |
| EndpointParams | |
| EndpointSpec | |
| FullAnchorSpec | An anchor spec in the form {type:..., options:{ ... }} |
| FullEndpointSpec | |
| FullOverlaySpec | |
| OverlaySpec | |
| SingleAnchorSpec | Models the specification of a single anchor. |
| UserDefinedEndpointId |