About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class NodeToRowIndexMap

A mapping between the rows in the column/table and the nodes in a hierarchy level.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- NodeToRowIndexMap

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

NodeCount RowCount GetNodeIndex GetNodeIndexes GetRowIndex GetRowIndexes GetRowOccurrenceCount

Methods

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>): null | T1
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 null | T1
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

NodeCount

get NodeCount(): number
Gets the number of nodes.

Returns number
Since
2.0

RowCount

get RowCount(): number
Gets the number of rows in the column/table that the hierarchy is based on.

Returns number
Since
2.0

GetNodeIndex

GetNodeIndex(rowIndex: number | Int32): number
Get the node that the row maps to.
Parameters
- rowIndex: number | Int32
  The row index.
Returns number
The node index that the row maps to.

Since
2.0

GetNodeIndexes

GetNodeIndexes(rowIndexes: IndexSet): IndexSet
Get the node indexes that the rows maps to.
Parameters
- rowIndexes: IndexSet
  The row indexes.
Returns IndexSet
The node indexes that the rows maps to.

Since
2.0

GetRowIndex

GetRowIndex(nodeIndex: number | Int32): number
Get the first row index that the node maps to.
Parameters
- nodeIndex: number | Int32
  The node index.
Returns number
The first row index that the node maps to.

Since
2.0

GetRowIndexes

GetRowIndexes(nodeIndex: number | Int32): IndexSet
Get the row indexes that the node maps to.
Parameters
- nodeIndex: number | Int32
  The node index.
Returns IndexSet
The row indexes that the node maps to.

Since
2.0
GetRowIndexes(nodeIndexes: IndexSet): IndexSet
Get the row indexes that the nodes maps to.
Parameters
- nodeIndexes: IndexSet
  The node indexes.
Returns IndexSet
The row indexes that the nodes maps to.

Since
2.0

GetRowOccurrenceCount

GetRowOccurrenceCount(nodeIndex: number | Int32): number
Get the number of rows for the given node index.
Parameters
- nodeIndex: number | Int32
  The node index.
Returns number
The number of rows that corresponds to the given node index.

Since
2.0