Skip to main content

Home > @jsplumbtoolkit/browser-ui > UIPath

UIPath class#

A wrapper around the Toolkit's path object, which offers a few DOM specific methods.

Signature:

export declare class UIPath 

Constructors#

ConstructorModifiersDescription
(constructor)(path, surface)Constructs a new instance of the UIPath class

Properties#

PropertyModifiersTypeDescription
pathPath

Methods#

MethodModifiersDescription
addClass(clazz)Adds a CSS class to the elements representing the vertices and edges in the path
addEdgeClass(clazz)Adds a CSS class to the elements representing the edges in the path
addVertexClass(clazz)Adds a CSS class to the elements representing the vertices in the path
getEdgeCount()Gets the total number of edges in the path.
getVertexCount()Gets the count of vertices in the path.
removeClass(clazz)Removes a CSS class from the elements representing the vertices and edges in the path
removeEdgeClass(clazz)Removes a CSS class from the elements representing the edges in the path
removeVertexClass(clazz)Removes a CSS class from the elements representing the vertices in the path
setVisible(val)Sets the visible state of all vertices and edges in the path