Class SfChart

Inheritance

System.Object

Syncfusion.Blazor.BaseComponent

SfChart

Implements

System.IDisposable

IChart

Namespace: Syncfusion.Blazor.Charts

Assembly: Syncfusion.Blazor.dll

Syntax

public class SfChart : BaseComponent, IDisposable, IChart

Constructors

SfChart()

Declaration

public SfChart()

Properties

AllowExport

To enable export feature in blazor chart.

Declaration

public bool AllowExport { get; set; }

Property Value

Type	Description
System.Boolean

AllowMultiSelection

If set true, enables the multi drag selection in chart. It requires SelectionMode to be Dragx | DragY | or DragXY.

Declaration

public bool AllowMultiSelection { get; set; }

Property Value

Type	Description
System.Boolean

Annotations

The configuration for annotation in chart.

Declaration

public List<ChartAnnotation> Annotations { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ChartAnnotation>

Axes

Secondary axis collection for the chart.

Declaration

public List<ChartAxis> Axes { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ChartAxis>

Background

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

BackgroundImage

The background image of the chart that accepts value in string as url link or location of an image.

Declaration

public string BackgroundImage { get; set; }

Property Value

Type	Description
System.String

Border

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

Declaration

public ChartBorder Border { get; set; }

Property Value

Type	Description
ChartBorder

ChartArea

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

Declaration

public ChartArea ChartArea { get; set; }

Property Value

Type	Description
ChartArea

ChildContent

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment

Columns

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

Declaration

public List<ChartColumn> Columns { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ChartColumn>

Crosshair

Options for customizing the crosshair of the chart.

Declaration

public ChartCrosshairSettings Crosshair { get; set; }

Property Value

Type	Description
ChartCrosshairSettings

DataSource

Specifies the DataSource for the chart. 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>

Description

Description for chart.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

EnableAnimation

If set true, Animation process will be executed.

Declaration

public bool EnableAnimation { get; set; }

Property Value

Type	Description
System.Boolean

EnableCanvas

It specifies whether the chart should be rendered in canvas mode

Declaration

public bool EnableCanvas { get; set; }

Property Value

Type	Description
System.Boolean

EnableExport

To enable export feature in chart.

Declaration

public bool EnableExport { 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

EnableSideBySidePlacement

To enable the side by side placing the points for column type series.

Declaration

public bool EnableSideBySidePlacement { get; set; }

Property Value

Type	Description
System.Boolean

Height

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

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String

HighlightMode

Specifies whether series or data point has to be selected. They are, none: Disables the highlight. series: highlight a series. point: highlight a point. cluster: highlight a cluster of point

Declaration

public HighlightMode HighlightMode { get; set; }

Property Value

Type	Description
HighlightMode

HighlightPattern

Specifies whether series or data point has to be selected. They are, none: sets none as highlighting pattern. chessboard: sets chess board as highlighting pattern. dots: sets dots as highlighting pattern. diagonalForward: sets diagonal forward as highlighting pattern. crosshatch: sets crosshatch as highlighting pattern. pacman: sets pacman highlighting pattern. diagonalbackward: sets diagonal backward as highlighting pattern. grid: sets grid as highlighting pattern. turquoise: sets turquoise as highlighting pattern. star: sets star as highlighting pattern. triangle: sets triangle as highlighting pattern. circle: sets circle as highlighting pattern. tile: sets tile as highlighting pattern. horizontaldash: sets horizontal dash as highlighting pattern. verticaldash: sets vertical dash as highlighting pattern. rectangle: sets rectangle as highlighting pattern. box: sets box as highlighting pattern. verticalstripe: sets vertical stripe as highlighting pattern. horizontalstripe: sets horizontal stripe as highlighting pattern. bubble: sets bubble as highlighting pattern.

Declaration

public SelectionPattern HighlightPattern { get; set; }

Property Value

Type	Description
SelectionPattern

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<ChartIndicator> Indicators { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ChartIndicator>

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

IsTransposed

It specifies whether the chart 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

Syncfusion.Blazor.BaseComponent.jsProperty

LegendSettings

Options for customizing the legend of the chart.

Declaration

public ChartLegendSettings LegendSettings { get; set; }

Property Value

Type	Description
ChartLegendSettings

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 chart.

Declaration

public ChartMargin Margin { get; set; }

Property Value

Type	Description
ChartMargin

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

Syncfusion.Blazor.BaseComponent.nameSpace

Palettes

Palette for the chart series.

Declaration

public string[] Palettes { get; set; }

Property Value

Type	Description
System.String[]

PrimaryXAxis

Options to configure the horizontal axis.

Declaration

public ChartPrimaryXAxis PrimaryXAxis { get; set; }

Property Value

Type	Description
ChartPrimaryXAxis

PrimaryYAxis

Options to configure the vertical axis.

Declaration

public ChartPrimaryYAxis PrimaryYAxis { get; set; }

Property Value

Type	Description
ChartPrimaryYAxis

Rows

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

Declaration

public List<ChartRow> Rows { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ChartRow>

SelectedDataIndexes

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

Declaration

public List<ChartSelectedDataIndex> SelectedDataIndexes { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ChartSelectedDataIndex>

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. lasso: selects points by dragging with respect to free form.

Declaration

public SelectionMode SelectionMode { get; set; }

Property Value

Type	Description
SelectionMode

SelectionPattern

Specifies whether series or data point has to be selected. They are, none: sets none as selecting pattern. chessboard: sets chess board as selecting pattern. dots: sets dots as selecting pattern. diagonalForward: sets diagonal forward as selecting pattern. crosshatch: sets crosshatch as selecting pattern. pacman: sets pacman selecting pattern. diagonalbackward: sets diagonal backward as selecting pattern. grid: sets grid as selecting pattern. turquoise: sets turquoise as selecting pattern. star: sets star as selecting pattern. triangle: sets triangle as selecting pattern. circle: sets circle as selecting pattern. tile: sets tile as selecting pattern. horizontaldash: sets horizontal dash as selecting pattern. verticaldash: sets vertical dash as selecting pattern. rectangle: sets rectangle as selecting pattern. box: sets box as selecting pattern. verticalstripe: sets vertical stripe as selecting pattern. horizontalstripe: sets horizontal stripe as selecting pattern. bubble: sets bubble as selecting pattern.

Declaration

public SelectionPattern SelectionPattern { get; set; }

Property Value

Type	Description
SelectionPattern

Series

The configuration for series in the chart.

Declaration

public List<ChartSeries> Series { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ChartSeries>

SubTitle

SubTitle of the chart

Declaration

public string SubTitle { get; set; }

Property Value

Type	Description
System.String

SubTitleStyle

Options for customizing the Subtitle of the Chart.

Declaration

public ChartSubTitleStyle SubTitleStyle { get; set; }

Property Value

Type	Description
ChartSubTitleStyle

TabIndex

TabIndex value for the chart.

Declaration

public double TabIndex { get; set; }

Property Value

Type	Description
System.Double

Theme

Specifies the theme for the chart.

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 ChartTitleStyle TitleStyle { get; set; }

Property Value

Type	Description
ChartTitleStyle

Tooltip

Options for customizing the tooltip of the chart.

Declaration

public ChartTooltipSettings Tooltip { get; set; }

Property Value

Type	Description
ChartTooltipSettings

UseGroupingSeparator

Specifies whether a grouping separator should be used for a number.

Declaration

public bool UseGroupingSeparator { get; set; }

Property Value

Type	Description
System.Boolean

Width

The width of the chart as a string accepts input as both like '100px' or '100%'. If specified as '100%, chart 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 ChartZoomSettings ZoomSettings { get; set; }

Property Value

Type	Description
ChartZoomSettings

Methods

AddSeries(Object)

To add series for the chart

Declaration

public Task AddSeries(object seriesCollection)

Parameters

Type	Name	Description
System.Object	seriesCollection

Returns

Type	Description
System.Threading.Tasks.Task

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

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

ClearSeries()

To Clear all series for the chart

Declaration

public Task ClearSeries()

Returns

Type	Description
System.Threading.Tasks.Task

CreateChartSvg()

Method to create SVG element.

Declaration

public Task CreateChartSvg()

Returns

Type	Description
System.Threading.Tasks.Task

Export(ExportType, String)

Export method for the chart.

Declaration

public Task Export(ExportType type, string fileName)

Parameters

Type	Name	Description
ExportType	type
System.String	fileName

Returns

Type	Description
System.Threading.Tasks.Task

GetJSNamespace()

Declaration

public string GetJSNamespace()

Returns

Type	Description
System.String

GetLocalizedLabel(String)

Gets the localized label by locale keyword.

Declaration

public Task<string> GetLocalizedLabel(string key)

Parameters

Type	Name	Description
System.String	key

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

GetModuleName()

Get component name

Declaration

public Task<string> GetModuleName()

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

OnAfterRenderAsync(Boolean)

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Syncfusion.Blazor.BaseComponent.OnAfterRenderAsync(System.Boolean)

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Syncfusion.Blazor.BaseComponent.OnInitializedAsync()

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Print(Object)

Handles the print method for chart control.

Declaration

public Task Print(object id = null)

Parameters

Type	Name	Description
System.Object	id

Returns

Type	Description
System.Threading.Tasks.Task

RefreshLiveData()

Fix for live data update flicker issue

Declaration

public Task RefreshLiveData()

Returns

Type	Description
System.Threading.Tasks.Task

RemoveSeries(Double)

To Remove series for the chart

Declaration

public Task RemoveSeries(double index)

Parameters

Type	Name	Description
System.Double	index

Returns

Type	Description
System.Threading.Tasks.Task

SetAnnotationValue(Double, String)

Method to set the annotation content dynamically for chart.

Declaration

public Task SetAnnotationValue(double annotationIndex, string content)

Parameters

Type	Name	Description
System.Double	annotationIndex
System.String	content

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

IChart