123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296 |
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
- <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>/Users/simon/programming/jsplumb-git/js/TEMP/jsPlumb 1.3.6</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/prettify.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
- if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
- <!-- Generated by Natural Docs, version 1.52 -->
- <!-- http://www.naturaldocs.org -->
- <!-- saved from url=(0026)http://www.naturaldocs.org -->
- <div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="jsPlumb 1.3.6"></a>jsPlumb 1.3.6</h1><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#jsPlumb 1.3.6" >jsPlumb 1.3.6</a></td><td class=SDescription></td></tr><tr class="SGroup"><td class=SEntry><a href="#Properties_and_Functions" >Properties and Functions</a></td><td class=SDescription></td></tr><tr class="SProperty SIndent1 SMarked"><td class=SEntry><a href="#overlays" >overlays</a></td><td class=SDescription>List of Overlays for this component.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#addOverlay" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">addOverlay</a></td><td class=SDescription>Adds an Overlay to the Connection.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#getOverlay" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">getOverlay</a></td><td class=SDescription>Gets an overlay, by ID. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#hideOverlay" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">hideOverlay</a></td><td class=SDescription>Hides the overlay specified by the given id.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#showOverlay" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">showOverlay</a></td><td class=SDescription>Shows the overlay specified by the given id.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#removeAllOverlays" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">removeAllOverlays</a></td><td class=SDescription>Removes all overlays from the Connection, and then repaints.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#setLabel" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">setLabel</a></td><td class=SDescription>Sets the Connection’s label.</td></tr><tr class="SProperty SIndent1"><td class=SEntry><a href="#Defaults" >Defaults</a></td><td class=SDescription>These are the default settings for jsPlumb. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#importDefaults" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">importDefaults</a></td><td class=SDescription>Imports all the given defaults into this instance of jsPlumb.</td></tr><tr class="SProperty SIndent1"><td class=SEntry><a href="#connectorClass" >connectorClass</a></td><td class=SDescription>The CSS class to set on Connection elements. </td></tr><tr class="SProperty SIndent1 SMarked"><td class=SEntry><a href="#endpointClass" >endpointClass</a></td><td class=SDescription>The CSS class to set on Endpoint elements. </td></tr><tr class="SProperty SIndent1"><td class=SEntry><a href="#overlayClass" >overlayClass</a></td><td class=SDescription>The CSS class to set on an Overlay that is an HTML element. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#bind" >bind</a></td><td class=SDescription>Bind to an event on jsPlumb.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#clearListeners" >clearListeners</a></td><td class=SDescription>Clears either all listeners, or listeners for some specific event.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#addClass" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">addClass</a></td><td class=SDescription>Helper method to abstract out differences in setting css classes on the different renderer types.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#removeClass" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">removeClass</a></td><td class=SDescription>Helper method to abstract out differences in setting css classes on the different renderer types.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#hasClass" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">hasClass</a></td><td class=SDescription>Helper method to abstract out differences in testing for css classes on the different renderer types.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#addEndpoint" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">addEndpoint</a></td><td class=SDescription>Adds an <a href="#Endpoint" class=LClass id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')">Endpoint</a> to a given element or elements.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#addEndpoints" id=link13 onMouseOver="ShowTip(event, 'tt13', 'link13')" onMouseOut="HideTip('tt13')">addEndpoints</a></td><td class=SDescription>Adds a list of <a href="#Endpoint" class=LClass id=link14 onMouseOver="ShowTip(event, 'tt12', 'link14')" onMouseOut="HideTip('tt12')">Endpoint</a>s to a given element or elements.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#animate" id=link15 onMouseOver="ShowTip(event, 'tt14', 'link15')" onMouseOut="HideTip('tt14')">animate</a></td><td class=SDescription>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). </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#connect" id=link16 onMouseOver="ShowTip(event, 'tt15', 'link16')" onMouseOut="HideTip('tt15')">connect</a></td><td class=SDescription>Establishes a <a href="#Connection" class=LClass id=link17 onMouseOver="ShowTip(event, 'tt16', 'link17')" onMouseOut="HideTip('tt16')">Connection</a> between two elements (or <a href="#Endpoint" class=LClass id=link18 onMouseOver="ShowTip(event, 'tt12', 'link18')" onMouseOut="HideTip('tt12')">Endpoint</a>s, which are themselves registered to elements).</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#deleteEndpoint" id=link19 onMouseOver="ShowTip(event, 'tt17', 'link19')" onMouseOut="HideTip('tt17')">deleteEndpoint</a></td><td class=SDescription>Deletes an Endpoint and removes all Connections it has (which removes the Connections from the other Endpoints involved too)</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#deleteEveryEndpoint" id=link20 onMouseOver="ShowTip(event, 'tt18', 'link20')" onMouseOut="HideTip('tt18')">deleteEveryEndpoint</a></td><td class=SDescription>Deletes every <a href="#Endpoint" class=LClass id=link21 onMouseOver="ShowTip(event, 'tt12', 'link21')" onMouseOut="HideTip('tt12')">Endpoint</a>, and their associated <a href="#Connection" class=LClass id=link22 onMouseOver="ShowTip(event, 'tt16', 'link22')" onMouseOut="HideTip('tt16')">Connection</a>s, in this instance of jsPlumb. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#detach" id=link23 onMouseOver="ShowTip(event, 'tt19', 'link23')" onMouseOut="HideTip('tt19')">detach</a></td><td class=SDescription>Detaches and then removes a <a href="#Connection" class=LClass id=link24 onMouseOver="ShowTip(event, 'tt16', 'link24')" onMouseOut="HideTip('tt16')">Connection</a>. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#detachAllConnections" id=link25 onMouseOver="ShowTip(event, 'tt20', 'link25')" onMouseOut="HideTip('tt20')">detachAllConnections</a></td><td class=SDescription>Removes all an element’s Connections.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#detachEveryConnection" id=link26 onMouseOver="ShowTip(event, 'tt21', 'link26')" onMouseOut="HideTip('tt21')">detachEveryConnection</a></td><td class=SDescription>Remove all Connections from all elements, but leaves Endpoints in place.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#draggable" >draggable</a></td><td class=SDescription>Initialises the draggability of some element or elements. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#extend" id=link27 onMouseOver="ShowTip(event, 'tt22', 'link27')" onMouseOut="HideTip('tt22')">extend</a></td><td class=SDescription>Wraps the underlying library’s extend functionality.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#getDefaultEndpointType" id=link28 onMouseOver="ShowTip(event, 'tt23', 'link28')" onMouseOut="HideTip('tt23')">getDefaultEndpointType</a></td><td class=SDescription>Returns the default Endpoint type. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#getDefaultConnectionType" id=link29 onMouseOver="ShowTip(event, 'tt24', 'link29')" onMouseOut="HideTip('tt24')">getDefaultConnectionType</a></td><td class=SDescription>Returns the default Connection type. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#getConnections" id=link30 onMouseOver="ShowTip(event, 'tt25', 'link30')" onMouseOut="HideTip('tt25')">getConnections</a></td><td class=SDescription>Gets all or a subset of connections currently managed by this jsPlumb instance. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#getAllConnections" id=link31 onMouseOver="ShowTip(event, 'tt26', 'link31')" onMouseOut="HideTip('tt26')">getAllConnections</a></td><td class=SDescription>Gets all connections, as a map of { scope -> [ connection... </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#getDefaultScope" id=link32 onMouseOver="ShowTip(event, 'tt27', 'link32')" onMouseOut="HideTip('tt27')">getDefaultScope</a></td><td class=SDescription>Gets the default scope for connections and endpoints. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#getEndpoint" >getEndpoint</a></td><td class=SDescription>Gets an Endpoint by UUID</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#hide" id=link33 onMouseOver="ShowTip(event, 'tt28', 'link33')" onMouseOut="HideTip('tt28')">hide</a></td><td class=SDescription>Sets an element’s connections to be hidden.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#makeTarget" >makeTarget</a></td><td class=SDescription>Makes some DOM element a Connection target, allowing you to drag connections to it without having to register any Endpoints on it first. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#makeSource" >makeSource</a></td><td class=SDescription>Makes some DOM element a Connection source, allowing you to drag connections from it without having to register any Endpoints on it first. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#ready" id=link34 onMouseOver="ShowTip(event, 'tt29', 'link34')" onMouseOut="HideTip('tt29')">ready</a></td><td class=SDescription>Helper method to bind a function to jsPlumb’s ready event.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#repaint" id=link35 onMouseOver="ShowTip(event, 'tt30', 'link35')" onMouseOut="HideTip('tt30')">repaint</a></td><td class=SDescription>Repaints an element and its connections. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#repaintEverything" id=link36 onMouseOver="ShowTip(event, 'tt31', 'link36')" onMouseOut="HideTip('tt31')">repaintEverything</a></td><td class=SDescription>Repaints all connections.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#removeAllEndpoints" id=link37 onMouseOver="ShowTip(event, 'tt32', 'link37')" onMouseOut="HideTip('tt32')">removeAllEndpoints</a></td><td class=SDescription>Removes all Endpoints associated with a given element. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#setAutomaticRepaint" id=link38 onMouseOver="ShowTip(event, 'tt33', 'link38')" onMouseOut="HideTip('tt33')">setAutomaticRepaint</a></td><td class=SDescription>Sets/unsets automatic repaint on window resize.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#setDefaultScope" id=link39 onMouseOver="ShowTip(event, 'tt34', 'link39')" onMouseOut="HideTip('tt34')">setDefaultScope</a></td><td class=SDescription>Sets the default scope for Connections and Endpoints. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#setDraggable" id=link40 onMouseOver="ShowTip(event, 'tt35', 'link40')" onMouseOut="HideTip('tt35')">setDraggable</a></td><td class=SDescription>Sets whether or not a given element is draggable, regardless of what any jsPlumb command may request.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#setRepaintFunction" id=link41 onMouseOver="ShowTip(event, 'tt36', 'link41')" onMouseOut="HideTip('tt36')">setRepaintFunction</a></td><td class=SDescription>Sets the function to fire when the window size has changed and a repaint was fired.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#setSuspendDrawing" >setSuspendDrawing</a></td><td class=SDescription>Suspends drawing operations. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#setRenderMode" id=link42 onMouseOver="ShowTip(event, 'tt37', 'link42')" onMouseOut="HideTip('tt37')">setRenderMode</a></td><td class=SDescription>Sets render mode: jsPlumb.CANVAS, jsPlumb.SVG or jsPlumb.VML. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#show" id=link43 onMouseOver="ShowTip(event, 'tt38', 'link43')" onMouseOut="HideTip('tt38')">show</a></td><td class=SDescription>Sets an element’s connections to be visible.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#sizeCanvas" id=link44 onMouseOver="ShowTip(event, 'tt39', 'link44')" onMouseOut="HideTip('tt39')">sizeCanvas</a></td><td class=SDescription>Helper to size a canvas. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#toggleVisible" >toggleVisible</a></td><td class=SDescription>Toggles visibility of an element’s Connections.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#toggleDraggable" >toggleDraggable</a></td><td class=SDescription>Toggles draggability (sic?)</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#unload" id=link45 onMouseOver="ShowTip(event, 'tt40', 'link45')" onMouseOut="HideTip('tt40')">unload</a></td><td class=SDescription>Unloads jsPlumb, deleting all storage. </td></tr><tr class="SClass"><td class=SEntry><a href="#Connection" >Connection</a></td><td class=SDescription>The connecting line between two Endpoints.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Connection.Functions_and_Properties" >Functions and Properties</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Connection.Connection" id=link46 onMouseOver="ShowTip(event, 'tt41', 'link46')" onMouseOut="HideTip('tt41')">Connection</a></td><td class=SDescription>Connection constructor.</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#Connection.sourceId" >sourceId</a></td><td class=SDescription>Id of the source element in the connection.</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#Connection.targetId" >targetId</a></td><td class=SDescription>Id of the target element in the connection.</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#Connection.scope" >scope</a></td><td class=SDescription>Optional scope descriptor for the connection.</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#Connection.endpoints" >endpoints</a></td><td class=SDescription>Array of [source, target] Endpoint objects.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#Connection.isDetachable" id=link47 onMouseOver="ShowTip(event, 'tt42', 'link47')" onMouseOut="HideTip('tt42')">isDetachable</a></td><td class=SDescription>Returns whether or not this connection can be detached from its target/source endpoint. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Connection.setDetachable" id=link48 onMouseOver="ShowTip(event, 'tt43', 'link48')" onMouseOut="HideTip('tt43')">setDetachable</a></td><td class=SDescription>Sets whether or not this connection is detachable.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#Connection.setConnector" id=link49 onMouseOver="ShowTip(event, 'tt44', 'link49')" onMouseOut="HideTip('tt44')">setConnector</a></td><td class=SDescription></td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#Connection.connector" >connector</a></td><td class=SDescription>The underlying Connector for this Connection (eg. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#Connection.bind" >bind</a></td><td class=SDescription>Bind to an event on the Connection.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Connection.setPaintStyle" >setPaintStyle</a></td><td class=SDescription>Sets the Connection’s paint style and then repaints the Connection.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#Connection.setHoverPaintStyle" >setHoverPaintStyle</a></td><td class=SDescription>Sets the paint style to use when the mouse is hovering over the Connection. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Connection.setHover" >setHover</a></td><td class=SDescription>Sets/unsets the hover state of this Connection.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#Connection.repaint" id=link50 onMouseOver="ShowTip(event, 'tt45', 'link50')" onMouseOut="HideTip('tt45')">repaint</a></td><td class=SDescription>Repaints the Connection.</td></tr><tr class="SClass"><td class=SEntry><a href="#Endpoint" >Endpoint</a></td><td class=SDescription>Models an endpoint. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Endpoint.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Endpoint.Endpoint" id=link51 onMouseOver="ShowTip(event, 'tt46', 'link51')" onMouseOut="HideTip('tt46')">Endpoint</a></td><td class=SDescription>Endpoint constructor.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#Endpoint.bind" >bind</a></td><td class=SDescription>Bind to an event on the Endpoint.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Endpoint.setPaintStyle" >setPaintStyle</a></td><td class=SDescription>Sets the Endpoint’s paint style and then repaints the Endpoint.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#Endpoint.setHoverPaintStyle" >setHoverPaintStyle</a></td><td class=SDescription>Sets the paint style to use when the mouse is hovering over the Endpoint. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Endpoint.setHover" >setHover</a></td><td class=SDescription>Sets/unsets the hover state of this Endpoint.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#Endpoint.isVisible" id=link52 onMouseOver="ShowTip(event, 'tt47', 'link52')" onMouseOut="HideTip('tt47')">isVisible</a></td><td class=SDescription>Returns whether or not the Endpoint is currently visible.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Endpoint.setVisible" id=link53 onMouseOver="ShowTip(event, 'tt48', 'link53')" onMouseOut="HideTip('tt48')">setVisible</a></td><td class=SDescription>Sets whether or not the Endpoint is currently visible.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#Endpoint.isEnabled" id=link54 onMouseOver="ShowTip(event, 'tt49', 'link54')" onMouseOut="HideTip('tt49')">isEnabled</a></td><td class=SDescription>Returns whether or not the Endpoint is enabled for drag/drop connections.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Endpoint.setEnabled" id=link55 onMouseOver="ShowTip(event, 'tt50', 'link55')" onMouseOut="HideTip('tt50')">setEnabled</a></td><td class=SDescription>Sets whether or not the Endpoint is enabled for drag/drop connections.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Endpoint.Properties" >Properties</a></td><td class=SDescription></td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#Endpoint.canvas" >canvas</a></td><td class=SDescription>The Endpoint’s Canvas.</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#Endpoint.connections" >connections</a></td><td class=SDescription>List of Connections this Endpoint is attached to.</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#Endpoint.scope" >scope</a></td><td class=SDescription>Scope descriptor for this Endpoint.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Endpoint.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Endpoint.addConnection" id=link56 onMouseOver="ShowTip(event, 'tt51', 'link56')" onMouseOut="HideTip('tt51')">addConnection</a></td><td class=SDescription>Adds a Connection to this Endpoint.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#Endpoint.detach" id=link57 onMouseOver="ShowTip(event, 'tt52', 'link57')" onMouseOut="HideTip('tt52')">detach</a></td><td class=SDescription>Detaches the given Connection from this Endpoint.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Endpoint.detachAll" id=link58 onMouseOver="ShowTip(event, 'tt53', 'link58')" onMouseOut="HideTip('tt53')">detachAll</a></td><td class=SDescription>Detaches all Connections this Endpoint has.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#Endpoint.detachFrom" id=link59 onMouseOver="ShowTip(event, 'tt54', 'link59')" onMouseOut="HideTip('tt54')">detachFrom</a></td><td class=SDescription>Removes any connections from this Endpoint that are connected to the given target endpoint.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Endpoint.detachFromConnection" id=link60 onMouseOver="ShowTip(event, 'tt55', 'link60')" onMouseOut="HideTip('tt55')">detachFromConnection</a></td><td class=SDescription>Detach this Endpoint from the Connection, but leave the Connection alive. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#Endpoint.getElement" id=link61 onMouseOver="ShowTip(event, 'tt56', 'link61')" onMouseOut="HideTip('tt56')">getElement</a></td><td class=SDescription>Returns the DOM element this Endpoint is attached to.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Endpoint.setElement" id=link62 onMouseOver="ShowTip(event, 'tt57', 'link62')" onMouseOut="HideTip('tt57')">setElement</a></td><td class=SDescription>Sets the DOM element this Endpoint is attached to.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#Endpoint.getUuid" id=link63 onMouseOver="ShowTip(event, 'tt58', 'link63')" onMouseOut="HideTip('tt58')">getUuid</a></td><td class=SDescription>Returns the UUID for this Endpoint, if there is one. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Endpoint.isConnectedTo" id=link64 onMouseOver="ShowTip(event, 'tt59', 'link64')" onMouseOut="HideTip('tt59')">isConnectedTo</a></td><td class=SDescription>Returns whether or not this endpoint is connected to the given Endpoint.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#Endpoint.isFull" id=link65 onMouseOver="ShowTip(event, 'tt60', 'link65')" onMouseOut="HideTip('tt60')">isFull</a></td><td class=SDescription>Returns whether or not the Endpoint can accept any more Connections.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Endpoint.setDragAllowedWhenFull" id=link66 onMouseOver="ShowTip(event, 'tt61', 'link66')" onMouseOut="HideTip('tt61')">setDragAllowedWhenFull</a></td><td class=SDescription>Sets whether or not connections can be dragged from this Endpoint once it is full. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#Endpoint.setStyle" >setStyle</a></td><td class=SDescription>Sets the paint style of the Endpoint. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Endpoint.paint" id=link67 onMouseOver="ShowTip(event, 'tt62', 'link67')" onMouseOut="HideTip('tt62')">paint</a></td><td class=SDescription>Paints the Endpoint, recalculating offset and anchor positions if necessary. </td></tr><tr class="SClass"><td class=SEntry><a href="#Connectors.Straight" >Connectors.Straight</a></td><td class=SDescription>The Straight connector draws a simple straight line between the two anchor points. </td></tr><tr class="SClass"><td class=SEntry><a href="#Connectors.Flowchart" >Connectors.Flowchart</a></td><td class=SDescription>Provides ‘flowchart’ connectors, consisting of vertical and horizontal line segments.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Connectors.Flowchart.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Connectors.Flowchart.Constructor" >Constructor</a></td><td class=SDescription></td></tr><tr class="SClass"><td class=SEntry><a href="#Endpoints.Dot" >Endpoints.Dot</a></td><td class=SDescription>A round endpoint, with default radius 10 pixels.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Endpoints.Dot.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Endpoints.Dot.Constructor" >Constructor</a></td><td class=SDescription></td></tr><tr class="SClass"><td class=SEntry><a href="#Endpoints.Rectangle" >Endpoints.Rectangle</a></td><td class=SDescription>A Rectangular Endpoint, with default size 20x20.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Endpoints.Rectangle.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Endpoints.Rectangle.Constructor" >Constructor</a></td><td class=SDescription></td></tr><tr class="SClass"><td class=SEntry><a href="#Endpoints.Image" >Endpoints.Image</a></td><td class=SDescription>Draws an image as the Endpoint.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Endpoints.Image.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Endpoints.Image.Constructor" >Constructor</a></td><td class=SDescription></td></tr><tr class="SClass"><td class=SEntry><a href="#Endpoints.Blank" >Endpoints.Blank</a></td><td class=SDescription>An Endpoint that paints nothing (visible) on the screen. </td></tr><tr class="SClass"><td class=SEntry><a href="#Endpoints.Triangle" >Endpoints.Triangle</a></td><td class=SDescription>A triangular Endpoint.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Endpoints.Triangle.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Endpoints.Triangle.Constructor" >Constructor</a></td><td class=SDescription></td></tr><tr class="SClass"><td class=SEntry><a href="#Overlays.Arrow" >Overlays.Arrow</a></td><td class=SDescription>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. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Overlays.Arrow.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Overlays.Arrow.Constructor" >Constructor</a></td><td class=SDescription></td></tr><tr class="SClass"><td class=SEntry><a href="#Overlays.PlainArrow" >Overlays.PlainArrow</a></td><td class=SDescription>A basic arrow. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Overlays.PlainArrow.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Overlays.PlainArrow.Constructor" >Constructor</a></td><td class=SDescription>See <a href="#Overlays.Arrow" class=LClass id=link68 onMouseOver="ShowTip(event, 'tt63', 'link68')" onMouseOut="HideTip('tt63')">Overlays.Arrow</a> for allowed parameters for this overlay.</td></tr><tr class="SClass"><td class=SEntry><a href="#Overlays.Diamond" >Overlays.Diamond</a></td><td class=SDescription>A diamond. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Overlays.Diamond.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Overlays.Diamond.Constructor" >Constructor</a></td><td class=SDescription>See <a href="#Overlays.Arrow" class=LClass id=link69 onMouseOver="ShowTip(event, 'tt63', 'link69')" onMouseOut="HideTip('tt63')">Overlays.Arrow</a> for allowed parameters for this overlay.</td></tr><tr class="SClass"><td class=SEntry><a href="#Overlays.Label" >Overlays.Label</a></td><td class=SDescription>A Label overlay. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Overlays.Label.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Overlays.Label.Constructor" >Constructor</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#Overlays.Label.setLabel" id=link70 onMouseOver="ShowTip(event, 'tt64', 'link70')" onMouseOut="HideTip('tt64')">setLabel</a></td><td class=SDescription>sets the label’s, um, label. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Overlays.Label.StateMachine_constructor" >StateMachine constructor</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
- <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Properties_and_Functions"></a>Properties and Functions</h3></div></div>
- <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="overlays"></a>overlays</h3><div class=CBody><p>List of Overlays for this component.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="addOverlay"></a>addOverlay</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.addOverlay = function(</td><td class="PParameter prettyprint " nowrap>overlay</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds an Overlay to the Connection.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>overlay</td><td class=CDLDescription>Overlay to add.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="getOverlay"></a>getOverlay</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.getOverlay = function(</td><td class="PParameter prettyprint " nowrap>id</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Gets an overlay, by ID. Note: by ID. You would pass an ‘id’ parameter in to the Overlay’s constructor arguments, and then use that to retrieve it via this method.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="hideOverlay"></a>hideOverlay</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.hideOverlay = function(</td><td class="PParameter prettyprint " nowrap>id</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Hides the overlay specified by the given id.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="showOverlay"></a>showOverlay</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.showOverlay = function(</td><td class="PParameter prettyprint " nowrap>id</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Shows the overlay specified by the given id.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="removeAllOverlays"></a>removeAllOverlays</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.removeAllOverlays = function()</td></tr></table></blockquote><p>Removes all overlays from the Connection, and then repaints.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="setLabel"></a>setLabel</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setLabel = function(</td><td class="PParameter prettyprint " nowrap>l</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the Connection’s label.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>l</td><td class=CDLDescription>label to set. May be a String, a Function that returns a String, or a params object containing { “label”, “labelStyle”, “location”, “cssClass” }</td></tr></table></div></div></div>
- <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="Defaults"></a>Defaults</h3><div class=CBody><p>These are the default settings for jsPlumb. They are what will be used if you do not supply specific pieces of information to the various API calls. A convenient way to implement your own look and feel can be to override these defaults by including a script somewhere after the jsPlumb include, but before you make any calls to jsPlumb.</p><h4 class=CHeading>Properties</h4><ul><li><b>Anchor</b> The default anchor to use for all connections (both source and target). Default is “BottomCenter”.</li><li><b>Anchors</b> The default anchors to use ([source, target]) for all connections. Defaults are [“BottomCenter”, “BottomCenter”].</li><li><b>ConnectionsDetachable</b> Whether or not connections are detachable by default (using the mouse). Defults to true.</li><li><b>ConnectionOverlays</b> The default overlay definitions for Connections. Defaults to an empty list.</li><li><b>Connector</b> The default connector definition to use for all connections. Default is “Bezier”.</li><li><b>Container</b> Optional selector or element id that instructs jsPlumb to append elements it creates to a specific element.</li><li><b>DragOptions</b> The default drag options to pass in to connect, makeTarget and addEndpoint calls. Default is empty.</li><li><b>DropOptions</b> The default drop options to pass in to connect, makeTarget and addEndpoint calls. Default is empty.</li><li><b>Endpoint</b> The default endpoint definition to use for all connections (both source and target). Default is “Dot”.</li><li><b>EndpointOverlays</b> The default overlay definitions for Endpoints. Defaults to an empty list.</li><li><b>Endpoints</b> The default endpoint definitions ([ source, target ]) to use for all connections. Defaults are [“Dot”, “Dot”].</li><li><b>EndpointStyle</b> The default style definition to use for all endpoints. Default is fillStyle:”#456”.</li><li><b>EndpointStyles</b> The default style definitions ([ source, target ]) to use for all endpoints. Defaults are empty.</li><li><b>EndpointHoverStyle</b> The default hover style definition to use for all endpoints. Default is null.</li><li><b>EndpointHoverStyles</b> The default hover style definitions ([ source, target ]) to use for all endpoints. Defaults are null.</li><li><b>HoverPaintStyle</b> The default hover style definition to use for all connections. Defaults are null.</li><li><b>LabelStyle</b> The default style to use for label overlays on connections.</li><li><b>LogEnabled</b> Whether or not the jsPlumb log is enabled. defaults to false.</li><li><b>Overlays</b> The default overlay definitions (for both Connections and Endpoint). Defaults to an empty list.</li><li><b>MaxConnections</b> The default maximum number of connections for an Endpoint. Defaults to 1.</li><li><b>PaintStyle</b> The default paint style for a connection. Default is line width of 8 pixels, with color “#456”.</li><li><b>RenderMode</b> What mode to use to paint with. If you’re on IE<9, you don’t really get to choose this. You’ll just get VML. Otherwise, the jsPlumb default is to use SVG.</li><li><b>Scope</b> The default “scope” to use for connections. Scope lets you assign connections to different categories.</li></ul></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="importDefaults"></a>importDefaults</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>_currentInstance.importDefaults = function(</td><td class="PParameter prettyprint " nowrap>d</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Imports all the given defaults into this instance of jsPlumb.</p></div></div></div>
- <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="connectorClass"></a>connectorClass</h3><div class=CBody><p>The CSS class to set on Connection elements. This value is a String and can have multiple classes; the entire String is appended as-is.</p></div></div></div>
- <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="endpointClass"></a>endpointClass</h3><div class=CBody><p>The CSS class to set on Endpoint elements. This value is a String and can have multiple classes; the entire String is appended as-is.</p></div></div></div>
- <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="overlayClass"></a>overlayClass</h3><div class=CBody><p>The CSS class to set on an Overlay that is an HTML element. This value is a String and can have multiple classes; the entire String is appended as-is.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="bind"></a>bind</h3><div class=CBody><p>Bind to an event on jsPlumb.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>event</td><td class=CDLDescription>the event to bind. Available events on jsPlumb are:</td></tr></table><ul><li><b>jsPlumbConnection</b> : notification that a new Connection was established. jsPlumb passes the new Connection to the callback.</li><li><b>jsPlumbConnectionDetached</b> : notification that a Connection was detached. jsPlumb passes the detached Connection to the callback.</li><li><b>click</b> : notification that a Connection was clicked. jsPlumb passes the Connection that was clicked to the callback.</li><li><b>dblclick</b> : notification that a Connection was double clicked. jsPlumb passes the Connection that was double clicked to the callback.</li><li><b>endpointClick</b> : notification that an Endpoint was clicked. jsPlumb passes the Endpoint that was clicked to the callback.</li><li><b>endpointDblClick</b> : notification that an Endpoint was double clicked. jsPlumb passes the Endpoint that was double clicked to the callback.</li></ul><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>callback</td><td class=CDLDescription>function to callback. This function will be passed the Connection/Endpoint that caused the event, and also the original event.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="clearListeners"></a>clearListeners</h3><div class=CBody><p>Clears either all listeners, or listeners for some specific event.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>event</td><td class=CDLDescription>optional. constrains the clear to just listeners for this event.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="addClass"></a>addClass</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.addClass = function(</td><td class="PParameter prettyprint " nowrap>el,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>clazz</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Helper method to abstract out differences in setting css classes on the different renderer types.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="removeClass"></a>removeClass</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.removeClass = function(</td><td class="PParameter prettyprint " nowrap>el,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>clazz</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Helper method to abstract out differences in setting css classes on the different renderer types.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="hasClass"></a>hasClass</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.hasClass = function(</td><td class="PParameter prettyprint " nowrap>el,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>clazz</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Helper method to abstract out differences in testing for css classes on the different renderer types.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="addEndpoint"></a>addEndpoint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.addEndpoint = function(</td><td class="PParameter prettyprint " nowrap>el,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>params,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>referenceParams</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds an <a href="#Endpoint" class=LClass id=link71 onMouseOver="ShowTip(event, 'tt12', 'link71')" onMouseOut="HideTip('tt12')">Endpoint</a> to a given element or elements.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>el</td><td class=CDLDescription>Element to add the endpoint to. Either an element id, a selector representing some element(s), or an array of either of these.</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription>Object containing Endpoint constructor arguments. For more information, see <a href="#Endpoint" class=LClass id=link72 onMouseOver="ShowTip(event, 'tt12', 'link72')" onMouseOut="HideTip('tt12')">Endpoint</a>.</td></tr><tr><td class=CDLEntry>referenceParams</td><td class=CDLDescription>Object containing more Endpoint constructor arguments; it will be merged with params by jsPlumb. You would use this if you had some shared parameters that you wanted to reuse when you added Endpoints to a number of elements. The allowed values in this object are anything that ‘params’ can contain. See <a href="#Endpoint" class=LClass id=link73 onMouseOver="ShowTip(event, 'tt12', 'link73')" onMouseOut="HideTip('tt12')">Endpoint</a>.</td></tr></table><h4 class=CHeading>Returns</h4><p>The newly created <a href="#Endpoint" class=LClass id=link74 onMouseOver="ShowTip(event, 'tt12', 'link74')" onMouseOut="HideTip('tt12')">Endpoint</a>, if el referred to a single element. Otherwise, an array of newly created <a href="#Endpoint" class=LClass id=link75 onMouseOver="ShowTip(event, 'tt12', 'link75')" onMouseOut="HideTip('tt12')">Endpoint</a>s.</p><h4 class=CHeading>See Also</h4><p><a href="#addEndpoints" class=LFunction id=link76 onMouseOver="ShowTip(event, 'tt13', 'link76')" onMouseOut="HideTip('tt13')">addEndpoints</a></p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="addEndpoints"></a>addEndpoints</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.addEndpoints = function(</td><td class="PParameter prettyprint " nowrap>el,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>endpoints,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>referenceParams</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds a list of <a href="#Endpoint" class=LClass id=link77 onMouseOver="ShowTip(event, 'tt12', 'link77')" onMouseOut="HideTip('tt12')">Endpoint</a>s to a given element or elements.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>target</td><td class=CDLDescription>element to add the Endpoint to. Either an element id, a selector representing some element(s), or an array of either of these.</td></tr><tr><td class=CDLEntry>endpoints</td><td class=CDLDescription>List of objects containing Endpoint constructor arguments. one Endpoint is created for each entry in this list. See <a href="#Endpoint" class=LClass id=link78 onMouseOver="ShowTip(event, 'tt12', 'link78')" onMouseOut="HideTip('tt12')">Endpoint</a>’s constructor documentation.</td></tr><tr><td class=CDLEntry>referenceParams</td><td class=CDLDescription>Object containing more Endpoint constructor arguments; it will be merged with params by jsPlumb. You would use this if you had some shared parameters that you wanted to reuse when you added Endpoints to a number of elements.</td></tr></table><h4 class=CHeading>Returns</h4><p>List of newly created <a href="#Endpoint" class=LClass id=link79 onMouseOver="ShowTip(event, 'tt12', 'link79')" onMouseOut="HideTip('tt12')">Endpoint</a>s, one for each entry in the ‘endpoints’ argument.</p><h4 class=CHeading>See Also</h4><p><a href="#addEndpoint" class=LFunction id=link80 onMouseOver="ShowTip(event, 'tt11', 'link80')" onMouseOut="HideTip('tt11')">addEndpoint</a></p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="animate"></a>animate</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.animate = function(</td><td class="PParameter prettyprint " nowrap>el,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>properties,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>options</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>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). This only supports the two-arg version of the animate call in jQuery, the one that takes an ‘options’ object as the second arg. MooTools has only one method, a two arg one. Which is handy. YUI has a one-arg method, so jsPlumb merges ‘properties’ and ‘options’ together for YUI.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>el</td><td class=CDLDescription>Element to animate. Either an id, or a selector representing the element.</td></tr><tr><td class=CDLEntry>properties</td><td class=CDLDescription>The ‘properties’ argument you want passed to the library’s animate call.</td></tr><tr><td class=CDLEntry>options</td><td class=CDLDescription>The ‘options’ argument you want passed to the library’s animate call.</td></tr></table><h4 class=CHeading>Returns</h4><p>void</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="connect"></a>connect</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.connect = function(</td><td class="PParameter prettyprint " nowrap>params,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>referenceParams</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Establishes a <a href="#Connection" class=LClass id=link81 onMouseOver="ShowTip(event, 'tt16', 'link81')" onMouseOut="HideTip('tt16')">Connection</a> between two elements (or <a href="#Endpoint" class=LClass id=link82 onMouseOver="ShowTip(event, 'tt12', 'link82')" onMouseOut="HideTip('tt12')">Endpoint</a>s, which are themselves registered to elements).</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>params</td><td class=CDLDescription>Object containing constructor arguments for the Connection. See <a href="#Connection" class=LClass id=link83 onMouseOver="ShowTip(event, 'tt16', 'link83')" onMouseOut="HideTip('tt16')">Connection</a>’s constructor documentation.</td></tr><tr><td class=CDLEntry>referenceParams</td><td class=CDLDescription>Optional object containing more constructor arguments for the Connection. Typically you would pass in data that a lot of Connections are sharing here, such as connector style etc, and then use the main params for data specific to this Connection.</td></tr></table><h4 class=CHeading>Returns</h4><p>The newly created <a href="#Connection" class=LClass id=link84 onMouseOver="ShowTip(event, 'tt16', 'link84')" onMouseOut="HideTip('tt16')">Connection</a>.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="deleteEndpoint"></a>deleteEndpoint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.deleteEndpoint = function(</td><td class="PParameter prettyprint " nowrap>object</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Deletes an Endpoint and removes all Connections it has (which removes the Connections from the other Endpoints involved too)</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>object</td><td class=CDLDescription>either an <a href="#Endpoint" class=LClass id=link85 onMouseOver="ShowTip(event, 'tt12', 'link85')" onMouseOut="HideTip('tt12')">Endpoint</a> object (such as from an addEndpoint call), or a String UUID.</td></tr></table><h4 class=CHeading>Returns</h4><p>void</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="deleteEveryEndpoint"></a>deleteEveryEndpoint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.deleteEveryEndpoint = function()</td></tr></table></blockquote><p>Deletes every <a href="#Endpoint" class=LClass id=link86 onMouseOver="ShowTip(event, 'tt12', 'link86')" onMouseOut="HideTip('tt12')">Endpoint</a>, and their associated <a href="#Connection" class=LClass id=link87 onMouseOver="ShowTip(event, 'tt16', 'link87')" onMouseOut="HideTip('tt16')">Connection</a>s, in this instance of jsPlumb. Does not unregister any event listeners (this is the only difference between this method and jsPlumb.reset).</p><h4 class=CHeading>Returns</h4><p>void</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="detach"></a>detach</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.detach = function()</td></tr></table></blockquote><p>Detaches and then removes a <a href="#Connection" class=LClass id=link88 onMouseOver="ShowTip(event, 'tt16', 'link88')" onMouseOut="HideTip('tt16')">Connection</a>. From 1.3.5 this method has been altered to remove support for specifying Connections by various parameters; you can now pass in a Connection as the first argument and an optional parameters object as a second argument. If you need the functionality this method provided before 1.3.5 then you should use the getConnections method to get the list of Connections to detach, and then iterate through them, calling this for each one.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>connection</td><td class=CDLDescription>the <a href="#Connection" class=LClass id=link89 onMouseOver="ShowTip(event, 'tt16', 'link89')" onMouseOut="HideTip('tt16')">Connection</a> to detach</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription>optional parameters to the detach call. valid values here are fireEvent : defaults to false; indicates you want jsPlumb to fire a connection detached event. The thinking behind this is that if you made a programmatic call to detach an event, you probably don’t need the callback. forceDetach : defaults to false. allows you to override any beforeDetach listeners that may be registered.</td></tr></table><h4 class=CHeading>Returns</h4><p>true if successful, false if not.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="detachAllConnections"></a>detachAllConnections</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.detachAllConnections = function(</td><td class="PParameter prettyprint " nowrap>el,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>params</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Removes all an element’s Connections.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>el</td><td class=CDLDescription>either the id of the element, or a selector for the element.</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription>optional parameters. alowed values: fireEvent : defaults to true, whether or not to fire the detach event.</td></tr></table><h4 class=CHeading>Returns</h4><p>void</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="detachEveryConnection"></a>detachEveryConnection</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.detachEveryConnection = function(</td><td class="PParameter prettyprint " nowrap>params</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Remove all Connections from all elements, but leaves Endpoints in place.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>params</td><td class=CDLDescription>optional params object containing: fireEvent : whether or not to fire detach events. defaults to true.</td></tr></table><h4 class=CHeading>Returns</h4><p>void</p><h4 class=CHeading>See Also</h4><p><removeEveryEndpoint></p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="draggable"></a>draggable</h3><div class=CBody><p>Initialises the draggability of some element or elements. You should use this instead of y our library’s draggable method so that jsPlumb can setup the appropriate callbacks. Your underlying library’s drag method is always called from this method.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>el</td><td class=CDLDescription>either an element id, a list of element ids, or a selector.</td></tr><tr><td class=CDLEntry>options</td><td class=CDLDescription>options to pass through to the underlying library</td></tr></table><h4 class=CHeading>Returns</h4><p>void</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="extend"></a>extend</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.extend = function(</td><td class="PParameter prettyprint " nowrap>o1,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>o2</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Wraps the underlying library’s extend functionality.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>o1</td><td class=CDLDescription>object to extend</td></tr><tr><td class=CDLEntry>o2</td><td class=CDLDescription>object to extend o1 with</td></tr></table><h4 class=CHeading>Returns</h4><p>o1, extended with all properties from o2.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="getDefaultEndpointType"></a>getDefaultEndpointType</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.getDefaultEndpointType = function()</td></tr></table></blockquote><p>Returns the default Endpoint type. Used when someone wants to subclass Endpoint and have jsPlumb return instances of their subclass. you would make a call like this in your class’s constructor: jsPlumb.getDefaultEndpointType().apply(this, arguments);</p><h4 class=CHeading>Returns</h4><p>the default Endpoint function used by jsPlumb.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="getDefaultConnectionType"></a>getDefaultConnectionType</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.getDefaultConnectionType = function()</td></tr></table></blockquote><p>Returns the default Connection type. Used when someone wants to subclass Connection and have jsPlumb return instances of their subclass. you would make a call like this in your class’s constructor: jsPlumb.getDefaultConnectionType().apply(this, arguments);</p><h4 class=CHeading>Returns</h4><p>the default Connection function used by jsPlumb.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="getConnections"></a>getConnections</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.getConnections = function(</td><td class="PParameter prettyprint " nowrap>options</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Gets all or a subset of connections currently managed by this jsPlumb instance. If only one scope is passed in to this method, the result will be a list of connections having that scope (passing in no scope at all will result in jsPlumb assuming you want the default scope). If multiple scopes are passed in, the return value will be a map of { scope -> [ connection... ] }.</p><p>Parameters scope - if the only argument to getConnections is a string, jsPlumb will treat that string as a scope filter, and return a list of connections that are in the given scope. options - if the argument is a JS object, you can specify a finer-grained filter:</p><ul><li><b>scope</b> may be a string specifying a single scope, or an array of strings, specifying multiple scopes.</li><li><b>source</b> either a string representing an element id, or a selector. constrains the result to connections having this source.</li><li><b>target</b> either a string representing an element id, or a selector. constrains the result to connections having this target.</li></ul></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="getAllConnections"></a>getAllConnections</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.getAllConnections = function()</td></tr></table></blockquote><p>Gets all connections, as a map of { scope -> [ connection... ] }.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="getDefaultScope"></a>getDefaultScope</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.getDefaultScope = function()</td></tr></table></blockquote><p>Gets the default scope for connections and endpoints. a scope defines a type of endpoint/connection; supplying a scope to an endpoint or connection allows you to support different types of connections in the same UI. but if you’re only interested in one type of connection, you don’t need to supply a scope. this method will probably be used by very few people; it’s good for testing though.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="getEndpoint"></a>getEndpoint</h3><div class=CBody><p>Gets an Endpoint by UUID</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>uuid</td><td class=CDLDescription>the UUID for the Endpoint</td></tr></table><h4 class=CHeading>Returns</h4><p>Endpoint with the given UUID, null if nothing found.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="hide"></a>hide</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.hide = function(</td><td class="PParameter prettyprint " nowrap>el,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>changeEndpoints</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets an element’s connections to be hidden.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>el</td><td class=CDLDescription>either the id of the element, or a selector for the element.</td></tr><tr><td class=CDLEntry>changeEndpoints</td><td class=CDLDescription>whether not to also hide endpoints on the element. by default this is false.</td></tr></table><h4 class=CHeading>Returns</h4><p>void</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="makeTarget"></a>makeTarget</h3><div class=CBody><p>Makes some DOM element a Connection target, allowing you to drag connections to it without having to register any Endpoints on it first. When a Connection is established, the endpoint spec that was passed in to this method is used to create a suitable Endpoint (the default will be used if you do not provide one).</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>el</td><td class=CDLDescription>string id or element selector for the element to make a target.</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription>JS object containing parameters: endpoint optional. specification of an endpoint to create when a connection is created. scope optional. scope for the drop zone. dropOptions optional. same stuff as you would pass to dropOptions of an Endpoint definition. deleteEndpointsOnDetach optional, defaults to true. whether or not to delete any Endpoints created by a connection to this target if the connection is subsequently detached. this will not remove Endpoints that have had more Connections attached to them after they were created.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="makeSource"></a>makeSource</h3><div class=CBody><p>Makes some DOM element a Connection source, allowing you to drag connections from it without having to register any Endpoints on it first. When a Connection is established, the endpoint spec that was passed in to this method is used to create a suitable Endpoint (the default will be used if you do not provide one).</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>el</td><td class=CDLDescription>string id or element selector for the element to make a source.</td></tr><tr><td class=CDLEntry>params</td><td class=CDLDescription>JS object containing parameters: endpoint optional. specification of an endpoint to create when a connection is created. parent optional. the element to add Endpoints to when a Connection is established. if you omit this, Endpoints will be added to ‘el’. scope optional. scope for the connections dragged from this element. dragOptions optional. same stuff as you would pass to dragOptions of an Endpoint definition. deleteEndpointsOnDetach optional, defaults to false. whether or not to delete any Endpoints created by a connection from this source if the connection is subsequently detached. this will not remove Endpoints that have had more Connections attached to them after they were created.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="ready"></a>ready</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.ready = function(</td><td class="PParameter prettyprint " nowrap>fn</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Helper method to bind a function to jsPlumb’s ready event.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="repaint"></a>repaint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.repaint = function(</td><td class="PParameter prettyprint " nowrap>el</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Repaints an element and its connections. This method gets new sizes for the elements before painting anything.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>el</td><td class=CDLDescription>either the id of the element or a selector representing the element.</td></tr></table><h4 class=CHeading>Returns</h4><p>void</p><h4 class=CHeading>See Also</h4><p><a href="#repaintEverything" class=LFunction id=link90 onMouseOver="ShowTip(event, 'tt31', 'link90')" onMouseOut="HideTip('tt31')">repaintEverything</a></p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="repaintEverything"></a>repaintEverything</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.repaintEverything = function()</td></tr></table></blockquote><p>Repaints all connections.</p><h4 class=CHeading>Returns</h4><p>void</p><h4 class=CHeading>See Also</h4><p><a href="#repaint" class=LFunction id=link91 onMouseOver="ShowTip(event, 'tt30', 'link91')" onMouseOut="HideTip('tt30')">repaint</a></p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="removeAllEndpoints"></a>removeAllEndpoints</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.removeAllEndpoints = function(</td><td class="PParameter prettyprint " nowrap>el</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Removes all Endpoints associated with a given element. Also removes all Connections associated with each Endpoint it removes.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>el</td><td class=CDLDescription>either an element id, or a selector for an element.</td></tr></table><h4 class=CHeading>Returns</h4><p>void</p><h4 class=CHeading>See Also</h4><p><removeEndpoint></p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="setAutomaticRepaint"></a>setAutomaticRepaint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setAutomaticRepaint = function(</td><td class="PParameter prettyprint " nowrap>value</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets/unsets automatic repaint on window resize.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>value</td><td class=CDLDescription>whether or not to automatically repaint when the window is resized.</td></tr></table><p>Returns: void</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="setDefaultScope"></a>setDefaultScope</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setDefaultScope = function(</td><td class="PParameter prettyprint " nowrap>scope</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the default scope for Connections and Endpoints. A scope defines a type of Endpoint/Connection; supplying a scope to an Endpoint or Connection allows you to support different types of Connections in the same UI. If you’re only interested in one type of Connection, you don’t need to supply a scope. This method will probably be used by very few people; it just instructs jsPlumb to use a different key for the default scope.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>scope</td><td class=CDLDescription>scope to set as default.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="setDraggable"></a>setDraggable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setDraggable = _setDraggable; this.setDebugLog = function(</td><td class="PParameter prettyprint " nowrap>debugLog</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets whether or not a given element is draggable, regardless of what any jsPlumb command may request.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>el</td><td class=CDLDescription>either the id for the element, or a selector representing the element.</td></tr></table><h4 class=CHeading>Returns</h4><p>void</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="setRepaintFunction"></a>setRepaintFunction</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setRepaintFunction = function(</td><td class="PParameter prettyprint " nowrap>f</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the function to fire when the window size has changed and a repaint was fired.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>f</td><td class=CDLDescription>Function to execute.</td></tr></table><p>Returns: void</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="setSuspendDrawing"></a>setSuspendDrawing</h3><div class=CBody><p>Suspends drawing operations. This can be used when you have a lot of connections to make or endpoints to register; it will save you a lot of time.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="setRenderMode"></a>setRenderMode</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setRenderMode = function(</td><td class="PParameter prettyprint " nowrap>mode</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets render mode: jsPlumb.CANVAS, jsPlumb.SVG or jsPlumb.VML. jsPlumb will fall back to VML if it determines that what you asked for is not supported (and that VML is). If you asked for VML but the browser does not support it, jsPlumb uses SVG.</p><h4 class=CHeading>Returns</h4><p>the render mode that jsPlumb set, which of course may be different from that requested.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="show"></a>show</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.show = function(</td><td class="PParameter prettyprint " nowrap>el,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>changeEndpoints</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets an element’s connections to be visible.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>el</td><td class=CDLDescription>either the id of the element, or a selector for the element.</td></tr><tr><td class=CDLEntry>changeEndpoints</td><td class=CDLDescription>whether or not to also change the visible state of the endpoints on the element. this also has a bearing on other connections on those endpoints: if their other endpoint is also visible, the connections are made visible.</td></tr></table><h4 class=CHeading>Returns</h4><p>void</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="sizeCanvas"></a>sizeCanvas</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.sizeCanvas = function(</td><td class="PParameter prettyprint " nowrap>canvas,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>x,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>y,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>w,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>h</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Helper to size a canvas. You would typically use this when writing your own Connector or Endpoint implementation.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>x</td><td class=CDLDescription>[int] x position for the Canvas origin</td></tr><tr><td class=CDLEntry>y</td><td class=CDLDescription>[int] y position for the Canvas origin</td></tr><tr><td class=CDLEntry>w</td><td class=CDLDescription>[int] width of the canvas</td></tr><tr><td class=CDLEntry>h</td><td class=CDLDescription>[int] height of the canvas</td></tr></table><h4 class=CHeading>Returns</h4><p>void</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="toggleVisible"></a>toggleVisible</h3><div class=CBody><p>Toggles visibility of an element’s Connections.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>el</td><td class=CDLDescription>either the element’s id, or a selector representing the element.</td></tr><tr><td class=CDLEntry>changeEndpoints</td><td class=CDLDescription>whether or not to also toggle the endpoints on the element.</td></tr></table><h4 class=CHeading>Returns</h4><p>void, but should be updated to return the current state</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="toggleDraggable"></a>toggleDraggable</h3><div class=CBody><p>Toggles draggability (sic?) of an element’s Connections.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>el</td><td class=CDLDescription>either the element’s id, or a selector representing the element.</td></tr></table><h4 class=CHeading>Returns</h4><p>The current draggable state.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="unload"></a>unload</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.unload = function()</td></tr></table></blockquote><p>Unloads jsPlumb, deleting all storage. You should call this from an onunload attribute on the <body> element.</p><h4 class=CHeading>Returns</h4><p>void</p></div></div></div>
- <div class="CClass"><div class=CTopic><h2 class=CTitle><a name="Connection"></a>Connection</h2><div class=CBody><p>The connecting line between two Endpoints.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#Connection.Functions_and_Properties" >Functions and Properties</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Connection.Connection" id=link92 onMouseOver="ShowTip(event, 'tt41', 'link92')" onMouseOut="HideTip('tt41')">Connection</a></td><td class=SDescription>Connection constructor.</td></tr><tr class="SProperty SIndent1"><td class=SEntry><a href="#Connection.sourceId" >sourceId</a></td><td class=SDescription>Id of the source element in the connection.</td></tr><tr class="SProperty SIndent1 SMarked"><td class=SEntry><a href="#Connection.targetId" >targetId</a></td><td class=SDescription>Id of the target element in the connection.</td></tr><tr class="SProperty SIndent1"><td class=SEntry><a href="#Connection.scope" >scope</a></td><td class=SDescription>Optional scope descriptor for the connection.</td></tr><tr class="SProperty SIndent1 SMarked"><td class=SEntry><a href="#Connection.endpoints" >endpoints</a></td><td class=SDescription>Array of [source, target] Endpoint objects.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#Connection.isDetachable" id=link93 onMouseOver="ShowTip(event, 'tt42', 'link93')" onMouseOut="HideTip('tt42')">isDetachable</a></td><td class=SDescription>Returns whether or not this connection can be detached from its target/source endpoint. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Connection.setDetachable" id=link94 onMouseOver="ShowTip(event, 'tt43', 'link94')" onMouseOut="HideTip('tt43')">setDetachable</a></td><td class=SDescription>Sets whether or not this connection is detachable.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#Connection.setConnector" id=link95 onMouseOver="ShowTip(event, 'tt44', 'link95')" onMouseOut="HideTip('tt44')">setConnector</a></td><td class=SDescription></td></tr><tr class="SProperty SIndent1 SMarked"><td class=SEntry><a href="#Connection.connector" >connector</a></td><td class=SDescription>The underlying Connector for this Connection (eg. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#Connection.bind" >bind</a></td><td class=SDescription>Bind to an event on the Connection.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Connection.setPaintStyle" >setPaintStyle</a></td><td class=SDescription>Sets the Connection’s paint style and then repaints the Connection.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#Connection.setHoverPaintStyle" >setHoverPaintStyle</a></td><td class=SDescription>Sets the paint style to use when the mouse is hovering over the Connection. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Connection.setHover" >setHover</a></td><td class=SDescription>Sets/unsets the hover state of this Connection.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#Connection.repaint" id=link96 onMouseOver="ShowTip(event, 'tt45', 'link96')" onMouseOut="HideTip('tt45')">repaint</a></td><td class=SDescription>Repaints the Connection.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
- <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Connection.Functions_and_Properties"></a>Functions and Properties</h3></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Connection.Connection"></a>Connection</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>var Connection = function(</td><td class="PParameter prettyprint " nowrap>params</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Connection constructor.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>source</td><td class=CDLDescription>either an element id, a selector for an element, or an Endpoint.</td></tr><tr><td class=CDLEntry>target</td><td class=CDLDescription>either an element id, a selector for an element, or an Endpoint</td></tr><tr><td class=CDLEntry>scope</td><td class=CDLDescription>scope descriptor for this connection. optional.</td></tr><tr><td class=CDLEntry>container</td><td class=CDLDescription>optional id or selector instructing jsPlumb where to attach all the elements it creates for this connection. you should read the documentation for a full discussion of this.</td></tr><tr><td class=CDLEntry>endpoint</td><td class=CDLDescription>Optional. Endpoint definition to use for both ends of the connection.</td></tr><tr><td class=CDLEntry>endpoints</td><td class=CDLDescription>Optional. Array of two Endpoint definitions, one for each end of the Connection. This and ‘endpoint’ are mutually exclusive parameters.</td></tr><tr><td class=CDLEntry>endpointStyle</td><td class=CDLDescription>Optional. Endpoint style definition to use for both ends of the Connection.</td></tr><tr><td class=CDLEntry>endpointStyles</td><td class=CDLDescription>Optional. Array of two Endpoint style definitions, one for each end of the Connection. This and ‘endpoint’ are mutually exclusive parameters.</td></tr><tr><td class=CDLEntry>paintStyle</td><td class=CDLDescription>Parameters defining the appearance of the Connection. Optional; jsPlumb will use the defaults if you supply nothing here.</td></tr><tr><td class=CDLEntry>hoverPaintStyle</td><td class=CDLDescription>Parameters defining the appearance of the Connection when the mouse is hovering over it. Optional; jsPlumb will use the defaults if you supply nothing here (note that the default hoverPaintStyle is null).</td></tr><tr><td class=CDLEntry>overlays</td><td class=CDLDescription>Optional array of Overlay definitions to appear on this Connection.</td></tr><tr><td class=CDLEntry>drawEndpoints</td><td class=CDLDescription>if false, instructs jsPlumb to not draw the endpoints for this Connection. Be careful with this: it only really works when you tell jsPlumb to attach elements to the document body. Read the documentation for a full discussion of this.</td></tr></table></div></div></div>
- <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="Connection.sourceId"></a>sourceId</h3><div class=CBody><p>Id of the source element in the connection.</p></div></div></div>
- <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="Connection.targetId"></a>targetId</h3><div class=CBody><p>Id of the target element in the connection.</p></div></div></div>
- <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="Connection.scope"></a>scope</h3><div class=CBody><p>Optional scope descriptor for the connection.</p></div></div></div>
- <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="Connection.endpoints"></a>endpoints</h3><div class=CBody><p>Array of [source, target] Endpoint objects.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Connection.isDetachable"></a>isDetachable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.isDetachable = function()</td></tr></table></blockquote><p>Returns whether or not this connection can be detached from its target/source endpoint. by default this is false; use it in conjunction with the ‘reattach’ parameter.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Connection.setDetachable"></a>setDetachable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setDetachable = function(</td><td class="PParameter prettyprint " nowrap>detachable</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets whether or not this connection is detachable.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Connection.setConnector"></a>setConnector</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setConnector = function(</td><td class="PParameter prettyprint " nowrap>connector,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>doNotRepaint</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>Sets the Connection’s connector (eg “Bezier”, “Flowchart”, etc). You pass a Connector definition into this method</td><td class=CDLDescription>the same thing that you would set as the ‘connector’ property on a jsPlumb.connect call.</td></tr></table><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>connector</td><td class=CDLDescription>Connector definition</td></tr></table></div></div></div>
- <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="Connection.connector"></a>connector</h3><div class=CBody><p>The underlying Connector for this Connection (eg. a Bezier connector, straight line connector, flowchart connector etc)</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Connection.bind"></a>bind</h3><div class=CBody><p>Bind to an event on the Connection.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>event</td><td class=CDLDescription>the event to bind. Available events on a Connection are:</td></tr></table><ul><li><b>click</b> : notification that a Connection was clicked.</li><li><b>dblclick</b> : notification that a Connection was double clicked.</li><li><b>mouseenter</b> : notification that the mouse is over a Connection.</li><li><b>mouseexit</b> : notification that the mouse exited a Connection.</li></ul><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>callback</td><td class=CDLDescription>function to callback. This function will be passed the Connection that caused the event, and also the original event.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Connection.setPaintStyle"></a>setPaintStyle</h3><div class=CBody><p>Sets the Connection’s paint style and then repaints the Connection.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>style</td><td class=CDLDescription>Style to use.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Connection.setHoverPaintStyle"></a>setHoverPaintStyle</h3><div class=CBody><p>Sets the paint style to use when the mouse is hovering over the Connection. This is null by default. The hover paint style is applied as extensions to the paintStyle; it does not entirely replace it. This is because people will most likely want to change just one thing when hovering, say the color for example, but leave the rest of the appearance the same.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>style</td><td class=CDLDescription>Style to use when the mouse is hovering.</td></tr><tr><td class=CDLEntry>doNotRepaint</td><td class=CDLDescription>if true, the Connection will not be repainted. useful when setting things up initially.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Connection.setHover"></a>setHover</h3><div class=CBody><p>Sets/unsets the hover state of this Connection.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>hover</td><td class=CDLDescription>hover state boolean</td></tr><tr><td class=CDLEntry>ignoreAttachedElements</td><td class=CDLDescription>if true, does not notify any attached elements of the change in hover state. used mostly to avoid infinite loops.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Connection.repaint"></a>repaint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.repaint = function(</td><td class="PParameter prettyprint " nowrap>params</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Repaints the Connection.</p></div></div></div>
- <div class="CClass"><div class=CTopic><h2 class=CTitle><a name="Endpoint"></a>Endpoint</h2><div class=CBody><p>Models an endpoint. Can have 1 to ‘maxConnections’ Connections emanating from it (set maxConnections to -1 to allow unlimited). Typically, if you use ‘jsPlumb.connect’ to programmatically connect two elements, you won’t actually deal with the underlying Endpoint objects. But if you wish to support drag and drop Connections, one of the ways you do so is by creating and registering Endpoints using ‘jsPlumb.addEndpoint’, and marking these Endpoints as ‘source’ and/or ‘target’ Endpoints for Connections.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#Endpoint.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Endpoint.Endpoint" id=link97 onMouseOver="ShowTip(event, 'tt46', 'link97')" onMouseOut="HideTip('tt46')">Endpoint</a></td><td class=SDescription>Endpoint constructor.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#Endpoint.bind" >bind</a></td><td class=SDescription>Bind to an event on the Endpoint.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Endpoint.setPaintStyle" >setPaintStyle</a></td><td class=SDescription>Sets the Endpoint’s paint style and then repaints the Endpoint.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#Endpoint.setHoverPaintStyle" >setHoverPaintStyle</a></td><td class=SDescription>Sets the paint style to use when the mouse is hovering over the Endpoint. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Endpoint.setHover" >setHover</a></td><td class=SDescription>Sets/unsets the hover state of this Endpoint.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#Endpoint.isVisible" id=link98 onMouseOver="ShowTip(event, 'tt47', 'link98')" onMouseOut="HideTip('tt47')">isVisible</a></td><td class=SDescription>Returns whether or not the Endpoint is currently visible.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Endpoint.setVisible" id=link99 onMouseOver="ShowTip(event, 'tt48', 'link99')" onMouseOut="HideTip('tt48')">setVisible</a></td><td class=SDescription>Sets whether or not the Endpoint is currently visible.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#Endpoint.isEnabled" id=link100 onMouseOver="ShowTip(event, 'tt49', 'link100')" onMouseOut="HideTip('tt49')">isEnabled</a></td><td class=SDescription>Returns whether or not the Endpoint is enabled for drag/drop connections.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Endpoint.setEnabled" id=link101 onMouseOver="ShowTip(event, 'tt50', 'link101')" onMouseOut="HideTip('tt50')">setEnabled</a></td><td class=SDescription>Sets whether or not the Endpoint is enabled for drag/drop connections.</td></tr><tr class="SGroup"><td class=SEntry><a href="#Endpoint.Properties" >Properties</a></td><td class=SDescription></td></tr><tr class="SProperty SIndent1 SMarked"><td class=SEntry><a href="#Endpoint.canvas" >canvas</a></td><td class=SDescription>The Endpoint’s Canvas.</td></tr><tr class="SProperty SIndent1"><td class=SEntry><a href="#Endpoint.connections" >connections</a></td><td class=SDescription>List of Connections this Endpoint is attached to.</td></tr><tr class="SProperty SIndent1 SMarked"><td class=SEntry><a href="#Endpoint.scope" >scope</a></td><td class=SDescription>Scope descriptor for this Endpoint.</td></tr><tr class="SGroup"><td class=SEntry><a href="#Endpoint.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Endpoint.addConnection" id=link102 onMouseOver="ShowTip(event, 'tt51', 'link102')" onMouseOut="HideTip('tt51')">addConnection</a></td><td class=SDescription>Adds a Connection to this Endpoint.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#Endpoint.detach" id=link103 onMouseOver="ShowTip(event, 'tt52', 'link103')" onMouseOut="HideTip('tt52')">detach</a></td><td class=SDescription>Detaches the given Connection from this Endpoint.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Endpoint.detachAll" id=link104 onMouseOver="ShowTip(event, 'tt53', 'link104')" onMouseOut="HideTip('tt53')">detachAll</a></td><td class=SDescription>Detaches all Connections this Endpoint has.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#Endpoint.detachFrom" id=link105 onMouseOver="ShowTip(event, 'tt54', 'link105')" onMouseOut="HideTip('tt54')">detachFrom</a></td><td class=SDescription>Removes any connections from this Endpoint that are connected to the given target endpoint.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Endpoint.detachFromConnection" id=link106 onMouseOver="ShowTip(event, 'tt55', 'link106')" onMouseOut="HideTip('tt55')">detachFromConnection</a></td><td class=SDescription>Detach this Endpoint from the Connection, but leave the Connection alive. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#Endpoint.getElement" id=link107 onMouseOver="ShowTip(event, 'tt56', 'link107')" onMouseOut="HideTip('tt56')">getElement</a></td><td class=SDescription>Returns the DOM element this Endpoint is attached to.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Endpoint.setElement" id=link108 onMouseOver="ShowTip(event, 'tt57', 'link108')" onMouseOut="HideTip('tt57')">setElement</a></td><td class=SDescription>Sets the DOM element this Endpoint is attached to.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#Endpoint.getUuid" id=link109 onMouseOver="ShowTip(event, 'tt58', 'link109')" onMouseOut="HideTip('tt58')">getUuid</a></td><td class=SDescription>Returns the UUID for this Endpoint, if there is one. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Endpoint.isConnectedTo" id=link110 onMouseOver="ShowTip(event, 'tt59', 'link110')" onMouseOut="HideTip('tt59')">isConnectedTo</a></td><td class=SDescription>Returns whether or not this endpoint is connected to the given Endpoint.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#Endpoint.isFull" id=link111 onMouseOver="ShowTip(event, 'tt60', 'link111')" onMouseOut="HideTip('tt60')">isFull</a></td><td class=SDescription>Returns whether or not the Endpoint can accept any more Connections.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Endpoint.setDragAllowedWhenFull" id=link112 onMouseOver="ShowTip(event, 'tt61', 'link112')" onMouseOut="HideTip('tt61')">setDragAllowedWhenFull</a></td><td class=SDescription>Sets whether or not connections can be dragged from this Endpoint once it is full. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#Endpoint.setStyle" >setStyle</a></td><td class=SDescription>Sets the paint style of the Endpoint. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Endpoint.paint" id=link113 onMouseOver="ShowTip(event, 'tt62', 'link113')" onMouseOut="HideTip('tt62')">paint</a></td><td class=SDescription>Paints the Endpoint, recalculating offset and anchor positions if necessary. </td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
- <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Endpoint.Functions"></a>Functions</h3></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.Endpoint"></a>Endpoint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>var Endpoint = function(</td><td class="PParameter prettyprint " nowrap>params</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Endpoint constructor.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>anchor</td><td class=CDLDescription>definition of the Anchor for the endpoint. You can include one or more Anchor definitions here; if you include more than one, jsPlumb creates a ‘dynamic’ Anchor, ie. an Anchor which changes position relative to the other elements in a Connection. Each Anchor definition can be either a string nominating one of the basic Anchors provided by jsPlumb (eg. “TopCenter”), or a four element array that designates the Anchor’s location and orientation (eg, and this is equivalent to TopCenter, [ 0.5, 0, 0, -1 ]). To provide more than one Anchor definition just put them all in an array. You can mix string definitions with array definitions.</td></tr><tr><td class=CDLEntry>endpoint</td><td class=CDLDescription>optional Endpoint definition. This takes the form of either a string nominating one of the basic Endpoints provided by jsPlumb (eg. “Rectangle”), or an array containing [name,params] for those cases where you don’t wish to use the default values, eg. [ “Rectangle”, { width:5, height:10 } ].</td></tr><tr><td class=CDLEntry>enabled</td><td class=CDLDescription>optional, defaults to true. Indicates whether or not the Endpoint should be enabled for mouse events (drag/drop).</td></tr><tr><td class=CDLEntry>paintStyle</td><td class=CDLDescription>endpoint style, a js object. may be null.</td></tr><tr><td class=CDLEntry>hoverPaintStyle</td><td class=CDLDescription>style to use when the mouse is hovering over the Endpoint. A js object. may be null; defaults to null.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription>element the Endpoint is attached to, of type String (an element id) or element selector. Required.</td></tr><tr><td class=CDLEntry>canvas</td><td class=CDLDescription>canvas element to use. may be, and most often is, null.</td></tr><tr><td class=CDLEntry>container</td><td class=CDLDescription>optional id or selector instructing jsPlumb where to attach the element it creates for this endpoint. you should read the documentation for a full discussion of this.</td></tr><tr><td class=CDLEntry>connections</td><td class=CDLDescription>optional list of Connections to configure the Endpoint with.</td></tr><tr><td class=CDLEntry>isSource</td><td class=CDLDescription>boolean. indicates the endpoint can act as a source of new connections. Optional; defaults to false.</td></tr><tr><td class=CDLEntry>maxConnections</td><td class=CDLDescription>integer; defaults to 1. a value of -1 means no upper limit.</td></tr><tr><td class=CDLEntry>dragOptions</td><td class=CDLDescription>if isSource is set to true, you can supply arguments for the underlying library’s drag method. Optional; defaults to null.</td></tr><tr><td class=CDLEntry>connectorStyle</td><td class=CDLDescription>if isSource is set to true, this is the paint style for Connections from this Endpoint. Optional; defaults to null.</td></tr><tr><td class=CDLEntry>connectorHoverStyle</td><td class=CDLDescription>if isSource is set to true, this is the hover paint style for Connections from this Endpoint. Optional; defaults to null.</td></tr><tr><td class=CDLEntry>connector</td><td class=CDLDescription>optional Connector type to use. Like ‘endpoint’, this may be either a single string nominating a known Connector type (eg. “Bezier”, “Straight”), or an array containing [name, params], eg. [ “Bezier”, { curviness:160 } ].</td></tr><tr><td class=CDLEntry>connectorOverlays</td><td class=CDLDescription>optional array of Overlay definitions that will be applied to any Connection from this Endpoint.</td></tr><tr><td class=CDLEntry>isTarget</td><td class=CDLDescription>boolean. indicates the endpoint can act as a target of new connections. Optional; defaults to false.</td></tr><tr><td class=CDLEntry>dropOptions</td><td class=CDLDescription>if isTarget is set to true, you can supply arguments for the underlying library’s drop method with this parameter. Optional; defaults to null.</td></tr><tr><td class=CDLEntry>reattach</td><td class=CDLDescription>optional boolean that determines whether or not the Connections reattach after they have been dragged off an Endpoint and left floating. defaults to false: Connections dropped in this way will just be deleted.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.bind"></a>bind</h3><div class=CBody><p>Bind to an event on the Endpoint.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>event</td><td class=CDLDescription>the event to bind. Available events on an Endpoint are:</td></tr></table><ul><li><b>click</b> : notification that a Endpoint was clicked.</li><li><b>dblclick</b> : notification that a Endpoint was double clicked.</li><li><b>mouseenter</b> : notification that the mouse is over a Endpoint.</li><li><b>mouseexit</b> : notification that the mouse exited a Endpoint.</li></ul><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>callback</td><td class=CDLDescription>function to callback. This function will be passed the Endpoint that caused the event, and also the original event.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.setPaintStyle"></a>setPaintStyle</h3><div class=CBody><p>Sets the Endpoint’s paint style and then repaints the Endpoint.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>style</td><td class=CDLDescription>Style to use.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.setHoverPaintStyle"></a>setHoverPaintStyle</h3><div class=CBody><p>Sets the paint style to use when the mouse is hovering over the Endpoint. This is null by default. The hover paint style is applied as extensions to the paintStyle; it does not entirely replace it. This is because people will most likely want to change just one thing when hovering, say the color for example, but leave the rest of the appearance the same.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>style</td><td class=CDLDescription>Style to use when the mouse is hovering.</td></tr><tr><td class=CDLEntry>doNotRepaint</td><td class=CDLDescription>if true, the Endpoint will not be repainted. useful when setting things up initially.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.setHover"></a>setHover</h3><div class=CBody><p>Sets/unsets the hover state of this Endpoint.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>hover</td><td class=CDLDescription>hover state boolean</td></tr><tr><td class=CDLEntry>ignoreAttachedElements</td><td class=CDLDescription>if true, does not notify any attached elements of the change in hover state. used mostly to avoid infinite loops.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.isVisible"></a>isVisible</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.isVisible = function()</td></tr></table></blockquote><p>Returns whether or not the Endpoint is currently visible.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.setVisible"></a>setVisible</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setVisible = function(</td><td class="PParameter prettyprint " nowrap>v,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>doNotChangeConnections,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>doNotNotifyOtherEndpoint</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets whether or not the Endpoint is currently visible.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>visible</td><td class=CDLDescription>whether or not the Endpoint should be visible.</td></tr><tr><td class=CDLEntry>doNotChangeConnections</td><td class=CDLDescription>Instructs jsPlumb to not pass the visible state on to any attached Connections. defaults to false.</td></tr><tr><td class=CDLEntry>doNotNotifyOtherEndpoint</td><td class=CDLDescription>Instructs jsPlumb to not pass the visible state on to Endpoints at the other end of any attached Connections. defaults to false.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.isEnabled"></a>isEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.isEnabled = function()</td></tr></table></blockquote><p>Returns whether or not the Endpoint is enabled for drag/drop connections.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.setEnabled"></a>setEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setEnabled = function(</td><td class="PParameter prettyprint " nowrap>e</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets whether or not the Endpoint is enabled for drag/drop connections.</p></div></div></div>
- <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Endpoint.Properties"></a>Properties</h3></div></div>
- <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="Endpoint.canvas"></a>canvas</h3><div class=CBody><p>The Endpoint’s Canvas.</p></div></div></div>
- <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="Endpoint.connections"></a>connections</h3><div class=CBody><p>List of Connections this Endpoint is attached to.</p></div></div></div>
- <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="Endpoint.scope"></a>scope</h3><div class=CBody><p>Scope descriptor for this Endpoint.</p></div></div></div>
- <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Endpoint.Functions"></a>Functions</h3></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.addConnection"></a>addConnection</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.addConnection = function(</td><td class="PParameter prettyprint " nowrap>connection</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds a Connection to this Endpoint.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>connection</td><td class=CDLDescription>the Connection to add.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.detach"></a>detach</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.detach = function(</td><td class="PParameter prettyprint " nowrap>connection,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>ignoreTarget,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>forceDetach,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fireEvent</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Detaches the given Connection from this Endpoint.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>connection</td><td class=CDLDescription>the Connection to detach.</td></tr><tr><td class=CDLEntry>ignoreTarget</td><td class=CDLDescription>optional; tells the Endpoint to not notify the Connection target that the Connection was detached. The default behaviour is to notify the target.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.detachAll"></a>detachAll</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.detachAll = function(</td><td class="PParameter prettyprint " nowrap>fireEvent</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Detaches all Connections this Endpoint has.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>fireEvent</td><td class=CDLDescription>whether or not to fire the detach event. defaults to false.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.detachFrom"></a>detachFrom</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.detachFrom = function(</td><td class="PParameter prettyprint " nowrap>targetEndpoint,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fireEvent</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Removes any connections from this Endpoint that are connected to the given target endpoint.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>targetEndpoint</td><td class=CDLDescription>Endpoint from which to detach all Connections from this Endpoint.</td></tr><tr><td class=CDLEntry>fireEvent</td><td class=CDLDescription>whether or not to fire the detach event. defaults to false.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.detachFromConnection"></a>detachFromConnection</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.detachFromConnection = function(</td><td class="PParameter prettyprint " nowrap>connection</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Detach this Endpoint from the Connection, but leave the Connection alive. Used when dragging.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>connection</td><td class=CDLDescription>Connection to detach from.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.getElement"></a>getElement</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.getElement = function()</td></tr></table></blockquote><p>Returns the DOM element this Endpoint is attached to.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.setElement"></a>setElement</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setElement = function(</td><td class="PParameter prettyprint " nowrap>el</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the DOM element this Endpoint is attached to.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.getUuid"></a>getUuid</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.getUuid = function()</td></tr></table></blockquote><p>Returns the UUID for this Endpoint, if there is one. Otherwise returns null.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.isConnectedTo"></a>isConnectedTo</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.isConnectedTo = function(</td><td class="PParameter prettyprint " nowrap>endpoint</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns whether or not this endpoint is connected to the given Endpoint.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>endpoint</td><td class=CDLDescription>Endpoint to test.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.isFull"></a>isFull</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.isFull = function()</td></tr></table></blockquote><p>Returns whether or not the Endpoint can accept any more Connections.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.setDragAllowedWhenFull"></a>setDragAllowedWhenFull</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setDragAllowedWhenFull = function(</td><td class="PParameter prettyprint " nowrap>allowed</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets whether or not connections can be dragged from this Endpoint once it is full. You would use this in a UI in which you’re going to provide some other way of breaking connections, if you need to break them at all. This property is by default true; use it in conjunction with the ‘reattach’ option on a connect call.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>allowed</td><td class=CDLDescription>whether drag is allowed or not when the Endpoint is full.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.setStyle"></a>setStyle</h3><div class=CBody><p>Sets the paint style of the Endpoint. This is a JS object of the same form you supply to a jsPlumb.addEndpoint or jsPlumb.connect call. TODO move setStyle into EventGenerator, remove it from here. is Connection’s method currently setPaintStyle ? wire that one up to setStyle and deprecate it if so.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>style</td><td class=CDLDescription>Style object to set, for example {fillStyle:”blue”}.</td></tr></table><p>@deprecated use setPaintStyle instead.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoint.paint"></a>paint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.paint = function(</td><td class="PParameter prettyprint " nowrap>params</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Paints the Endpoint, recalculating offset and anchor positions if necessary. This does NOT paint any of the Endpoint’s connections.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>timestamp</td><td class=CDLDescription>optional timestamp advising the Endpoint of the current paint time; if it has painted already once for this timestamp, it will not paint again.</td></tr><tr><td class=CDLEntry>canvas</td><td class=CDLDescription>optional Canvas to paint on. Only used internally by jsPlumb in certain obscure situations.</td></tr><tr><td class=CDLEntry>connectorPaintStyle</td><td class=CDLDescription>paint style of the Connector attached to this Endpoint. Used to get a fillStyle if nothing else was supplied.</td></tr></table></div></div></div>
- <div class="CClass"><div class=CTopic><h2 class=CTitle><a name="Connectors.Straight"></a>Connectors.Straight</h2><div class=CBody><p>The Straight connector draws a simple straight line between the two anchor points. It does not have any constructor parameters.</p></div></div></div>
- <div class="CClass"><div class=CTopic><h2 class=CTitle><a name="Connectors.Flowchart"></a>Connectors.Flowchart</h2><div class=CBody><p>Provides ‘flowchart’ connectors, consisting of vertical and horizontal line segments.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#Connectors.Flowchart.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Connectors.Flowchart.Constructor" >Constructor</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
- <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Connectors.Flowchart.Functions"></a>Functions</h3></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Connectors.Flowchart.Constructor"></a>Constructor</h3><div class=CBody><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>stub</td><td class=CDLDescription>minimum length for the stub at each end of the connector. defaults to 30 pixels.</td></tr></table></div></div></div>
- <div class="CClass"><div class=CTopic><h2 class=CTitle><a name="Endpoints.Dot"></a>Endpoints.Dot</h2><div class=CBody><p>A round endpoint, with default radius 10 pixels.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#Endpoints.Dot.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Endpoints.Dot.Constructor" >Constructor</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
- <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Endpoints.Dot.Functions"></a>Functions</h3></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoints.Dot.Constructor"></a>Constructor</h3><div class=CBody><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>radius</td><td class=CDLDescription>radius of the endpoint. defaults to 10 pixels.</td></tr></table></div></div></div>
- <div class="CClass"><div class=CTopic><h2 class=CTitle><a name="Endpoints.Rectangle"></a>Endpoints.Rectangle</h2><div class=CBody><p>A Rectangular Endpoint, with default size 20x20.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#Endpoints.Rectangle.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Endpoints.Rectangle.Constructor" >Constructor</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
- <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Endpoints.Rectangle.Functions"></a>Functions</h3></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoints.Rectangle.Constructor"></a>Constructor</h3><div class=CBody><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>width</td><td class=CDLDescription>width of the endpoint. defaults to 20 pixels.</td></tr><tr><td class=CDLEntry>height</td><td class=CDLDescription>height of the endpoint. defaults to 20 pixels.</td></tr></table></div></div></div>
- <div class="CClass"><div class=CTopic><h2 class=CTitle><a name="Endpoints.Image"></a>Endpoints.Image</h2><div class=CBody><p>Draws an image as the Endpoint.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#Endpoints.Image.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Endpoints.Image.Constructor" >Constructor</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
- <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Endpoints.Image.Functions"></a>Functions</h3></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoints.Image.Constructor"></a>Constructor</h3><div class=CBody><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>src</td><td class=CDLDescription>location of the image to use.</td></tr></table></div></div></div>
- <div class="CClass"><div class=CTopic><h2 class=CTitle><a name="Endpoints.Blank"></a>Endpoints.Blank</h2><div class=CBody><p>An Endpoint that paints nothing (visible) on the screen. Supports cssClass and hoverClass parameters like all Endpoints.</p></div></div></div>
- <div class="CClass"><div class=CTopic><h2 class=CTitle><a name="Endpoints.Triangle"></a>Endpoints.Triangle</h2><div class=CBody><p>A triangular Endpoint.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#Endpoints.Triangle.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Endpoints.Triangle.Constructor" >Constructor</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
- <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Endpoints.Triangle.Functions"></a>Functions</h3></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Endpoints.Triangle.Constructor"></a>Constructor</h3><div class=CBody><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>width</td><td class=CDLDescription>width of the triangle’s base. defaults to 55 pixels.</td></tr><tr><td class=CDLEntry>height</td><td class=CDLDescription>height of the triangle from base to apex. defaults to 55 pixels.</td></tr></table></div></div></div>
- <div class="CClass"><div class=CTopic><h2 class=CTitle><a name="Overlays.Arrow"></a>Overlays.Arrow</h2><div class=CBody><p>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. The foldback point is defined using a decimal that indicates some fraction of the length of the arrow and has a default value of 0.623. A foldback point value of 1 would mean that the arrow had a straight line across the tail.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#Overlays.Arrow.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Overlays.Arrow.Constructor" >Constructor</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
- <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Overlays.Arrow.Functions"></a>Functions</h3></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Overlays.Arrow.Constructor"></a>Constructor</h3><div class=CBody><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>length</td><td class=CDLDescription>distance in pixels from head to tail baseline. default 20.</td></tr><tr><td class=CDLEntry>width</td><td class=CDLDescription>width in pixels of the tail baseline. default 20.</td></tr><tr><td class=CDLEntry>fillStyle</td><td class=CDLDescription>style to use when filling the arrow. defaults to “black”.</td></tr><tr><td class=CDLEntry>strokeStyle</td><td class=CDLDescription>style to use when stroking the arrow. defaults to null, which means the arrow is not stroked.</td></tr><tr><td class=CDLEntry>lineWidth</td><td class=CDLDescription>line width to use when stroking the arrow. defaults to 1, but only used if strokeStyle is not null.</td></tr><tr><td class=CDLEntry>foldback</td><td class=CDLDescription>distance (as a decimal from 0 to 1 inclusive) along the length of the arrow marking the point the tail points should fold back to. defaults to 0.623.</td></tr><tr><td class=CDLEntry>location</td><td class=CDLDescription>distance (as a decimal from 0 to 1 inclusive) marking where the arrow should sit on the connector. defaults to 0.5.</td></tr><tr><td class=CDLEntry>direction</td><td class=CDLDescription>indicates the direction the arrow points in. valid values are -1 and 1; 1 is default.</td></tr></table></div></div></div>
- <div class="CClass"><div class=CTopic><h2 class=CTitle><a name="Overlays.PlainArrow"></a>Overlays.PlainArrow</h2><div class=CBody><p>A basic arrow. This is in fact just one instance of the more generic case in which the tail folds back on itself to some point along the length of the arrow: in this case, that foldback point is the full length of the arrow. so it just does a ‘call’ to Arrow with foldback set appropriately.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#Overlays.PlainArrow.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Overlays.PlainArrow.Constructor" >Constructor</a></td><td class=SDescription>See <a href="#Overlays.Arrow" class=LClass id=link114 onMouseOver="ShowTip(event, 'tt63', 'link114')" onMouseOut="HideTip('tt63')">Overlays.Arrow</a> for allowed parameters for this overlay.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
- <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Overlays.PlainArrow.Functions"></a>Functions</h3></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Overlays.PlainArrow.Constructor"></a>Constructor</h3><div class=CBody><p>See <a href="#Overlays.Arrow" class=LClass id=link115 onMouseOver="ShowTip(event, 'tt63', 'link115')" onMouseOut="HideTip('tt63')">Overlays.Arrow</a> for allowed parameters for this overlay.</p></div></div></div>
- <div class="CClass"><div class=CTopic><h2 class=CTitle><a name="Overlays.Diamond"></a>Overlays.Diamond</h2><div class=CBody><p>A diamond. Like PlainArrow, this is a concrete case of the more generic case of the tail points converging on some point...it just happens that in this case, that point is greater than the length of the the arrow.</p><p>this could probably do with some help with positioning...due to the way it reuses the Arrow paint code, what Arrow thinks is the center is actually 1/4 of the way along for this guy. but we don’t have any knowledge of pixels at this point, so we’re kind of stuck when it comes to helping out the Arrow class. possibly we could pass in a ‘transpose’ parameter or something. the value would be -l/4 in this case - move along one quarter of the total length.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#Overlays.Diamond.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Overlays.Diamond.Constructor" >Constructor</a></td><td class=SDescription>See <a href="#Overlays.Arrow" class=LClass id=link116 onMouseOver="ShowTip(event, 'tt63', 'link116')" onMouseOut="HideTip('tt63')">Overlays.Arrow</a> for allowed parameters for this overlay.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
- <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Overlays.Diamond.Functions"></a>Functions</h3></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Overlays.Diamond.Constructor"></a>Constructor</h3><div class=CBody><p>See <a href="#Overlays.Arrow" class=LClass id=link117 onMouseOver="ShowTip(event, 'tt63', 'link117')" onMouseOut="HideTip('tt63')">Overlays.Arrow</a> for allowed parameters for this overlay.</p></div></div></div>
- <div class="CClass"><div class=CTopic><h2 class=CTitle><a name="Overlays.Label"></a>Overlays.Label</h2><div class=CBody><p>A Label overlay. For all different renderer types (SVG/Canvas/VML), jsPlumb draws a Label overlay as a styled DIV. Version 1.3.0 of jsPlumb introduced the ability to set css classes on the label; this is now the preferred way for you to style a label. The ‘labelStyle’ parameter is still supported in 1.3.0 but its usage is deprecated. Under the hood, jsPlumb just turns that object into a bunch of CSS directive that it puts on the Label’s ‘style’ attribute, so the end result is the same.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#Overlays.Label.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Overlays.Label.Constructor" >Constructor</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#Overlays.Label.setLabel" id=link118 onMouseOver="ShowTip(event, 'tt64', 'link118')" onMouseOut="HideTip('tt64')">setLabel</a></td><td class=SDescription>sets the label’s, um, label. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#Overlays.Label.StateMachine_constructor" >StateMachine constructor</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
- <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Overlays.Label.Functions"></a>Functions</h3></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Overlays.Label.Constructor"></a>Constructor</h3><div class=CBody><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cssClass</td><td class=CDLDescription>optional css class string to append to css class. This string is appended “as-is”, so you can of course have multiple classes defined. This parameter is preferred to using labelStyle, borderWidth and borderStyle.</td></tr><tr><td class=CDLEntry>label</td><td class=CDLDescription>the label to paint. May be a string or a function that returns a string. Nothing will be painted if your label is null or your label function returns null. empty strings <u>will</u> be painted.</td></tr><tr><td class=CDLEntry>location</td><td class=CDLDescription>distance (as a decimal from 0 to 1 inclusive) marking where the label should sit on the connector. defaults to 0.5.</td></tr></table></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Overlays.Label.setLabel"></a>setLabel</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setLabel = function(</td><td class="PParameter prettyprint " nowrap>l</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>sets the label’s, um, label. you would think i’d call this function ‘setText’, but you can pass either a Function or a String to this, so it makes more sense as ‘setLabel’.</p></div></div></div>
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Overlays.Label.StateMachine_constructor"></a>StateMachine constructor</h3><div class=CBody><h4 class=CHeading>Allowed parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>curviness</td><td class=CDLDescription>measure of how “curvy” the connectors will be. this is translated as the distance that the Bezier curve’s control point is from the midpoint of the straight line connecting the two endpoints, and does not mean that the connector is this wide. The Bezier curve never reaches its control points; they act as gravitational masses. defaults to 10.</td></tr><tr><td class=CDLEntry>margin</td><td class=CDLDescription>distance from element to start and end connectors, in pixels. defaults to 5.</td></tr><tr><td class=CDLEntry>proximityLimit</td><td class=CDLDescription>sets the distance beneath which the elements are consider too close together to bother with fancy curves. by default this is 80 pixels.</td></tr><tr><td class=CDLEntry>loopbackRadius</td><td class=CDLDescription>the radius of a loopback connector. optional; defaults to 25.</td></tr></table></div></div></div>
- </div><!--Content-->
- <div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
- <div id=Menu><div class=MEntry><div class=MFile id=MSelected>jsPlumb 1.3.6</div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Index</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MIndex><a href="../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Classes.html">Classes</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Files.html">Files</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Properties.html">Properties</a></div></div></div></div></div><script type="text/javascript"><!--
- var searchPanel = new SearchPanel("searchPanel", "HTML", "../search");
- --></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Properties">Properties</option></select></div></div><!--Menu-->
- <!--START_ND_TOOLTIPS-->
- <div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.addOverlay = function(</td><td class="PParameter prettyprint " nowrap>overlay</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Adds an Overlay to the Connection.</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.getOverlay = function(</td><td class="PParameter prettyprint " nowrap>id</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Gets an overlay, by ID. </div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.hideOverlay = function(</td><td class="PParameter prettyprint " nowrap>id</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Hides the overlay specified by the given id.</div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.showOverlay = function(</td><td class="PParameter prettyprint " nowrap>id</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Shows the overlay specified by the given id.</div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.removeAllOverlays = function()</td></tr></table></blockquote>Removes all overlays from the Connection, and then repaints.</div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setLabel = function(</td><td class="PParameter prettyprint " nowrap>l</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Sets the Connection’s label.</div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>_currentInstance.importDefaults = function(</td><td class="PParameter prettyprint " nowrap>d</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Imports all the given defaults into this instance of jsPlumb.</div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.addClass = function(</td><td class="PParameter prettyprint " nowrap>el,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>clazz</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Helper method to abstract out differences in setting css classes on the different renderer types.</div></div><div class=CToolTip id="tt9"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.removeClass = function(</td><td class="PParameter prettyprint " nowrap>el,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>clazz</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Helper method to abstract out differences in setting css classes on the different renderer types.</div></div><div class=CToolTip id="tt10"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.hasClass = function(</td><td class="PParameter prettyprint " nowrap>el,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>clazz</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Helper method to abstract out differences in testing for css classes on the different renderer types.</div></div><div class=CToolTip id="tt11"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.addEndpoint = function(</td><td class="PParameter prettyprint " nowrap>el,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>params,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>referenceParams</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Adds an Endpoint to a given element or elements.</div></div><div class=CToolTip id="tt12"><div class=CClass>Models an endpoint. </div></div><div class=CToolTip id="tt13"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.addEndpoints = function(</td><td class="PParameter prettyprint " nowrap>el,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>endpoints,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>referenceParams</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Adds a list of Endpoints to a given element or elements.</div></div><div class=CToolTip id="tt14"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.animate = function(</td><td class="PParameter prettyprint " nowrap>el,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>properties,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>options</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>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). </div></div><div class=CToolTip id="tt15"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.connect = function(</td><td class="PParameter prettyprint " nowrap>params,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>referenceParams</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Establishes a Connection between two elements (or Endpoints, which are themselves registered to elements).</div></div><div class=CToolTip id="tt16"><div class=CClass>The connecting line between two Endpoints.</div></div><div class=CToolTip id="tt17"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.deleteEndpoint = function(</td><td class="PParameter prettyprint " nowrap>object</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Deletes an Endpoint and removes all Connections it has (which removes the Connections from the other Endpoints involved too)</div></div><div class=CToolTip id="tt18"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.deleteEveryEndpoint = function()</td></tr></table></blockquote>Deletes every Endpoint, and their associated Connections, in this instance of jsPlumb. </div></div><div class=CToolTip id="tt19"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.detach = function()</td></tr></table></blockquote>Detaches and then removes a Connection. </div></div><div class=CToolTip id="tt20"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.detachAllConnections = function(</td><td class="PParameter prettyprint " nowrap>el,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>params</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Removes all an element’s Connections.</div></div><div class=CToolTip id="tt21"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.detachEveryConnection = function(</td><td class="PParameter prettyprint " nowrap>params</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Remove all Connections from all elements, but leaves Endpoints in place.</div></div><div class=CToolTip id="tt22"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.extend = function(</td><td class="PParameter prettyprint " nowrap>o1,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>o2</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Wraps the underlying library’s extend functionality.</div></div><div class=CToolTip id="tt23"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.getDefaultEndpointType = function()</td></tr></table></blockquote>Returns the default Endpoint type. </div></div><div class=CToolTip id="tt24"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.getDefaultConnectionType = function()</td></tr></table></blockquote>Returns the default Connection type. </div></div><div class=CToolTip id="tt25"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.getConnections = function(</td><td class="PParameter prettyprint " nowrap>options</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Gets all or a subset of connections currently managed by this jsPlumb instance. </div></div><div class=CToolTip id="tt26"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.getAllConnections = function()</td></tr></table></blockquote>Gets all connections, as a map of { scope -> [ connection... </div></div><div class=CToolTip id="tt27"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.getDefaultScope = function()</td></tr></table></blockquote>Gets the default scope for connections and endpoints. </div></div><div class=CToolTip id="tt28"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.hide = function(</td><td class="PParameter prettyprint " nowrap>el,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>changeEndpoints</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Sets an element’s connections to be hidden.</div></div><div class=CToolTip id="tt29"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.ready = function(</td><td class="PParameter prettyprint " nowrap>fn</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Helper method to bind a function to jsPlumb’s ready event.</div></div><div class=CToolTip id="tt30"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.repaint = function(</td><td class="PParameter prettyprint " nowrap>el</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Repaints an element and its connections. </div></div><div class=CToolTip id="tt31"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.repaintEverything = function()</td></tr></table></blockquote>Repaints all connections.</div></div><div class=CToolTip id="tt32"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.removeAllEndpoints = function(</td><td class="PParameter prettyprint " nowrap>el</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Removes all Endpoints associated with a given element. </div></div><div class=CToolTip id="tt33"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setAutomaticRepaint = function(</td><td class="PParameter prettyprint " nowrap>value</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Sets/unsets automatic repaint on window resize.</div></div><div class=CToolTip id="tt34"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setDefaultScope = function(</td><td class="PParameter prettyprint " nowrap>scope</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Sets the default scope for Connections and Endpoints. </div></div><div class=CToolTip id="tt35"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setDraggable = _setDraggable; this.setDebugLog = function(</td><td class="PParameter prettyprint " nowrap>debugLog</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Sets whether or not a given element is draggable, regardless of what any jsPlumb command may request.</div></div><div class=CToolTip id="tt36"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setRepaintFunction = function(</td><td class="PParameter prettyprint " nowrap>f</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Sets the function to fire when the window size has changed and a repaint was fired.</div></div><div class=CToolTip id="tt37"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setRenderMode = function(</td><td class="PParameter prettyprint " nowrap>mode</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Sets render mode: jsPlumb.CANVAS, jsPlumb.SVG or jsPlumb.VML. </div></div><div class=CToolTip id="tt38"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.show = function(</td><td class="PParameter prettyprint " nowrap>el,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>changeEndpoints</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Sets an element’s connections to be visible.</div></div><div class=CToolTip id="tt39"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.sizeCanvas = function(</td><td class="PParameter prettyprint " nowrap>canvas,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>x,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>y,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>w,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>h</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Helper to size a canvas. </div></div><div class=CToolTip id="tt40"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.unload = function()</td></tr></table></blockquote>Unloads jsPlumb, deleting all storage. </div></div><div class=CToolTip id="tt41"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>var Connection = function(</td><td class="PParameter prettyprint " nowrap>params</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Connection constructor.</div></div><div class=CToolTip id="tt42"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.isDetachable = function()</td></tr></table></blockquote>Returns whether or not this connection can be detached from its target/source endpoint. </div></div><div class=CToolTip id="tt43"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setDetachable = function(</td><td class="PParameter prettyprint " nowrap>detachable</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Sets whether or not this connection is detachable.</div></div><div class=CToolTip id="tt44"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setConnector = function(</td><td class="PParameter prettyprint " nowrap>connector,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>doNotRepaint</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt45"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.repaint = function(</td><td class="PParameter prettyprint " nowrap>params</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Repaints the Connection.</div></div><div class=CToolTip id="tt46"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>var Endpoint = function(</td><td class="PParameter prettyprint " nowrap>params</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Endpoint constructor.</div></div><div class=CToolTip id="tt47"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.isVisible = function()</td></tr></table></blockquote>Returns whether or not the Endpoint is currently visible.</div></div><div class=CToolTip id="tt48"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setVisible = function(</td><td class="PParameter prettyprint " nowrap>v,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>doNotChangeConnections,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>doNotNotifyOtherEndpoint</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Sets whether or not the Endpoint is currently visible.</div></div><div class=CToolTip id="tt49"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.isEnabled = function()</td></tr></table></blockquote>Returns whether or not the Endpoint is enabled for drag/drop connections.</div></div><div class=CToolTip id="tt50"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setEnabled = function(</td><td class="PParameter prettyprint " nowrap>e</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Sets whether or not the Endpoint is enabled for drag/drop connections.</div></div><div class=CToolTip id="tt51"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.addConnection = function(</td><td class="PParameter prettyprint " nowrap>connection</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Adds a Connection to this Endpoint.</div></div><div class=CToolTip id="tt52"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.detach = function(</td><td class="PParameter prettyprint " nowrap>connection,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>ignoreTarget,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>forceDetach,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fireEvent</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Detaches the given Connection from this Endpoint.</div></div><div class=CToolTip id="tt53"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.detachAll = function(</td><td class="PParameter prettyprint " nowrap>fireEvent</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Detaches all Connections this Endpoint has.</div></div><div class=CToolTip id="tt54"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.detachFrom = function(</td><td class="PParameter prettyprint " nowrap>targetEndpoint,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fireEvent</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Removes any connections from this Endpoint that are connected to the given target endpoint.</div></div><div class=CToolTip id="tt55"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.detachFromConnection = function(</td><td class="PParameter prettyprint " nowrap>connection</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Detach this Endpoint from the Connection, but leave the Connection alive. </div></div><div class=CToolTip id="tt56"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.getElement = function()</td></tr></table></blockquote>Returns the DOM element this Endpoint is attached to.</div></div><div class=CToolTip id="tt57"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setElement = function(</td><td class="PParameter prettyprint " nowrap>el</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Sets the DOM element this Endpoint is attached to.</div></div><div class=CToolTip id="tt58"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.getUuid = function()</td></tr></table></blockquote>Returns the UUID for this Endpoint, if there is one. </div></div><div class=CToolTip id="tt59"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.isConnectedTo = function(</td><td class="PParameter prettyprint " nowrap>endpoint</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Returns whether or not this endpoint is connected to the given Endpoint.</div></div><div class=CToolTip id="tt60"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">this.isFull = function()</td></tr></table></blockquote>Returns whether or not the Endpoint can accept any more Connections.</div></div><div class=CToolTip id="tt61"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setDragAllowedWhenFull = function(</td><td class="PParameter prettyprint " nowrap>allowed</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Sets whether or not connections can be dragged from this Endpoint once it is full. </div></div><div class=CToolTip id="tt62"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.paint = function(</td><td class="PParameter prettyprint " nowrap>params</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Paints the Endpoint, recalculating offset and anchor positions if necessary. </div></div><div class=CToolTip id="tt63"><div class=CClass>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. </div></div><div class=CToolTip id="tt64"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>this.setLabel = function(</td><td class="PParameter prettyprint " nowrap>l</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>sets the label’s, um, label. </div></div><!--END_ND_TOOLTIPS-->
- <div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
- <script language=JavaScript><!--
- if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
|