Class Graph

A directed/undirected graph. Each instance of JsPlumb has a Graph at its core.

Methods

addEdge addGroup addNodes deleteEdge deleteGroup findPath getAllEdges getAncestors getBetweenness getCloseness getClusters getDiameter getDistance getEdge getEdgeCount getEdges getFarness getGroupAt getGroups getIndegreeCentrality getOutdegreeCentrality getPortSeparator getType getVertexAt getVertexByPortId getVertexCount getVertices isAncestor legacySerialize printPath serialize setEnableSubgraphs setPortSeparator setSource setTarget splitPortId

Methods

addEdge

  • addEdge(params, idFunction?, connectableFilterFunction?): Edge

  • Adds an edge to the graph.

    Parameters

    • params: AddEdgeOptions
    • OptionalidFunction: IdFunction
    • OptionalconnectableFilterFunction: Function

    Returns Edge

addGroup

addNodes

  • addNodes(data, idFunction?): void

  • Adds a list of Nodes to the Graph

    Parameters

    • data: ObjectData[]

      List of data objects, one for each Node to be added.

    • OptionalidFunction: IdFunction

      Optional function to use to retrieve ID from backing data. Defaults to retrieving id from data object.

    Returns void

deleteEdge

  • deleteEdge(edge): void

  • Deletes an Edge.

    Parameters

    • edge: string | Edge

      Edge, or ID of Edge, to delete.

    Returns void

deleteGroup

  • deleteGroup(g, removeMembers?): GroupDeletion

  • Deletes a Group

    Parameters

    • g: string | Group

      Either a Group, or a Group id.

    • OptionalremoveMembers: boolean

      If true, also remove all the Nodes/Groups that are members of the Group.

    Returns GroupDeletion

findPath

  • findPath(source, target, strict?, nodeFilter?, edgeFilter?): ShortestPathResult

  • Finds the shortest path from source to target, using the Djikstra algorithm.

    Parameters

    • source: string | Vertex

      Source Node or Node ID.

    • target: string | Vertex

      Target Node or Node ID.

    • Optionalstrict: boolean

      Defaults to true. Sets whether or not paths are searched strictly by the given source/target. If, for instance, you supply a node as the source, but there are only edges connected to ports on that node, by default these edges will be ignored. Switching strict to false will mean these edges are considered.

    • OptionalnodeFilter: Function

      Optional function that is given each Node's backing data and asked to return true or false - true means include the Node, false means exclude it.

    • OptionaledgeFilter: Function

      Optional function that is given each Edge's backing data and asked to return true or false - true means include the Edge, false means exclude it.

    Returns ShortestPathResult

    A ShortestPathResult object.

getAllEdges

  • getAllEdges(): Edge[]

  • Gets every edge in the Graph.

    Returns Edge[]

getAncestors

  • getAncestors(vertex): Group[]

  • Gets a list of groups that are ancestors of the given node/group/port. The list of ancestors is ordered in terms of their proximity to the focus, ie. the first entry is the focus vertex's immediate parent.

    Parameters

    Returns Group[]

getBetweenness

  • getBetweenness(vertex): number

  • Returns the betweenness centrality of the given node.

    Parameters

    • vertex: string | Vertex

      Vertex, or Vertex ID, to retrieve betweenness centrality for.

    Returns number

    Vertex's "betweenness" centrality.

getCloseness

  • getCloseness(vertex): number

  • Returns the Closeness centrality of the given vertex. This is the inverse of the vertex's farness.

    Parameters

    • vertex: string | Vertex

      Vertex, or Vertex ID, to retrieve closeness for.

    Returns number

    Node's "closeness".

    See

    getFarness

getClusters

  • getClusters(): Cluster[]

  • Calculates "clusters" of nodes (and groups), where a 'cluster' is a set of Nodes/Groups that are connected. Direction of connections is not taken into account. Nodes that are children of Groups are included in all cluster calculations, which might cause some weird situations, but this functionality is mostly intended just for Nodes anyway.

    Returns Cluster[]

    An array of arrays, each entry being a list of nodes in the cluster.

getDiameter

  • getDiameter(dontUseMax?): number

  • Returns the diameter of the Graph.

    Parameters

    • OptionaldontUseMax: boolean

      Whether or not to return Infinity if there is at least one pair of nodes for which there is no available path. Defaults to false.

    Returns number

    Diameter of the Graph.

getDistance

  • getDistance(source, target, strict?): number

  • Finds the distance between source and target.

    Parameters

    • source: Vertex

      Source vertex or vertex ID.

    • target: Vertex

      Target vertex or vertex ID.

    • Optionalstrict: boolean

      Defauls to true. Sets whether or not paths are searched strictly by the given source/target. If, for instance, you supply a node as the source, but there are only edges connected to ports on that node, by default these edges will be ignored. Switching strict to false will mean these edges are considered.

    Returns number

    Distance from the source to the target.

getEdge

  • getEdge(e): Edge

  • Gets an Edge by id, or if the given object is already an Edge, hands that back.

    Parameters

    • e: any

      ID of the Edge to retrieve, or an actual Edge, or some data from which an ID could be derived.

    Returns Edge

    The requested Edge, if found, otherwise null.

getEdgeCount

  • getEdgeCount(): number

  • Returns the total number of Edges in the graph.

    Returns number

    The total number of Edges.

getEdges

  • getEdges(params?): Edge[]

  • For some given node, get a subset of edges that match the given filter function.

    Parameters

    • Optionalparams: {
          filter?: ((e: Edge) => boolean);
          node?: string | Vertex;
          source?: boolean;
          target?: boolean;
      }

      Method parameters

      • Optionalfilter?: ((e: Edge) => boolean)

        Optional edge filter.

          • (e): boolean

          • Parameters

            Returns boolean

      • Optionalnode?: string | Vertex
      • Optionalsource?: boolean

        If true, only match edges for which this node is the source.

      • Optionaltarget?: boolean

        If true, only match edges for which this node is the target.

    Returns Edge[]

getFarness

  • getFarness(vertex): number

  • Returns the farness centrality of the given node, ie. the sum of its distance from all other nodes, where the distance from one vertex to another is given by the associated cost of the Edge joining the two nodes.

    Parameters

    • vertex: string | Vertex

      Vertex, or Vertex ID, to retrieve farness for.

    Returns number

    Vertex's "farness".

getGroupAt

  • getGroupAt(idx): Group

  • Returns the Group at the given index.

    Parameters

    • idx: number

      Index into group list

    Returns Group

    a Group, or null if not found.

getGroups

  • getGroups(): Group[]

  • Gets the Groups in the graph.

    Returns Group[]

    All the groups in the Graph.

getIndegreeCentrality

  • getIndegreeCentrality(vertex): number

  • Returns the indegree centrality of the given vertex (number of connections entering the vertex)

    Parameters

    • vertex: string | Vertex

      Vertex, or Vertex ID, to retrieve indegree centrality for.

    Returns number

    Vertex's indegree centrality.

getOutdegreeCentrality

  • getOutdegreeCentrality(vertex): number

  • Returns the outdegree centrality of the given vertex (number of connections exiting the vertex)

    Parameters

    • vertex: string | Vertex

      Vertex, or Vertex ID, to retrieve outdegree centrality for.

    Returns number

    Vertex's indegree centrality.

getPortSeparator

  • getPortSeparator(): string

  • Gets the current port separator.

    Returns string

    Port separator string. Default is "."

getType

  • getType(data): string

  • Gets the type for some data, by running it through the current typeFunction.

    Parameters

    Returns string

    The calculated type for the given object.

getVertexAt

  • getVertexAt(index): Node

  • Returns the vertex at the given index (used for bulk init type purposes)

    Parameters

    • index: number

      Index of the Node to retrieve

    Returns Node

    vertex at the given index.

getVertexByPortId

  • getVertexByPortId(portId): Vertex

  • Looks up a vertex identified by the port id, which is in full port id (vertexId.portId) format, returning null if nothing found. (Note that we show full port id format as vertexId.portId, but the '.' is just the default portSeparator; it is possible to change that to some other character)

    Parameters

    • portId: string

      ID of the port to find a vertex for.

    Returns Vertex

getVertexCount

  • getVertexCount(): number

  • Gets the count of nodes in the Graph.

    Returns number

getVertices

  • getVertices(): Node[]

  • Gets all the nodes in the Graph.

    Returns Node[]

isAncestor

  • isAncestor(focus, possibleAncestor): boolean

  • Returns whether or not possibleAncestor is in fact an ancestor of the given focus node/group/port

    Parameters

    Returns boolean

legacySerialize

  • legacySerialize(): any

  • This is the original serialize method, which writes out ports, unnecessarily. From 6.12.0 onwards the serializer does not write out ports, but you can - for the time being - use an export type of LEGACY_JSON to invoke this method.

    Returns any

    Deprecated

printPath

  • printPath(source, target): string

  • Returns the path from source to target as a string.

    Parameters

    Returns string

    Printed path. Mostly useful for debugging.

serialize

  • serialize(): any

  • Serialize the graph.

    Returns any

setEnableSubgraphs

  • setEnableSubgraphs(enable): void

  • Sets whether or not Nodes are Graphs themselves, and can have child Nodes. If you enable this then you cannot use slashes (/) in your Node ids, as they will be treated as components of a path to a Node in a nested Graph.

    Parameters

    • enable: boolean

      True to enable, false to disable.

    Returns void

setPortSeparator

  • setPortSeparator(separator): void

  • Sets the character(s) used to separate ports from nodes in port ids. By default this is '.', ie a port is addressed as nodeId.portId. This may need to be changed depending on the data in your model.

    Parameters

    • separator: string

      Separator to use.

    Returns void

setSource

  • setSource(edge, o): {
        edge?: Edge;
        new?: Vertex;
        old?: Vertex;
        success: boolean;
    }

  • Sets the source Group/Node/Port for some Edge.

    Parameters

    • edge: Edge

      The Edge to change the source for

    • o: string | Vertex

      Group/Node/Port or id for new Edge source

    Returns {
        edge?: Edge;
        new?: Vertex;
        old?: Vertex;
        success: boolean;
    }

setTarget

  • setTarget(edge, o): {
        edge?: Edge;
        new?: Vertex;
        old?: Vertex;
        success: boolean;
    }

  • Sets the target Group/Node/Port for some Edge.

    Parameters

    • edge: Edge

      The Edge to change the target for

    • o: string | Vertex

      group/Node/Port/id for new Edge target

    Returns {
        edge?: Edge;
        new?: Vertex;
        old?: Vertex;
        success: boolean;
    }

splitPortId

  • splitPortId(portId): string[]

  • Splits the given port id using the current portSeparator.

    Parameters

    • portId: string

      Port ID to split.

    Returns string[]

    An array of [ vertexId, portId], or [] if the portId was null.

Settings

Member Visibility

On This Page

Methods
Version :