Class StockChartSeries

To specify customization options for stock chart series.

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

Constructors

StockChartSeries()

Declaration
public StockChartSeries()

Properties

BearFillColor

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

BullFillColor

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

CardinalSplineTension

It defines tension of cardinal spline types.

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

Close

The DataSource field that contains the close value of y It is applicable for series and technical indicators.

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

ColumnSpacing

To render the column series points with particular column spacing. It takes value from 0 - 1.

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

ColumnWidth

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

DashArray

Defines the pattern of dashes and gaps to stroke the lines in Line type series.

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

DataSource

Specifies the DataSource for the series. It can be an array of JSON objects or an instance of DataManager.

Declaration
[Parameter]
public IEnumerable<object> DataSource { get; set; }
Property Value
Type
IEnumerable<object>

EnableSolidCandles

This property is applicable for candle series. It enables/disables to visually compare the current values with the previous values in stock.

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

EnableTooltip

If set true, the Tooltip for series will be visible.

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

Fill

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

High

The DataSource field that contains the high value of y It is applicable for series and technical indicators.

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

LegendShape

Specifies the legend shape of the series.

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

Low

The DataSource field that contains the low value of y It is applicable for series and technical indicators.

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

Name

The name of the series visible in legend.

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

Opacity

The opacity of the series.

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

Open

The DataSource field that contains the open value of y It is applicable for series and technical indicators.

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

PointColorMapping

The DataSource field that contains the color value of point It is applicable for series.

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

Query

Specifies query to select data from DataSource. This property is applicable only when the DataSource is Ej.DataManager.

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

SelectionStyle

Custom style for the selected series or points.

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

ShowNearestTooltip

Gets or sets a value that determines whether tooltips are displayed for the nearest data point to the cursor for a specific chart series.

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

true to display the tooltip for the nearest data point to the cursor on the specific chart series; otherwise, false. The default value is true.
Remarks

This property controls the display of the tooltip based on the proximity of the nearest data point to the cursor for a specific chart series. The StockChartTooltipSettings.ShowNearestTooltip property must be set to true for this property to function. When the StockChartSeries.ShowNearestTooltip property is set to false, the tooltip for the nearest data point will not be displayed for the current series, but it may still be shown for other series.

TooltipFormat

The provided format will be considered as a Tooltip format.

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

TooltipMappingName

The provided value will be considered as a Tooltip name.

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

Type

The type of the series are Line Column Area Spline Hilo HiloOpenClose Candle.

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

Visible

Specifies the visibility of series.

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

Volume

Defines the data source field that contains the volume value in candle charts It is applicable for financial series and technical indicators.

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

Width

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

XAxisName

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

XName

The DataSource field that contains the x value. It is applicable for series and technical indicators.

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

YAxisName

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

YName

The DataSource field that contains the y value.

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

Methods

BuildRenderTree(RenderTreeBuilder)

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

Implements