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

Class DataLevel

A single level in a Spotfire.Dxp.Data.DataHierarchy.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- DataLevel

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Formatter Name NodeValueType TryGetNodes

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

Formatter

get Formatter(): IDataFormatter
Gets the formatter for the level which can be used for format the node values in the level.

Returns IDataFormatter
Since
2.0

Name

get Name(): string
Gets the name of the level.

Returns string
Since
2.0

NodeValueType

get NodeValueType(): DataType
Gets the Spotfire.Dxp.Data.DataType of the nodes in the level.

Returns DataType
Since
2.0

TryGetNodes

TryGetNodes(
nodeCountLimit: number | Int32,
nodes: OutParam<DataNodeCollection>,
): boolean
Gets the nodes of this level.
Parameters
- nodeCountLimit: number | Int32
  The maximum number of nodes allowed. The value is used only if the level is not materialized at the time of the call.
- nodes: OutParam<DataNodeCollection>
  The node collection.
Returns boolean
True if the nodes could be retrieved; otherwise, false.

Since
2.0