Legend in Circular Gauge Control
19 Dec 20229 minutes to read
Legend provides valuable information for interpreting what the circular gauge axis range displays, and they can be represented in various colors, shapes, and other identifiers based on the data. It gives a breakdown of what each symbol represents in the axis range of circular gauge.
You can add the legend for circular gauge ranges by setting the visible property of legendSettings to true.
Legend customization
Customization option is also provided for the legend shape, alignment, and position.
Position and alignment
The position of the legend is used to place legend in various positions. You can use the position property in legendSettings. Based on the position, the legend item will be aligned. The following options are available to customize the legend position:
- Top
- Bottom
- Left
- Right
- Custom
- Auto
The legend alignment is used to align the legend items in specific location. You can use the alignment property in legendSettings to align the legend items. The following options are available to customize the legend alignment:
- Near
- Center
- Far
The legends can also be positioned to absolute position using the location.x and location.y properties available in legendSettings.
Legend size
The legend size can be modified using the height and width properties in legendSettings.
Legend opacity
To specify the transparency for legend shape, set the opacity property in legendSettings.
Legend shape
To change the legend item shape, specify the desired shape in the shape property of the legend. By default, the shape of the legend is circle.
It also supports the following shapes:
- Circle
- Rectangle
- Diamond
- Triangle
- InvertedTriangle
- Image
You can customize a shape using the shapeWidth and shapeHeight properties.
Legend padding
You can control the spacing between the legend items using the padding option of the legend. The default value of padding is 5.
Legend border
You can customize the legend border using the border option in the legend. The legend border can be customized using the border color and width properties.
Font of the legend text
The font of the legend item text can be customized using the following properties:
- fontFamily
- fontStyle
- fontWeight
- opacity
- color
- size
@using Syncfusion.EJ2;
<ejs-circulargauge id="circular">
<e-circulargauge-legendsettings visible="true" shapeWidth="30" shapeHeight="30" padding="15">
<e-legendsettings-border width="3" color="green"></e-legendsettings-border>
</e-circulargauge-legendsettings>
<e-circulargauge-axes>
<e-circulargauge-axis minimum="0" maximum="100">
<e-axis-labelstyle useRangeColor="true">
</e-axis-labelstyle>
<e-axis-majorticks useRangeColor="true"></e-axis-majorticks>
<e-axis-minorticks useRangeColor="true"></e-axis-minorticks>
<e-circulargauge-ranges>
<e-circulargauge-range start="0" end="25" radius="108%"></e-circulargauge-range>
<e-circulargauge-range start="25" end="50" radius="70%"></e-circulargauge-range>
<e-circulargauge-range start="50" end="75" radius="70%"></e-circulargauge-range>
<e-circulargauge-range start="75" end="100" radius="108%"></e-circulargauge-range>
</e-circulargauge-ranges>
</e-circulargauge-axis>
</e-circulargauge-axes>
</ejs-circulargauge>Toggle option in legend
The toggle option has been provided for legend. So, if you toggle the legend, the given color will be changed to the corresponding circular gauge range. You can enable the toggle option using toggleVisibility in the legendSettings property.
@using Syncfusion.EJ2;
<ejs-circulargauge id="circular">
<e-circulargauge-legendsettings visible="true" toggleVisibility="true">
</e-circulargauge-legendsettings>
<e-circulargauge-axes>
<e-circulargauge-axis minimum="0" maximum="100">
<e-axis-labelstyle useRangeColor="true">
</e-axis-labelstyle>
<e-axis-majorticks useRangeColor="true"></e-axis-majorticks>
<e-axis-minorticks useRangeColor="true"></e-axis-minorticks>
<e-circulargauge-ranges>
<e-circulargauge-range start="0" end="25" radius="108%"></e-circulargauge-range>
<e-circulargauge-range start="25" end="50" radius="70%"></e-circulargauge-range>
<e-circulargauge-range start="50" end="75" radius="70%"></e-circulargauge-range>
<e-circulargauge-range start="75" end="100" radius="108%"></e-circulargauge-range>
</e-circulargauge-ranges>
</e-circulargauge-axis>
</e-circulargauge-axes>
</ejs-circulargauge>Paging support in legend
By default, paging will be enabled if the legend items exceed the legend bounds. You can view each legend item by navigating between the pages using navigation buttons.
@using Syncfusion.EJ2;
<ejs-circulargauge id="circular">
<e-circulargauge-legendsettings visible="true" height="50">
</e-circulargauge-legendsettings>
<e-circulargauge-axes>
<e-circulargauge-axis minimum="0" maximum="100">
<e-axis-labelstyle useRangeColor="true">
</e-axis-labelstyle>
<e-axis-majorticks useRangeColor="true"></e-axis-majorticks>
<e-axis-minorticks useRangeColor="true"></e-axis-minorticks>
<e-circulargauge-ranges>
<e-circulargauge-range start="0" end="25" radius="108%"></e-circulargauge-range>
<e-circulargauge-range start="25" end="50" radius="70%"></e-circulargauge-range>
<e-circulargauge-range start="50" end="75" radius="70%"></e-circulargauge-range>
<e-circulargauge-range start="75" end="100" radius="108%"></e-circulargauge-range>
</e-circulargauge-ranges>
</e-circulargauge-axis>
</e-circulargauge-axes>
</ejs-circulargauge>Legend text customization
You can customize the legend text using legendText property in ranges.
@using Syncfusion.EJ2;
<ejs-circulargauge id="circular">
<e-circulargauge-legendsettings visible="true">
</e-circulargauge-legendsettings>
<e-circulargauge-axes>
<e-circulargauge-axis minimum="0" maximum="100">
<e-axis-labelstyle useRangeColor="true">
</e-axis-labelstyle>
<e-axis-majorticks useRangeColor="true"></e-axis-majorticks>
<e-axis-minorticks useRangeColor="true"></e-axis-minorticks>
<e-circulargauge-ranges>
<e-circulargauge-range start="0" end="25" radius="108%" legendText="Light air"></e-circulargauge-range>
<e-circulargauge-range start="25" end="50" radius="70%" legendText="Light air"></e-circulargauge-range>
<e-circulargauge-range start="50" end="75" radius="70%" legendText="Light breeze"></e-circulargauge-range>
<e-circulargauge-range start="75" end="100" radius="108%" legendText="Gentle breeze"></e-circulargauge-range>
</e-circulargauge-ranges>
</e-circulargauge-axis>
</e-circulargauge-axes>
</ejs-circulargauge>legendRendering event will be triggered before rendering each legend item, using this event you can customize needed legend items using following arguments.
| Argument Name | Description |
|---|---|
| fill | Specifies the legend shape color |
| text | Specifies the current legend text |
| shape | Customize the shape of the legends |
| name | Specifies the name of the event |
| cancel | Set to true, to cancel the event status |
NOTE