LegendSettings
23 Sep 20251 minute to read
Gets and sets the options to customize the legend in the heatmap.
Properties
alignment Alignment
Specifies the alignment of the legend.
Defaults to ‘Center’
enableSmartLegend boolean
Specifies whether smart legend should be displayed or not when palette type is fixed.
Defaults to false
height string
Sets and gets the height of the legend.
Defaults to ’’
labelDisplayType LabelDisplayType
Specifies the display mode for label for smart legend. The available display types are,
- All: All the labels in the legend are displayed.
- Edge: Labels will be displayed only at the edges of the legend.
- None: No labels are displayed.
Defaults to ‘All’
labelFormat string
Used to format the legend label.
Defaults to ’’
position LegendPosition
Sets and gets the position of the legend.
Defaults to ‘Right’
showGradientPointer boolean
Enables or disables the visibility of the gradient pointer in the gradient legend.
Defaults to true
showLabel boolean
Specifies whether the labels in the legend should be visible or not.
Defaults to true
textStyle FontModel
Sets and gets the options to customize the font style of the legend label.
Defaults to ’’
title TitleModel
Sets and gets the options to customize the title of the legend.
Defaults to ’’
toggleVisibility boolean
Enables or disables the toggle visibility of heatmap cells based on legend item selection.
Defaults to true
visible boolean
Specifies whether the legend should be visible or not.
Defaults to true
width string
Sets and gets the width of the legend.
Defaults to ’’