LegendSettingsModel

23 Sep 20251 minute to read

Interface for a class LegendSettings

Properties

alignment Alignment

Specifies the alignment of the legend.

enableSmartLegend boolean

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

height string

Sets and gets the height of the legend.

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.

labelFormat string

Used to format the legend label.

position LegendPosition

Sets and gets the position of the legend.

showGradientPointer boolean

Enables or disables the visibility of the gradient pointer in the gradient legend.

showLabel boolean

Specifies whether the labels in the legend should be visible or not.

textStyle FontModel

Sets and gets the options to customize the font style of the legend label.

title TitleModel

Sets and gets the options to customize the title of the legend.

toggleVisibility boolean

Enables or disables the toggle visibility of heatmap cells based on legend item selection.

visible boolean

Specifies whether the legend should be visible or not.

width string

Sets and gets the width of the legend.