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

Class DataLevelCollection

A collection of the levels in a Spotfire.Dxp.Data.DataHierarchy.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- DataLevelCollection

Implements

Index

Methods

[iterator] Cast Equals GetHashCode ToString TryCast Equals

Default capability

Item Count LeafLevel RootLevel GetEnumerator

Methods

[iterator]

"[iterator]"(): Iterator<DataLevel>
Returns Iterator<DataLevel>

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

`Readonly`Item

Item: PropertyGet<number | Int32, DataLevel> & PropertyGet<
    string
    | String,
    DataLevel,
>

Gets the level with a given name.

Param: name

The level name.

Returns

A Spotfire.Dxp.Data.DataLevel instance.

Since

2.0

Count

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

Returns number
Since
2.0

LeafLevel

get LeafLevel(): DataLevel
Gets the leaf (lowest) level of the hierarchy.

Returns DataLevel
Since
2.0

RootLevel

get RootLevel(): DataLevel
Gets the root (highest) level of the hierarchy.

Returns DataLevel
Since
2.0

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<DataLevel>
Returns an enumerator that iterates through the collection.

Returns System.Collections.Generic.IEnumerator<DataLevel>
A System.Collections.Generic.IEnumerator that can be used to iterate through the collection.

Since
2.0