Class CircularLegend
Class for circular gauge Legend.
Inherited Members
Namespace: Syncfusion.JavaScript.DataVisualization.Models
Assembly: Syncfusion.EJ.dll
Syntax
public class CircularLegend : EJTagHelper
Constructors
CircularLegend()
Declaration
public CircularLegend()
Properties
Alignment
Gets or sets the Alignment of the legend.
Declaration
[JsonProperty("alignment")]
[JsonConverter(typeof(StringEnumConverter))]
public CircularLegendAlignment Alignment { get; set; }
Property Value
Type | Description |
---|---|
CircularLegendAlignment |
Remarks
Horizontal alignment of the legend.
Border
Gets or sets the Border of the legend.
Declaration
[JsonProperty("border")]
public CircularLegendBorder Border { get; set; }
Property Value
Type | Description |
---|---|
CircularLegendBorder |
Remarks
Options for customizing the legend border.
Fill
Gets or sets the Fill color of the legend.
Declaration
[JsonProperty("fill")]
public string Fill { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Fill color for the legend items. By using this property, it displays all legend item shapes in same color. Legend items representing invisible series is displayed in gray color.
Font
Gets or sets the Font used for legend.
Declaration
[JsonProperty("font")]
public CircularLegendFont Font { get; set; }
Property Value
Type | Description |
---|---|
CircularLegendFont |
Remarks
Options to customize the font used for legend item text.
ItemPadding
Gets or sets the ItemPadding value of the legend.
Declaration
[JsonProperty("itemPadding")]
public int ItemPadding { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Remarks
Gap or padding between the legend items.
ItemStyle
Gets or sets the Style of the legend items.
Declaration
[JsonProperty("itemStyle")]
public CircularLegendItemStyle ItemStyle { get; set; }
Property Value
Type | Description |
---|---|
CircularLegendItemStyle |
Remarks
Options to customize the style of legend items.
Opacity
Gets or sets the Opacity of the legend.
Declaration
[JsonProperty("opacity")]
public double Opacity { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
Remarks
Opacity of the legend.
Position
Gets or sets the Position of the legend.
Declaration
[JsonProperty("position")]
[JsonConverter(typeof(StringEnumConverter))]
public CircularLegendPosition Position { get; set; }
Property Value
Type | Description |
---|---|
CircularLegendPosition |
Remarks
Places the legend at specified position.
Shape
Gets or sets the Shape of the legend.
Declaration
[JsonProperty("shape")]
[JsonConverter(typeof(StringEnumConverter))]
public CircularLegendShape Shape { get; set; }
Property Value
Type | Description |
---|---|
CircularLegendShape |
Remarks
Shape of the legend items.
Size
Gets or sets the Size of the legend.
Declaration
[JsonProperty("size")]
public LegendSize Size { get; set; }
Property Value
Type | Description |
---|---|
LegendSize |
Remarks
Options to customize the size of the legend.
ToggleVisibility
Gets or sets the value of ToggleVisibility property of the legend.
Declaration
[JsonProperty("toggleVisibility")]
public bool ToggleVisibility { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Controls whether ranges visibility should be toggled by clicking the legend or not.
Visible
Gets or sets the value of Visible property of the legend.
Declaration
[JsonProperty("visible")]
public bool Visible { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Controls the visibility of the legend.
Methods
ShouldSerializeBorder()
Declaration
public bool ShouldSerializeBorder()
Returns
Type | Description |
---|---|
System.Boolean |
ShouldSerializeFont()
Declaration
public bool ShouldSerializeFont()
Returns
Type | Description |
---|---|
System.Boolean |
ShouldSerializeItemStyle()
Declaration
public bool ShouldSerializeItemStyle()
Returns
Type | Description |
---|---|
System.Boolean |
ShouldSerializeSize()
Declaration
public bool ShouldSerializeSize()
Returns
Type | Description |
---|---|
System.Boolean |