Class AccumulationSeriesBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
AccumulationSeriesBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class AccumulationSeriesBuilder : ControlBuilder
Constructors
AccumulationSeriesBuilder()
Declaration
public AccumulationSeriesBuilder()
AccumulationSeriesBuilder(List<AccumulationSeries>)
Declaration
public AccumulationSeriesBuilder(List<AccumulationSeries> collection)
Parameters
Methods
Accessibility(AccumulationChartAccessibility)
Options to improve accessibility for series elements.
Declaration
public AccumulationSeriesBuilder Accessibility(AccumulationChartAccessibility accessibility)
Parameters
Returns
Accessibility(Action<AccumulationChartAccessibilityBuilder>)
Declaration
public AccumulationSeriesBuilder Accessibility(Action<AccumulationChartAccessibilityBuilder> accessibility)
Parameters
Returns
Add()
Declaration
AddPoint(Object)
Declaration
public AccumulationSeriesBuilder AddPoint(object addPoint)
Parameters
| Type |
Name |
Description |
| System.Object |
addPoint |
|
Returns
Animation(AccumulationChartAnimation)
Options for customizing the animation of the series.
By default, animation is enabled with a duration of 1000 milliseconds (about 1 second). It can be disabled by setting enable to false.
The following properties are supported in animation:
enable: If set to true, the series is animated on initial loading.
duration: The duration of the animation in milliseconds.
delay: The delay before the animation starts, in milliseconds.
Declaration
public AccumulationSeriesBuilder Animation(AccumulationChartAnimation animation)
Parameters
Returns
Animation(Action<AccumulationChartAnimationBuilder>)
Declaration
public AccumulationSeriesBuilder Animation(Action<AccumulationChartAnimationBuilder> animation)
Parameters
Returns
ApplyPattern(Boolean)
When set to true, a different pattern is applied to each slice of the pie.
Declaration
public AccumulationSeriesBuilder ApplyPattern(bool applyPattern)
Parameters
| Type |
Name |
Description |
| System.Boolean |
applyPattern |
|
Returns
Border(AccumulationChartBorder)
Options for customizing the border of the series.
Declaration
public AccumulationSeriesBuilder Border(AccumulationChartBorder border)
Parameters
Returns
Border(Action<AccumulationChartBorderBuilder>)
Declaration
public AccumulationSeriesBuilder Border(Action<AccumulationChartBorderBuilder> border)
Parameters
Returns
BorderRadius(Double)
Option for customizing the border radius.
Declaration
public AccumulationSeriesBuilder BorderRadius(double borderRadius)
Parameters
| Type |
Name |
Description |
| System.Double |
borderRadius |
|
Returns
DashArray(String)
Defines the pattern of dashes and gaps for the series border.
Declaration
public AccumulationSeriesBuilder DashArray(string dashArray)
Parameters
| Type |
Name |
Description |
| System.String |
dashArray |
|
Returns
DataLabel(AccumulationDataLabelSettings)
The data label property can be used to show the data label and customize its position and styling.
Declaration
public AccumulationSeriesBuilder DataLabel(AccumulationDataLabelSettings dataLabel)
Parameters
Returns
DataLabel(Action<AccumulationDataLabelSettingsBuilder>)
Declaration
public AccumulationSeriesBuilder DataLabel(Action<AccumulationDataLabelSettingsBuilder> dataLabel)
Parameters
Returns
DataSource(Action<DataManagerBuilder>)
Declaration
public AccumulationSeriesBuilder DataSource(Action<DataManagerBuilder> dataSource)
Parameters
| Type |
Name |
Description |
| System.Action<Syncfusion.EJ2.DataManagerBuilder> |
dataSource |
|
Returns
DataSource(Object)
Specifies the data source for the series. It can be an array of JSON objects, or an instance of DataManager.
Declaration
public AccumulationSeriesBuilder DataSource(object dataSource)
Parameters
| Type |
Name |
Description |
| System.Object |
dataSource |
|
Returns
EmptyPointSettings(AccumulationChartEmptyPointSettings)
Customization options for the appearance of empty points in the series, where null or undefined values are considered as empty points.
Declaration
public AccumulationSeriesBuilder EmptyPointSettings(AccumulationChartEmptyPointSettings emptyPointSettings)
Parameters
Returns
EmptyPointSettings(Action<AccumulationChartEmptyPointSettingsBuilder>)
Declaration
public AccumulationSeriesBuilder EmptyPointSettings(Action<AccumulationChartEmptyPointSettingsBuilder> emptyPointSettings)
Parameters
Returns
Controls whether the tooltip for the accumulation chart series is enabled or disabled. Set to true to display tooltips on hover, or false to hide them.
Declaration
public AccumulationSeriesBuilder EnableTooltip(bool enableTooltip)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableTooltip |
|
Returns
EndAngle(Double)
Specifies the ending angle for the series, in degrees.
Declaration
public AccumulationSeriesBuilder EndAngle(double endAngle)
Parameters
| Type |
Name |
Description |
| System.Double |
endAngle |
|
Returns
Explode(Boolean)
If set to true, series points will explode on mouse click or touch.
Declaration
public AccumulationSeriesBuilder Explode(bool explode)
Parameters
| Type |
Name |
Description |
| System.Boolean |
explode |
|
Returns
ExplodeAll(Boolean)
If set to true, all the points in the series will explode on load.
Declaration
public AccumulationSeriesBuilder ExplodeAll(bool explodeAll)
Parameters
| Type |
Name |
Description |
| System.Boolean |
explodeAll |
|
Returns
ExplodeIndex(Double)
Index of the point in the series to be exploded on initial load.
Declaration
public AccumulationSeriesBuilder ExplodeIndex(double explodeIndex)
Parameters
| Type |
Name |
Description |
| System.Double |
explodeIndex |
|
Returns
ExplodeOffset(String)
Specifies the distance of the point from the center, which can be defined in both pixels and percentage.
Declaration
public AccumulationSeriesBuilder ExplodeOffset(string explodeOffset)
Parameters
| Type |
Name |
Description |
| System.String |
explodeOffset |
|
Returns
FunnelMode(FunnelModes)
Defines the rendering mode for the funnel chart.
Available options are:
Standard - Displays a funnel shape that narrows down to a point.
Trapezoid - Displays a funnel shape with parallel sides near the top.
Declaration
public AccumulationSeriesBuilder FunnelMode(FunnelModes funnelMode)
Parameters
Returns
GapRatio(Double)
Defines the distance between the segments of a funnel or pyramid series.
The range is from 0 to 1.
Declaration
public AccumulationSeriesBuilder GapRatio(double gapRatio)
Parameters
| Type |
Name |
Description |
| System.Double |
gapRatio |
|
Returns
GroupMode(GroupModes)
In the accumulation series, y-values less than groupMode are combined into a single slice named 'others'.
Declaration
public AccumulationSeriesBuilder GroupMode(GroupModes groupMode)
Parameters
Returns
GroupTo(String)
The y-values of the accumulation series that are less than groupTo are combined into a single slice named 'others'.
Declaration
public AccumulationSeriesBuilder GroupTo(string groupTo)
Parameters
| Type |
Name |
Description |
| System.String |
groupTo |
|
Returns
Height(String)
Defines the height of the funnel or pyramid series relative to the chart area.
Declaration
public AccumulationSeriesBuilder Height(string height)
Parameters
| Type |
Name |
Description |
| System.String |
height |
|
Returns
InnerRadius(String)
When the innerRadius value is greater than 0%, a donut shape will appear in the pie series. It accepts only percentage values.
Declaration
public AccumulationSeriesBuilder InnerRadius(string innerRadius)
Parameters
| Type |
Name |
Description |
| System.String |
innerRadius |
|
Returns
LegendImageUrl(String)
The URL for the image to be displayed as a legend icon.
Note that legendShape must be set to Image.
Declaration
public AccumulationSeriesBuilder LegendImageUrl(string legendImageUrl)
Parameters
| Type |
Name |
Description |
| System.String |
legendImageUrl |
|
Returns
LegendShape(LegendShape)
Specifies the shape of the legend icon for each data point.
Available shapes for legend:
Circle - Renders a circular icon.
Rectangle - Renders a rectangular icon.
Triangle - Renders a triangular icon.
Diamond - Renders a diamond-shaped icon.
Cross - Renders a cross-shaped icon.
HorizontalLine - Renders a horizontal line icon.
VerticalLine - Renders a vertical line icon.
Pentagon - Renders a pentagon-shaped icon.
InvertedTriangle - Renders an inverted triangle-shaped icon.
SeriesType - Uses the default icon shape based on the series type.
Image - Renders a custom image for the legend icon.
Declaration
public AccumulationSeriesBuilder LegendShape(LegendShape legendShape)
Parameters
Returns
Name(String)
The name property allows for setting a name for the series.
Declaration
public AccumulationSeriesBuilder Name(string name)
Parameters
| Type |
Name |
Description |
| System.String |
name |
|
Returns
NeckHeight(String)
Defines the height of the funnel neck relative to the chart area.
Declaration
public AccumulationSeriesBuilder NeckHeight(string neckHeight)
Parameters
| Type |
Name |
Description |
| System.String |
neckHeight |
|
Returns
NeckWidth(String)
Defines the width of the funnel neck relative to the chart area.
Declaration
public AccumulationSeriesBuilder NeckWidth(string neckWidth)
Parameters
| Type |
Name |
Description |
| System.String |
neckWidth |
|
Returns
Opacity(Double)
Sets the opacity of the series, with a value between 0 and 1 where 0 is fully transparent and 1 is fully opaque.
Declaration
public AccumulationSeriesBuilder Opacity(double opacity)
Parameters
| Type |
Name |
Description |
| System.Double |
opacity |
|
Returns
Palettes(String[])
The palettes array defines a set of colors used for rendering the accumulation chart's points. Each color in the array is applied to each point in order.
Declaration
public AccumulationSeriesBuilder Palettes(string[] palettes)
Parameters
| Type |
Name |
Description |
| System.String[] |
palettes |
|
Returns
PointColorMapping(String)
The data source field that contains the color value of a point.
It is applicable for series.
Declaration
public AccumulationSeriesBuilder PointColorMapping(string pointColorMapping)
Parameters
| Type |
Name |
Description |
| System.String |
pointColorMapping |
|
Returns
PyramidMode(PyramidModes)
Defines how the values are represented, either through the height or surface area of the segments.
Declaration
public AccumulationSeriesBuilder PyramidMode(PyramidModes pyramidMode)
Parameters
Returns
Query(String)
Specifies a query to select data from the data source. This property is applicable only when the data source is an ej.DataManager.
Declaration
public AccumulationSeriesBuilder Query(string query)
Parameters
| Type |
Name |
Description |
| System.String |
query |
|
Returns
Radius(String)
Specifies the radius of the pie series as a percentage of the chart's size.
Declaration
public AccumulationSeriesBuilder Radius(string radius)
Parameters
| Type |
Name |
Description |
| System.String |
radius |
|
Returns
RemovePoint(Object)
Declaration
public AccumulationSeriesBuilder RemovePoint(object removePoint)
Parameters
| Type |
Name |
Description |
| System.Object |
removePoint |
|
Returns
SelectionStyle(String)
The selectionStyle property is used to specify custom CSS styles for the selected series or points.
Declaration
public AccumulationSeriesBuilder SelectionStyle(string selectionStyle)
Parameters
| Type |
Name |
Description |
| System.String |
selectionStyle |
|
Returns
SetData(Object)
Declaration
public AccumulationSeriesBuilder SetData(object setData)
Parameters
| Type |
Name |
Description |
| System.Object |
setData |
|
Returns
StartAngle(Double)
Specifies the starting angle for the series, in degrees.
Declaration
public AccumulationSeriesBuilder StartAngle(double startAngle)
Parameters
| Type |
Name |
Description |
| System.Double |
startAngle |
|
Returns
The data source field that contains the value to be displayed in the tooltip.
Declaration
public AccumulationSeriesBuilder TooltipMappingName(string tooltipMappingName)
Parameters
| Type |
Name |
Description |
| System.String |
tooltipMappingName |
|
Returns
Type(AccumulationType)
Specifies the type of series in the accumulation chart.
Declaration
public AccumulationSeriesBuilder Type(AccumulationType type)
Parameters
Returns
Visible(Boolean)
If set to true, the series will be visible. If set to false, the series will be hidden.
Declaration
public AccumulationSeriesBuilder Visible(bool visible)
Parameters
| Type |
Name |
Description |
| System.Boolean |
visible |
|
Returns
Width(String)
Defines the width of the funnel or pyramid series relative to the chart area.
Declaration
public AccumulationSeriesBuilder Width(string width)
Parameters
| Type |
Name |
Description |
| System.String |
width |
|
Returns
XName(String)
The data source field that contains the x value.
Declaration
public AccumulationSeriesBuilder XName(string xName)
Parameters
| Type |
Name |
Description |
| System.String |
xName |
|
Returns
YName(String)
The data source field that contains the y value.
Declaration
public AccumulationSeriesBuilder YName(string yName)
Parameters
| Type |
Name |
Description |
| System.String |
yName |
|
Returns
