Endpoints

Parent for all Endpoint types. When you provide an Endpoint definition to an appropriate jsPlumb method, you can do so either as a string, or as an array of the form [String, Object]. In the former case, the string must be one of the members from this namespace, such as "Dot" or "Rectangle". In the latter case, the first argument to the array is the Endpoint name, and the second is a JS object containing constructor parameters for the Endpoint, for instance

[ "Dot", { radius:75 } ]

Valid values for the constructor parameters for each Endpoint type are given below.

Source:
  • endpoint-api.js, line 43

Members

<static> Blank

Does not draw anything visible to the user. This Endpoint is probably not what you want if you need your users to be able to drag existing Connections - for that, use a Rectangle or Dot Endpoint and assign to it a CSS class that causes it to be transparent.

Source:
  • endpoint-api.js, line 51

<static> Dot

A circular Endpoint.

Source:
  • endpoint-api.js, line 45

<static> Image

An Image Endpoint.

Source:
  • endpoint-api.js, line 49

<static> Rectangle

A rectangular Endpoint.

Source:
  • endpoint-api.js, line 47

Methods

<static> Dot(params)

Parameters:
Name Type Description
params Object

Constructor parameters

Properties
Name Type Argument Default Description
radius Integer <optional>
 10

Radius of the Endpoint
cssClass String <optional>

Optional space-delimited list of CSS classes to attach to the Endpoint.
hoverClass String <optional>

Optional space-delimited list of CSS classes to attach to the Endpoint when the mouse is hovering over it.
Source:
  • endpoint-api.js, line 53

<static> Image(params)

Parameters:
Name Type Description
params Object

Constructor parameters

Properties
Name Type Argument Description
src Integer

Url of the image to display
cssClass String <optional>

Optional space-delimited list of CSS classes to attach to the Endpoint.
hoverClass String <optional>

Optional space-delimited list of CSS classes to attach to the Endpoint when the mouse is hovering over it.
Source:
  • endpoint-api.js, line 57

<static> Rectangle(params)

Parameters:
Name Type Description
params Object

Constructor parameters

Properties
Name Type Argument Default Description
width Integer <optional>
 20

Width of the Endpoint
height Integer <optional>
 20

Height of the Endpoint
cssClass String <optional>

Optional space-delimited list of CSS classes to attach to the Endpoint.
hoverClass String <optional>

Optional space-delimited list of CSS classes to attach to the Endpoint when the mouse is hovering over it.
Source:
  • endpoint-api.js, line 55