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

Class HierarchyDefinition

This is a definition of a hierarchy.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- HierarchyDefinition

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor LevelExpressions NestingMode

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

constructor

new HierarchyDefinition(
    nestingMode: HierarchyNestingMode,
    levelExpressions: OrExplicit<
        System.Collections.Generic.IList<string | String>,
    >,
): HierarchyDefinition
Initializes a new instance of the Spotfire.Dxp.Data.HierarchyDefinition class. Create a new hierarchy definition.
Parameters
- nestingMode: HierarchyNestingMode
  The nesting mode.
- levelExpressions: OrExplicit<System.Collections.Generic.IList<string | String>>
  The expressions for the levels in the hierarchy. This is the same syntax as calculated columns, see the Spotfire.Dxp.Data.Expressions.ColumnExpression class for utility methods.
Returns HierarchyDefinition
Since
2.0

Overrides Object.constructor

LevelExpressions

get LevelExpressions(): System.Collections.Generic.IList<string>
Gets the expressions for the levels in the hierarchy.

Returns System.Collections.Generic.IList<string>
Since
2.0

NestingMode

get NestingMode(): HierarchyNestingMode
Gets the hierarchy nesting mode.

Returns HierarchyNestingMode
Since
2.0