Class AccumulationChart
Inheritance
Namespace: Syncfusion.EJ2.Charts
Assembly: Syncfusion.EJ2.dll
Syntax
public class AccumulationChart : EJTagHelper
Constructors
AccumulationChart()
Declaration
public AccumulationChart()
Properties
Accessibility
Options to improve accessibility for accumulation chart elements.
Declaration
public AccumulationAccessibility Accessibility { get; set; }
Property Value
Type | Description |
---|---|
AccumulationAccessibility | The default value is null |
AfterExport
Triggers after the export is completed.
Declaration
public string AfterExport { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
AllowExport
To enable export feature in blazor chart.
Declaration
public bool AllowExport { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
AnimationComplete
Triggers after the animation for the series is completed.
Declaration
public string AnimationComplete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
AnnotationRender
Triggers before the annotation gets rendered. This event allows for modifications of the annotation content and its location before it is rendered on the accumulation chart.
Declaration
public string AnnotationRender { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Annotations
Annotations are used to highlight specific data points or areas in the chart, providing additional context and information.
Declaration
public List<AccumulationAnnotationSettings> Annotations { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<Syncfusion.EJ2.Charts.AccumulationAnnotationSettings> | The default value is null |
Background
The background color of the chart, which accepts values in hex or rgba formats as valid CSS color strings.
Declaration
public string Background { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BackgroundImage
The background image of the chart accepts a string value as a URL link or the location of an image.
Declaration
public string BackgroundImage { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforePrint
Triggers before the print process starts. This event allows for the modification of the accumulation chart's HTML content before it is sent to the printer.
Declaration
public string BeforePrint { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeResize
Triggers before the window resize event occurs. This event allows for modifications to the accumulation chart size before resizing.
Declaration
public string BeforeResize { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Border
Options for customizing the appearance of the border in the chart by using the color
and width
properties in the border
.
Declaration
public AccumulationChartBorder Border { get; set; }
Property Value
Type | Description |
---|---|
AccumulationChartBorder | The default value is null |
Center
The center
property allows changing the center position of the pie chart using the x
and y
properties.
By default, the center value of the pie series is set to 50% for both the x and y coordinates.
Declaration
public AccumulationChartCenter Center { get; set; }
Property Value
Type | Description |
---|---|
AccumulationChartCenter | The default value is null |
CenterLabel
Options to customize the label that appears at the center of the accumulation chart.
Declaration
public AccumulationChartCenterLabel CenterLabel { get; set; }
Property Value
Type | Description |
---|---|
AccumulationChartCenterLabel | The default value is null |
ChartDoubleClick
Triggers when double-clicking the accumulation chart.
Declaration
public string ChartDoubleClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ChartMouseClick
Triggers when clicking on the accumulation chart.
Declaration
public string ChartMouseClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ChartMouseDown
Triggers on the mouse down event within the accumulation chart.
Declaration
public string ChartMouseDown { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ChartMouseLeave
Triggers when the cursor leaves the accumulation chart.
Declaration
public string ChartMouseLeave { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ChartMouseMove
Triggers when hovering over the accumulation chart.
Declaration
public string ChartMouseMove { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ChartMouseUp
Triggers on the mouse up event within the accumulation chart.
Declaration
public string ChartMouseUp { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
DataSource
Specifies the data source for the accumulation 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 | The default value is null |
EnableAnimation
If set to true, enables animation for the accumulation chart.
Declaration
public bool EnableAnimation { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
EnableBorderOnMouseMove
If set to true, enables the border in pie and accumulation charts when the mouse moves over a data point.
Declaration
public bool EnableBorderOnMouseMove { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
EnableExport
When set to true, it enables exporting the accumulation chart to various formats such as JPEG
, PNG
, SVG
, PDF
, XLSX
, or CSV
.
Declaration
public bool EnableExport { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
EnableHtmlSanitizer
Specifies whether to display or remove the untrusted HTML values in the Accumulation Chart component. If 'enableHtmlSanitizer' set to true, the component will sanitize any suspected untrusted strings and scripts before rendering them.
Declaration
public bool EnableHtmlSanitizer { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnablePersistence
Enable or disable persisting component's state between page reloads.
Declaration
public bool EnablePersistence { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableRtl
Enable or disable rendering component in right to left direction.
Declaration
public bool EnableRtl { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableSmartLabels
If set to true, labels for the points will be placed smartly to avoid overlapping.
Declaration
public bool EnableSmartLabels { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
FocusBorderColor
Customize the focus border color. If not specified, the element will use the default focus border color.
Declaration
public string FocusBorderColor { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
FocusBorderMargin
Customize the focus border margin. If not specified, the element will use the default focus border margin.
Declaration
public double FocusBorderMargin { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 0 |
FocusBorderWidth
Customize the focus border width. If not specified, the element will use the default focus border width.
Declaration
public double FocusBorderWidth { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 1.5 |
Height
The height of the chart as a string, allowing input in formats such as '100px' or '100%'. If specified as '100%', the chart will render to the full height of its parent element.
Declaration
public string Height { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
HighlightColor
Defines the color used to highlight a data point on mouse hover.
Declaration
public string HighlightColor { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
HighlightMode
Specifies whether points in the accumulation chart should be highlighted. Accepts the following values: None: Disables the highlighting of points. Point: Highlights an individual point on hover.
Declaration
public AccumulationHighlightMode HighlightMode { get; set; }
Property Value
Type | Description |
---|---|
AccumulationHighlightMode | The default value is AccumulationHighlightMode.None |
HighlightPattern
Specifies the pattern used for highlighting series or data points.
The highlightPattern
property determines how the data points or series are visually highlighted.
The available options are:
None: No highlighting pattern.
Chessboard: Applies a chessboard pattern for highlighting.
Dots: Applies a dot pattern for highlighting.
DiagonalForward: Applies a forward diagonal line pattern for highlighting.
Crosshatch: Applies a crosshatch pattern for highlighting.
Pacman: Applies a Pacman pattern for highlighting.
DiagonalBackward: Applies a backward diagonal line pattern for highlighting.
Grid: Applies a grid pattern for highlighting.
Turquoise: Applies a turquoise pattern for highlighting.
Star: Applies a star pattern for highlighting.
Triangle: Applies a triangle pattern for highlighting.
Circle: Applies a circle pattern for highlighting.
Tile: Applies a tile pattern for highlighting.
HorizontalDash: Applies a horizontal dash pattern for highlighting.
VerticalDash: Applies a vertical dash pattern for highlighting.
Rectangle: Applies a rectangle pattern for highlighting.
Box: Applies a box pattern for highlighting.
VerticalStripe: Applies a vertical stripe pattern for highlighting.
HorizontalStripe: Applies a horizontal stripe pattern for highlighting.
Bubble: Applies a bubble pattern for highlighting.
Declaration
public SelectionPattern HighlightPattern { get; set; }
Property Value
Type | Description |
---|---|
SelectionPattern | The default value is SelectionPattern.None |
HtmlAttributes
Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.
Declaration
public object HtmlAttributes { get; set; }
Property Value
Type |
---|
System.Object |
IsMultiSelect
When set to true, allows for the selection of multiple data points.
Note that
selectionMode
must be set toPoint
for multi-selection to be enabled.
Declaration
public bool IsMultiSelect { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
LegendClick
Triggers after the legend is clicked.
Declaration
public string LegendClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
LegendRender
Triggers before the legend gets rendered. This allows the customization of legend before rendering on the accumulation chart.
Declaration
public string LegendRender { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
LegendSettings
The legend provides descriptive information about the data points displayed in the accumulation chart, helping to understand what each point represents.
Declaration
public AccumulationChartLegendSettings LegendSettings { get; set; }
Property Value
Type | Description |
---|---|
AccumulationChartLegendSettings | The default value is null |
Load
Triggers before the accumulation chart loads. This event allows for customization and configuration before the accumulation chart is rendered.
Declaration
public string Load { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Loaded
Triggers after the accumulation chart has been loaded.
Declaration
public string Loaded { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
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 | The default value is "" |
Margin
Options to customize the margins around the accumulation chart, including the left, right, top, and bottom margins. These margins define the space between the outer edge of the accumulation chart and its chart area.
Declaration
public AccumulationChartMargin Margin { get; set; }
Property Value
Type | Description |
---|---|
AccumulationChartMargin | The default value is null |
PointClick
Triggers when a point in the accumulation chart is clicked.
Declaration
public string PointClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
PointMove
Triggers when a point in the accumulation chart is moved.
Declaration
public string PointMove { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
PointRender
Triggers before each point in the series gets rendered. This allows for the customization of each data point before it is rendered on the accumulation chart.
Declaration
public string PointRender { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Resized
Triggers after the window resize event completes.
Declaration
public string Resized { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
SelectedDataIndexes
Specifies the point indexes to be selected when the accumulation chart is initially loaded.
Note that
selectionMode
must be set toPoint
for this feature to work.
Declaration
public object SelectedDataIndexes { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
SelectionComplete
Triggers after the selection is completed.
Declaration
public string SelectionComplete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
SelectionMode
Specifies whether points in the accumulation chart can be selected. Accepts the following values: None: Disables the selection of points. Point: Enables the selection of individual points.
Declaration
public AccumulationSelectionMode SelectionMode { get; set; }
Property Value
Type | Description |
---|---|
AccumulationSelectionMode | The default value is AccumulationSelectionMode.None |
SelectionPattern
Specifies the selection pattern for series or data points.
The selectionPattern
property determines how the selected data points or series are visually represented.
The available options are:
None: No selection pattern is applied.
Chessboard: Applies a chessboard pattern as the selection effect.
Dots: Applies a dot pattern as the selection effect.
DiagonalForward: Applies a forward diagonal line pattern as the selection effect.
Crosshatch: Applies a crosshatch pattern as the selection effect.
Pacman: Applies a Pacman pattern as the selection effect.
DiagonalBackward: Applies a backward diagonal line pattern as the selection effect.
Grid: Applies a grid pattern as the selection effect.
Turquoise: Applies a turquoise pattern as the selection effect.
Star: Applies a star pattern as the selection effect.
Triangle: Applies a triangle pattern as the selection effect.
Circle: Applies a circle pattern as the selection effect.
Tile: Applies a tile pattern as the selection effect.
HorizontalDash: Applies a horizontal dash pattern as the selection effect.
VerticalDash: Applies a vertical dash pattern as the selection effect.
Rectangle: Applies a rectangle pattern as the selection effect.
Box: Applies a box pattern as the selection effect.
VerticalStripe: Applies a vertical stripe pattern as the selection effect.
HorizontalStripe: Applies a horizontal stripe pattern as the selection effect.
Bubble: Applies a bubble pattern as the selection effect.
Declaration
public SelectionPattern SelectionPattern { get; set; }
Property Value
Type | Description |
---|---|
SelectionPattern | The default value is SelectionPattern.None |
Series
The configuration for series in the accumulation chart.
Declaration
public List<AccumulationSeries> Series { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<Syncfusion.EJ2.Charts.AccumulationSeries> | The default value is null |
SeriesRender
Triggers before the series gets rendered. This event allows for the customization of series properties before they are rendered on the accumulation chart.
Declaration
public string SeriesRender { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
SubTitle
The subtitle is positioned below the main title and provides further details about the data represented in the accumulation chart.
Declaration
public string SubTitle { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
SubTitleStyle
Options for customizing the appearance of the subtitle, which displays information about the plotted data below the main title.
Use the fontFamily
, size
, fontStyle
, fontWeight
, and color
properties in Font
to adjust the subtitle's appearance.
Declaration
public AccumulationChartFont SubTitleStyle { get; set; }
Property Value
Type | Description |
---|---|
AccumulationChartFont | The default value is null |
TextRender
Triggers before the data label for the series gets rendered. This allows customization of data labels before they are rendered on the accumulation chart.
Declaration
public string TextRender { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Theme
The theme applied to the accumulation chart for visual styling. Choose from predefined themes to change the overall look and feel of the accumulation chart. The available themes are: Fabric FabricDark Bootstrap4 Bootstrap BootstrapDark HighContrastLight HighContrast Tailwind TailwindDark Bootstrap5 Bootstrap5Dark Fluent FluentDark Fluent2 Fluent2Dark Fluent2HighContrast Material3 Material3Dark Material MaterialDark
Declaration
public AccumulationTheme Theme { get; set; }
Property Value
Type | Description |
---|---|
AccumulationTheme | The default value is AccumulationTheme.Material |
Title
The title is displayed at the top of the chart to provide information about the plotted data.
Declaration
public string Title { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
TitleStyle
Options for customizing the appearance of the title, which displays information about the plotted data.
Use the fontFamily
, size
, fontStyle
, fontWeight
, and color
properties in Font
to adjust the title's appearance.
Declaration
public AccumulationChartFont TitleStyle { get; set; }
Property Value
Type | Description |
---|---|
AccumulationChartFont | The default value is null |
Tooltip
Tooltips display information about the data points when the mouse hovers over a point.
Declaration
public AccumulationChartTooltipSettings Tooltip { get; set; }
Property Value
Type | Description |
---|---|
AccumulationChartTooltipSettings | The default value is null |
TooltipRender
Triggers before the tooltip for the series gets rendered. This event allows customization of the tooltip properties such as text, style, and template before it is rendered on the accumulation chart.
Declaration
public string TooltipRender { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
UseGroupingSeparator
When set to true, a grouping separator will be used for numbers to separate groups of thousands in the accumulation chart.
Declaration
public bool UseGroupingSeparator { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
Width
The width of the chart as a string, allowing input in formats such as '100px' or '100%'. If specified as '100%', the chart will render to the full width of its parent element.
Declaration
public string Width { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |