LegendSettings API in Angular HeatMap API component

Configures the Legend

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

Specifies the height of Legend.

Defaults to ”

labelDisplayType

LabelDisplayType

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.

Defaults to ‘All’

labelFormat

string

Specifies the formatting options for the legend label.

Defaults to ”

position

LegendPosition

Specifies the position of Legend to render.

Defaults to ‘Right’

showGradientPointer

boolean

Specifies whether the gradient pointer should be visible or not.

Defaults to true

showLabel

boolean

Specifies whether the label should be visible or not.

Defaults to true

textStyle

FontModel

Specifies the legend label style.

Defaults to ”

title

TitleModel

Specifies title of Legend.

Defaults to ”

toggleVisibility

boolean

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

Defaults to true

visible

boolean

Specifies whether the Legend should be visible or not.

Defaults to true

width

string

Specifies the width of Legend.

Defaults to ”