LegendSettings

23 Sep 20252 minutes to read

Sets and gets the options to customize the legend for the ranges in the circular gauge.

Properties

alignment Alignment

Sets and gets the alignment of the legend in the circular gauge.

Defaults to ‘Center’

background string

Sets and gets the background color of the legend in circular gauge.

Defaults to ‘transparent’

border BorderModel

Sets and gets the options to customize the style properties of the border of the legend.

height string

Sets and gets the height of the legend in the circular gauge.

Defaults to null

location LocationModel

Sets and gets the location of the legend, relative to the circular gauge.
If x is 20, legend moves by 20 pixels to the right of the gauge. It requires the position to be Custom.

<div id='Gauge'></div>

let gauge: CircularGauge = new CircularGauge({
...
  legendSettings: {
    visible: true,
    position: 'Custom',
    location: { x: 100, y: 150 },
  },
...
});
this.gauge.appendTo('#Gauge');

margin MarginModel

Sets and gets the options to customize the legend margin.

opacity number

Sets and gets the opacity of the legend.

Defaults to 1

padding number

Sets and gets the options to customize the padding between legend items.

Defaults to 8

position LegendPosition

Sets and gets the position of the legend in the circular gauge.

Defaults to ‘Auto’

shape GaugeShape

Sets and gets the shape of the legend in circular gauge.

Defaults to Circle

shapeBorder BorderModel

Sets and gets the options to customize the style properties of the border for the shape of the legend in the circular gauge.

shapeHeight number

Sets and gets the height of the legend shape in circular gauge.

Defaults to 10

shapePadding number

Sets and gets the padding for the legend shape in circular gauge.

Defaults to 5

shapeWidth number

Sets and gets the width of the legend shape in circular gauge.

Defaults to 10

textStyle FontModel

Sets and gets the options to customize the text of the legend item.

toggleVisibility boolean

Enables and disables the visibility of the ranges. When the legend is clicked, the visibility of the legend will be toggled.

Defaults to true

visible boolean

Enable and disables the visibility of the legend in circular gauge.

Defaults to false

width string

Sets and gets the width of the legend in the circular gauge.

Defaults to null