Class ChartLegendSettings

Options to customize the legend settings in the chart

Inheritance
System.Object
Syncfusion.Blazor.SfBaseComponent
ChartLegendSettings
Namespace: Syncfusion.Blazor.Charts
Assembly: Syncfusion.Blazor.dll
Syntax
public class ChartLegendSettings : SfBaseComponent, IBaseLegend

Constructors

ChartLegendSettings()

Declaration
public ChartLegendSettings()

Properties

Alignment

Legend in chart can be aligned as follows: Near: Aligns the legend to the left of the chart. Center: Aligns the legend to the center of the chart. Far: Aligns the legend to the right of the chart.

Declaration
public Alignment Alignment { get; set; }
Property Value
Type Description
Alignment

Background

The background color of the legend that accepts value in hex and rgba as a valid CSS color string.

Declaration
public string Background { get; set; }
Property Value
Type Description
System.String

Border

Options to customize the border of the legend.

Declaration
public ChartLegendBorder Border { get; set; }
Property Value
Type Description
ChartLegendBorder

ChildContent

Gets and sets the content of the component

Declaration
public RenderFragment ChildContent { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment

Description

Description for legends.

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String

Height

The height of the legend in pixels.

Declaration
public string Height { get; set; }
Property Value
Type Description
System.String

Location

Specifies the location of the legend, relative to the chart. If x is 20, legend moves by 20 pixels to the right of the chart. It requires the position to be Custom.

Declaration
public ChartLocation Location { get; set; }
Property Value
Type Description
ChartLocation

Margin

Options to customize left, right, top and bottom margins of the legend.

Declaration
public ChartLegendMargin Margin { get; set; }
Property Value
Type Description
ChartLegendMargin

Opacity

Options to customize left, right, top and bottom margins of the chart.

Declaration
public double Opacity { get; set; }
Property Value
Type Description
System.Double

Padding

Option to customize the padding between legend items.

Declaration
public double Padding { get; set; }
Property Value
Type Description
System.Double

Position

Position of the legend in the chart are, Auto: Places the legend based on area type. Top: Displays the legend at the top of the chart. Left: Displays the legend at the left of the chart. Bottom: Displays the legend at the bottom of the chart. Right: Displays the legend at the right of the chart. Custom: Displays the legend based on the given x and y values.

Declaration
public LegendPosition Position { get; set; }
Property Value
Type Description
LegendPosition

ShapeHeight

Shape width of the legend in pixels.

Declaration
public double ShapeHeight { get; set; }
Property Value
Type Description
System.Double

ShapePadding

Padding between the legend shape and text.

Declaration
public double ShapePadding { get; set; }
Property Value
Type Description
System.Double

ShapeWidth

Shape height of the legend in pixels.

Declaration
public double ShapeWidth { get; set; }
Property Value
Type Description
System.Double

TabIndex

TabIndex value for the legend.

Declaration
public double TabIndex { get; set; }
Property Value
Type Description
System.Double

TextStyle

Options to customize the legend text.

Declaration
public ChartLegendTextStyle TextStyle { get; set; }
Property Value
Type Description
ChartLegendTextStyle

ToggleVisibility

If set to true, series' visibility collapses based on the legend visibility.

Declaration
public bool ToggleVisibility { get; set; }
Property Value
Type Description
System.Boolean

Visible

If set to true, legend will be visible.

Declaration
public bool Visible { get; set; }
Property Value
Type Description
System.Boolean

Width

The width of the legend in pixels.

Declaration
public string Width { get; set; }
Property Value
Type Description
System.String

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.SfBaseComponent.OnInitializedAsync()

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
System.Threading.Tasks.Task