Skip to main content

Vertex

Base vertex class, extended by Port and Node (which is itself extended by Group). A vertex models some entity in your app, and may have one or more edges to other vertices.

Extends​

Extended by​

Implements​

Methods​

getAllEdges()​

abstract getAllEdges(filter?): Edge[]

Gets all edges where this vertex - or any of its ports - are the source of target of the edge.

Parameters​

filter?​

(e) => boolean

Returns​

Edge[]

Implementation of​

AbstractEdgeTerminus.getAllEdges

getEdges()​

getEdges(params?): Edge[]

Gets all edges where this vertex is either the source or the target of the edge. Note that this does not retrieve edges on any ports associated with this Vertex - for that,

Parameters​

params?​
filter​

(e) => boolean

Optional function to test whether a given edge should be included.

Returns​

Edge[]

List of matching edges.

See​

#getAllEdges.

getFullId()​

getFullId(): string

Gets the Vertex's id, which, for Nodes and Groups, is just the id property. This method is overridden by Ports.

Returns​

string

Vertex id

Implementation of​

AbstractEdgeTerminus.getFullId

Overrides​

Base.getFullId

getIndegreeCentrality()​

getIndegreeCentrality(): number

Returns the indegree centrality of this vertex.

Returns​

number

getOutdegreeCentrality()​

getOutdegreeCentrality(): number

Returns the outdegree centrality of this vertex.

Returns​

number

getSourceEdges()​

getSourceEdges(): Edge[]

Gets all Edges where this Vertex is the source.

Returns​

Edge[]

Implementation of​

AbstractEdgeTerminus.getSourceEdges

getTargetEdges()​

getTargetEdges(): Edge[]

Gets all Edges where this Vertex is the target.

Returns​

Edge[]

Implementation of​

AbstractEdgeTerminus.getTargetEdges

inspect()​

inspect(): string

Returns a string representation of the Vertex. *

Returns​

string

Vertex dumped to a string.

Properties​

id​

id: string

The vertex's id. Must be a string.

Implementation of​

HasId.id

type​

type: string

Object's type.

Inherited from​

Base.type