Class NodeCollection<N, D, S>

A collection of nodes from a given graph. All nodes have a common node type. If the nodes can be of any node type, the common type is BaseNode.

Type Parameters

N extends BaseNode.Class<D, S>
D extends BaseNode.Data = Node.ExtractData<N>
S extends BaseNode.ScratchData = Node.ExtractScratchData<N>

Indexable

[index: number]: N
Access the node at the given index.

Accessors

isEmpty

get isEmpty(): boolean
Returns boolean
Whether this collection is empty.
- Defined in lara-flow/src/graph/NodeCollection.ts:213

length

get length(): number
Returns number
The number of nodes in this collection.
- Defined in lara-flow/src/graph/NodeCollection.ts:206

outgoers

get outgoers(): EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>, BaseEdge.Data, BaseEdge.ScratchData>
Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>, BaseEdge.Data, BaseEdge.ScratchData>
The edges coming out of the nodes in this collection.
- Defined in lara-flow/src/graph/NodeCollection.ts:291

parents

get parents(): NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>
Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>
The parents of the nodes in this collection.
- Defined in lara-flow/src/graph/NodeCollection.ts:232

predecessors

get predecessors(): NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>
Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>
The predecessors of the nodes in this collection. This repeatedly follows the sources of incoming edges.
- Defined in lara-flow/src/graph/NodeCollection.ts:279

successors

get successors(): NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>
Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>
The successors of the nodes in this collection. This repeatedly follows the targets of outgoing edges.
- Defined in lara-flow/src/graph/NodeCollection.ts:304

totalDegree

get totalDegree(): number
Returns the total degree of all nodes in the collection. Loop edges are counted twice.

Returns number
the total degree of this collection.
- Defined in lara-flow/src/graph/NodeCollection.ts:722

totalDegreeWithoutLoops

get totalDegreeWithoutLoops(): number
Returns the total degree of all nodes in the collection. Loop edges are not counted.

Returns number
the total degree of this collection, excluding loop edges.
- Defined in lara-flow/src/graph/NodeCollection.ts:732

Methods

[iterator]

[iterator](): Iterator<N, void, any>
Makes this class behave like an iterable object.

Returns Iterator<N, void, any>
- Defined in lara-flow/src/graph/NodeCollection.ts:1016

allAre

allAre<N2, D2, S2>(NodeType): this is NodeCollection<BaseNode.Class<D2, S2>, D2, S2>
Checks if all nodes in this collection are compatible with a specific type. This is effectively a type guard function.
Type Parameters
- N2 extends BaseNode.Class<D2, S2>
- D2 extends BaseNode.Data
- S2 extends BaseNode.ScratchData
Parameters
- NodeType: Node<D2, S2, N2>
  The node type to check compatibility with.
Returns this is NodeCollection<BaseNode.Class<D2, S2>, D2, S2>
Whether the node is compatible with the given type.
- Defined in lara-flow/src/graph/NodeCollection.ts:383

allAs

allAs<N>(NodeType): NodeCollection<N, D, S>
Changes the functionality class of the nodes. This is only possible if the data and scratch data are compatible with the new class.

This is analogous to BaseNode.Class.as but for a collection of nodes.
Type Parameters
- N extends BaseNode.Class<D, S>
Parameters
- NodeType: {
  Class: Node.Class<D, S, N>;
  }
  The node type to change the functionality class into.
  - Class: Node.Class<D, S, N>
Returns NodeCollection<N, D, S>
The same collection, with the new functionality class.
- Defined in lara-flow/src/graph/NodeCollection.ts:428

at

at(index): undefined | N
Access the node at the given index. This is similar to indexing, but has undefined in the return type.
Parameters
- index: number
  The index of the node to access.
Returns undefined | N
The node at the given index, or undefined if it does not exist.
- Defined in lara-flow/src/graph/NodeCollection.ts:181

commonAncestors

commonAncestors(): NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>
Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>
The common ancestors of all nodes in the collection, starting with the closest and getting progressively farther.
- Defined in lara-flow/src/graph/NodeCollection.ts:740

compareDiff

compareDiff<D2, S2, N2>(other): {
    both: NodeCollection<N, D, S>;
    onlyLeft: NodeCollection<N, D, S>;
    onlyRight: NodeCollection<N2, D2, S2>;
}
Performs a diff comparison between this collection and another collection. You can think of the result as the added, removed, and kept elements to go from this collection to the other collection.
Type Parameters
- D2 extends BaseNode.Data
- S2 extends BaseNode.ScratchData
- N2 extends BaseNode.Class<D2, S2>
Parameters
- other: NodeCollection<N2, D2, S2>
  The other collection to compare with.
Returns {
    both: NodeCollection<N, D, S>;
    onlyLeft: NodeCollection<N, D, S>;
    onlyRight: NodeCollection<N2, D2, S2>;
}
An object with three properties:
- both: A collection with the nodes that are in both collections. The type of this collection is maintained.
- onlyLeft: A collection with the nodes that are only in this collection. The type of this collection is maintained.
- onlyRight: A collection with the nodes that are only in the other collection. The type of the other collection is maintained.
- both: NodeCollection<N, D, S>
- onlyLeft: NodeCollection<N, D, S>
- onlyRight: NodeCollection<N2, D2, S2>
- Defined in lara-flow/src/graph/NodeCollection.ts:673

complement

complement(): NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>
Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>
The complement of this collection with respect to the universe of all nodes in the graph.
- Defined in lara-flow/src/graph/NodeCollection.ts:588

contains

contains<N2, D2, S2>(elements): boolean
Returns whether the collection contains the given node or collection.
Type Parameters
- N2 extends BaseNode.Class<D2, S2>
- D2 extends BaseNode.Data
- S2 extends BaseNode.ScratchData
Parameters
- elements: N2 | NodeCollection<N2, D2, S2>
  The node or collection to check for.
Returns boolean
Whether the collection contains the given node or collection.
- Defined in lara-flow/src/graph/NodeCollection.ts:500

containsAny

containsAny<N2, D2, S2>(elements): boolean
Returns whether the collection contains any of the nodes in the given collection.
Type Parameters
- N2 extends BaseNode.Class<D2, S2>
- D2 extends BaseNode.Data
- S2 extends BaseNode.ScratchData
Parameters
- elements: NodeCollection<N2, D2, S2>
  The collection to check for.
Returns boolean
Whether the collection contains any of the nodes in the given collection.
- Defined in lara-flow/src/graph/NodeCollection.ts:514

difference

difference<D2, S2>(other): NodeCollection<N, D, S>
Returns the set difference of this collection with another collection. You may chain this method to remove multiple collections.
Type Parameters
- D2 extends BaseNode.Data
- S2 extends BaseNode.ScratchData
Parameters
- other: NodeCollection<BaseNode.Class<D2, S2>, D2, S2>
  The other collection.
Returns NodeCollection<N, D, S>
A new collection that consists of the nodes in this collection that are not in the other collection.
- Defined in lara-flow/src/graph/NodeCollection.ts:600

edgesFrom

edgesFrom(nodes): EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>, BaseEdge.Data, BaseEdge.ScratchData>
Retrieves the edges from the given nodes to this collection.
Parameters
- nodes: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData> | NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>
  The node or collection of nodes to check for edges connected with this collection.
Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>, BaseEdge.Data, BaseEdge.ScratchData>
The edges from the given nodes to this collection.
- Defined in lara-flow/src/graph/NodeCollection.ts:367

edgesTo

edgesTo(nodes): EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>, BaseEdge.Data, BaseEdge.ScratchData>
Retrieves the edges from this collection to the given nodes.
Parameters
- nodes: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData> | NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>
  The node or collection of nodes to check for edges connected with this collection.
Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>, BaseEdge.Data, BaseEdge.ScratchData>
The edges from this collection to the given nodes.
- Defined in lara-flow/src/graph/NodeCollection.ts:351

edgesWith

edgesWith(nodes): EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>, BaseEdge.Data, BaseEdge.ScratchData>
Retrieves the edges that connect this collection with the given nodes. Direction is not considered.
Parameters
- nodes: BaseNode.Class<BaseNode.Data, BaseNode.ScratchData> | NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>
  The node or collection of nodes to check for edges connected with this collection.
Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>, BaseEdge.Data, BaseEdge.ScratchData>
The edges that connect this collection with the given nodes.
- Defined in lara-flow/src/graph/NodeCollection.ts:335

every

every(f): boolean
Returns whether all nodes in the collection satisfy the provided function. Returns true for an empty collection.
Parameters
- f: ((ele: N, i: number, eles: this) => boolean)
  The function to test each node. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (ele, i, eles): boolean
    - Parameters
      ele: N
      i: number
      eles: this
      Returns boolean
Returns boolean
Whether all nodes in the collection satisfy the function.
- Defined in lara-flow/src/graph/NodeCollection.ts:791
every<T>(f, thisArg): boolean
Returns whether all nodes in the collection satisfy the provided function. Returns true for an empty collection.
Type Parameters
- T
Parameters
- f: ((this: T, ele: N, i: number, eles: this) => boolean)
  The function to test each node. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (this, ele, i, eles): boolean
    - Parameters
      this: T
      ele: N
      i: number
      eles: this
      Returns boolean
- thisArg: T
  The value to use as this when executing the function.
Returns boolean
Whether all nodes in the collection satisfy the function.
- Defined in lara-flow/src/graph/NodeCollection.ts:801

expectAll

expectAll<N2, D2, S2>(NodeType, message?): NodeCollection<N2, D2, S2>
Changes the functionality class of the nodes. Should only be used when it is known (but not statically provable) that all nodes are compatible with the new class. If not, an error will be thrown.

It is bad practice to try and catch the error thrown by this function. For such cases, combine NodeCollection.allAre with NodeCollection.allAs.
Type Parameters
- N2 extends BaseNode.Class<D2, S2>
- D2 extends BaseNode.Data
- S2 extends BaseNode.ScratchData
Parameters
- NodeType: Node<D2, S2, N2>
  The node type to change the functionality class into.
- Optionalmessage: string | ((i: number) => string)
  The message to throw if the node is not compatible with the type. May also be a function that takes the index of the first incompatible node and returns a message.
Returns NodeCollection<N2, D2, S2>
The node collection, wrapped in the new functionality class.

Throws
LaraFlowError if any node is not compatible with the type. This error should be seen as a logic error and not catched.
- Defined in lara-flow/src/graph/NodeCollection.ts:453

filter

filter(f): NodeCollection<N, D, S>
Returns a new collection containing only the nodes that satisfy the provided function.
Parameters
- f: ((ele: N, i: number, eles: this) => boolean)
  The function to test each node. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (ele, i, eles): boolean
    - Parameters
      ele: N
      i: number
      eles: this
      Returns boolean
Returns NodeCollection<N, D, S>
A new collection containing only the nodes that satisfy the function.
- Defined in lara-flow/src/graph/NodeCollection.ts:868
filter<T>(f, thisArg): NodeCollection<N, D, S>
Returns a new collection containing only the nodes that satisfy the provided function.
Type Parameters
- T
Parameters
- f: ((this: T, ele: N, i: number, eles: this) => boolean)
  The function to test each node. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (this, ele, i, eles): boolean
    - Parameters
      this: T
      ele: N
      i: number
      eles: this
      Returns boolean
- thisArg: T
  The value to use as this when executing the function.
Returns NodeCollection<N, D, S>
A new collection containing only the nodes that satisfy the function.
- Defined in lara-flow/src/graph/NodeCollection.ts:878

filterIs

filterIs<N2, D2, S2>(NodeType): NodeCollection<N2, D2, S2>
Filters the collection, keeping only the nodes that are compatible with the given type. The collection automatically becomes a collection of that type.
Type Parameters
- N2 extends BaseNode.Class<D2, S2>
- D2 extends BaseNode.Data
- S2 extends BaseNode.ScratchData
Parameters
- NodeType: Node<D2, S2, N2>
  The node type to test compatibility with.
Returns NodeCollection<N2, D2, S2>
The collection, with the new node type.
- Defined in lara-flow/src/graph/NodeCollection.ts:407

first

first(): undefined | N
Get the first node in the collection.

Returns undefined | N
- Defined in lara-flow/src/graph/NodeCollection.ts:192

forEach

forEach(f): void
Executes the provided function once for each node in the collection.

Unline the analogous cytoscape method, this method does not support exiting early by returning false, due to the fact that a return false; would not be clear and intuitive for someone reading the code. As such, this function follows the behavior of the Array.prototype.forEach method.

In the future, if that feature is really desirable, instead of returning false, the function could return an enum value that represents a control flow instruction. Until then, a for loop may be used.
Parameters
- f: ((ele: N, i: number, eles: this) => void)
  The function to execute for each node. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (ele, i, eles): void
    - Parameters
      ele: N
      i: number
      eles: this
      Returns void
Returns void
- Defined in lara-flow/src/graph/NodeCollection.ts:832
forEach<T>(f, thisArg): void
Executes the provided function once for each node in the collection.

Unline the analogous cytoscape method, this method does not support exiting early by returning false, due to the fact that a return false; would not be clear and intuitive for someone reading the code. As such, this function follows the behavior of the Array.prototype.forEach method.

In the future, if that feature is really desirable, instead of returning false, the function could return an enum value that represents a control flow instruction. Until then, a for loop may be used.
Type Parameters
- T
Parameters
- f: ((this: T, ele: N, i: number, eles: this) => void)
  The function to execute for each node. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (this, ele, i, eles): void
    - Parameters
      this: T
      ele: N
      i: number
      eles: this
      Returns void
- thisArg: T
  The value to use as this when executing the function.
Returns void
- Defined in lara-flow/src/graph/NodeCollection.ts:849

getElementById

getElementById(id): undefined | N
Parameters
- id: string
Returns undefined | N
The node with the given id, or undefined if it is not in this collection.
- Defined in lara-flow/src/graph/NodeCollection.ts:221

intersection

intersection<D2, S2>(other): NodeCollection<N, D, S>
Returns the intersection of this collection with another collection. You may chain this method to intersect multiple collections.
Type Parameters
- D2 extends BaseNode.Data
- S2 extends BaseNode.ScratchData
Parameters
- other: NodeCollection<BaseNode.Class<D2, S2>, D2, S2>
  The other collection to intersect with.
Returns NodeCollection<N, D, S>
A new collection containing the intersection of all nodes.
- Defined in lara-flow/src/graph/NodeCollection.ts:573

last

last(): undefined | N
Get the last node in the collection.

Returns undefined | N
- Defined in lara-flow/src/graph/NodeCollection.ts:199

max

max(f): undefined | {
element: N;
value: number;
}
Find the maximum value in a collection.
Parameters
- f: ((ele: N, i: number, eles: this) => number)
  The function that returns the value to compare. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (ele, i, eles): number
    - Parameters
      ele: N
      i: number
      eles: this
      Returns number
Returns undefined | {
element: N;
value: number;
}
An object with the maximum element and its value, or undefined if the collection is empty.
- Defined in lara-flow/src/graph/NodeCollection.ts:956
max<T>(f, thisArg): undefined | {
element: N;
value: number;
}
Find the maximum value in a collection.
Type Parameters
- T
Parameters
- f: ((this: T, ele: N, i: number, eles: this) => number)
  The function that returns the value to compare. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (this, ele, i, eles): number
    - Parameters
      this: T
      ele: N
      i: number
      eles: this
      Returns number
- thisArg: T
  The value to use as this when executing the function.
Returns undefined | {
element: N;
value: number;
}
An object with the maximum element and its value, or undefined if the collection is empty.
- Defined in lara-flow/src/graph/NodeCollection.ts:969

min

min(f): undefined | {
element: N;
value: number;
}
Find the minimum value in a collection.
Parameters
- f: ((ele: N, i: number, eles: this) => number)
  The function that returns the value to compare. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (ele, i, eles): number
    - Parameters
      ele: N
      i: number
      eles: this
      Returns number
Returns undefined | {
element: N;
value: number;
}
An object with the minimum element and its value, or undefined if the collection is empty.
- Defined in lara-flow/src/graph/NodeCollection.ts:909
min<T>(f, thisArg): undefined | {
element: N;
value: number;
}
Find the minimum value in a collection.
Type Parameters
- T
Parameters
- f: ((this: T, ele: N, i: number, eles: this) => number)
  The function that returns the value to compare. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (this, ele, i, eles): number
    - Parameters
      this: T
      ele: N
      i: number
      eles: this
      Returns number
- thisArg: T
  The value to use as this when executing the function.
Returns undefined | {
element: N;
value: number;
}
An object with the minimum element and its value, or undefined if the collection is empty.
- Defined in lara-flow/src/graph/NodeCollection.ts:922

same

same<N2, D2, S2>(other): boolean
Returns whether the elements in the collection are the same as the elements in the other collection.
Type Parameters
- N2 extends BaseNode.Class<D2, S2>
- D2 extends BaseNode.Data
- S2 extends BaseNode.ScratchData
Parameters
- other: NodeCollection<N2, D2, S2>
  The other collection to compare with.
Returns boolean
Whether the elements in the collection are the same as the elements in the other collection.
- Defined in lara-flow/src/graph/NodeCollection.ts:486

slice

slice(start?, end?): NodeCollection<N, D, S>
Get a subset of the elements in the collection based on specified indices.
Parameters
- Optionalstart: number
  An integer that specifies where to start the selection. If omitted, the first element, with an index of 0, will be selected. Use negative numbers to select from the end of an array.
- Optionalend: number
  An integer that specifies where to end the selection. If omitted, all elements from the start position and to the end of the array will be selected. Use negative numbers to select from the end of an array.
Returns NodeCollection<N, D, S>
A new collection containing the selected elements.
- Defined in lara-flow/src/graph/NodeCollection.ts:1004

some

some(f): boolean
Returns whether any node in the collection satisfies the provided function. Returns false for an empty collection.
Parameters
- f: ((ele: N, i: number, eles: this) => boolean)
  The function to test each node. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (ele, i, eles): boolean
    - Parameters
      ele: N
      i: number
      eles: this
      Returns boolean
Returns boolean
Whether any node in the collection satisfies the function.
- Defined in lara-flow/src/graph/NodeCollection.ts:757
some<T>(f, thisArg): boolean
Returns whether any node in the collection satisfies the provided function. Returns false for an empty collection.
Type Parameters
- T
Parameters
- f: ((this: T, ele: N, i: number, eles: this) => boolean)
  The function to test each node. ele - The current element, i - The index of the current element, eles - The collection of elements being iterated.
  - - (this, ele, i, eles): boolean
    - Parameters
      this: T
      ele: N
      i: number
      eles: this
      Returns boolean
- thisArg: T
  The value to use as this when executing the function.
Returns boolean
Whether any node in the collection satisfies the function.
- Defined in lara-flow/src/graph/NodeCollection.ts:767

sort

sort(f): NodeCollection<N, D, S>
Returns a collection with the elements sorted according to the given comparison function.

Regarding the return value of the comparison function:
- A negative value indicates that a should come before b.
- A positive value indicates that a should come after b.
- Zero or NaN indicates that a and b are considered equal.
Parameters
- f: ((a: N, b: N) => number)
  The comparison function to use for sorting.
  - - (a, b): number
    - Parameters
      a: N
      b: N
      Returns number
Returns NodeCollection<N, D, S>
A new collection with the elements sorted.
- Defined in lara-flow/src/graph/NodeCollection.ts:705

symmetricDifference

symmetricDifference<D2, S2>(other): NodeCollection<N, D, S>
Returns the symmetric difference of this collection with another collection. This collection consists of the nodes that are in either collection, but not in both.

If the rhs collection is a subtype of the lhs collection, the resulting collection will have the lhs type.
Type Parameters
- D2 extends BaseNode.Data
- S2 extends BaseNode.ScratchData
Parameters
- other: NodeCollection<BaseNode.Class<D2, S2>, D2, S2>
  The other collection to apply the symmetric difference with.
Returns NodeCollection<N, D, S>
A new collection containing the symmetric difference of the two collections.

Throws
LaraFlowError if the other collection is from a different graph.
- Defined in lara-flow/src/graph/NodeCollection.ts:624
symmetricDifference<D2, S2>(other): NodeCollection<BaseNode.Class<D | D2, S | S2>, D | D2, S | S2>
Returns the symmetric difference of this collection with another collection. This collection consists of the nodes that are in either collection, but not in both.

If the rhs collection is not a subtype of the lhs collection, the resulting collection will be downgraded to a BaseNode and must be casted to the desired type explicitly with NodeCollection.allAs.
Type Parameters
- D2 extends BaseNode.Data
- S2 extends BaseNode.ScratchData
Parameters
- other: NodeCollection<BaseNode.Class<D2, S2>, D2, S2>
  The other collection to apply the symmetric difference with.
Returns NodeCollection<BaseNode.Class<D | D2, S | S2>, D | D2, S | S2>
A new collection containing the symmetric difference of the two collections.

Throws
LaraFlowError if the other collection is from a different graph.
- Defined in lara-flow/src/graph/NodeCollection.ts:641

toArray

toArray(): N[]
Returns N[]
This collection as an array of nodes.
- Defined in lara-flow/src/graph/NodeCollection.ts:1025

toCy

toCy(): NodeCollection
Returns NodeCollection
The underlying cytoscape collection object.
- Defined in lara-flow/src/graph/NodeCollection.ts:1039

union

union<D2, S2>(other): NodeCollection<N, D, S>
Returns the union of this collection with another collection. You may chain this method to union multiple collections.

If the rhs collection is a subtype of the lhs collection, the resulting collection will have the lhs type.
Type Parameters
- D2 extends BaseNode.Data
- S2 extends BaseNode.ScratchData
Parameters
- other: NodeCollection<BaseNode.Class<D2, S2>, D2, S2>
  The other collection to union with.
Returns NodeCollection<N, D, S>
A new collection containing the union of all nodes.

Throws
LaraFlowError if the other collection is from a different graph.
- Defined in lara-flow/src/graph/NodeCollection.ts:533
union<D2, S2>(other): NodeCollection<BaseNode.Class<D | D2, S | S2>, D | D2, S | S2>
Returns the union of this collection with another collection. You may chain this method to union multiple collections.

If the rhs collection is not a subtype of the lhs collection, the resulting collection will be downgraded to a BaseNode and must be casted to the desired type explicitly with NodeCollection.allAs.
Type Parameters
- D2 extends BaseNode.Data
- S2 extends BaseNode.ScratchData
Parameters
- other: NodeCollection<BaseNode.Class<D2, S2>, D2, S2>
  The other collection to union with.
Returns NodeCollection<BaseNode.Class<D | D2, S | S2>, D | D2, S | S2>
A new collection containing the union of all nodes.

Throws
LaraFlowError if the other collection is from a different graph.
- Defined in lara-flow/src/graph/NodeCollection.ts:548

`Static`from

from<N, D, S>(first, ...elements): NodeCollection<N, D, S>
Creates a new collection from the given nodes. At least one node must be provided. For an empty collection, use BaseGraph.Class.emptyCollection.
Type Parameters
- N extends BaseNode.Class<D, S>
- D extends BaseNode.Data
- S extends BaseNode.ScratchData
Parameters
- first: N
  The first node in the collection.
- Rest...elements: N[]
  The rest of the nodes in the collection.
Returns NodeCollection<N, D, S>
A new collection containing the given nodes.
- Defined in lara-flow/src/graph/NodeCollection.ts:114

`Static`fromCy

fromCy(nodes): NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>
Creates a new collection from the given cytoscape collection.
Parameters
- nodes: NodeCollection
  The cytoscape collection to create the collection from.
Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>
A new collection containing the nodes from the cytoscape collection.
- Defined in lara-flow/src/graph/NodeCollection.ts:143

Class NodeCollection<N, D, S>

Type Parameters

Indexable

Index

Accessors

Methods

Accessors

adjacentEdges

Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>, BaseEdge.Data, BaseEdge.ScratchData>

adjacentNodes

Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>

ancestors

Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>

children

Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>

descendants

Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>

graph

Returns BaseGraph.Class<BaseGraph.Data, BaseGraph.ScratchData>

incomers

Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>, BaseEdge.Data, BaseEdge.ScratchData>

isEmpty

Returns boolean

length

Returns number

outgoers

Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>, BaseEdge.Data, BaseEdge.ScratchData>

parents

Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>

predecessors

Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>

successors

Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>

totalDegree

Returns number

totalDegreeWithoutLoops

Returns number

Methods

[iterator]

Returns Iterator<N, void, any>

allAre

Type Parameters

Parameters

Returns this is NodeCollection<BaseNode.Class<D2, S2>, D2, S2>

allAs

Type Parameters

Parameters

Class: Node.Class<D, S, N>

Returns NodeCollection<N, D, S>

at

Parameters

Returns undefined | N

commonAncestors

Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>

compareDiff

Type Parameters

Parameters

Returns { both: NodeCollection<N, D, S>; onlyLeft: NodeCollection<N, D, S>; onlyRight: NodeCollection<N2, D2, S2>; }

both: NodeCollection<N, D, S>

onlyLeft: NodeCollection<N, D, S>

onlyRight: NodeCollection<N2, D2, S2>

complement

Returns NodeCollection<BaseNode.Class<BaseNode.Data, BaseNode.ScratchData>, BaseNode.Data, BaseNode.ScratchData>

contains

Type Parameters

Parameters

Returns boolean

containsAny

Type Parameters

Parameters

Returns boolean

difference

Type Parameters

Parameters

Returns NodeCollection<N, D, S>

edgesFrom

Parameters

Returns EdgeCollection<BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>, BaseEdge.Data, BaseEdge.ScratchData>

edgesTo

Parameters

Returns {
both: NodeCollection<N, D, S>;
onlyLeft: NodeCollection<N, D, S>;
onlyRight: NodeCollection<N2, D2, S2>;
}

Returns undefined | {
element: N;
value: number;
}

Returns undefined | {
element: N;
value: number;
}

Returns undefined | {
element: N;
value: number;
}