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

Class KpiVisualizationActionContext

Holds context information for an action invoked on a KPI visualization.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- KpiVisualizationActionContext

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

ComparativeValue HierarchyPathValues Value Visualization

Methods

Cast

Cast<T1, T2>(this, type): 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): 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, type): 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, objB): 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

ComparativeValue

get ComparativeValue(): unknown
Gets the comparative value of the KPI visualization tile for which an action is invoked. May be null.

Returns unknown
Since
2.0

HierarchyPathValues

get HierarchyPathValues(): System.Collections.Generic.IList<unknown>
Gets the path of values identifying the leaf in a hierarchy for which an action is invoked. May be null or empty.

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

Value

get Value(): unknown
Gets the value of the KPI visualization tile for which an action is invoked. May be null.

Returns unknown
Since
2.0

Visualization

get Visualization(): KpiVisualization
Gets the Spotfire.Dxp.Application.Visuals.KpiVisualization for which an action is invoked.

Returns KpiVisualization
Since
2.0