Class SmithChartLegendSettings

Options to customize the legend in the chart.

Inheritance
System.Object
SfBaseComponent
SmithChartLegendSettings
Inherited Members
Namespace: Syncfusion.Blazor.Charts
Assembly: Syncfusion.Blazor.dll
Syntax
public class SmithChartLegendSettings : SfBaseComponent

Constructors

SmithChartLegendSettings()

Declaration
public SmithChartLegendSettings()

Properties

Alignment

Alignment for legend.

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

ChildContent

Gets and sets the content of the UI element.

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

ColumnCount

Column count for legend.

Declaration
public int ColumnCount { get; set; }
Property Value
Type
System.Int32

Description

Description for legend.

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

Height

Height of the legend.

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

ItemPadding

Spacing between legend items.

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

Position

Position of the legend.

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

RowCount

Row count for legend.

Declaration
public int RowCount { get; set; }
Property Value
Type
System.Int32

Shape

Shape of the legend.

Declaration
public Shape Shape { get; set; }
Property Value
Type
Shape

ShapePadding

Padding between the legend shape and text.

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

ToggleVisibility

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

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

Visible

Visibility of the legend.

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

Width

Width of the legend.

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

Methods

BuildRenderTree(RenderTreeBuilder)

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

OnInitializedAsync()

Method invoked when the component is ready to start.

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

A System.Threading.Tasks.Task representing the asynchronous operation.
Overrides

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent in the render tree and the incoming values have been assigned to properties.

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

A System.Threading.Tasks.Task representing the asynchronous operation.