Class DataNodeCollection

[iterator]

• [iterator](): Iterator<DataNode, any, undefined>

• Returns Iterator<DataNode, any, undefined>

ReadonlyItem

Count

• get Count(): number

• Gets the number of nodes in the collection.

  Returns number

  Since

  2.0

IndexMap

• get IndexMap(): NodeToRowIndexMap

• Gets the mapping between the rows in the column/table and the nodes in the hierarchy level.

  Returns NodeToRowIndexMap

  Since

  2.0

GetChildren

• GetChildren(nodeIndex): DataNodeCollection

• Get the child nodes given a node index.

  Parameters

  • nodeIndex: number | Int32

    The node index.

  Returns DataNodeCollection

  A collection of child nodes, could be empty.

  Since

  2.0

• GetChildren(nodes): DataNodeCollection

• Get the child nodes given an enumeration of node indexes.

  Parameters

  • nodes: OrExplicit<System.Collections.Generic.IEnumerable<number | Int32>>

    The node indexes to get children for.

  Returns DataNodeCollection

  A collection of the child nodes, could be empty.

  Since

  2.0

GetEnumerator

• GetEnumerator(): System.Collections.Generic.IEnumerator<DataNode>

• Returns an enumerator that iterates through the collection.

  Returns System.Collections.Generic.IEnumerator<DataNode>

  A System.Collections.Generic.IEnumerator that can be used to iterate through the collection.

  Since

  2.0

• GetEnumerator(dataNodeProducer): System.Collections.Generic.IEnumerable<DataNode>

• Get an enumerator of the nodes in the collection.

  Parameters

  • dataNodeProducer: IDataNodeProducer

    An Spotfire.Dxp.Data.IDataNodeProducer to create the DataNode used when enumerating.

  Returns System.Collections.Generic.IEnumerable<DataNode>

  An enumerator of the nodes.

  Since

  2.0

• GetEnumerator(nodes, dataNodeProducer): System.Collections.Generic.IEnumerable<DataNode>

• Get an enumerator of a subset of the nodes in the collection.

  Parameters

  • nodes: OrExplicit<System.Collections.Generic.IEnumerable<number | Int32>>

    An enumerator of the node indexes to enumerate.
  • dataNodeProducer: IDataNodeProducer

    An Spotfire.Dxp.Data.IDataNodeProducer to create the DataNode used when enumerating.

  Returns System.Collections.Generic.IEnumerable<DataNode>

  An enumerator of the nodes.

  Since

  2.0

GetParents

• GetParents(nodeIndex): DataNodeCollection

• Get the parent nodes given a node index.

  Parameters

  • nodeIndex: number | Int32

    The node index.

  Returns DataNodeCollection

  A collection of the parent nodes, could be empty.

  Since

  2.0

• GetParents(nodes): DataNodeCollection

• Get the parent nodes given an enumeration of node indexes.

  Parameters

  • nodes: OrExplicit<System.Collections.Generic.IEnumerable<number | Int32>>

    The node indexes to get parents for.

  Returns DataNodeCollection

  A collection of the parent nodes, could be empty.

  Since

  2.0

GetSiblings

• GetSiblings(nodeIndex): DataNodeCollection

• Get the siblings given a node index.

  Parameters

  • nodeIndex: number | Int32

    The node index.

  Returns DataNodeCollection

  A collection of sibling nodes, could be empty.

  Since

  2.0

IndexOf

• IndexOf(value): number

• Get the index of the node that has the given value.

  Parameters

  • value: any

    The node value to find the index for.

  Returns number

  The index of a node which has the given value, or -1 if no node could be found.

  Since

  2.0

Intersect

• Intersect(dataNodeCollection): DataNodeCollection

• Get the intersection of the node collections. The nodes must be defined on the same hierarchy level.

  Parameters

  • dataNodeCollection: DataNodeCollection

    The node collection to intersect with.

  Returns DataNodeCollection

  A collection of the nodes that intersect.

  Since

  2.0

Subset

• Subset(nodes): DataNodeCollection

• Get a subset of the nodes in the collection.

  Parameters

  • nodes: OrExplicit<System.Collections.Generic.IEnumerable<number | Int32>>

    The nodes to include in the subset.

  Returns DataNodeCollection

  A collection which contains the nodes in the subset.

  Since

  2.0

Subtract

• Subtract(dataNodeCollection): DataNodeCollection

• Create a new node collection where the nodes in the argument collection are removed from this collection. The nodes must be defined on the same hierarchy level.

  Parameters

  • dataNodeCollection: DataNodeCollection

    The node collection which defines which nodes to remove.

  Returns DataNodeCollection

  A collection where the argument nodes are removed.

  Since

  2.0

Toggle

• Toggle(dataNodeCollection): DataNodeCollection

• Toggle the nodes (xor) between the two collections. The nodes must be defined on the same hierarchy level.

  Parameters

  • dataNodeCollection: DataNodeCollection

    The node collection to toggle with.

  Returns DataNodeCollection

  A collection of the toggle of the nodes.

  Since

  2.0

Union

• Union(dataNodeCollection): DataNodeCollection

• Get the union of the node collections. The nodes must be defined on the same hierarchy level.

  Parameters

  • dataNodeCollection: DataNodeCollection

    The node collection to union with.

  Returns DataNodeCollection

  A collection of the union of the nodes.

  Since

  2.0