LegendSettingsModel API in JavaScript HeatMap API control

Interface for a class LegendSettings

Properties

alignment

string

Specifies the alignment of the legend

enableSmartLegend

boolean

Specifies whether smart legend should be displayed or not when palette type is fixed.

height

string

Specifies the height of Legend.

labelDisplayType

string

Specifies the type of label display for smart legend.

• All: All labels are displayed.
• Edge: Labels will be displayed only at the edges of the legend.
• None: No labels are displayed.

labelFormat

string

Specifies the formatting options for the legend label.

position

string

Specifies the position of Legend to render.

showGradientPointer

boolean

Specifies whether the gradient pointer should be visible or not.

showLabel

boolean

Specifies whether the label should be visible or not.

textStyle

FontModel

Specifies the legend label style.

title

TitleModel

Specifies title of Legend.

toggleVisibility

boolean

To toggle the visibility of heatmap cells based on legend range selection

visible

boolean

Specifies whether the Legend should be visible or not.

width

string

Specifies the width of Legend.