Class StockChartLegendSettings

To specify customization options for stock chart legend settings.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
StockChartLegendSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.Charts
Assembly: Syncfusion.Blazor.dll
Syntax
public class StockChartLegendSettings : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

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
[Parameter]
public Alignment Alignment { get; set; }
Property Value
Type
Alignment

Background

The background of the chart legend area.

Declaration
[Parameter]
public string Background { get; set; }
Property Value
Type
string

BorderColor

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

Declaration
[Parameter]
public string BorderColor { get; set; }
Property Value
Type
string

BorderWidth

The width of the legend border in pixels.

Declaration
[Parameter]
public double BorderWidth { get; set; }
Property Value
Type
double

EnableHighlight

Enabling the highlight options of legend.

Declaration
[Parameter]
public bool EnableHighlight { get; set; }
Property Value
Type
bool

Height

Specifies the height for legend.

Declaration
[Parameter]
public string Height { get; set; }
Property Value
Type
string

IsInversed

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

Declaration
[Parameter]
public bool IsInversed { get; set; }
Property Value
Type Description
bool

true if the legend should be inversed; otherwise, false.

ItemPadding

Option to customize the padding between legend items.

Declaration
[Parameter]
public double ItemPadding { get; set; }
Property Value
Type
double

MaxLabelWidth

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

Declaration
[Parameter]
public double MaxLabelWidth { get; set; }
Property Value
Type Description
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
[Parameter]
public double Opacity { get; set; }
Property Value
Type
double

Padding

Option to customize the padding around legend collection.

Declaration
[Parameter]
public double Padding { get; set; }
Property Value
Type
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
[Parameter]
public LegendPosition Position { get; set; }
Property Value
Type
LegendPosition

Reversed

Gets or sets whether to reverse the legend items order.

Declaration
[Parameter]
public bool Reversed { get; set; }
Property Value
Type Description
bool

true if the legend should be reverse; otherwise, false.

ShapeHeight

Shape height of the legend shape.

Declaration
[Parameter]
public double ShapeHeight { get; set; }
Property Value
Type
double

ShapePadding

Padding between the legend shape and text.

Declaration
[Parameter]
public double ShapePadding { get; set; }
Property Value
Type
double

ShapeWidth

Shape width of the legend shape.

Declaration
[Parameter]
public double ShapeWidth { get; set; }
Property Value
Type
double

TextOverFlow

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

Declaration
[Parameter]
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 MaximumLabelWidth

Declaration
[Parameter]
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
[Parameter]
public bool ToggleVisibility { get; set; }
Property Value
Type
bool

Visible

Specifies the visibility of legend.

Declaration
[Parameter]
public bool Visible { get; set; }
Property Value
Type
bool

Width

Specifies the width for legend.

Declaration
[Parameter]
public string Width { get; set; }
Property Value
Type
string

X

Specifies the X value of legend.

Declaration
[Parameter]
public double X { get; set; }
Property Value
Type
double

Y

Specifies the Y value of legend.

Declaration
[Parameter]
public double Y { get; set; }
Property Value
Type
double

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

Implements