Class SfStockChart

Stock Chart is a well-crafted, easy-to-use financial charting package to track and visualize the stock price of any company over a specific period using charting (such as Candlestick chart, OHLC, etc) and range tools.

Inheritance

System.Object

SfBaseComponent

SfDataBoundComponent

SfStockChart

Inherited Members

SfBaseComponent.Dispose()

SfBaseComponent.Dispose(Boolean)

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

SfDataBoundComponent.DataManager

SfDataBoundComponent.MainParent

SfDataBoundComponent.SetDataManager<T>(Object)

Namespace: Syncfusion.Blazor.Charts

Assembly: Syncfusion.Blazor.dll

Syntax

public class SfStockChart : SfDataBoundComponent

Constructors

SfStockChart()

Declaration

public SfStockChart()

Properties

Background

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

Declaration

public string Background { get; set; }

Property Value

Type	Description
System.String	Accepts the string value that specifies the background color of stock chart.

ChildContent

Gets and sets the content of the UI element.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	Accepts a RenderFragment that defines the content of the UI element.

DataSource

Specifies the data source for the stock chart. 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>

EnableCustomRange

Defines the custom range.

Declaration

public bool EnableCustomRange { get; set; }

Property Value

Type	Description
System.Boolean	true, if the custom range can be enabled for the component. otherwise, false. The default value is true.

EnablePeriodSelector

It specifies whether the period selector to be rendered in financial chart.

Declaration

public bool EnablePeriodSelector { get; set; }

Property Value

Type	Description
System.Boolean	true, if the period of selector can be enabled for the component. Otherwise, false. The default value is true.

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean	true, if the right to left direction can be enabled for the component. The default value is false.

EnableSelector

It specifies whether the range navigator to be rendered in financial chart.

Declaration

public bool EnableSelector { get; set; }

Property Value

Type	Description
System.Boolean	true, if the range navigator can be enabled. Otherwise, false. The default value is true.

ExportType

It specifies the types of export options in financial chart.

Declaration

public List<ExportType> ExportType { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ExportType>	A list of ExportType enumeration values that specifies the types of export options available in stock chart. The available exported values are "PNG, JPEG, SVG, PDF".

Height

The height of the stock chart as a string accepts input both as '100px' or '100%'. If specified as '100%, stockChart renders to the full height of its parent element.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String	Accepts the string value in the format "100px" or "100%".

ID

Gets and sets the identification of the component.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String	Accepts the string value.

IndicatorType

It specifies the types of indicators in financial chart.

Declaration

public List<TechnicalIndicators> IndicatorType { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<TechnicalIndicators>	A list of TechnicalIndicators enumeration values that specifies the types of technical indicators available in stock chart. The available indicator values are "Ema, Tma, Sma, Momentum, Atr, AccumulationDistribution, BollingerBands, Macd, Stochastic, Rsi".

IsMultiSelect

If set true, enables the multi-selection in chart. It requires SelectionMode set to be Point | Series | or Cluster.

Declaration

public bool IsMultiSelect { get; set; }

Property Value

Type	Description
System.Boolean	true, if the multiple selection can be enabled. The default value is false.

IsSelect

If set true, enables the animation in chart.

Declaration

public bool IsSelect { get; set; }

Property Value

Type	Description
System.Boolean	true, if the selection can be enabled. The default value is false.

IsTransposed

It specifies whether the stock chart should be render in transposed manner or not.

Declaration

public bool IsTransposed { get; set; }

Property Value

Type	Description
System.Boolean	true, if the transposed can be enabled. Otherwise, false.

SelectionMode

Specifies whether series or data point has to be selected. They are, None: Disables the selection. Series: Selects a series. Point: Selects a point. Cluster: Selects a cluster of point. DragXY: Selects points by dragging with respect to both horizontal and vertical axes. DragX: Selects points by dragging with respect to horizontal axis. DragY: Selects points by dragging with respect to vertical axis.

Declaration

public SelectionMode SelectionMode { get; set; }

Property Value

Type	Description
SelectionMode	One of the SelectionMode enumeration that specifies the selection mode of chart. The default value is None.

SeriesType

It specifies the types of series in financial chart.

Declaration

public List<ChartSeriesType> SeriesType { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ChartSeriesType>	A list of ChartSeriesType enumeration values that specifies the types of chart series available in the stock chart. The available series types are "Line, Hilo, HiloOpenClose, Candle, Spline".

Theme

Specifies the theme for the stock chart.

Declaration

public Theme Theme { get; set; }

Property Value

Type	Description
Theme	Accepts a value from the Theme enum. The default value is Bootstrap4.

Title

Title of the stock chart.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String	Accepts the string value. The default value is empty.

TrendlineType

It specifies the types of trendline types in financial chart.

Declaration

public List<TrendlineTypes> TrendlineType { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<TrendlineTypes>	A list of TrendlineTypes enumeration values that specifies the types of trendlines available in the stock chart. The available trendline types are "Linear, Exponential, Polynomial, Logarithmic, MovingAverage".

Width

The width of the stock chart as a string accepts input as both like '100px' or '100%'. If specified as '100%, stock chart renders to the full width of its parent element.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	Accepts the string value in the format "100px" or "100%".

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

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

ExportAsync(ExportType, String, Nullable<PdfPageOrientation>, Boolean, Boolean)

The method is used to perform the export functionality for the rendered stock chart.

Declaration

public Task ExportAsync(ExportType type, string fileName, Nullable<PdfPageOrientation> orientation = null, bool allowDownload = true, bool isBase64 = false)

Parameters

Type	Name	Description
ExportType	type	Specifies the export type for the rendered stock chart.
System.String	fileName	Specifies the filename.
System.Nullable<Syncfusion.PdfExport.PdfPageOrientation>	orientation	Specifies the portrait or landscape orientation of the page.
System.Boolean	allowDownload	Specifies whether to download or not.
System.Boolean	isBase64	Specify whether to obtain the chart image as a base64 string or not.

Returns

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

GetStockChartTooltipPosition()

Returns the stock chart tooltip position.

Declaration

public string GetStockChartTooltipPosition()

Returns

Type	Description
System.String	The tooltip position as a string.

Remarks

For internal use only.

OnAfterRenderAsync(Boolean)

Method invoked after each time the component has been rendered.

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender	Represents the first render.

Returns

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

Overrides

SfDataBoundComponent.OnAfterRenderAsync(Boolean)

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()

PrintAsync(ElementReference)

The method is used to perform the print functionality in stock chart.

Declaration

public Task PrintAsync(ElementReference elementRef = null)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.ElementReference	elementRef

Returns

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

Refresh()

Method helps to re-render the stock chart.

Declaration

public void Refresh()

ShouldRender()

Declaration

protected override bool ShouldRender()

Returns

Type
System.Boolean

UpdateStockChart()

Method helps to re-render the stock chart UI element.

Declaration

public void UpdateStockChart()