Class VertexAbstract

addGraph

• addGraph(g): Graph

• Adds a sub-graph to this vertex. If you provide an existing Graph instance that does not have an id, one will be assigned.

  Parameters

  • g: string | Graph

    Either a Graph instance, or the id you wish to assign to a new Graph.

  Returns Graph

  The Graph that was added.

AbstractgetAllEdges

• getAllEdges(params?): Edge[]

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

  Parameters

  • Optionalparams: {
        filter: ((e: Edge) => boolean);
    }

    • filter: ((e: Edge) => boolean)

      • • (e): boolean

        • Parameters

          • e: Edge

          Returns boolean

  Returns Edge[]

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

  • Optionalparams: {
        filter: ((e: Edge) => boolean);
    }

    • filter: ((e: Edge) => boolean)

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

      • • (e): boolean

        • Parameters

          • e: Edge

          Returns boolean

  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

getGraph

• getGraph(id): Graph

• Retrieves a sub-graph by id. *

  Parameters

  • id: string

  Returns Graph

  Sub-graph with the given id, null if not found.

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[]

getTargetEdges

• getTargetEdges(): Edge[]

• Gets all Edges where this Vertex is the target.

  Returns Edge[]

inspect

• inspect(): string

• Returns a string representation of the Vertex. *

  Returns string

  Vertex dumped to a string.

id

Optionaltransient