Class SfAccumulationChart

The accumulation chart control is used to visualize the data in the different types of graphical representations with built-in features like Grouping, legends, tooltip, and more.

Inheritance

System.Object

SfBaseComponent

SfDataBoundComponent

SfAccumulationChart

Implements

IAccumulationChart

Inherited Members

SfBaseComponent.Dispose()

SfBaseComponent.Dispose(Boolean)

SfDataBoundComponent.DataManager

SfDataBoundComponent.MainParent

SfDataBoundComponent.SetDataManager<T>(Object)

Namespace: Syncfusion.Blazor.Charts

Assembly: Syncfusion.Blazor.dll

Syntax

public class SfAccumulationChart : SfDataBoundComponent, IAccumulationChart

Constructors

SfAccumulationChart()

Declaration

public SfAccumulationChart()

Properties

AccumulationChartEvents

Declaration

public AccumulationChartEvents AccumulationChartEvents { get; set; }

Property Value

Type
AccumulationChartEvents

Annotations

Declaration

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

Property Value

Type
System.Collections.Generic.List<AccumulationChartAnnotation>

Background

The background color of the chart, which accepts data in hex, 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 the chart.

BackgroundImage

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

Declaration

public string BackgroundImage { get; set; }

Property Value

Type	Description
System.String	Accepts the string value that representing the URL or path to the background image.

Border

Declaration

public AccumulationChartBorder Border { get; set; }

Property Value

Type
AccumulationChartBorder

Center

Declaration

public AccumulationChartCenter Center { get; set; }

Property Value

Type
AccumulationChartCenter

ChildContent

Sets content for chart element including HTML and its customizations.

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.

CustomClass

Defines class/multiple classes separated by a space in the chart element.

Declaration

public string CustomClass { get; set; }

Property Value

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

DataSource

Specifies the dataSource for the AccumulationChart. 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>

DataSourceChanged

Triggers when dataSource for the chart changed.

Declaration

public EventCallback<object> DataSourceChanged { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Object>

EnableAdaptiveRendering

Gets or sets a value indicating whether adaptive rendering is enabled for the SfAccumulationChart component.

Declaration

public bool EnableAdaptiveRendering { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value that enables or disables adaptive rendering for the SfAccumulationChart component. The default value is false.

Remarks

When adaptive rendering is enabled, the chart renders with optimized elements based on the device resolution. This setting may override existing chart element properties such as titles, data labels, and legends. For example, when the screen size is 300x300, data labels may move inside, and the legend position may adjust to fit the screen size, among other changes.

EnableAnimation

If set true, enables the animation for accumulation chart.

Declaration

public bool EnableAnimation { get; set; }

Property Value

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

EnableBorderOnMouseMove

If set true, enables the border in pie chart while mouse moving.

Declaration

public bool EnableBorderOnMouseMove { get; set; }

Property Value

Type	Description
System.Boolean	true, if the border can be displayed when the mouse move on the chart. Otherwise, false. The default value is true.

EnableGroupingSeparator

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

Declaration

public bool EnableGroupingSeparator { get; set; }

Property Value

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

EnableRtl

Gets or sets the right to left direction that defines the text writing and user interface (UI) elements direction in layout.

Declaration

public bool EnableRtl { get; set; }

Property Value

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

EnableSmartLabels

If set true, labels for the point will be placed smartly without overlapping.

Declaration

public bool EnableSmartLabels { get; set; }

Property Value

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

Height

The height of the chart as a string in order to provide input as both like '100px' or '100%'. If specified as '100%, chart will render to the full height of its parent element.

Declaration

public string Height { get; set; }

Property Value

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

HighlightColor

Gets and sets the highlight color for the data point when user hover the data point.

Declaration

public string HighlightColor { get; set; }

Property Value

Type	Description
System.String	Specifies the hover color for data point. The default value is null.

HighlightMode

Specifies whether point has to get highlighted or not. Takes chartItems either 'None 'or 'Point'.

Declaration

public AccumulationSelectionMode HighlightMode { get; set; }

Property Value

Type	Description
AccumulationSelectionMode	The highlight mode of the chart component.

HighlightPattern

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

Declaration

public SelectionPattern HighlightPattern { get; set; }

Property Value

Type	Description
SelectionPattern	The highlighting pattern for the series or data point in the accumulation chart.

ID

Sets id attribute for chart element.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String	Accepts the string value.

IsMultiSelect

If set true, enables the multi selection in accumulation chart. It requires SelectionMode to be Point.

Declaration

public bool IsMultiSelect { get; set; }

Property Value

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

LegendSettings

Declaration

public AccumulationChartLegendSettings LegendSettings { get; set; }

Property Value

Type
AccumulationChartLegendSettings

Margin

Declaration

public AccumulationChartMargin Margin { get; set; }

Property Value

Type
AccumulationChartMargin

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	Description
Query	An object of the type Query that represents the query to be selected the data from data source.

SelectedDataIndexes

Declaration

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

Property Value

Type
System.Collections.Generic.List<AccumulationChartSelectedDataIndex>

SelectionMode

Specifies whether point has to get selected or not. Takes chartItems either 'None 'or 'Point'.

Declaration

public AccumulationSelectionMode SelectionMode { get; set; }

Property Value

Type	Description
AccumulationSelectionMode	One of the AccumulationSelectionMode enumeration values that specifies the mode of selection in chart component.

SelectionPattern

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

Declaration

public SelectionPattern SelectionPattern { get; set; }

Property Value

Type	Description
SelectionPattern	The selection pattern for the series or data point in the accumulation chart.

Series

Declaration

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

Property Value

Type
System.Collections.Generic.List<AccumulationChartSeries>

SubTitle

Specifies the SubTitle of the accumulation chart.

Declaration

public string SubTitle { get; set; }

Property Value

Type	Description
System.String	Accepts the string value.

SubTitleStyle

Declaration

public AccumulationChartSubTitleStyle SubTitleStyle { get; set; }

Property Value

Type
AccumulationChartSubTitleStyle

Theme

Specifies the theme for accumulation 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

Specifies the Title of the accumulation chart.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String	Accepts the string value.

TitleStyle

Declaration

public AccumulationChartTitleStyle TitleStyle { get; set; }

Property Value

Type
AccumulationChartTitleStyle

Tooltip

Declaration

public AccumulationChartTooltipSettings Tooltip { get; set; }

Property Value

Type
AccumulationChartTooltipSettings

Width

The width of the chart as a string in order to provide input as both like '100px' or '100%'. If specified as '100%, chart will render to the full width of its parent element.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	Accepts the string value. The default value is 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)

The method is used to perform the export functionality for the Chart.

Declaration

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

Parameters

Type	Name	Description
ExportType	type	Specifies the format of the file to export the circular gauge.
System.String	fileName	Specifies the name of the file for the exported circular gauge.
System.Nullable<Syncfusion.PdfExport.PdfPageOrientation>	orientation	Specifies the orientation of the exported PDF document when the type parameter is PDF.
System.Boolean	allowDownload	Specifies whether the exported file is to be downloaded or not.

Returns

Type
System.Threading.Tasks.Task

OnAfterRenderAsync(Boolean)

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender

Returns

Type
System.Threading.Tasks.Task

Overrides

SfDataBoundComponent.OnAfterRenderAsync(Boolean)

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type
System.Threading.Tasks.Task

Overrides

SfDataBoundComponent.OnInitializedAsync()

OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)

Declaration

protected override void OnObservableChange(string propertyName, object sender, bool isCollectionChanged = false, NotifyCollectionChangedEventArgs e = null)

Parameters

Type	Name	Description
System.String	propertyName
System.Object	sender
System.Boolean	isCollectionChanged
System.Collections.Specialized.NotifyCollectionChangedEventArgs	e

Overrides

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

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type
System.Threading.Tasks.Task

Overrides

SfDataBoundComponent.OnParametersSetAsync()

PrintAsync(ElementReference)

Handles the print method for accumulation chart control.

Declaration

public Task PrintAsync(ElementReference elementRef = null)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.ElementReference	elementRef

Returns

Type
System.Threading.Tasks.Task

Refresh(Boolean)

This re renders the accumulation chart.

Declaration

public void Refresh(bool shouldAnimate = true)

Parameters

Type	Name	Description
System.Boolean	shouldAnimate

SetAnnotationValueAsync(Double, String)

Method to set the annotation content dynamically for accumulation.

Declaration

public Task SetAnnotationValueAsync(double annotationIndex, string content)

Parameters

Type	Name	Description
System.Double	annotationIndex
System.String	content

Returns

Type
System.Threading.Tasks.Task

Implements

IAccumulationChart