Class StockChartStockChartLegendSettings

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

StockChartStockChartLegendSettings

Namespace: Syncfusion.EJ2.Charts

Assembly: Syncfusion.EJ2.dll

Syntax

public class StockChartStockChartLegendSettings : EJTagHelper

Constructors

StockChartStockChartLegendSettings()

Declaration

public StockChartStockChartLegendSettings()

Properties

Alignment

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

Declaration

public Alignment Alignment { get; set; }

Property Value

Type	Description
Alignment	The default value is Syncfusion.EJ2.Charts.Alignment.Center

Background

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

Declaration

public string Background { get; set; }

Property Value

Type	Description
System.String	The default value is "transparent"

Border

Options to customize the border of the legend.

Declaration

public StockChartLegendBorder Border { get; set; }

Property Value

Type	Description
StockChartLegendBorder	The default value is null

ContainerPadding

Options to customize left, right, top and bottom padding for legend container of the stock chart.

Declaration

public StockChartContainerPadding ContainerPadding { get; set; }

Property Value

Type	Description
StockChartContainerPadding	The default value is null

ContentTemplate

To get or set value for ContentTemplate.

Declaration

public MvcTemplate<object> ContentTemplate { get; set; }

Property Value

Type
Syncfusion.EJ2.MvcTemplate<System.Object>

Description

Description for legends in stock chart.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String	The default value is null

EnablePages

If set to true, legend will be visible using pages in stock chart.

Declaration

public bool EnablePages { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

Height

The height of the legend in pixels.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String	The default value is null

IsInversed

If set to true, legend will be Reversed in stock chart.

Declaration

public bool IsInversed { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

ItemPadding

Option to customize the padding between legend items.

Declaration

public double ItemPadding { get; set; }

Property Value

Type	Description
System.Double	The default value is Double.NaN

Location

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

Declaration

public StockChartLocation Location { get; set; }

Property Value

Type	Description
StockChartLocation	The default value is null

Margin

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

Declaration

public StockChartMargin Margin { get; set; }

Property Value

Type	Description
StockChartMargin	The default value is null

MaximumTitleWidth

maximum width for the legend title in stock chart.

Declaration

public double MaximumTitleWidth { get; set; }

Property Value

Type	Description
System.Double	The default value is 100

Mode

Mode of legend items. Series: Legend items generated based on series count. Point: Legend items generated based on unique data points. Range: Legend items generated based on range color mapping property. Gradient: Single linear bar generated based on range color mapping property. This property is applicable for chart component only.

Declaration

public LegendMode Mode { get; set; }

Property Value

Type	Description
LegendMode	The default value is null

Opacity

Opacity of the legend in stock chart.

Declaration

public double Opacity { get; set; }

Property Value

Type	Description
System.Double	The default value is 1

Padding

Option to customize the padding around the legend items.

Declaration

public double Padding { get; set; }

Property Value

Type	Description
System.Double	The default value is 8

Position

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

Declaration

public LegendPosition Position { get; set; }

Property Value

Type	Description
LegendPosition	The default value is LegendPosition.Auto

ShapeHeight

Shape height of the legend in pixels.

Declaration

public double ShapeHeight { get; set; }

Property Value

Type	Description
System.Double	The default value is 10

ShapePadding

Padding between the legend shape and text in stock chart.

Declaration

public double ShapePadding { get; set; }

Property Value

Type	Description
System.Double	The default value is 8

ShapeWidth

Shape width of the legend in pixels.

Declaration

public double ShapeWidth { get; set; }

Property Value

Type	Description
System.Double	The default value is 10

TabIndex

TabIndex value for the legend in stock chart.

Declaration

public double TabIndex { get; set; }

Property Value

Type	Description
System.Double	The default value is 3

Template

Specifies the custom template used to render the content of the legend item for the current series. The template can contain any valid HTML element or layout. When set, the provided template replaces the default legend text for the series.

Declaration

public object Template { get; set; }

Property Value

Type	Description
System.Object	The default value is null

TextStyle

Options to customize the legend text.

Declaration

public StockChartLegendTextStyle TextStyle { get; set; }

Property Value

Type	Description
StockChartLegendTextStyle	The default value is null

Title

Title for legends in stock chart.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String	The default value is null

TitlePosition

legend title position in stock chart.

Declaration

public LegendTitlePosition TitlePosition { get; set; }

Property Value

Type	Description
LegendTitlePosition	The default value is LegendTitlePosition.Top

TitleStyle

Options to customize the legend title in stock chart.

Declaration

public StockChartLegendTitleStyle TitleStyle { get; set; }

Property Value

Type	Description
StockChartLegendTitleStyle	The default value is null

ToggleVisibility

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

Declaration

public bool ToggleVisibility { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

Visible

If set to true, legend will be visible.

Declaration

public bool Visible { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

Width

The width of the legend in pixels.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	The default value is null