Class Heatmap

A heatmap visualization of three dimensional data (X, Y, color).

Hierarchy

Heatmap

Index

Constructors

Methods

dispose getName setData setInterpolate setName setPalette setSize showInResultTable

Constructors

constructor

new Heatmap(priceChart, chart, startX, startY, endX, endY, dataValues): Heatmap
Parameters
- priceChart: TradingChart
- chart: ChartXY<UIBackground>
- startX: number
- startY: number
- endX: number
- endY: number
- dataValues: number[][]
Returns Heatmap

Methods

dispose

dispose(): void
Disposes the heatmap.

Returns void

getName

getName(): string
Gets the name of the heatmap.

Returns string
The name of the heatmap.

setData

setData(newData): void
Sets new data values to the heatmap.
Parameters
- newData: number[][]
  
  New data values.
Returns void

setInterpolate

setInterpolate(interpolate): void
Enables or disables the interpolation of the heatmap.
Parameters
- interpolate: boolean
  
  Set true to enable interpolation.
Returns void

setName

setName(newName): void
Sets the name of the heatmap.
Parameters
- newName: string
  
  New name for the heatmap.
Returns void

setPalette

setPalette(paletteSteps): void
Assigns new set of steps for the palette used by the heatmap. Each step is a pair object consisting of value and color fields.

Example usage:
```
heatmap.setPalette([

     {value: 0, color: ColorRGBA( 0, 0, 255 )},
     {value: 50, color: ColorRGBA( 0, 255, 0 )},
     {value: 100, color: ColorRGBA( 255, 0, 0 )}
])
```
Parameters
- paletteSteps: LUTStep[]
  
  An array of palette steps.
Returns void

setSize

setSize(startX, startY, endX, endY): void
Sets the size of the heatmap using axis values. Doesn't affect the row or column count of the heatmap.
Parameters
- startX: number
  
  Start X-position.
- startY: number
  
  Start Y-position.
- endX: number
  
  End X-position.
- endY: number
  
  End Y-position.
Returns void

showInResultTable

showInResultTable(showInTable): void
Controls whether the heatmap is visible in the result table.
Parameters
- showInTable: boolean
  
  Set true to show the heatmap in the result table.
Returns void