ChartIQ SDK Legacy Documentation -

Class: Heatmap

STX.Renderer. Heatmap

new Heatmap(config)

Creates a Heatmap renderer See STX.Renderer#construct for parameters required by all renderers

Parameters:
Name Type Description
config Object

Config for renderer

Properties
Name Type Argument Description
params object <optional>

Parameters to control the renderer itself

Properties
Name Type Argument Description
widthFactor number <optional>

Width of each bar as a percentage of the candleWidth. Valid values are 0.00-1.00. Default: 1
height number <optional>

The amount of vertical space to use, in price units. For example, 2=>2 unit increments on yaxis.