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

Class HeatMapDetails

Class representing heat map detail information, typically displayed in tooltips.

Since

2.0

Hierarchy (view full)

Details
- HeatMapDetails

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context DisplayMode IsAttached Items Transactions X Y

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 Details.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 Details.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Details.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Details.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 Details.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 Details.Equals

Default capability

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from Details.Context

DisplayMode

get DisplayMode(): DetailsDisplayMode
Gets or sets the display mode.

Returns DetailsDisplayMode
Since
2.0

Inherited from Details.DisplayMode
set DisplayMode(value): void
Parameters
- value: DetailsDisplayMode
Returns void
Inherited from Details.DisplayMode

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from Details.IsAttached

Items

get Items(): DetailItemCollection
Gets a Spotfire.Dxp.Application.Visuals.DetailItemCollection containing the parts that build up detail (tooltip) information.

Returns DetailItemCollection
Since
2.0

Inherited from Details.Items

Transactions

get Transactions(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from Details.Transactions

X

get X(): NamedDetailItem
Gets the detail item associated with the XAxis of the plot.

Returns NamedDetailItem
Since
2.0

Y

get Y(): NamedDetailItem
Gets the detail item associated with the YAxis of the plot.

Returns NamedDetailItem
Since
2.0