Class StockChartStockChartLegendSettingsBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
StockChartStockChartLegendSettingsBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class StockChartStockChartLegendSettingsBuilder : ControlBuilder
Constructors
StockChartStockChartLegendSettingsBuilder()
Declaration
public StockChartStockChartLegendSettingsBuilder()
StockChartStockChartLegendSettingsBuilder(StockChartStockChartLegendSettings)
Declaration
public StockChartStockChartLegendSettingsBuilder(StockChartStockChartLegendSettings model)
Parameters
Methods
Alignment(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 StockChartStockChartLegendSettingsBuilder Alignment(Alignment value)
Parameters
Returns
Background(String)
The background color of the legend that accepts value in hex and rgba as a valid CSS color string in stock chart.
Declaration
public StockChartStockChartLegendSettingsBuilder Background(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Border(StockChartLegendBorder)
Options to customize the border of the legend.
Declaration
public StockChartStockChartLegendSettingsBuilder Border(StockChartLegendBorder value)
Parameters
Returns
Border(Action<StockChartBorderBuilder>)
Declaration
public StockChartStockChartLegendSettingsBuilder Border(Action<StockChartBorderBuilder> border)
Parameters
Returns
ContainerPadding(StockChartContainerPadding)
Options to customize left, right, top and bottom padding for legend container of the stock chart.
Declaration
public StockChartStockChartLegendSettingsBuilder ContainerPadding(StockChartContainerPadding value)
Parameters
Returns
ContainerPadding(Action<StockChartContainerPaddingBuilder>)
Declaration
public StockChartStockChartLegendSettingsBuilder ContainerPadding(Action<StockChartContainerPaddingBuilder> containerPadding)
Parameters
Returns
Description(String)
Description for legends in stock chart.
Declaration
public StockChartStockChartLegendSettingsBuilder Description(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
EnablePages(Boolean)
If set to true, legend will be visible using pages in stock chart.
Declaration
public StockChartStockChartLegendSettingsBuilder EnablePages(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Height(String)
The height of the legend in pixels.
Declaration
public StockChartStockChartLegendSettingsBuilder Height(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
IsInversed(Boolean)
If set to true, legend will be Reversed in stock chart.
Declaration
public StockChartStockChartLegendSettingsBuilder IsInversed(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
ItemPadding(Double)
Option to customize the padding between legend items.
Declaration
public StockChartStockChartLegendSettingsBuilder ItemPadding(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Location(StockChartLocation)
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 StockChartStockChartLegendSettingsBuilder Location(StockChartLocation value)
Parameters
Returns
Location(Action<StockChartLocationBuilder>)
Declaration
public StockChartStockChartLegendSettingsBuilder Location(Action<StockChartLocationBuilder> location)
Parameters
Returns
Margin(StockChartMargin)
Options to customize left, right, top and bottom margins of the stock chart.
Declaration
public StockChartStockChartLegendSettingsBuilder Margin(StockChartMargin value)
Parameters
Returns
Margin(Action<StockChartMarginBuilder>)
Declaration
public StockChartStockChartLegendSettingsBuilder Margin(Action<StockChartMarginBuilder> margin)
Parameters
Returns
MaximumTitleWidth(Double)
maximum width for the legend title in stock chart.
Declaration
public StockChartStockChartLegendSettingsBuilder MaximumTitleWidth(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Mode(LegendMode)
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 StockChartStockChartLegendSettingsBuilder Mode(LegendMode value)
Parameters
Returns
Opacity(Double)
Opacity of the legend in stock chart.
Declaration
public StockChartStockChartLegendSettingsBuilder Opacity(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Padding(Double)
Option to customize the padding around the legend items.
Declaration
public StockChartStockChartLegendSettingsBuilder Padding(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Position(LegendPosition)
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 StockChartStockChartLegendSettingsBuilder Position(LegendPosition value)
Parameters
Returns
ShapeHeight(Double)
Shape height of the legend in pixels.
Declaration
public StockChartStockChartLegendSettingsBuilder ShapeHeight(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
ShapePadding(Double)
Padding between the legend shape and text in stock chart.
Declaration
public StockChartStockChartLegendSettingsBuilder ShapePadding(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
ShapeWidth(Double)
Shape width of the legend in pixels.
Declaration
public StockChartStockChartLegendSettingsBuilder ShapeWidth(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
TabIndex(Double)
TabIndex value for the legend in stock chart.
Declaration
public StockChartStockChartLegendSettingsBuilder TabIndex(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
TextStyle(StockChartLegendTextStyle)
Options to customize the legend text.
Declaration
public StockChartStockChartLegendSettingsBuilder TextStyle(StockChartLegendTextStyle value)
Parameters
Returns
TextStyle(Action<StockChartFontBuilder>)
Declaration
public StockChartStockChartLegendSettingsBuilder TextStyle(Action<StockChartFontBuilder> textStyle)
Parameters
Returns
Title(String)
Title for legends in stock chart.
Declaration
public StockChartStockChartLegendSettingsBuilder Title(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
TitlePosition(LegendTitlePosition)
legend title position in stock chart.
Declaration
public StockChartStockChartLegendSettingsBuilder TitlePosition(LegendTitlePosition value)
Parameters
Returns
TitleStyle(StockChartLegendTitleStyle)
Options to customize the legend title in stock chart.
Declaration
public StockChartStockChartLegendSettingsBuilder TitleStyle(StockChartLegendTitleStyle value)
Parameters
Returns
TitleStyle(Action<StockChartFontBuilder>)
Declaration
public StockChartStockChartLegendSettingsBuilder TitleStyle(Action<StockChartFontBuilder> titleStyle)
Parameters
Returns
ToggleVisibility(Boolean)
If set to true, series' visibility collapses based on the legend visibility in stock chart.
Declaration
public StockChartStockChartLegendSettingsBuilder ToggleVisibility(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Visible(Boolean)
If set to true, legend will be visible.
Declaration
public StockChartStockChartLegendSettingsBuilder Visible(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Width(String)
The width of the legend in pixels.
Declaration
public StockChartStockChartLegendSettingsBuilder Width(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
