Class StockChartStockChartSeriesBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
StockChartStockChartSeriesBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class StockChartStockChartSeriesBuilder : ControlBuilder
Constructors
StockChartStockChartSeriesBuilder()
Declaration
public StockChartStockChartSeriesBuilder()
StockChartStockChartSeriesBuilder(List<StockChartStockChartSeries>)
Declaration
public StockChartStockChartSeriesBuilder(List<StockChartStockChartSeries> collection)
Parameters
Methods
Add()
Declaration
Animation(StockChartAnimation)
Options to customizing animation for the series.
Declaration
public StockChartStockChartSeriesBuilder Animation(StockChartAnimation animation)
Parameters
Returns
Animation(Action<StockChartAnimationBuilder>)
Declaration
public StockChartStockChartSeriesBuilder Animation(Action<StockChartAnimationBuilder> animation)
Parameters
Returns
BearFillColor(String)
This property is used in stock charts to visualize the price movements in stock.
It defines the color of the candle/point, when the opening price is less than the closing price.
Declaration
public StockChartStockChartSeriesBuilder BearFillColor(string bearFillColor)
Parameters
| Type |
Name |
Description |
| System.String |
bearFillColor |
|
Returns
Border(StockChartSeriesBorder)
Options to customizing the border of the series. This is applicable only for Column and Bar type series.
Declaration
public StockChartStockChartSeriesBuilder Border(StockChartSeriesBorder border)
Parameters
Returns
Border(Action<StockChartBorderBuilder>)
Declaration
public StockChartStockChartSeriesBuilder Border(Action<StockChartBorderBuilder> border)
Parameters
Returns
BullFillColor(String)
This property is used in financial charts to visualize the price movements in stock.
It defines the color of the candle/point, when the opening price is higher than the closing price.
Declaration
public StockChartStockChartSeriesBuilder BullFillColor(string bullFillColor)
Parameters
| Type |
Name |
Description |
| System.String |
bullFillColor |
|
Returns
CardinalSplineTension(Double)
It defines tension of cardinal spline types.
Declaration
public StockChartStockChartSeriesBuilder CardinalSplineTension(double cardinalSplineTension)
Parameters
| Type |
Name |
Description |
| System.Double |
cardinalSplineTension |
|
Returns
Close(String)
The DataSource field that contains the close value of y
It is applicable for series and technical indicators
Declaration
public StockChartStockChartSeriesBuilder Close(string close)
Parameters
| Type |
Name |
Description |
| System.String |
close |
|
Returns
ColumnSpacing(Double)
To render the column series points with particular column spacing. It takes value from 0 - 1.
Declaration
public StockChartStockChartSeriesBuilder ColumnSpacing(double columnSpacing)
Parameters
| Type |
Name |
Description |
| System.Double |
columnSpacing |
|
Returns
ColumnWidth(Double)
To render the column series points with particular column width. If the series type is histogram the
default value is 1 otherwise 0.7.
Declaration
public StockChartStockChartSeriesBuilder ColumnWidth(double columnWidth)
Parameters
| Type |
Name |
Description |
| System.Double |
columnWidth |
|
Returns
CornerRadius(StockChartCornerRadius)
To render the column series points with particular rounded corner.
Declaration
public StockChartStockChartSeriesBuilder CornerRadius(StockChartCornerRadius cornerRadius)
Parameters
Returns
CornerRadius(Action<StockChartCornerRadiusBuilder>)
Declaration
public StockChartStockChartSeriesBuilder CornerRadius(Action<StockChartCornerRadiusBuilder> cornerRadius)
Parameters
Returns
DashArray(String)
Defines the pattern of dashes and gaps to stroke the lines in Line type series.
Declaration
public StockChartStockChartSeriesBuilder DashArray(string dashArray)
Parameters
| Type |
Name |
Description |
| System.String |
dashArray |
|
Returns
DataSource(Action<DataManagerBuilder>)
Declaration
public StockChartStockChartSeriesBuilder DataSource(Action<DataManagerBuilder> dataSource)
Parameters
| Type |
Name |
Description |
| System.Action<Syncfusion.EJ2.DataManagerBuilder> |
dataSource |
|
Returns
DataSource(Object)
Specifies the DataSource for the series. It can be an array of JSON objects or an instance of DataManager.
Declaration
public StockChartStockChartSeriesBuilder DataSource(object dataSource)
Parameters
| Type |
Name |
Description |
| System.Object |
dataSource |
|
Returns
EmptyPointSettings(StockChartEmptyPointSettings)
options to customize the empty points in series.
Declaration
public StockChartStockChartSeriesBuilder EmptyPointSettings(StockChartEmptyPointSettings emptyPointSettings)
Parameters
Returns
EmptyPointSettings(Action<StockChartEmptyPointSettingsBuilder>)
Declaration
public StockChartStockChartSeriesBuilder EmptyPointSettings(Action<StockChartEmptyPointSettingsBuilder> emptyPointSettings)
Parameters
Returns
EnableSolidCandles(Boolean)
This property is applicable for candle series.
It enables/disables to visually compare the current values with the previous values in stock.
Declaration
public StockChartStockChartSeriesBuilder EnableSolidCandles(bool enableSolidCandles)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableSolidCandles |
|
Returns
If set true, the Tooltip for series will be visible.
Declaration
public StockChartStockChartSeriesBuilder EnableTooltip(bool enableTooltip)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableTooltip |
|
Returns
Fill(String)
The fill color for the series that accepts value in hex and rgba as a valid CSS color string.
It also represents the color of the signal lines in technical indicators.
For technical indicators, the default value is 'blue' and for series, it has null.
Declaration
public StockChartStockChartSeriesBuilder Fill(string fill)
Parameters
| Type |
Name |
Description |
| System.String |
fill |
|
Returns
High(String)
The DataSource field that contains the high value of y
It is applicable for series and technical indicators
Declaration
public StockChartStockChartSeriesBuilder High(string high)
Parameters
| Type |
Name |
Description |
| System.String |
high |
|
Returns
LegendImageUrl(String)
The URL for the Image that is to be displayed as a Legend icon. It requires legendShape value to be an Image.
Declaration
public StockChartStockChartSeriesBuilder LegendImageUrl(string legendImageUrl)
Parameters
| Type |
Name |
Description |
| System.String |
legendImageUrl |
|
Returns
LegendShape(LegendShape)
The shape of the legend. Each series has its own legend shape. They are
Circle - Renders a circle.
Rectangle - Renders a rectangle.
Triangle - Renders a triangle.
Diamond - Renders a diamond.
Cross - Renders a cross.
HorizontalLine - Renders a horizontalLine.
VerticalLine - Renders a verticalLine.
Pentagon - Renders a pentagon.
InvertedTriangle - Renders a invertedTriangle.
SeriesType -Render a legend shape based on series type.
Image -Render a image.
Declaration
public StockChartStockChartSeriesBuilder LegendShape(LegendShape legendShape)
Parameters
Returns
Low(String)
The DataSource field that contains the low value of y
It is applicable for series and technical indicators
Declaration
public StockChartStockChartSeriesBuilder Low(string low)
Parameters
| Type |
Name |
Description |
| System.String |
low |
|
Returns
Marker(StockChartSeriesMarker)
Options for displaying and customizing markers for individual points in a series.
Declaration
public StockChartStockChartSeriesBuilder Marker(StockChartSeriesMarker marker)
Parameters
Returns
Marker(Action<StockChartMarkerSettingsBuilder>)
Declaration
public StockChartStockChartSeriesBuilder Marker(Action<StockChartMarkerSettingsBuilder> marker)
Parameters
Returns
Name(String)
The name of the series visible in legend.
Declaration
public StockChartStockChartSeriesBuilder Name(string name)
Parameters
| Type |
Name |
Description |
| System.String |
name |
|
Returns
Opacity(Double)
The opacity of the series.
Declaration
public StockChartStockChartSeriesBuilder Opacity(double opacity)
Parameters
| Type |
Name |
Description |
| System.Double |
opacity |
|
Returns
Open(String)
The DataSource field that contains the open value of y
It is applicable for series and technical indicators
Declaration
public StockChartStockChartSeriesBuilder Open(string open)
Parameters
| Type |
Name |
Description |
| System.String |
open |
|
Returns
PointColorMapping(String)
The DataSource field that contains the color value of point
It is applicable for series
Declaration
public StockChartStockChartSeriesBuilder PointColorMapping(string pointColorMapping)
Parameters
| Type |
Name |
Description |
| System.String |
pointColorMapping |
|
Returns
Query(String)
Specifies query to select data from DataSource. This property is applicable only when the DataSource is ej.DataManager.
Declaration
public StockChartStockChartSeriesBuilder Query(string query)
Parameters
| Type |
Name |
Description |
| System.String |
query |
|
Returns
SelectionStyle(String)
Custom style for the selected series or points.
Declaration
public StockChartStockChartSeriesBuilder SelectionStyle(string selectionStyle)
Parameters
| Type |
Name |
Description |
| System.String |
selectionStyle |
|
Returns
Enables or disables the display of tooltips for the nearest data point to the cursor for series.
Declaration
public StockChartStockChartSeriesBuilder ShowNearestTooltip(bool showNearestTooltip)
Parameters
| Type |
Name |
Description |
| System.Boolean |
showNearestTooltip |
|
Returns
The provided value will be considered as a Tooltip name
Declaration
public StockChartStockChartSeriesBuilder TooltipMappingName(string tooltipMappingName)
Parameters
| Type |
Name |
Description |
| System.String |
tooltipMappingName |
|
Returns
Trendlines(Action<StockChartTrendlinesBuilder>)
Declaration
public StockChartStockChartSeriesBuilder Trendlines(Action<StockChartTrendlinesBuilder> trendlines)
Parameters
Returns
Trendlines(List<StockChartTrendlines>)
Defines the collection of trendlines that are used to predict the trend
Declaration
public StockChartStockChartSeriesBuilder Trendlines(List<StockChartTrendlines> trendlines)
Parameters
Returns
Type(ChartSeriesType)
The type of the series are
Line
Column
Area
Spline
Hilo
HiloOpenClose
Candle
Declaration
public StockChartStockChartSeriesBuilder Type(ChartSeriesType type)
Parameters
Returns
Visible(Boolean)
Specifies the visibility of series.
Declaration
public StockChartStockChartSeriesBuilder Visible(bool visible)
Parameters
| Type |
Name |
Description |
| System.Boolean |
visible |
|
Returns
Volume(String)
Defines the data source field that contains the volume value in candle charts
It is applicable for financial series and technical indicators
Declaration
public StockChartStockChartSeriesBuilder Volume(string volume)
Parameters
| Type |
Name |
Description |
| System.String |
volume |
|
Returns
Width(Double)
The stroke width for the series that is applicable only for Line type series.
It also represents the stroke width of the signal lines in technical indicators.
Declaration
public StockChartStockChartSeriesBuilder Width(double width)
Parameters
| Type |
Name |
Description |
| System.Double |
width |
|
Returns
XAxisName(String)
The name of the horizontal axis associated with the series. It requires axes of the chart.
It is applicable for series and technical indicators
Declaration
public StockChartStockChartSeriesBuilder XAxisName(string xAxisName)
Parameters
| Type |
Name |
Description |
| System.String |
xAxisName |
|
Returns
XName(String)
The DataSource field that contains the x value.
It is applicable for series and technical indicators
Declaration
public StockChartStockChartSeriesBuilder XName(string xName)
Parameters
| Type |
Name |
Description |
| System.String |
xName |
|
Returns
YAxisName(String)
The name of the vertical axis associated with the series. It requires axes of the chart.
It is applicable for series and technical indicators
Declaration
public StockChartStockChartSeriesBuilder YAxisName(string yAxisName)
Parameters
| Type |
Name |
Description |
| System.String |
yAxisName |
|
Returns
YName(String)
The DataSource field that contains the y value.
Declaration
public StockChartStockChartSeriesBuilder YName(string yName)
Parameters
| Type |
Name |
Description |
| System.String |
yName |
|
Returns
