core 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. |
AbstractLayout | Base class for all layouts. |
AddGroupMemberAction | |
AutoSaver | |
Base | |
CatchAllEventHandler | |
Cluster | |
Edge | |
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. |
Graph | |
Group | |
GroupCollapseAction | |
GroupExpandAction | |
GroupRemoveAction | |
JsPlumbToolkit | Core Toolkit functionality. This class is extended by renderer specific subclasses. |
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 |
Node | |
Path | Models the path between two Nodes/Ports, which consists of a series of [Group/Node/Port, Edge] pairs. |
Port | |
PortAddAction | |
PortRemoveAction | |
RemoveGroupMemberAction | |
Selection | A selection is a group of vertices and edges, upon which you can perform bulk operations. |
TerminusAddAction | |
TerminusRemoveAction | |
Vertex |
Functions
Function | Description |
---|---|
calculateSpacingAdjustment(r1, r2) | |
data(inObj, path, value) | Extract a value from, or set a value into, an object. This static method can be used outside of Knockle. |
defaultIdFunction(obj) | |
djikstra(params) | |
exportData(type, toolkit, parameters) | Internal method that handles data export, by looking for an exporter registered for the given type . |
floydWarshall(params) | |
isEdge(obj) | |
isGroup(obj) | |
isGroupVertex(v) | |
isNestedGroup(obj) | |
isNode(obj) | |
isNodeInsideAGroup(obj) | |
isNodeVertex(v) | |
isPort(obj) | |
isPortVertex(v) | |
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. |
registerExporter(name, p) | |
registerParser(name, p) | |
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) |
Interfaces
Variables
Type Aliases
Type Alias | Description |
---|---|
BeforeConnectInterceptor | Definition of a function to use as a beforeConnect 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. |
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. |
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. |
Exporter | |
FilterFunction | |
IdFunction | |
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 | |
ObjectData | |
ObjectFactory | Definition of a function that can act as a factory for model objects. |
Parser | |
TransactionCleanupAction | Defines the available actions in response to a new transaction being opened when one is currently open. |
TypeFunction | |
VertexUpdatedReason |