Skip to main content

Home > @jsplumbtoolkit/browser-ui-vanilla-2

browser-ui-vanilla-2 package

Classes

ClassDescription
BrowserUIConcrete instance of JsPlumbToolkit that uses the templates-2 package as its renderer.

Functions

FunctionDescription
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 id and type of Nodes and Edges, if you need to. This method will throw an error if your jsPlumb instance does not have a Container set; it is a requirement for the Surface widget.

When you ingest an existing jsPlumb instance, its Container is configured to be a Surface widget, which makes it pannable and zoomable, and the set of Nodes and Edges it is managing are loaded into the Toolkit's data model.

newInstance(options)
ready(f)

Interfaces

InterfaceDescription
CustomTagDefinitionCustom tags let you define your own tags and attach behaviour to them.
JsPlumbToolkitGlobal
VanillaSurfaceRenderOptionsConstructor options for the BrowserUI class.