Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
A
 addClass
 addConnection, Endpoint
 addEndpoint
 addEndpoints
 addOverlay
 animate
B
 bind
C
 canvas, Endpoint
 clearListeners
 connect
 Connection
 connections, Endpoint
 connector, Connection
 connectorClass
 Connectors.Flowchart
 Connectors.Straight
 Constructor
D
 Defaults
 deleteEndpoint
 deleteEveryEndpoint
 detach
 detachAll, Endpoint
 detachAllConnections
 detachEveryConnection
 detachFrom, Endpoint
 detachFromConnection, Endpoint
 draggable
E
 Endpoint
 endpointClass
 endpoints, Connection
 Endpoints.Blank
 Endpoints.Dot
 Endpoints.Image
 Endpoints.Rectangle
 Endpoints.Triangle
 extend
F
 Functions
 Functions and Properties, Connection
G
 getAllConnections
 getConnections
 getDefaultConnectionType
 getDefaultEndpointType
 getDefaultScope
 getElement, Endpoint
 getEndpoint
 getOverlay
 getUuid, Endpoint
H
 hasClass
 hide
 hideOverlay
I
 isConnectedTo, Endpoint
 isDetachable, Connection
 isFull, Endpoint
 isVisible, Endpoint
J
 jsPlumb 1.3.5
M
 makeSource
 makeTarget
O
 overlayClass
 overlays
 Overlays.Arrow
 Overlays.Diamond
 Overlays.Label
 Overlays.PlainArrow
P
 paint, Endpoint
 Properties
R
 ready
 removeAllEndpoints
 removeAllOverlays
 removeClass
 repaint
 repaintEverything
this.addClass = function(el,
clazz)
Helper method to abstract out differences in setting css classes on the different renderer types.
this.addConnection = function(connection)
Adds a Connection to this Endpoint.
this.addEndpoint = function(el,
params,
referenceParams)
Adds an Endpoint to a given element or elements.
this.addEndpoints = function(el,
endpoints,
referenceParams)
Adds a list of Endpoints to a given element or elements.
this.addOverlay = function(overlay)
Adds an Overlay to the Connection.
this.animate = function(el,
properties,
options)
This is a wrapper around the supporting library’s animate function; it injects a call to jsPlumb in the ‘step’ function (creating the ‘step’ function if necessary).
Bind to an event on jsPlumb.
Bind to an event on the Connection.
Bind to an event on the Endpoint.
The Endpoint’s Canvas.
Clears either all listeners, or listeners for some specific event.
this.connect = function(params,
referenceParams)
Establishes a Connection between two elements (or Endpoints, which are themselves registered to elements).
The connecting line between two Endpoints.
var Connection = function(params)
Connection constructor.
List of Connections this Endpoint is attached to.
The underlying Connector for this Connection (eg.
The CSS class to set on Connection elements.
Provides ‘flowchart’ connectors, consisting of vertical and horizontal line segments.
The Straight connector draws a simple straight line between the two anchor points.
See Overlays.Arrow for allowed parameters for this overlay.
See Overlays.Arrow for allowed parameters for this overlay.
These are the default settings for jsPlumb.
this.deleteEndpoint = function(object)
Deletes an Endpoint and removes all Connections it has (which removes the Connections from the other Endpoints involved too)
this.deleteEveryEndpoint = function()
Deletes every Endpoint, and their associated Connections, in this instance of jsPlumb.
this.detach = function()
Detaches and then removes a Connection.
this.detach = function(connection,
ignoreTarget,
forceDetach,
fireEvent)
Detaches the given Connection from this Endpoint.
this.detachAll = function(fireEvent)
Detaches all Connections this Endpoint has.
this.detachAllConnections = function(el,
params)
Removes all an element’s Connections.
this.detachEveryConnection = function(params)
Remove all Connections from all elements, but leaves Endpoints in place.
this.detachFrom = function(targetEndpoint,
fireEvent)
Removes any connections from this Endpoint that are connected to the given target endpoint.
this.detachFromConnection = function(connection)
Detach this Endpoint from the Connection, but leave the Connection alive.
Initialises the draggability of some element or elements.
Models an endpoint.
var Endpoint = function(params)
Endpoint constructor.
The CSS class to set on Endpoint elements.
Array of [source, target] Endpoint objects.
An Endpoint that paints nothing (visible) on the screen.
A round endpoint, with default radius 10 pixels.
Draws an image as the Endpoint.
A Rectangular Endpoint, with default size 20x20.
A triangular Endpoint.
this.extend = function(o1,
o2)
Wraps the underlying library’s extend functionality.
this.getAllConnections = function()
Gets all connections, as a map of { scope -> [ connection...
this.getConnections = function(options)
Gets all or a subset of connections currently managed by this jsPlumb instance.
this.getDefaultConnectionType = function()
Returns the default Connection type.
this.getDefaultEndpointType = function()
Returns the default Endpoint type.
this.getDefaultScope = function()
Gets the default scope for connections and endpoints.
this.getElement = function()
Returns the DOM element this Endpoint is attached to.
Gets an Endpoint by UUID
this.getOverlay = function(id)
Gets an overlay, by ID.
this.getUuid = function()
Returns the UUID for this Endpoint, if there is one.
this.hasClass = function(el,
clazz)
Helper method to abstract out differences in testing for css classes on the different renderer types.
this.hide = function(el,
changeEndpoints)
Sets an element’s connections to be hidden.
this.hideOverlay = function(id)
Hides the overlay specified by the given id.
this.isConnectedTo = function(endpoint)
Returns whether or not this endpoint is connected to the given Endpoint.
this.isDetachable = function()
Returns whether or not this connection can be detached from its target/source endpoint.
this.isFull = function()
Returns whether or not the Endpoint can accept any more Connections.
this.isVisible = function()
Returns whether or not the Endpoint is currently visible.
Makes some DOM element a Connection source, allowing you to drag connections from it without having to register any Endpoints on it first.
Makes some DOM element a Connection target, allowing you to drag connections to it without having to register any Endpoints on it first.
The CSS class to set on an Overlay that is an HTML element.
List of Overlays for this component.
An arrow overlay, defined by four points: the head, the two sides of the tail, and a ‘foldback’ point at some distance along the length of the arrow that lines from each tail point converge into.
A diamond.
A Label overlay.
A basic arrow.
this.paint = function(params)
Paints the Endpoint, recalculating offset and anchor positions if necessary.
this.ready = function(fn)
Helper method to bind a function to jsPlumb’s ready event.
this.removeAllEndpoints = function(el)
Removes all Endpoints associated with a given element.
this.removeAllOverlays = function()
Removes all overlays from the Connection, and then repaints.
this.removeClass = function(el,
clazz)
Helper method to abstract out differences in setting css classes on the different renderer types.
this.repaint = function(el)
Repaints an element and its connections.
this.repaint = function(params)
Repaints the Connection.
this.repaintEverything = function()
Repaints all connections.
Close