Home > @jsplumbtoolkit/browser-ui
browser-ui package
Classes
| Class | Description |
|---|---|
| AbsoluteBackedLayout | Base class for layouts that want to be backed with an absolute layout, ie. if for a given vertex there is positioning data available in the dataset, that positioning data should be used instead of the layout's computed position. |
| AbsoluteLayout | This layout uses left and top positions in your data model to position elements, unless you provide a locationFunction in its options. |
| AbstractHierarchicalLayout | |
| AbstractLayout | Base class for all layouts. |
| ActiveFilteringPlugin | |
| AddGroupMemberAction | |
| ArrowOverlay | |
| AssignLayersStage | |
| AutoSaver | |
| BackgroundPlugin | Offers a means to manage backgrounds for a Surface. |
| BalloonLayout | |
| Base | |
| BezierConnector | |
| BezierEditor | |
| BezierSegment | |
| BlankEndpoint | |
| BrowserJsPlumbInstance | JsPlumbInstance that renders to the DOM in a browser, and supports dragging of elements/connections. |
| BrowserUI | Concrete instance of JsPlumbToolkit that uses the templates-2 package as its renderer. |
| BrowserUIBase | Base instance of the Toolkit that uses ajax to load data asynchronously. This is extended in the various integrations and in the vanilla packages. |
| BrowserUIClipboard | A clipboard to use with a Surface widget, offering methods to copy data and to paste it. |
| BrowserUIMagnetizer | |
| BrowserUIModel | A Model describes the appearance and behaviour of a set of Nodes, Edges, Ports and Groups. You do not create one of these directly; instead you pass a definition to a jsPlumbToolkit.render or jsPlumbToolkitBrowserUI.newInstance() call. Although the Model has the same syntax in each context, you are encouraged to configure model-specific things in the Model you pass to the newInstance method (such as, which Nodes/Ports can be connected to which others, what is the maximum number of connections, etc), and view-specific things (such as css classes, paint styles, connector appearance etc) to the model you pass to the render method. The render method automatically merges in a Node/Port/Edge definition from a Model defined on the associated Toolkit, if there is one. Only the Surface widget provides this. The Toolkit instance creates a Model but it is headless. |
| CatchAllEventHandler | |
| CircularLayout | A layout that places vertices in a circle, optionally with one at the center. |
| Clipboard | Offers methods to copy and paste data from/to a Toolkit instance. This class is abstract and is subclassed to concrete implementations by UI specific packages, of which currently there is only @jsplumbtoolkit/browser-ui-copy-paste. In the future if alternate renderers are written for the Toolkit it is expected that an implementation of the Clipboard would be one of the inclusions. |
| Cluster | |
| Collicat | |
| Component | Base class for Endpoint and Connection. |
| Connection | |
| ConnectionDragSelector | |
| ConnectionSelection | |
| ControlsComponent | Simple component that was created for our demonstrations. We decided to include it in the Toolkit since it may of some use to others. |
| CrossingStage | |
| CustomOverlay | |
| CustomTag | |
| Decorator | |
| Dialogs | |
| DialogsBase | Simple dialog library. Created for use in the Toolkit demonstrations. |
| DiamondOverlay | |
| DotEndpoint | |
| Drag | |
| DragGroupsPlugin | Provides the ability to assign elements to groups for dragging purposes: when a member of some group is dragged, the other elements of the group can be dragged along with it. The core concept is of the "DragGroup", which is basically just a tag. Each member of a group can belong to the group in one of two roles: - **active** The element, when dragged, causes all of the other members of the group to be dragged too. - **passive** The element, when dragged, will not cause any of the other members of the group to be dragged. But when an active member of the group is dragged, passive elements are dragged at the same time. When you configure this plugin you are required to provide an |
assignDragGroup:(v:Vertex) => DragGroupSpec
The return value DragGroupSpec may be either:
- a string, in which case the element is added to the drag group with the given name in an active role - an object containing id and active which you can specify the active/passive role - null, in which case the element is not added to a drag group.
SurfaceDropManager, and for the vast majority of applications, SurfaceDropManager will be the class you want to use. The difference between the two classes is that DropManager provides a means for you to respond to items being dropped onto a surface canvas, but it does not do anything when such an event occurs other than inform you, via a set of callbacks, whereas the SurfaceDropManager provides implementations of these callbacks that manipulate the canvas and the data model. | | [Edge](/apidocs/browser-ui.edge) | | | [EdgeGeometryTransformer](/apidocs/browser-ui.edgegeometrytransformer) | | | [EdgePathEditor](/apidocs/browser-ui.edgepatheditor) | Editor for edge paths. Currently support Bezier, StateMachine and Orthogonal connectors. | | [EdgeTypePicker](/apidocs/browser-ui.edgetypepicker) | Helper class that renders a set of edge styles to the DOM and offers a callback method for when one is selected via a mouse click.
This was created as part of the demonstration applications for version 6.2.0 of the Toolkit and since it seemed useful for other applications we're shipping it in the Toolkit package.
| | [ElementDragHandler](/apidocs/browser-ui.elementdraghandler) | | | [EmptyLayout](/apidocs/browser-ui.emptylayout) | A layout that has no opinions whatsoever about where nodes should be placed. Everything is placed at \[0,0\] and assumed to have a width and height of 0. This layout is a placeholder. | | [Endpoint](/apidocs/browser-ui.endpoint) | | | [EndpointRepresentation](/apidocs/browser-ui.endpointrepresentation) | Superclass for all types of Endpoint. This class is renderer agnostic, as are any subclasses of it. | | [EndpointSelection](/apidocs/browser-ui.endpointselection) | | | [EventGenerator](/apidocs/browser-ui.eventgenerator) | Base class for classes that wish to support binding and firing of events. | | [EventManager](/apidocs/browser-ui.eventmanager) | | | [FixedLayer](/apidocs/browser-ui.fixedlayer) | | | [ForceDirectedLayout](/apidocs/browser-ui.forcedirectedlayout) | A layout that treats edges as springs, and places each vertex in proximity to other vertices to which it is connected. This is a rewrite of the original Spring layout, with several placement enhancements and typically a shorter run time. As of 5.7.0, existing users of the Spring layout are encouraged to switch to this layout, and new users are encouraged to prefer this layout over the Spring layout. | | [GeneratedGridBackground](/apidocs/browser-ui.generatedgridbackground) |A background that generates an SVG grid based upon the current content bounds, ensuring that there is always a grid visible underneath the content. The grid may consist of lines or dots - control this via the gridType option.
The size of the grid can be mandated in the options for the background, or it can be extracted from the surface.
You can hide/show the background grid via the hide(), show(), toggle() or setVisible(boolean) methods.
Layout adapter that operates on a single group. getElements returns member of this group. filter filters out vertices that are not children of this group.
TODO why exactly does filter have to exist here? If getElements only returns group members, what's the filter for?
A new version of a hierarchy layout, which can better handle upstream links and multiple parents. This layout runs in 3 stages -
1. placement of nodes into layers 2. reordering nodes in layers to minimise edge crossing 3. placement of nodes into final layout
In step (3) all nodes are currently centered around the midpoint of the chart, as opposed to being grouped below their parent; it is possible a future enhancement of this could offer the aligned on parent option but since multiple parents is one of the expected conditions for use for this layout it doesn't always make sense to align on the parent - the question being, which parent? update, 9/12/21 - i think it needs to be the midpoint of parents in the layer directly above.
Note also this layout currently ignores Ports. And probably Groups.
| | [HierarchyLayoutStage](/apidocs/browser-ui.hierarchylayoutstage) | | | [ImageExporter](/apidocs/browser-ui.imageexporter) | Exports the contents of some Surface as an image. The default supported image type in browsers isimage/png but you'll probably find image/jpeg also works, although that is not under jsPlumb's control. | | [ImageExporterUI](/apidocs/browser-ui.imageexporterui) | | | [Index](/apidocs/browser-ui.index) | | | [IngestedSurface](/apidocs/browser-ui.ingestedsurface) | Extension of the Surface widget that is created when ingesting a Community edition instance. This class augments the Surface with an importNode method, which can be used in place of the manage method on the Community instance. | | [Ingester](/apidocs/browser-ui.ingester) | Manages an ingested community edition instance. This class is the return value of the ingest method, and the main piece of interest to a user is the Surface member, which is an IngestedSurface - a subclass of Surface which contains an importNode method, that can be used in place of the manage method in the Community instance. | | [Inspector](/apidocs/browser-ui.inspector) | Offers a simple means to inspect and change the values in some object or set of objects. | | [JsPlumbInstance](/apidocs/browser-ui.jsplumbinstance) | | | [JsPlumbList](/apidocs/browser-ui.jsplumblist) | Models a list of elements that is scrollable, and connections to the elements contained in the list are proxied onto the top of bottom edge of the list element whenever their source/target is not within the list element's current viewport. | | [JsPlumbListManager](/apidocs/browser-ui.jsplumblistmanager) | Provides methods to create/destroy scrollable lists. | | [JsPlumbToolkit](/apidocs/browser-ui.jsplumbtoolkit) | Core Toolkit functionality. This class is extended by renderer specific subclasses. | | [jsPlumbToolkitTestHarness](/apidocs/browser-ui.jsplumbtoolkittestharness) | | | [LabelDragManager](/apidocs/browser-ui.labeldragmanager) | | | [LabelManipulator](/apidocs/browser-ui.labelmanipulator) | | | [LabelOverlay](/apidocs/browser-ui.labeloverlay) | | | [LabelSpacer](/apidocs/browser-ui.labelspacer) | | | [Lasso](/apidocs/browser-ui.lasso) | | | [LassoPlugin](/apidocs/browser-ui.lassoplugin) | A plugin that allows the user to select multiple elements with the mouse. | | [LightweightFloatingAnchor](/apidocs/browser-ui.lightweightfloatinganchor) | | | [LightweightRouter](/apidocs/browser-ui.lightweightrouter) | | | [Magnetizer](/apidocs/browser-ui.magnetizer) | Offers a means to apply 'magnetization' to some list of elements, pushing them apart so that they do not overlap. For a given run of the magnetizer there is the concept of a "focus" rectangle. The center of this rectangle is the point from which magnetization occurs, with elements being pushed out radially from this point. There are a few different scenarios:
- execute magnetizer with a given origin, and affect all elements - execute magnetizer on all elements, having first computed the center of them - execute magnetizer using a specific element as the focus
| | [MiniviewPlugin](/apidocs/browser-ui.miniviewplugin) | Miniview plugin for Surface. In previous versions of jsplumb this was embedded in the Surface. | | [Node](/apidocs/browser-ui.node) | | | [OptimisticEventGenerator](/apidocs/browser-ui.optimisticeventgenerator) | Subclass of EventGenerator with a default implementation ofshouldFireEvent, which returns true always. | | [OrthogonalConnector](/apidocs/browser-ui.orthogonalconnector) | An orthogonal connector. In the Community edition this connector was/is known as the Flowchart connector. The Orthogonal connector behaves like the Flowchart connector but is editable, ie. it is possible to supply the segments for the connector's path, and also to edit the path interactively with the mouse with the @jsplumbtoolkit/connector-editors-orthogonal package. | | [OrthogonalEditor](/apidocs/browser-ui.orthogonaleditor) | | | [Overlay](/apidocs/browser-ui.overlay) | | | [PanButtonsPlugin](/apidocs/browser-ui.panbuttonsplugin) | | | [Path](/apidocs/browser-ui.path) | Models the path between two Nodes/Ports, which consists of a series of \[Group/Node/Port, Edge\] pairs. | | [PathTransport](/apidocs/browser-ui.pathtransport) | | | [PinchListener](/apidocs/browser-ui.pinchlistener) | | | [PlainArrowOverlay](/apidocs/browser-ui.plainarrowoverlay) | | | [Port](/apidocs/browser-ui.port) | | | [PortAddAction](/apidocs/browser-ui.portaddaction) | | | [PortRemoveAction](/apidocs/browser-ui.portremoveaction) | | | [PrintHandler](/apidocs/browser-ui.printhandler) | | | [RectangleEndpoint](/apidocs/browser-ui.rectangleendpoint) | | | [RemoveGroupMemberAction](/apidocs/browser-ui.removegroupmemberaction) | | | [SegmentedConnector](/apidocs/browser-ui.segmentedconnector) | | | [SegmentedEditor](/apidocs/browser-ui.segmentededitor) | | | [Selection](/apidocs/browser-ui.selection) | A selection is a group of vertices and edges, upon which you can perform bulk operations. | | [ShapeLibraryImpl](/apidocs/browser-ui.shapelibraryimpl) | Default ShapeLibrary implementation. Use one of these to manage a set of shapes for rendering into your vertices and/or for rendering as a palette from which the user can drag new objects. | | [ShapeLibraryPalette](/apidocs/browser-ui.shapelibrarypalette) | A palette for drag/drop that renders the contents of a shape library. | | [SimpleBackground](/apidocs/browser-ui.simplebackground) | A background consisting of a single image. | | [StateMachineConnector](/apidocs/browser-ui.statemachineconnector) | | | [StateMachineEditor](/apidocs/browser-ui.statemachineeditor) | | | [StatePlugin](/apidocs/browser-ui.stateplugin) | | | [StraightConnector](/apidocs/browser-ui.straightconnector) | | | [Surface](/apidocs/browser-ui.surface) | | | [SurfaceAnimator](/apidocs/browser-ui.surfaceanimator) | SurfaceAnimator offers a few methods for animating parts of a Surface widget:
- animateToPosition animates some vertex to a new position - tracePath animates an overlay along the path from some vertex to some other vertex - traceEdge animates an overlay along one edge
| | [SurfaceDropManager](/apidocs/browser-ui.surfacedropmanager) | SurfaceDropManager wraps DropManager with default implementations of the various callbacks. Most users will want to use this class rather than DropManager, as it operates at a higher level. | | [SvgExporter](/apidocs/browser-ui.svgexporter) |An exporter for Surfaces. This was first released in version 6.6.0 and currently has a few caveats attached to its usage:
- Primarily, the exporter is expected to be used with a Surface that has a ShapeLibrary set on it. The shape library is used to render appropriate SVG elements for each node. If you use this exporter on a Surface that does not have a ShapeLibrary attached, a default SVG rectangle will be used to represent each node.
- When using a shape library it is expected that your node data will contain left, top, w and h properties, defining the dimensions of the node.
- If you want to see labels on exported edges, you must ensure that you set useHtmlElement to "false" on the overlay spec. This means that you cannot use the label shorthand property, because, in 6.x at least, it will result in the Toolkit creating an HTML element as that is the default behaviour. In the next major release - 7.x - the Toolkit will default to creating an SVG text element to render the label shorthand property.
Also, as of 6.6.0, the Toolkit ships with a single set of shapes, and there are no shapes that support dynamic content insertion, with the exception of a node label.
6.6.0
| | [SvgExporterUI](/apidocs/browser-ui.svgexporterui) | | | [TerminusAddAction](/apidocs/browser-ui.terminusaddaction) | | | [TerminusRemoveAction](/apidocs/browser-ui.terminusremoveaction) | | | [TiledBackground](/apidocs/browser-ui.tiledbackground) | | | [UIGroup](/apidocs/browser-ui.uigroup) | | | [UINode](/apidocs/browser-ui.uinode) | | | [UIPath](/apidocs/browser-ui.uipath) | A wrapper around the Toolkit's path object, which offers a few DOM specific methods. | | [UIState](/apidocs/browser-ui.uistate) | | | [UiStatesBrowserUIModel](/apidocs/browser-ui.uistatesbrowseruimodel) | | | [UiStatesPlugin](/apidocs/browser-ui.uistatesplugin) | | | [VanillaInspector](/apidocs/browser-ui.vanillainspector) | An inspector that renders to a nominated DOM element, using the Toolkit's default template renderer. You have to provide atemplateResolver which, for a given object, can return a template in the Toolkit's default template syntax. | | [Vertex](/apidocs/browser-ui.vertex) | | | [Viewport](/apidocs/browser-ui.viewport) | Models the positions of the elements a given jsPlumb instance is tracking. Users of the API should not need to interact directly with a Viewport. | | [xml](/apidocs/browser-ui.xml) | |Enumerations
| Enumeration | Description |
|---|---|
| AnchorLocations | Default anchor locations. |
| AnimationClasses | The css classes that are used when animating an overlay along some path. |
| AnimationEvents | |
| AnimationPhases | The phases of an overlay path animation. |
| BackgroundTypes | |
| ContainmentType | |
| ElementTypes | |
| GridTypes | |
| HierarchicalLayoutOrientations | Axis orientations for hierarchical layout |
| HierarchyLayoutAlignmentValues | |
| HierarchyLayoutAxisValues | |
| PanAxes | Axes in which the canvas can be panned - x, y, or both. |
| PathTransportState | |
| PerimeterAnchorShapes | Supported shapes for a Perimeter anchor. |
| PlacementStageStrategyValues | |
| PositioningStrategies | |
| SelectionModes | Possible modes for a Selection. mixed: any combination of vertices and edges is supported isolated: either a set of vertices, or a set of edges, but not both at the same time nodesOnly: only Node objects groupsOnly: only Group objects edgesOnly:only Edge object. |
| SupportedEdge | |
| SurfaceMode | |
| TilingStrategies | Defines how the tiles are arranged. With With |
Functions
| Function | Description |
|---|---|
| _createPerimeterAnchor(params) | |
| _makeAndAppendHandle(x, y, _jsPlumb, clazz, visible) | |
| _makeHandle(x, y, clazz, visible) | |
| _removeTypeCssHelper(component, typeId) | |
| _updateHoverStyle(component) | |
| add(p1, p2) | Adds the x and y values of the two points and returns a new point. |
| addClass(el, clazz) | |
| addWheelListener(el, callback, ignoreTouchWheelEvents, requireMetaKey) | |
| ajax(params) | Basic ajax function. |
| apply(dataset, el, autoCommitHandler, unresolvedElementSetter) | Apply the given object to the given DOM element. This method will find all child elements of el that have a jtk-att attribute set, and then attempt to set the value of any found DOM element with a value extracted from dataset. |
| att(attName) | |
| attSel(att) | |
| attWithValue(att, value) | |
| bezierLineIntersection(x1, y1, x2, y2, curve) | Calculates all intersections of the given line with the given curve. |
| boundingBoxIntersection(boundingBox, curve) | Calculates all intersections of the given bounding box with the given curve. |
| boxIntersection(x, y, w, h, curve) | Calculates all intersections of the given box with the given curve. |
| calculateSpacingAdjustment(r1, r2) | |
| checkValidity(el) | Searches children of the given element to find elements that have a
|
| classList(className) | |
| clear(els, source) | |
| clientSize(el) | |
| cls(className) | |
| compoundEvent(stem, event, subevent) | |
| computeBezierLength(curve) | |
| consume(e, doNotPreventDefault) | Consume the given event, using stopPropagation() if present or returnValue if not, and optionally also calling preventDefault(). |
| convertToFullOverlaySpec(spec) | Convert the given input into an object in the form of a FullOverlaySpec |
| createDropManager(options) | |
| createEdgeTypePickerTag(propertyName, edgeMappings, onSelect) | |
| createElement(tag, style, clazz, atts) | |
| createElementNS(ns, tag, style, clazz, atts) | |
| createFinderFromAnchorPositions(positions) | |
| createFloatingAnchor(instance, ep, element, elementId) | |
| createSurfaceDropManager(options) | |
| data(inObj, path, value) | |
| debounce(fn, timeout) | Create a debounced version of the given function. |
| defaultIdFunction(obj) | |
| DefaultSearchTokenizer(value) | |
| dist(p1, p2) | |
| distanceFromCurve(point, curve) | Calculates the distance that the given point lies from the given Bezier. Note that it is computed relative to the center of the Bezier, so if you have stroked the curve with a wide pen you may wish to take that into account! The distance returned is relative to the values of the curve and the point - it will most likely be pixels. |
| djikstra(params) | |
| eachNotEmpty(strings, fn) | Runs the given function for each value in the array that is not null and has a non-zero length. |
| encloses(r1, r2, allowSharedEdges) | Calculates whether or not r2 is completely enclosed by r1. |
| exportData(type, toolkit, parameters) | Internal method that handles data export, by looking for an exporter registered for the given type. |
| extend(o1, o2, keys) | Equivalent of Object.assign, which IE11 does not support. |
| extract(el, unresolvedElementGetter) | Extracts a dataset from the given element by finding child elements that have a jtk-att attribute set, and extracting from those elements their value. When the same jtk-att value appears more than once as a child of el, the values are stored in an array for that field. |
| extractValueFromElement(el, unresolvedElementGetter) | Extract the value represented by the given element. |
| fastTrim(s) | Trims whitespace from the given string. |
| filterEmpty(l) | Filters out empty or null values from the given list of strings |
| findClosestPoint(pos, constrainRect, locations) | Find the closest point out of locations to the given point on the given constraining rectangle. |
| findParent(el, selector, container, matchOnElementAlso) | |
| fixPrecision(n, digits) | Trim decimal points from a number. Defaults to 3 decimal points. |
| floydWarshall(params) | |
| getAbsolutePosition(element) | Returns the position of the given element, as reported by the left and top properties of the element's style. |
| getClass(el) | |
| getElementType(el) | |
| getEventSource(e) | |
| getPageLocation(e) | Gets the page location for the given event, abstracting out differences between touch and mouse events. |
| getsert(map, key, valueGenerator) | Get, or insert then get, a value from the map. |
| getTouch(touches, idx) | |
| gradient(p1, p2) | Calculates the gradient of a line between the two points. |
| gradientAtPoint(curve, location) | Calculates the gradient at the point on the given curve at the given location |
| gradientAtPointAlongPathFrom(curve, location, distance) | Returns the gradient of the curve at the point which is 'distance' from the given location. if this point is greater than location 1, the gradient at location 1 is returned. if this point is less than location 0, the gradient at location 0 is returned. |
| hasClass(el, clazz) | |
| ingest(params) | Ingests an existing jsPlumb instance into a new Toolkit instance, and turns the instance's Container into a Surface. Every element that is the source or target of a Connection is added to the Toolkit instance as a Node, and every Connection is added as an Edge. You can provide your own functions for determining the When you ingest an existing jsPlumb instance, its |
| initializeBezierConnectorEditors() | Register the bezier/state machines editors with the connector editors modules. In certain setups, for instance a React app, you need to do this in order to ensure the editor code is included. |
| initializeOrthogonalConnectorEditors() | Register the orthogonal editor with the connector editors modules. In certain setups, for instance a React app, you need to do this in order to ensure the orthogonal editor code is included. |
| initializeSegmentedConnectorEditors() | Register the orthogonal editor with the connector editors modules. In certain setups, for instance a React app, you need to do this in order to ensure the orthogonal editor code is included. |
| insertSorted(value, array, comparator, sortDescending) | Inserts the given value into the given array at a sorted location. |
| intersects(r1, r2) | Calculates whether or not the two rectangles intersect. |
| isArrayLike(el) | |
| isArrowOverlay(o) | |
| isAssignableFrom(object, cls) | Returns true if the given object can be considered to be an instance of the class cls. This is done by testing the proto chain of the object and checking at each level to see if the proto is an instance of the given class. |
| isBoolean(s) | Returns whether or not the given value is of boolean type. |
| isContinuous(a) | |
| isCustomOverlay(o) | |
| isDate(o) | Returns whether or not the given value is of type Date |
| isDiamondOverlay(o) | |
| isDynamic(a) | |
| isEdge(obj) | |
| isEdgeEditingSupported(type) | Returns whether or not there is an edge editor registered for connectors of the given type. |
| isEdgeNode(entry) | |
| isEmpty(o) | Returns whether or not the given object - which may be ArrayLike, or an object - is empty. |
| isFloating(a) | |
| isFullOverlaySpec(o) | Returns whether or not the given overlay spec is a 'full' overlay spec, ie. has a type and some options, or is just an overlay name. |
| isFunction(o) | Returns whether or not the given value is of type Function |
| isGroup(obj) | |
| isGroupVertex(v) | |
| isInsideParent(instance, _el, pos) | |
| isLabelOverlay(o) | |
| isMouseDevice() | |
| isNamedFunction(o) | Returns whether or not the given value is of type Function and is a named Function. |
| isNestedGroup(obj) | |
| isNode(obj) | |
| isNodeInsideAGroup(obj) | |
| isNodeList(el) | |
| isNodeVertex(v) | |
| isNumber(n) | Returns whether or not the given value is of number type. |
| isObject(o) | Returns whether or not the given value is of type object |
| isPlainArrowOverlay(o) | |
| isPoint(curve) | |
| isPort(obj) | |
| isPortVertex(v) | |
| isReadyToPrint(handlerId) | Returns whether or not the handler with the given id considers itself ready to print. if no such handler is found we also return false; it is entirely possible that this call could be made before the handler has been instantiated. |
| isString(s) | Returns whether or not the given value is of string type. |
| isSVGElement(el) | |
| isTouchDevice() | |
| lineIntersection(l1, l2) | Compute the intersection of the two lines. |
| lineLength(p1, p2) | Calculates the length of a line between the two points. |
| lineRectangleIntersection(line, r) | Finds all points where the given line intersects the given rectangle. |
| locationAlongCurveFrom(curve, location, distance) | finds the location that is 'distance' along the path from 'location'. |
| makeLightweightAnchorFromSpec(spec) | |
| matchesSelector(el, selector, ctx) | |
| mergeWithParents(type, map, shouldOverride) | Extract the definition(s) with the given type and merge them, |
| nearestPointOnCurve(point, curve) | Calculates the nearest point to the given point on the given curve. The return value of this is a JS object literal, containing both the point's coordinates and also the 'location' of the point (see above). |
| newBrowserJsPlumbInstance(defaults) | Create a new BrowserJsPlumbInstance, optionally with the given defaults. |
| newInstance(options) | |
| newTemplates2Renderer(params) | Create a template renderer using the template-2 package. |
| normal(p1, p2) | Calculates the gradient of a normal to a line between the two points. |
| offsetSize(el) | Gets the offset width and offset height of the given element. Not safe for SVG elements. This method was previously exported as Note that |
| onDocumentReady(f) | Execute the given function when the DOM is ready, or if the DOM is already ready, execute the given function immediately. |
| pageLocation(e) | |
| parse(type, source, toolkit, parameters) | |
| partition(l, partitioner) | Partitions a list into two lists - one for which the supplied partitioner returns true (the left list), and the other, the right list, for which the supplied partitioner does not return true. |
| perpendicularLineTo(fromPoint, toPoint, length) | Calculates a line of length length that is perpendicular to the line from fromPoint to toPoint and passes through toPoint. |
| perpendicularToPathAt(curve, location, length, distance) | calculates a line that is 'length' pixels long, perpendicular to, and centered on, the path at 'distance' pixels from the given location. if distance is not supplied, the perpendicular for the given location is computed (ie. we set distance to zero). |
| pointAlongCurveFrom(curve, location, distance) | finds the point that is 'distance' along the path from 'location'. |
| pointAlongPath(curve, location, distance) | finds the point that is 'distance' along the path from 'location'. this method returns both the x,y location of the point and also its 'location' (proportion of travel along the path); the method below - _pointAlongPathFrom - calls this method and just returns the point. TODO The compute length functionality was made much faster recently, using a lookup table. is it possible to use that lookup table find a value for the point some distance along the curve from somewhere? |
| pointOnCurve(curve, location) | calculates a point on the curve, for a Bezier of arbitrary order. |
| pointOnLine(fromPoint, toPoint, distance) | Calculates a point on the line from fromPoint to toPoint that is distance units along the length of the line. |
| quadrant(p1, p2) | Calculates the quadrant in which the angle between the two points lies. |
| ready(f) | |
| registerDecorator(name, dec) | |
| registerEndpointRenderer(name, fns) | |
| registerExporter(name, p) | |
| registerHandler(surface, id) | Register a print handler for the given surface, optionally with the given id. An id will be generated if not provided. |
| registerParser(name, p) | |
| relocateContinuousAnchor(anchor, ep, pos, dragEl, constrainRect, elementSize, idx, connector, instance) | |
| relocateDynamicAnchor(anchor, ep, pos, dragEl, constrainRect) | Relocate the given dynamic anchor according to the given proximity of pos to each of the anchor's supported locations. the face is changed on the anchor itself (and the anchor is locked), and in this case we simply return the current value of pos, meaning the user sees the drag proxy under the mouse cursor, which is probably not where the anchor is now positioned, but it makes for a better UX. on drag stop, for all anchor types, the anchor proxy is relocated to the current value. |
| removeClass(el, clazz) | |
| removeWheelListener(el, callback) | |
| resolveIfExecution(e, templateData, expander) | |
| resolveNode(v) | For the given vertex, resolves the node/group it pertains to. If the vertex is already a node/group, it is returned. Otherwise, if it is a port, the parent of the port is returned. |
| resolvePortId(v) | For the given vertex, resolve its port id. If it is not a port, null is returned. If it is a port, its id is returned (without the parent vertex's id prefixed to it) |
| rotatePoint(point, center, rotation) | Rotate the given point around the given center, by the given rotation (in degrees) |
| scaleToBounds(handlerId, wh, margins) | Instructs the given handler to zoom and pan its content so that it would fit into the given width and height (which are pixel values). This is used when printing if we wish to fix to a specific page size like A4. |
| scaleToFullPage(handlerId, margins, units) | Instructs the given handler to zoom its content to 1, and then report back how big the page needs to be to render the entire dataset. Note that this method returns an array serialized as a string. |
| scaleToPageDimensions(handlerId, dimensions, margins, units) | Instructs the given handler to zoom its content so that it would fit into a page of the given dimensions. The values are in centimetres, unless you specify in the third argument to the method that the dimensions are inches. |
| scaleToPageSize(handlerId, size, margins, units) | Instructs the given handler to zoom its content so that it would fit into a page of the given size. We currently know about LETTER, A5, A4, A3, A2, A1, A0 and FULL (which is the same as calling scaleToFullPage). Note that this method returns an array serialized as a string. |
| setAbsolutePosition(element, x, y) | Sets the position of the given DOM element, by setting values for left and top on the element's style. |
| setBoundingRect(element, origin, size) | Sets the position and size of the given element. This method is equivalent to first calling setAbsolutePosition and then setSize on the given element. |
| setForceMouseEvents(value) | |
| setForceTouchEvents(value) | |
| setSize(element, w, h) | Sets the size of the given DOM element, by setting values for width and height on the element's style. |
| sgn(x) | Replacement for Math.sign, which IE11 does not support. |
| shouldOverrideEndpoints(p, from) | |
| snapToGrid(pos, grid, thresholdX, thresholdY) | Snap the given x,y to a point on the grid defined by gridX and gridY, using the given thresholds to calculate proximity to the grid. |
| subtract(p1, p2) | Subtracts p2 from p1, returning a new point. |
| svgWidthHeightSize(el) | |
| svgXYPosition(el) | |
| theta(p1, p2) | Calculates the angle between the two points. |
| toggleClass(el, clazz) | |
| touchCount(e) | |
| touches(e) | |
| uuid() | Generate a v4 UUID. |
| WhitespaceReplacingTokenizer(value) |
Interfaces
| Interface | Description |
|---|---|
| AbsoluteBackedLayoutParameters | Parameters for a layout that extends AbsoluteBackedLayout |
| AbstractBezierOptions | Base options interface for StateMachine and Bezier connectors. |
| AbstractEdgeTerminus | Base class for objects in a Graph that can act as the terminus for an Edge. |
| AbstractHierarchicalLayoutParameters | |
| AbstractSelectOptions | |
| ActiveFilteringPluginOptions | |
| AddEdgeOptions | |
| AddGroupOptions | |
| AnchorOptions | |
| ArrowOverlayOptions | |
| AutoSaveOptions | |
| Background | |
| BackgroundOptions | Base options for background |
| BalloonLayoutParameters | Constructor parameters for a Balloon layout. |
| BeforeDragParams | The parameters passed to a beforeDrag interceptor. |
| BeforeDropParams | Definition of the parameters passed to the beforeDrop interceptor. |
| BeforeStartConnectionDetachParams | The parameters passed to a beforeStartDetach interceptor. |
| BeforeStartEventParams | |
| BehaviouralTypeDescriptor | Extends EndpointTypeDescriptor to add the options supported by an addSourceSelector or addTargetSelector call. |
| BezierConnectorGeometry | |
| BezierEditorOptions | |
| BezierOptions | Options for the Bezier connector. |
| BezierSegmentParams | |
| BlankEndpointParams | |
| BrowserJsPlumbDefaults | Defaults for the BrowserUI implementation of jsPlumb. |
| BrowserUIPasteOptions | Extension of paste options for use in a browser. |
| CircularLayoutParameters | Parameters for the circular layout. |
| ClonedSet | The return value from a paste. Contains a list of nodes, groups and edges that were pasted, as well as a map of previous edge/vertex ids to their new ids, the computed origin of the copied vertices, and the amount by which the set of objects was translated for the paste (so the paste location is origin + transform). |
| CollicatOptions | |
| ConnectionDetachedParams | Definition of the parameters passed to a listener for the connection:detach event. |
| ConnectionDragEventHandlers | Callbacks you can provide to connection drag methods to interrupt the process and inspect what's going on, |
| ConnectionEstablishedParams | Definition of the parameters passed to a listener for the connection event. |
| ConnectionMovedParams | Definition of the parameters passed to a listener for the connection:move event. |
| ConnectionTypeDescriptor | Definition of a connection type. |
| ConnectOptions | Options for a connect call. |
| Connector | High level definition of a Connector. |
| ConnectorEditor | |
| ConnectorEditorActivateParams | |
| ConnectorEditorFactory | |
| ConnectorEditorOptions | Options for the EdgePathEditor. |
| ConnectorOptions | Common options for connectors. |
| ConnectParams | Options for the connect call on a JsPlumbInstance |
| ConstructableConnectorEditor | |
| ContainerOptions | |
| CrossingStageOptions | |
| CustomOverlayOptions | |
| CustomTagDefinition | |
| CustomTagOptions | |
| DataLoadOptions | |
| DataSource | |
| Deletion | |
| DialogsOptions | |
| DjikstraOptions | |
| DotEndpointParams | |
| DragEventHandlers | Handlers you can pass as an argument to various element drag methods, to interrupt the drag and inspect what's going on. |
| DragEventParams | |
| DragGroupsPluginOptions | |
| DragHandler | |
| DragHandlerOptions | |
| DragManagerOptions | |
| DragMovePayload | Payload for drag:move event. |
| DragOptions | |
| DragParams | |
| DragPayload | Base payload for drag events. Contains the element being dragged, the corresponding mouse event, the current position, and the position when drag started. |
| DragStartEventParams | |
| DragStartPayload | Payload for drag:start event. |
| DragStopEventParams | |
| DragStopPayload | Payload for drag:stop event. In addition to the base payload, contains a redraw result object, listing all the connections and endpoints that were affected by the drag. |
| DrawingToolsPluginOptions | |
| DropManagerOptions | Options for the DropManager. |
| EdgeAddedParams | |
| EdgeNode | |
| EdgeOptions | |
| EdgePathEditedParams | |
| EdgePathRestoredParams | |
| EdgeRemovedParams | |
| EdgeSelectionParams | |
| EdgeSourceChangedParams | |
| EdgeTargetChangedParams | |
| EdgeUpdatedParams | |
| EdgeVertexChangedParams | |
| EndpointOptions | |
| EndpointRepresentationParams | |
| EndpointStyle | |
| EndpointTypeDescriptor | Definition of an endpoint type. |
| EntryNode | |
| ExportOptions | Options for data export. |
| FilterableDataset | Extension of dataset that offers operation to perform operations on the contents, and to filter the contents. |
| FloydWarshallOptions | |
| FloydWarshallResult | |
| ForceDirectedLayoutParameters | Parameters for the force directed layout |
| GeneratedGridBackgroundOptions | Options for the generated grid background. This background is still in beta as of 5.10.6. |
| Geometry | Geometry defines the path along which a connector travels. The internal contents of a Geometry vary widely between connectors. |
| GhostProxyingDragHandler | |
| GraphObject | |
| GraphOptions | |
| Grid | Definition of a grid - the width/height of each cell, and, optionally, a threshold value for each axis to use when trying to snap some coordinate to the grid. |
| GroupAddedParams | |
| GroupCollapsedParams | |
| GroupDefinition | A group definition in a view. |
| GroupDeletion | |
| GroupExpandedParams | |
| GroupMemberAddedParams | |
| GroupMemberRemovedParams | |
| GroupOptions | |
| GroupRemovedParams | |
| HasScore | |
| HierarchicalLayoutParameters | Parameters for the Hierarchical Layout. |
| HierarchyLayoutEdgeNodeEntry | |
| HierarchyLayoutParameters | Optional parameters for a Hierarchy layout |
| Hit | |
| IIfExecution | |
| ImageBackground | |
| ImageBackgroundOptions | Options for an image background |
| ImageExportOptions | Options for an image export. |
| ImageExportUIOptions | Options for the image export UI. |
| IndexDocument | |
| IndexEntry | |
| IngestOptions | Options for the ingest method |
| InspectorOptions | Options for an inspector. |
| InternalConnectParams | Internal extension of ConnectParams containing a few extra things needed to establish a connection. |
| InternalEndpointOptions | |
| InternalSurfacePluginOptions | |
| IntersectingObjectData | |
| JsPlumbDefaults | |
| jsPlumbDOMElement | |
| jsPlumbDragManager | |
| jsPlumbElement | |
| JsPlumbListOptions | Constructor options for a list. |
| jsPlumbToolkitDOMElement | |
| jsPlumbToolkitDOMInformation | |
| JsPlumbToolkitGlobal | |
| JsPlumbToolkitOptions | Constructor options for a Toolkit instance. |
| jsPlumbToolkitSearchIndexOptions | Options for the search index. |
| LabelOverlayOptions | |
| LassoOptions | |
| LassoPluginOptions | |
| LayoutParameters | Base interface for layout parameters. All layout parameter interfaces extend this. |
| LightweightAnchor | |
| LightweightContinuousAnchor | |
| LightweightPerimeterAnchor | |
| ListManagerOptions | |
| ListSpec | |
| LoadOptions | Options for loading data. |
| MagnetizerOptions | |
| MagnetizerRunOptions | |
| ManageElementParams | Payload for an element managed event |
| MiniviewPluginOptions | |
| ModelOptions | |
| NodeAddedParams | |
| NodeDefinition | A node definition in a view. |
| NodeDeletion | |
| NodeRemovedParams | |
| ObjectInfo | |
| OrthogonalConnectorGeometry | The format used to load/export orthogonal connector geometry |
| OrthogonalConnectorOptions | Options for an orthogonal connector. |
| OrthogonalEditorActivationParams | |
| OrthogonalEditorOptions | |
| OverlayAnimationOptions | Options for animating an overlay along an edge |
| OverlayMouseEventParams | |
| OverlayOptions | |
| PaintStyle | |
| PanButtonsPluginOptions | |
| PanZoomOptions | Options for the PanZoom widget. This widget is used internally by the Toolkit and is not something users of the library will need to interact with. |
| ParentRelativePlacementStrategyOptions | |
| PasteOptions | |
| PathOptions | Path specification. |
| PerimeterAnchorOptions | Constructor options for a Perimeter Anchor. |
| PinchListenerOptions | Pinch listener for all touch browsers - ipad, android, and windows laptops/surfaces. Needless to say, every browser does it differently. IE10+ uses PointerEvents; ipad safari/windows chrome/ipad chrome/ android chrome use TouchEvents. The listener posts pinchstart, pinch happening, and pinch end events. |
| PointXY | Defines an x/y location. |
| PortAddedParams | |
| PortDefinition | A port definition in a view. |
| PortRemovedParams | |
| PortUpdatedParams | |
| PropertyMapping | |
| PropertyMappings | |
| RectangleEndpointParams | |
| RedrawResult | |
| RendererAddedParams | |
| ResultSet | |
| Router | |
| SaveOptions | Options for a save via ajax. |
| SegmentedConnectorGeometry | The format used to load/export segmented connector geometry 7.0.0 |
| SegmentedConnectorOptions | Options for an orthogonal connector. 7.0.0 |
| SegmentedEditorActivationParams | |
| SegmentedEditorOptions | |
| SegmentParams | |
| SelectEndpointOptions | |
| SelectionOptions | Options for the behaviour of a selection. |
| SelectOptions | |
| ShapeLibraryPaletteOptions | Options for a shape library palette. |
| ShapeSet | Defines a set of shapes. This is the interface you should extend if you wish to supply custom shape sets to the widget. |
| ShapeType | Defines a shape type. If you wish to supply custom shape types you should extend this interface. |
| ShortestPathComponent | |
| ShortestPathResult | |
| ShowOptions | Defines the allowed options to the show method. |
| Size | Defines the width and height of some element. |
| SourceDefinition | Defines the supported options on an addSourceSelector call. |
| SourceOrTargetDefinition | Base interface for source/target definitions |
| StateMachineOptions | |
| StatePluginOptions | |
| StraightConnectorGeometry | |
| SurfaceDragOptions | Options for element drag in a Surface. |
| SurfaceDropManagerOptions | Options for the SurfaceDropManager. |
| SurfaceEdgeAddedParams | Payload for an edge:added event from a surface. |
| SurfaceGridOptions | |
| SurfaceGroupAddedParams | Payload for a group:added event from the Surface. |
| SurfaceGroupCollapsedParams | Payload for a group:collapse event from a surface |
| SurfaceGroupExpandedParams | Payload for a group:expand event from a surface |
| SurfaceGroupMemberAddedParams | Payload for a group:member:added event from the Surface. |
| SurfaceGroupMemberRemovedParams | Payload for a group:member:removed event from the Surface. |
| SurfaceGroupRemovedParams | Payload for a group:removed event from the Surface. |
| SurfaceGroupResizedParams | Payload for a group:resize event from a surface. |
| SurfaceMagnetizeOptions | Options for the magnetize functionality of the Surface. |
| SurfaceNodeAddedParams | Payload for a node:added event from the Surface. |
| SurfaceNodeRemovedParams | Payload for a node:removed event from the Surface. |
| SurfaceObjectInfo | |
| SurfacePanZoomParams | Payload for a pan/zoom event from a surface. |
| SurfacePlugin | |
| SurfacePluginOptions | |
| SurfacePortRemovedParams | Payload for a port:removed event from a Surface. |
| SurfaceRenderOptions | This interface defines the allowed parameters on a render call that will create a new Surface. |
| SurfaceSelector | |
| SurfaceVertexAddedParams | Payload for a node:added or group:added event from the Surface. |
| SurfaceVertexMoveStartParams | Payload for the node:move:start event that is fired when a node/group has just begun to be moved. |
| SurfaceVertexRemovedParams | Parent payload for a node:removed or group:removed event from the Surface. |
| SurfaceViewOptions | |
| SurfaceWheelOptions | |
| SvgExportOptions | Options for SVG export. |
| SvgExportUIOptions | Options for the SVG export UI. |
| SynthesizedEvent | An object conforming to enough of the Event interface to be used to trigger events in the DOM. |
| TargetDefinition | Defines the supported options on an addTargetSelector call. |
| TemplateRenderer | Defines a template renderer |
| TiledBackgroundOptions | |
| ToolkitRenderer | |
| TypeDescriptor | Base interface for type descriptors for public methods. |
| UIComponent | |
| UINodeDefinition | |
| UiStatesPluginOptions | |
| UIStatesSurfaceViewOptions | |
| UndoRedoUpdateParams | |
| UnmanageElementParams | Payload for an element unmanaged event. |
| UpdateOffsetOptions | Options for the UpdateOffset method |
| VanillaInspectorOptions | Options for the VanillaInspector, an instance of Inspector that uses the Toolkit's default templating mechanism to render elements. |
| VanillaSurfaceRenderOptions | Constructor options for the BrowserUI class. |
| VertexDefinition | Base class for node, group and port definitions. This interface is shared by the model and the view. |
| VertexMovedParams | |
| VertexUpdatedParams | |
| ViewEdgeOptions | The mapping for the definition of an edge inside a view. |
| ViewGroupOptions | The mapping for the definition of a group inside a view. |
| ViewNodeOptions | The mapping for the definition of a node inside a view. |
| ViewNodeOrPortOptions | Base view definition options for nodes and ports (and groups, since they extend nodes) |
| ViewOptionsCommon | Common options for edge/node/group/port definitions in a view. |
| ViewportBounds | Models the current bounds of a viewport, containing its left/top, width/height, padding and current zoom. |
| ViewPortOptions | Definition of a port inside a view. |
| ViewportPosition | Definition of some element's location and rotation in the viewport. |
| WheelOptions | Options for how to respond to wheel events. |
Variables
Type Aliases
| Type Alias | Description |
|---|---|
| AnchorId | List of entries in the AnchorLocations enum |
| AnchorOrientationHint | |
| AnchorSpec | Models the specification of anchor - which may be a SingleAnchorSpec, or an array of SingleAnchorSpec objects. |
| AnimationEvent | |
| AnimationEventCallbackParams | The type defining the object that is passed to all events fired by the tracePath method. |
| AnimationPhase | |
| ArrayAnchorSpec | An anchor spec in the form [ x, y, ox, oy ] |
| Axis | |
| AxisCoefficients | |
| BackgroundType | Type of a background - the values from the BackgroundTypes enum. |
| BeforeConnectInterceptor | Definition of a function to use as a beforeConnect interceptor. |
| BeforeConnectionDetachInterceptor | Defines the method signature for the callback to the beforeDetach interceptor. Returning false from this method prevents the connection from being detached. The interceptor is fired by the core, meaning that it will be invoked regardless of whether the detach occurred programmatically, or via the mouse. |
| BeforeConnectionDropInterceptor | Defines the method signature for the callback to the beforeDrop interceptor. |
| BeforeDetachInterceptor | A function to run before the given edge is detached from the given source vertex. If this method returns false, the detach will be aborted. |
| BeforeDragInterceptor | Defines the method signature for the callback to the beforeDrag interceptor. This method can return boolean false to abort the connection drag, or it can return an object containing values that will be used as the data for the connection that is created. |
| BeforeMoveConnectionInterceptor | A function to run before an edge of the given type is relocated from its current source or target to a new source or target. Returning false from this method will abort the move. |
| BeforeStartConnectInterceptor | A function to run before an edge of the given type is dragged from the given source. Returning false from this method will abort the connection. |
| BeforeStartConnectionDetachInterceptor | Defines the method signature for the callback to the beforeStartDetach interceptor. |
| BeforeStartDetachInterceptor | A function to run before the given edge is detached from the given source vertex. If this method returns false, the detach will be aborted. The difference between this and beforeDetach is that this method is fired as soon as a user tries to detach an edge from an endpoint in the UI, whereas beforeDetach allows a user to detach the edge in the UI. |
| BezierEditorMode | |
| BindableEvent | |
| BoundingBox | Defines the bounding box for some element - its x/y location, width and height, and optionally the computed center, but that can of course be calculated from the other values. Internally there are times when the code has this to hand so we include it here. |
| CancelFunction | |
| CanvasDropFilter | Defines a function used to filter drop on a canvas |
| CanvasDropFunction | Defines the function invoked when an item is dropped onto whitespace in the canvas. |
| ChildEdgesFunction | |
| ChildVerticesFunction | |
| CloseFunction | |
| ClosestPointCandidate | |
| CommitFunction | |
| ComponentParameters | |
| ComputedBlankEndpoint | |
| ComputedDotEndpoint | |
| ComputedRectangleEndpoint | |
| ConnectionOverlayAnimator | Definition of the control surface for a specific segment in the tracePath method. |
| ConnectorComputeParams | |
| ConnectorId | Alias for the use case that a Connector is referenced just by its type. |
| ConnectorSpec | Specification of a connector - either the type id of some Connector, a type+options object. |
| ConnectorWithOptions | Connector spec in the form {type:.., options:{.. }} |
| ConstrainFunction | Definition of a function that can be used to constrain the movemement of an element that is being dragged. The function is given the "desiredLoc", which is the location the element would be moved to if not constrained, and it is expected to return either some other value, meaning place the element at that position, or null, meaning for the given desired location there is no preferred position and the element should not be moved. |
| Constructable | Defines an object that has a constructor. Used internally to create endpoints/connectors/overlays from their names. Exposed as public for people to create their own endpoints/connectors/overlays. |
| Crossings | |
| CurrentState | |
| Curve | |
| DataGeneratorFunction | Defines the function that is invoked to gather a dataset to associate with an item that is being dragged. |
| DecorateParams | |
| DecoratorSpec | |
| DeleteConnectionOptions | Optional parameters to the DeleteConnection method. |
| DistanceFromCurve | |
| DragFunction | Defines the callback function invoked when an item is being dragged. |
| DraggedElement | |
| DragGroupSpec | Definition of a drag group membership - either just the id of a drag group, or the id of a drag group and whether or not this element plays an active role in the drag group. |
| DropFilter | |
| DropFunction | Defines the function invoked when an item is dropped onto an existing vertex. |
| EdgeDropFilter | Defines a function used to filter drop on an edge. |
| EdgeDropFunction | Defines the function invoked when an item is dropped on an edge. |
| EdgePropertyMappings | |
| ElementSelectionSpecifier | |
| ElementType | |
| EndpointHelperFunctions | |
| EndpointId | |
| EndpointParams | |
| EndpointSpec | |
| EnhancedCrossing | |
| EnhancedCrossings | |
| Exporter | |
| Face | |
| FilterFunction | |
| FixedElementConstraint | |
| FixedElementConstraints | |
| FullAnchorSpec | An anchor spec in the form {type:..., options:{ ... }} |
| FullDecoratorSpec | |
| FullEndpointSpec | |
| FullOverlaySpec | |
| FullPluginSpec | |
| GetPositionFunction | |
| GetSizeFunction | |
| GhostProxyGenerator | |
| GridType | |
| GroupIdentifierFunction | Defines the function that is invoked to determine whether an item that is about to be dragged represents a group. |
| GroupLocation | |
| HasId | |
| HierarchicalLayoutAlignment | Possible values for the align option on a Hierarchical layout. |
| HierarchicalLayoutChildVerticesFunction | |
| HierarchicalLayoutOrientation | Possible values for hierarchical layout orientation. horizontal means that the layers of vertices are arranged horizontally. vertical means the layers of vertices are arranged vertically. |
| HierarchicalLayoutSpacing | Defines the type of the spacing option on a Hierarchical layout. |
| HierarchyLayoutAlignment | |
| HierarchyLayoutAxis | |
| HierarchyLayoutOrdering | |
| IdFunction | |
| ImageReadyFunction | |
| IntersectingElementsFilter | |
| IntersectingGroup | |
| IntersectingVertex | |
| jsPlumbToolkitSearchResults | |
| LayerSet | |
| LineXY | Defines a line from some point to another. |
| LocationFunction | Defines a function that, given some vertex, can provide the x/y location of the vertex on the canvas. During a group layout, the second argument will contain the group that is being laid out, but when running the layout for the main canvas, parentGroup will not be provided. |
| MagnetizerConstrainFunction | |
| ManagedElement | |
| Margins | |
| MaybeCloseFunction | |
| ModelEventCallback | |
| ObjectAnchorSpec | |
| ObjectData | |
| ObjectFactory | Definition of a function that can act as a factory for model objects. |
| OnBackgroundReadyCallback | Callback from the SimpleBackground when the background image has loaded. |
| OpenFunction | |
| Orientation | |
| OverlaySpec | |
| PageBounds | |
| PageDimensions | |
| PageSize | |
| PanAxis | Axes in which the canvas can be panned - x, y, or both. |
| Parser | |
| PathTransportListener | |
| PlacementStageStrategy | |
| PointOnPath | |
| PositioningStrategy | |
| Quadrant | |
| RectangleXY | This is an alias for BoundingBox. |
| RedropPolicy | Defines how redrop of source endpoints can be done. |
| RevertEventParams | |
| RevertFunction | |
| SearchDocumentIdFunction | |
| SegmentContext | |
| SegmentEditorInfo | |
| SegmentMoveResult | |
| SelectionList | |
| SelectionMode | Possible modes for a selection. |
| SetPositionFunction | |
| SetSizeFunction | |
| ShapeGeneratorFunction | Defines a function that can take a vertex's data object and return a document fragment with it rendered. |
| SingleAnchorSpec | Models the specification of a single anchor. |
| Sorter | |
| StraightSegmentCoordinates | |
| SupportsClassManipulation | List of entities whose class, in the visual representation, can be manipulated. |
| SupportsClassManipulationElement | Models some entity whose class, in the visual representation, can be manipulated. |
| SurfaceBindableEvent | |
| SurfaceEvent | |
| SurfacePluginSpec | |
| TemplateResolver | Resolves the content for some template, via id. |
| TileSpecs | |
| TilingStrategy | Tiling strategy - the values from the TilingStrategies enum |
| Token | |
| Tokenizer | |
| TransactionCleanupAction | Defines the available actions in response to a new transaction being opened when one is currently open. |
| TranslatedViewportElement | |
| TypeFunction | |
| TypeGeneratorFunction | Defines the function invoked to determine the type of some item that is about to be dragged. |
| Units | |
| UserDefinedEndpointId | |
| UUID | |
| VertexDefinitionEvents | Allowed event bindings for vertices in a view. |
| VertexUpdatedReason | |
| ViewEventOptions | |
| ViewOptionsEntry | |
| ZoomRange | Models the minimum and maximum values in an allowed zoom range. These value are expressed decimals: 0.5 means 50%, for instance. |