Class Port

A Port models a logical connection point on some vertex. Examples are things like columns on a database table, or yes/no outputs in a flowchart question, or, from the real world, TCP ports on a server

Hierarchy (view full)

Methods

addGraph getAllEdges getAttribute getEdges getFullId getGraph getIndegreeCentrality getOutdegreeCentrality getParent getSourceEdges getTargetEdges inspect isChildOf setAttribute

Properties

data id transient? type

Methods

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.

getAllEdges

  • getAllEdges(params?): Edge[]

  • gets all the edges connected to this port, as source or target.

    Parameters

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

          • Parameters

            Returns boolean

    Returns Edge[]

getAttribute

  • getAttribute(key): string

  • Sets some attribute on the object.

    Parameters

    • key: string

    Returns string

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

            Returns boolean

    Returns Edge[]

    List of matching edges.

    See

    #getAllEdges.

getFullId

  • getFullId(): string

  • Overrides the getFullId of Node to return a value in dotted notation of the form nodeId.portId.

    Returns string

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

getParent

  • getParent(): Node

  • Gets the vertex this Port belongs to. Remember that Group extends Node, so this could be a Group, but Ports cannot have child Ports.

    Returns Node

getSourceEdges

getTargetEdges

inspect

  • inspect(): string

  • Returns a string representation of the Vertex. *

    Returns string

    Vertex dumped to a string.

isChildOf

  • isChildOf(v): boolean

  • Returns whether or not this port is a child of the given object.

    Parameters

    Returns boolean

setAttribute

  • setAttribute(key, value): void

  • Gets some attribute from the object.

    Parameters

    • key: string
    • value: string

    Returns void

Properties

data

data: ObjectData

Underlying data for the object.

id

id: string

The vertex's id. A string.

Optionaltransient

transient?: boolean

Transient vertices are created at various points in the lifecycle of a renderer, such as dragging new edges, and are not exported in the dataset

type

type: string

Type of the object

Settings

Member Visibility

On This Page

Methods
Properties
Version :