Class DataNodeCollection

A collection of nodes in a hierarchy level.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- DataNodeCollection

Implements

Index

Methods

[iterator] Cast Equals GetHashCode ToString TryCast Equals

Default capability

Item Count IndexMap GetChildren GetEnumerator GetParents GetSiblings IndexOf Intersect Subset Subtract Toggle Union

Methods

[iterator]

"[iterator]"(): Iterator<Spotfire.Dxp.Data.DataNode>
Returns Iterator<Spotfire.Dxp.Data.DataNode>

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Object.Cast

Equals

Equals(obj: any): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from Object.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Object.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): T1 | null
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1 | null
Inherited from Object.TryCast

`Static`Equals

Equals(objA: any, objB: any): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from Object.Equals

Default capability

`Readonly`Item

Item: PropertyGet<number | System.Int32, Spotfire.Dxp.Data.DataNode>

Gets the node at the given index.

Param: index

The index of the node.

Returns

The node at the given index.

Since

2.0

Count

get Count(): number
Gets the number of nodes in the collection.

Returns number
Since
2.0

IndexMap

get IndexMap(): Spotfire.Dxp.Data.NodeToRowIndexMap
Gets the mapping between the rows in the column/table and the nodes in the hierarchy level.

Returns Spotfire.Dxp.Data.NodeToRowIndexMap
Since
2.0

GetChildren

GetChildren(
nodeIndex: number | System.Int32,
): Spotfire.Dxp.Data.DataNodeCollection
Get the child nodes given a node index.
Parameters
- nodeIndex: number | System.Int32
  The node index.
Returns Spotfire.Dxp.Data.DataNodeCollection
A collection of child nodes, could be empty.

Since
2.0
GetChildren(
    nodes: OrExplicit<
        System.Collections.Generic.IEnumerable<number | System.Int32>,
    >,
): Spotfire.Dxp.Data.DataNodeCollection
Get the child nodes given an enumeration of node indexes.
Parameters
- nodes: OrExplicit<System.Collections.Generic.IEnumerable<number | System.Int32>>
  The node indexes to get children for.
Returns Spotfire.Dxp.Data.DataNodeCollection
A collection of the child nodes, could be empty.

Since
2.0

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<
Spotfire.Dxp.Data.DataNode,
>
Returns an enumerator that iterates through the collection.

Returns System.Collections.Generic.IEnumerator<Spotfire.Dxp.Data.DataNode>
A System.Collections.Generic.IEnumerator that can be used to iterate through the collection.

Since
2.0
GetEnumerator(
dataNodeProducer: Spotfire.Dxp.Data.IDataNodeProducer,
): System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.DataNode>
Get an enumerator of the nodes in the collection.
Parameters
- dataNodeProducer: Spotfire.Dxp.Data.IDataNodeProducer
  An Spotfire.Dxp.Data.IDataNodeProducer to create the DataNode used when enumerating.
Returns System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.DataNode>
An enumerator of the nodes.

Since
2.0
GetEnumerator(
    nodes: OrExplicit<
        System.Collections.Generic.IEnumerable<number | System.Int32>,
    >,
    dataNodeProducer: Spotfire.Dxp.Data.IDataNodeProducer,
): System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.DataNode>
Get an enumerator of a subset of the nodes in the collection.
Parameters
- nodes: OrExplicit<System.Collections.Generic.IEnumerable<number | System.Int32>>
  An enumerator of the node indexes to enumerate.
- dataNodeProducer: Spotfire.Dxp.Data.IDataNodeProducer
  An Spotfire.Dxp.Data.IDataNodeProducer to create the DataNode used when enumerating.
Returns System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.DataNode>
An enumerator of the nodes.

Since
2.0

GetParents

GetParents(
nodeIndex: number | System.Int32,
): Spotfire.Dxp.Data.DataNodeCollection
Get the parent nodes given a node index.
Parameters
- nodeIndex: number | System.Int32
  The node index.
Returns Spotfire.Dxp.Data.DataNodeCollection
A collection of the parent nodes, could be empty.

Since
2.0
GetParents(
    nodes: OrExplicit<
        System.Collections.Generic.IEnumerable<number | System.Int32>,
    >,
): Spotfire.Dxp.Data.DataNodeCollection
Get the parent nodes given an enumeration of node indexes.
Parameters
- nodes: OrExplicit<System.Collections.Generic.IEnumerable<number | System.Int32>>
  The node indexes to get parents for.
Returns Spotfire.Dxp.Data.DataNodeCollection
A collection of the parent nodes, could be empty.

Since
2.0

GetSiblings

GetSiblings(
nodeIndex: number | System.Int32,
): Spotfire.Dxp.Data.DataNodeCollection
Get the siblings given a node index.
Parameters
- nodeIndex: number | System.Int32
  The node index.
Returns Spotfire.Dxp.Data.DataNodeCollection
A collection of sibling nodes, could be empty.

Since
2.0

IndexOf

IndexOf(value: any): 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: Spotfire.Dxp.Data.DataNodeCollection,
): Spotfire.Dxp.Data.DataNodeCollection
Get the intersection of the node collections. The nodes must be defined on the same hierarchy level.
Parameters
- dataNodeCollection: Spotfire.Dxp.Data.DataNodeCollection
  The node collection to intersect with.
Returns Spotfire.Dxp.Data.DataNodeCollection
A collection of the nodes that intersect.

Since
2.0

Subset

Subset(
    nodes: OrExplicit<
        System.Collections.Generic.IEnumerable<number | System.Int32>,
    >,
): Spotfire.Dxp.Data.DataNodeCollection
Get a subset of the nodes in the collection.
Parameters
- nodes: OrExplicit<System.Collections.Generic.IEnumerable<number | System.Int32>>
  The nodes to include in the subset.
Returns Spotfire.Dxp.Data.DataNodeCollection
A collection which contains the nodes in the subset.

Since
2.0

Subtract

Subtract(
dataNodeCollection: Spotfire.Dxp.Data.DataNodeCollection,
): Spotfire.Dxp.Data.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: Spotfire.Dxp.Data.DataNodeCollection
  The node collection which defines which nodes to remove.
Returns Spotfire.Dxp.Data.DataNodeCollection
A collection where the argument nodes are removed.

Since
2.0

Toggle

Toggle(
dataNodeCollection: Spotfire.Dxp.Data.DataNodeCollection,
): Spotfire.Dxp.Data.DataNodeCollection
Toggle the nodes (xor) between the two collections. The nodes must be defined on the same hierarchy level.
Parameters
- dataNodeCollection: Spotfire.Dxp.Data.DataNodeCollection
  The node collection to toggle with.
Returns Spotfire.Dxp.Data.DataNodeCollection
A collection of the toggle of the nodes.

Since
2.0

Union

Union(
dataNodeCollection: Spotfire.Dxp.Data.DataNodeCollection,
): Spotfire.Dxp.Data.DataNodeCollection
Get the union of the node collections. The nodes must be defined on the same hierarchy level.
Parameters
- dataNodeCollection: Spotfire.Dxp.Data.DataNodeCollection
  The node collection to union with.
Returns Spotfire.Dxp.Data.DataNodeCollection
A collection of the union of the nodes.

Since
2.0

Class DataNodeCollection

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

[iterator]

Returns Iterator<Spotfire.Dxp.Data.DataNode>

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns T1 | null

StaticEquals

Parameters

Returns boolean

Default capability

ReadonlyItem

Param: index

Returns

Since

Count

Returns number

Since

IndexMap

Returns Spotfire.Dxp.Data.NodeToRowIndexMap

Since

GetChildren

Parameters

Returns Spotfire.Dxp.Data.DataNodeCollection

Since

Parameters

Returns Spotfire.Dxp.Data.DataNodeCollection

Since

GetEnumerator

Returns System.Collections.Generic.IEnumerator<Spotfire.Dxp.Data.DataNode>

Since

Parameters

Returns System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.DataNode>

Since

Parameters

Returns System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.DataNode>

Since

GetParents

Parameters

Returns Spotfire.Dxp.Data.DataNodeCollection

Since

Parameters

Returns Spotfire.Dxp.Data.DataNodeCollection

Since

GetSiblings

Parameters

Returns Spotfire.Dxp.Data.DataNodeCollection

Since

IndexOf

Parameters

Returns number

Since

Intersect

Parameters

Returns Spotfire.Dxp.Data.DataNodeCollection

Since

Subset

Parameters

Returns Spotfire.Dxp.Data.DataNodeCollection

Since

Subtract

Parameters

`Static`Equals

`Readonly`Item