Class StockChartSeries

To specify customization options for stockchart series.

Inheritance

System.Object

SfBaseComponent

SfDataBoundComponent

StockChartSeries

Inherited Members

SfBaseComponent.Dispose()

SfBaseComponent.Dispose(Boolean)

SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)

SfDataBoundComponent.DataManager

SfDataBoundComponent.MainParent

SfDataBoundComponent.OnAfterRenderAsync(Boolean)

SfDataBoundComponent.SetDataManager<T>(Object)

Namespace: Syncfusion.Blazor.Charts

Assembly: Syncfusion.Blazor.dll

Syntax

public class StockChartSeries : SfDataBoundComponent

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

public string BearFillColor { get; set; }

Property Value

Type
System.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

public string BullFillColor { get; set; }

Property Value

Type
System.String

CardinalSplineTension

It defines tension of cardinal spline types.

Declaration

public double CardinalSplineTension { get; set; }

Property Value

Type
System.Double

ChildContent

Gets and sets the content of the UI element.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.RenderFragment

Close

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

Declaration

public string Close { get; set; }

Property Value

Type
System.String

ColumnSpacing

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

Declaration

public double ColumnSpacing { get; set; }

Property Value

Type
System.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

public double ColumnWidth { get; set; }

Property Value

Type
System.Double

DashArray

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

Declaration

public string DashArray { get; set; }

Property Value

Type
System.String

DataSource

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

Declaration

public IEnumerable<object> DataSource { get; set; }

Property Value

Type
System.Collections.Generic.IEnumerable<System.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

public bool EnableSolidCandles { get; set; }

Property Value

Type
System.Boolean

EnableTooltip

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

Declaration

public bool EnableTooltip { get; set; }

Property Value

Type
System.Boolean

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

public string Fill { get; set; }

Property Value

Type
System.String

High

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

Declaration

public string High { get; set; }

Property Value

Type
System.String

LegendShape

Specifies the legend shape of the series.

Declaration

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

public string Low { get; set; }

Property Value

Type
System.String

Name

The name of the series visible in legend.

Declaration

public string Name { get; set; }

Property Value

Type
System.String

Opacity

The opacity of the series.

Declaration

public double Opacity { get; set; }

Property Value

Type
System.Double

Open

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

Declaration

public string Open { get; set; }

Property Value

Type
System.String

PointColorMapping

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

Declaration

public string PointColorMapping { get; set; }

Property Value

Type
System.String

Query

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

Declaration

public Query Query { get; set; }

Property Value

Type
Query

SelectionStyle

Custom style for the selected series or points.

Declaration

public string SelectionStyle { get; set; }

Property Value

Type
System.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

public bool ShowNearestTooltip { get; set; }

Property Value

Type	Description
System.Boolean	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

public string TooltipFormat { get; set; }

Property Value

Type
System.String

TooltipMappingName

The provided value will be considered as a Tooltip name.

Declaration

public string TooltipMappingName { get; set; }

Property Value

Type
System.String

Type

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

Declaration

public ChartSeriesType Type { get; set; }

Property Value

Type
ChartSeriesType

Visible

Specifies the visibility of series.

Declaration

public bool Visible { get; set; }

Property Value

Type
System.Boolean

Volume

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

Declaration

public string Volume { get; set; }

Property Value

Type
System.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

public double Width { get; set; }

Property Value

Type
System.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

public string XAxisName { get; set; }

Property Value

Type
System.String

XName

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

Declaration

public string XName { get; set; }

Property Value

Type
System.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

public string YAxisName { get; set; }

Property Value

Type
System.String

YName

The DataSource field that contains the y value.

Declaration

public string YName { get; set; }

Property Value

Type
System.String

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

OnInitializedAsync()

Method invoked when the component is ready to start.

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.

Overrides

SfDataBoundComponent.OnInitializedAsync()

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent in the render tree and the incoming values have been assigned to properties.

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.

Overrides

SfDataBoundComponent.OnParametersSetAsync()