Class StockChartLegendSettings

To specify customization options for stock chart legend settings.

Inheritance

System.Object

StockChartLegendSettings

Namespace: Syncfusion.Blazor.Charts

Assembly: Syncfusion.Blazor.dll

Syntax

public class StockChartLegendSettings : OwningComponentBase

Constructors

StockChartLegendSettings()

Declaration

public StockChartLegendSettings()

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
Alignment

Background

The background of the chart legend area.

Declaration

public string Background { get; set; }

Property Value

Type
System.String

BorderColor

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

Declaration

public string BorderColor { get; set; }

Property Value

Type
System.String

BorderWidth

The width of the legend border in pixels.

Declaration

public double BorderWidth { get; set; }

Property Value

Type
System.Double

ChildContent

Gets and sets the content of the UI element.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.RenderFragment

EnableHighlight

Enabling the highlight options of legend.

Declaration

public bool EnableHighlight { get; set; }

Property Value

Type
System.Boolean

Height

Specifies the height for legend.

Declaration

public string Height { get; set; }

Property Value

Type
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.

Declaration

public double ItemPadding { get; set; }

Property Value

Type
System.Double

MaxLabelWidth

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

Declaration

public double MaxLabelWidth { get; set; }

Property Value

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

Opacity

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

Declaration

public double Opacity { get; set; }

Property Value

Type
System.Double

Padding

Option to customize the padding around legend collection.

Declaration

public double Padding { get; set; }

Property Value

Type
System.Double

Position

Position of the legend in the chart are, Auto: Places the legend based on chart 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
LegendPosition

Reversed

Gets or sets whether to reverse the legend items order.

Declaration

public bool Reversed { get; set; }

Property Value

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

ShapeHeight

Shape height of the legend shape.

Declaration

public double ShapeHeight { get; set; }

Property Value

Type
System.Double

ShapePadding

Padding between the legend shape and text.

Declaration

public double ShapePadding { get; set; }

Property Value

Type
System.Double

ShapeWidth

Shape width of the legend shape.

Declaration

public double ShapeWidth { get; set; }

Property Value

Type
System.Double

TextOverFlow

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

Declaration

public LabelOverflow TextOverFlow { get; set; }

Property Value

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

TextWrap

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

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
System.Boolean

Visible

Specifies the visibility of legend.

Declaration

public bool Visible { get; set; }

Property Value

Type
System.Boolean

Width

Specifies the width for legend.

Declaration

public string Width { get; set; }

Property Value

Type
System.String

X

Specifies the X value of legend.

Declaration

public double X { get; set; }

Property Value

Type
System.Double

Y

Specifies the Y value of legend.

Declaration

public double Y { get; set; }

Property Value

Type
System.Double

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

Dispose(Boolean)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

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.

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type
System.Threading.Tasks.Task