Class AccumulationChartLegendSettings

Legend is used to help readers understand the plotted data. The chart legend shows information about the datasets that are appearing on the chart.

Inheritance

System.Object

SfBaseComponent

AccumulationChartLegendSettings

Implements

ILegend

Inherited Members

SfBaseComponent.OnAfterRenderAsync(Boolean)

SfBaseComponent.Dispose()

SfBaseComponent.Dispose(Boolean)

SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)

Namespace: Syncfusion.Blazor.Charts

Assembly: Syncfusion.Blazor.dll

Syntax

public class AccumulationChartLegendSettings : SfBaseComponent, ILegend

Constructors

AccumulationChartLegendSettings()

Declaration

public AccumulationChartLegendSettings()

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 AccumulationChartLegendBorder Border { get; set; }

Property Value

Type	Description
AccumulationChartLegendBorder

ChildContent

Sets and gets the content of the UI element.

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

EnableHighlight

Enabling highlight for legend.

Declaration

public bool EnableHighlight { get; set; }

Property Value

Type	Description
System.Boolean

Height

The height of the legend in pixels.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String

IsInversed

Gets or sets whether to inverse legend item content (image and text).

Declaration

public bool IsInversed { get; set; }

Property Value

Type	Description
System.Boolean	true if the legend should be inversed; otherwise, false.

ItemPadding

Option to customize the padding between legend items. Applicable for top and bottom legend position only.

Declaration

public double ItemPadding { get; set; }

Property Value

Type	Description
System.Double

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 AccumulationChartLocation Location { get; set; }

Property Value

Type	Description
AccumulationChartLocation

Margin

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

Declaration

public AccumulationChartLegendMargin Margin { get; set; }

Property Value

Type	Description
AccumulationChartLegendMargin

MaximumLabelWidth

Gets and sets the maximum width of the individual legend item after which they get trimmed, wrapped or clipped.

Declaration

public double MaximumLabelWidth { get; set; }

Property Value

Type	Description
System.Double	Specifies the maximum width for the legend text. The default value is null.

Opacity

Opacity of the legend.

Declaration

public double Opacity { get; set; }

Property Value

Type	Description
System.Double

Padding

Option to customize the padding around 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 value.

Declaration

public LegendPosition Position { get; set; }

Property Value

Type	Description
LegendPosition

Reverse

Gets or sets whether to reverse the legend items order.

Declaration

public bool Reverse { get; set; }

Property Value

Type	Description
System.Boolean	true if the legend should be reverse; otherwise, false.

ShapeHeight

Shape height 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 width of the legend in pixels.

Declaration

public double ShapeWidth { get; set; }

Property Value

Type	Description
System.Double

TabIndex

TabIndex legendItem for the legend.

Declaration

public double TabIndex { get; set; }

Property Value

Type	Description
System.Double

TextOverflow

Gets and sets the text overflow behavior to employ when the individual legend text overflowing the legend bounds or MaximumLabelWidth

Declaration

public LabelOverflow TextOverflow { get; set; }

Property Value

Type	Description
LabelOverflow	One of the TextOverflow enumeration.The default value is Ellipse

TextStyle

Options to customize the legend text.

Declaration

public AccumulationChartLegendFont TextStyle { get; set; }

Property Value

Type	Description
AccumulationChartLegendFont

TextWrap

Gets and sets the text wrap behavior to employ when the individual legend text overflowing the legend bounds or MaximumLabelWidth

Declaration

public TextWrap TextWrap { get; set; }

Property Value

Type	Description
TextWrap	One of the TextWrap enumeration. The default value is Normal

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

SfBaseComponent.OnInitializedAsync()

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Implements

ILegend