Class UIPath

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

Index

Constructors

Properties

Methods

addClass addEdgeClass addVertexClass getEdgeCount getVertexCount removeClass removeEdgeClass removeVertexClass setVisible

Constructors

constructor

new UIPath(path, surface): UIPath
Parameters
- path: Path
  Underlying path object.
- surface: Surface
  The surface that constructed this path.
Returns UIPath

Properties

path

path: Path

Underlying path object.

`Private` surface

surface: Surface

The surface that constructed this path.

Methods

addClass

addClass(clazz): void
Adds a CSS class to the elements representing the vertices and edges in the path
Parameters
- clazz: string
Returns void

addEdgeClass

addEdgeClass(clazz): void
Adds a CSS class to the elements representing the edges in the path
Parameters
- clazz: string
Returns void

addVertexClass

addVertexClass(clazz): void
Adds a CSS class to the elements representing the vertices in the path
Parameters
- clazz: string
Returns void

getEdgeCount

getEdgeCount(): number
Gets the total number of edges in the path.

Returns number

getVertexCount

getVertexCount(): number
Gets the count of vertices in the path.

Returns number

removeClass

removeClass(clazz): void
Removes a CSS class from the elements representing the vertices and edges in the path
Parameters
- clazz: string
Returns void

removeEdgeClass

removeEdgeClass(clazz): void
Removes a CSS class from the elements representing the edges in the path
Parameters
- clazz: string
Returns void

removeVertexClass

removeVertexClass(clazz): void
Removes a CSS class from the elements representing the vertices in the path
Parameters
- clazz: string
Returns void

setVisible

setVisible(val): void
Sets the visible state of all vertices and edges in the path
Parameters
- val: boolean
Returns void