Home > @jsplumbtoolkit/browser-ui
browser-ui package
Classes
| Class | Description |
|---|---|
| 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. |
| BrowserUIMagnetizer | An extension of the Magnetizer that knows about the DOM, offering an executeAtEvent method that takes a MouseEvent as the focus of the operation. |
| 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. |
| Decorator | |
| FixedLayer | |
| GroupLayoutAdapter | Layout adapter that operates on a single group. TODO why exactly does |
| 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 | 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. |
| PinchListener | |
| Surface | |
| UIPath | A wrapper around the Toolkit's path object, which offers a few DOM specific methods. |
| xml |
Enumerations
| Enumeration | Description |
|---|---|
| PanAxes | Axes in which the canvas can be panned - x, y, or both. |
| SurfaceMode |
Functions
| Function | Description |
|---|---|
| addWheelListener(el, callback, ignoreTouchWheelEvents, requireMetaKey) | |
| ajax(params) | Basic ajax function. |
| attWithValue(att, value) | |
| debounce(fn, timeout) | Create a debounced version of the given function. |
| getAbsolutePosition(element) | Returns the position of the given element, as reported by the left and top properties of the element's style. |
| mergeWithParents(type, map, shouldOverride) | Extract the definition(s) with the given type and merge them, |
| registerDecorator(name, dec) | |
| removeWheelListener(el, callback) | |
| 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. |
| setSize(element, w, h) | Sets the size of the given DOM element, by setting values for width and height on the element's style. |
| shouldOverrideEndpoints(p, from) |
Interfaces
| Interface | Description |
|---|---|
| Background | |
| ConnectorEditor | |
| ConnectorEditorActivateParams | |
| ConnectorEditorFactory | |
| ConstructableConnectorEditor | |
| ImageBackground | |
| IngestOptions | Options for the ingest method |
| InternalSurfacePluginOptions | |
| IntersectingObjectData | |
| jsPlumbToolkitDOMElement | |
| jsPlumbToolkitDOMInformation | |
| ModelOptions | |
| 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. |
| 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. |
| PropertyMapping | |
| PropertyMappings | |
| SurfaceDragOptions | |
| SurfaceEdgeAddedParams | Payload for an edge:added event from a surface. |
| SurfaceGridOptions | Options for the grid in a Surface. |
| 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 | |
| TemplateRenderer | Defines a template renderer |
| UINodeDefinition | |
| 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. |
| WheelOptions | Options for how to respond to wheel events. |
Variables
Type Aliases
| Type Alias | Description |
|---|---|
| BindableEvent | |
| DecorateParams | |
| DecoratorSpec | |
| EdgePropertyMappings | |
| FixedElementConstraint | |
| FixedElementConstraints | |
| FullDecoratorSpec | |
| FullPluginSpec | |
| IntersectingElementsFilter | |
| IntersectingVertex | |
| ModelEventCallback | |
| PanAxis | Axes in which the canvas can be panned - x, y, or both. |
| 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 | |
| VertexDefinitionEvents | Allowed event bindings for vertices in a view. |
| 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. |