Blazor

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfStockChart - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SfStockChart

    Inheritance
    System.Object
    BaseComponent
    SfStockChart
    Implements
    System.IDisposable
    IStockChart
    Inherited Members
    BaseComponent.CreateJsAdaptor()
    BaseComponent.OnAfterRenderAsync(Boolean)
    BaseComponent.Dispose()
    BaseComponent.Refresh()
    BaseComponent.clearClientChanges(Boolean)
    BaseComponent.InvokeSet<T>(String, String, Object[])
    BaseComponent.InvokeGet<T>(String, String)
    BaseComponent.WireObservableEvents(Object)
    BaseComponent.getSerializedModel()
    BaseComponent.getUpdateModel(Boolean)
    BaseComponent.GetDataManager(Object, String)
    BaseComponent.uniqueId
    BaseComponent.jsRuntime
    BaseComponent.EditContext
    BaseComponent.mainParent
    BaseComponent.DotNetObjectRef
    Namespace: Syncfusion.Blazor.Charts
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class SfStockChart : BaseComponent, IDisposable, IStockChart

    Constructors

    SfStockChart()

    Declaration
    public SfStockChart()

    Properties

    Annotations

    The configuration for annotation in chart.

    Declaration
    public List<StockChartAnnotation> Annotations { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<StockChartAnnotation>

    Axes

    Secondary axis collection for the stockChart.

    Declaration
    public List<StockChartAxis> Axes { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<StockChartAxis>

    Background

    The background color of the stockChart 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

    Border

    Options for customizing the color and width of the stockChart border.

    Declaration
    public StockChartChartBorder Border { get; set; }
    Property Value
    Type Description
    StockChartChartBorder

    ChartArea

    Options for configuring the border and background of the stockChart area.

    Declaration
    public StockChartChartArea ChartArea { get; set; }
    Property Value
    Type Description
    StockChartChartArea

    ChildContent

    Declaration
    public RenderFragment ChildContent { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment

    Crosshair

    Options for customizing the crosshair of the chart.

    Declaration
    public StockChartCrosshairSettings Crosshair { get; set; }
    Property Value
    Type Description
    StockChartCrosshairSettings

    DataSource

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

    Declaration
    public object DataSource { get; set; }
    Property Value
    Type Description
    System.Object

    DataSourceChanged

    Declaration
    public EventCallback<object> DataSourceChanged { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<System.Object>

    EnableCustomRange

    Custom Range

    Declaration
    public bool EnableCustomRange { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnablePeriodSelector

    It specifies whether the periodSelector to be rendered in financial chart

    Declaration
    public bool EnablePeriodSelector { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnablePersistence

    Enable or disable persisting component's state between page reloads.

    Declaration
    public bool EnablePersistence { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnableRtl

    Enable or disable rendering component in right to left direction.

    Declaration
    public bool EnableRtl { get; set; }
    Property Value
    Type Description
    System.Boolean

    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

    ExportType

    It specifies the types of Export types in financial chart.

    Declaration
    public List<ExportType> ExportType { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<ExportType>

    Height

    The height of the stockChart 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

    HtmlAttributes

    Declaration
    public Dictionary<string, object> HtmlAttributes { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.Dictionary<System.String, System.Object>

    ID

    Declaration
    public override string ID { get; set; }
    Property Value
    Type Description
    System.String
    Overrides
    Syncfusion.Blazor.BaseComponent.ID

    Indicators

    Defines the collection of technical indicators, that are used in financial markets

    Declaration
    public List<StockChartIndicator> Indicators { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<StockChartIndicator>

    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>

    IsMultiSelect

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

    Declaration
    public bool IsMultiSelect { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsSelect

    If set true, enables the animation in chart.

    Declaration
    public bool IsSelect { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsTransposed

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

    Declaration
    public bool IsTransposed { get; set; }
    Property Value
    Type Description
    System.Boolean

    jsProperty

    Declaration
    protected override string jsProperty { get; set; }
    Property Value
    Type Description
    System.String
    Overrides
    BaseComponent.jsProperty

    Locale

    Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

    Declaration
    public string Locale { get; set; }
    Property Value
    Type Description
    System.String

    Margin

    Options to customize left, right, top and bottom margins of the stockChart.

    Declaration
    public StockChartChartMargin Margin { get; set; }
    Property Value
    Type Description
    StockChartChartMargin

    ModelType

    Declaration
    public override Type ModelType { get; set; }
    Property Value
    Type Description
    System.Type
    Overrides
    Syncfusion.Blazor.BaseComponent.ModelType

    nameSpace

    Declaration
    protected override string nameSpace { get; set; }
    Property Value
    Type Description
    System.String
    Overrides
    BaseComponent.nameSpace

    Periods

    To configure period selector options.

    Declaration
    public List<StockChartPeriod> Periods { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<StockChartPeriod>

    PrimaryXAxis

    Options to configure the horizontal axis.

    Declaration
    public StockChartPrimaryXAxis PrimaryXAxis { get; set; }
    Property Value
    Type Description
    StockChartPrimaryXAxis

    PrimaryYAxis

    Options to configure the vertical axis.

    Declaration
    public StockChartPrimaryYAxis PrimaryYAxis { get; set; }
    Property Value
    Type Description
    StockChartPrimaryYAxis

    Rows

    Options to split stockChart into multiple plotting areas horizontally. Each object in the collection represents a plotting area in the stockChart.

    Declaration
    public List<StockChartRow> Rows { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<StockChartRow>

    SelectedDataIndexes

    Specifies the point indexes to be selected while loading a chart. It requires SelectionMode to be Point | Series | or Cluster.

    Declaration
    public List<StockChartSelectedDataIndex> SelectedDataIndexes { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<StockChartSelectedDataIndex>

    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

    Series

    The configuration for series in the stockChart.

    Declaration
    public List<StockChartSeries> Series { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<StockChartSeries>

    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>

    StockEvents

    The configuration for stock events in the stockChart.

    Declaration
    public List<StockChartStockEvent> StockEvents { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<StockChartStockEvent>

    Theme

    Specifies the theme for the stockChart.

    Declaration
    public ChartTheme Theme { get; set; }
    Property Value
    Type Description
    ChartTheme

    Title

    Title of the chart

    Declaration
    public string Title { get; set; }
    Property Value
    Type Description
    System.String

    TitleStyle

    Options for customizing the title of the Chart.

    Declaration
    public StockChartTitleStyle TitleStyle { get; set; }
    Property Value
    Type Description
    StockChartTitleStyle

    Tooltip

    Options for customizing the tooltip of the chart.

    Declaration
    public StockChartTooltipSettings Tooltip { get; set; }
    Property Value
    Type Description
    StockChartTooltipSettings

    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>

    Width

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

    Declaration
    public string Width { get; set; }
    Property Value
    Type Description
    System.String

    ZoomSettings

    Options to enable the zooming feature in the chart.

    Declaration
    public StockChartZoomSettings ZoomSettings { get; set; }
    Property Value
    Type Description
    StockChartZoomSettings

    Methods

    BuildRenderTree(RenderTreeBuilder)

    Declaration
    protected override void BuildRenderTree(RenderTreeBuilder __builder)
    Parameters
    Type Name Description
    Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

    ChartModuleInjection()

    Module Injection for components

    Declaration
    public Task ChartModuleInjection()
    Returns
    Type Description
    System.Threading.Tasks.Task

    FindCurrentData(Object, String)

    Declaration
    public Task<object> FindCurrentData(object totalData, string xName)
    Parameters
    Type Name Description
    System.Object totalData
    System.String xName
    Returns
    Type Description
    System.Threading.Tasks.Task<System.Object>

    GetJSNamespace()

    Declaration
    public string GetJSNamespace()
    Returns
    Type Description
    System.String

    GetModuleName()

    Get component name

    Declaration
    public Task<string> GetModuleName()
    Returns
    Type Description
    System.Threading.Tasks.Task<System.String>

    OnInitializedAsync()

    Declaration
    protected override Task OnInitializedAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    BaseComponent.OnInitializedAsync()

    OnParametersSetAsync()

    Declaration
    protected override Task OnParametersSetAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task

    RangeChanged(Double, Double)

    To change the range for chart

    Declaration
    public Task RangeChanged(double updatedStart, double updatedEnd)
    Parameters
    Type Name Description
    System.Double updatedStart
    System.Double updatedEnd
    Returns
    Type Description
    System.Threading.Tasks.Task

    RenderPeriodSelector()

    Render period selector

    Declaration
    public Task RenderPeriodSelector()
    Returns
    Type Description
    System.Threading.Tasks.Task

    StockChartDataManagerSuccess()

    DataManager Success

    Declaration
    public Task StockChartDataManagerSuccess()
    Returns
    Type Description
    System.Threading.Tasks.Task

    updateChildProperties(String, Object)

    Declaration
    public void updateChildProperties(string key, object value)
    Parameters
    Type Name Description
    System.String key
    System.Object value

    Implements

    System.IDisposable
    IStockChart
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved