Class PivotViewPivotSeriesBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
PivotViewPivotSeriesBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class PivotViewPivotSeriesBuilder : ControlBuilder
Constructors
PivotViewPivotSeriesBuilder()
Declaration
public PivotViewPivotSeriesBuilder()
PivotViewPivotSeriesBuilder(PivotViewPivotSeries)
Declaration
public PivotViewPivotSeriesBuilder(PivotViewPivotSeries model)
Parameters
Methods
Animation(PivotViewPivotChartSeriesAnimation)
Allows options to customizing animation for the series.
Declaration
public PivotViewPivotSeriesBuilder Animation(PivotViewPivotChartSeriesAnimation value)
Parameters
Returns
Animation(Action<PivotViewPivotChartSeriesAnimationBuilder>)
Declaration
public PivotViewPivotSeriesBuilder Animation(Action<PivotViewPivotChartSeriesAnimationBuilder> animation)
Parameters
Returns
Border(PivotViewPivotChartSeriesBorder)
Allows options to customizing the border of the series. This is applicable only for Column and Bar type series.
Declaration
public PivotViewPivotSeriesBuilder Border(PivotViewPivotChartSeriesBorder value)
Parameters
Returns
Border(Action<PivotViewPivotChartSeriesBorderBuilder>)
Declaration
public PivotViewPivotSeriesBuilder Border(Action<PivotViewPivotChartSeriesBorderBuilder> border)
Parameters
Returns
CardinalSplineTension(Double)
Allows to set the tension of cardinal spline types
Declaration
public PivotViewPivotSeriesBuilder CardinalSplineTension(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
ColumnSpacing(Double)
Allows to render the column series points with particular column spacing. It takes value from 0 - 1.
Declaration
public PivotViewPivotSeriesBuilder ColumnSpacing(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
ColumnWidth(Double)
Allows to render the column series points with particular column width.
Declaration
public PivotViewPivotSeriesBuilder ColumnWidth(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
CornerRadius(PivotViewPivotChartSeriesCornerRadius)
Allows to render the column series points with particular rounded corner.
Declaration
public PivotViewPivotSeriesBuilder CornerRadius(PivotViewPivotChartSeriesCornerRadius value)
Parameters
Returns
CornerRadius(Action<PivotViewPivotChartSeriesCornerRadiusBuilder>)
Declaration
public PivotViewPivotSeriesBuilder CornerRadius(Action<PivotViewPivotChartSeriesCornerRadiusBuilder> cornerRadius)
Parameters
Returns
DashArray(String)
Allows to set the pattern of dashes and gaps to stroke the lines in Line type series.
Declaration
public PivotViewPivotSeriesBuilder DashArray(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
DataLabel(PivotViewPivotChartDataLabel)
Allows options to customize data label for the pie, funnel, pyramid, doughnut chart series.
Declaration
public PivotViewPivotSeriesBuilder DataLabel(PivotViewPivotChartDataLabel value)
Parameters
Returns
DataLabel(Action<PivotViewPivotChartDataLabelBuilder>)
Declaration
public PivotViewPivotSeriesBuilder DataLabel(Action<PivotViewPivotChartDataLabelBuilder> dataLabel)
Parameters
Returns
DrawType(Object)
Allows to set the type of series to be drawn in radar or polar series. They are
'Line'
'Column'
'Area'
'Scatter'
'Spline'
'StackingColumn'
'StackingArea'
'RangeColumn'
'SplineArea'
Declaration
public PivotViewPivotSeriesBuilder DrawType(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
EmptyPointSettings(PivotViewPivotChartSeriesEmptyPointSettings)
Allows options to customize the empty points in series
Declaration
public PivotViewPivotSeriesBuilder EmptyPointSettings(PivotViewPivotChartSeriesEmptyPointSettings value)
Parameters
Returns
EmptyPointSettings(Action<PivotViewPivotChartSeriesEmptyPointSettingsBuilder>)
Declaration
public PivotViewPivotSeriesBuilder EmptyPointSettings(Action<PivotViewPivotChartSeriesEmptyPointSettingsBuilder> emptyPointSettings)
Parameters
Returns
If set true, the Tooltip for series will be visible.
Declaration
public PivotViewPivotSeriesBuilder EnableTooltip(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
EndAngle(Double)
Allows to set the end angle for the pie and doughnut chart series.
Declaration
public PivotViewPivotSeriesBuilder EndAngle(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
ErrorBar(PivotViewPivotChartSeriesErrorSettings)
Allows options for displaying and customizing error bar for individual point in a series.
Declaration
public PivotViewPivotSeriesBuilder ErrorBar(PivotViewPivotChartSeriesErrorSettings value)
Parameters
Returns
ErrorBar(Action<PivotViewPivotChartSeriesErrorSettingsBuilder>)
Declaration
public PivotViewPivotSeriesBuilder ErrorBar(Action<PivotViewPivotChartSeriesErrorSettingsBuilder> errorBar)
Parameters
Returns
Explode(Boolean)
Allows to enable or disable series point explode on mouse click or touch for pie, funnel, doughnut and pyramid chart.
Declaration
public PivotViewPivotSeriesBuilder Explode(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
ExplodeAll(Boolean)
Allows to enable or disable all series point explode on mouse click or touch for pie, funnel, doughnut and pyramid chart.
Declaration
public PivotViewPivotSeriesBuilder ExplodeAll(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
ExplodeIndex(Double)
Allows to set Index of the point to be exploded on load for pie, funnel, doughnut and pyramid chart.
Declaration
public PivotViewPivotSeriesBuilder ExplodeIndex(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
ExplodeOffset(String)
Allows to set distance of the point from the center, which takes values in both pixels and
percentage for pie, funnel, doughnut and pyramid chart.
Declaration
public PivotViewPivotSeriesBuilder ExplodeOffset(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Fill(String)
Allows to set the fill color for the series that accepts value in hex and rgba as a valid CSS color string.
Declaration
public PivotViewPivotSeriesBuilder Fill(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
GapRatio(Double)
Allows to set the distance between the segments of a funnel/pyramid series. The range will be from 0 to 1.
Declaration
public PivotViewPivotSeriesBuilder GapRatio(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
GroupMode(Object)
Allows to define the mode of grouping for pie, funnel, doughnut and pyramid chart series.
Declaration
public PivotViewPivotSeriesBuilder GroupMode(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
GroupTo(String)
Allows to combine the y values into slice named other for pie, funnel, doughnut and pyramid chart Series.
Declaration
public PivotViewPivotSeriesBuilder GroupTo(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
InnerRadius(String)
Allows to set inner radius for pie and doughnut series chart.
Declaration
public PivotViewPivotSeriesBuilder InnerRadius(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
IsClosed(Boolean)
Specifies whether to join start and end point of a line/area series used in polar/radar chart to form a closed path.
Declaration
public PivotViewPivotSeriesBuilder IsClosed(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
LegendShape(Object)
Allows to set the shape of the legend. Each series has its own legend shape. They are,
Circle - Renders a circle.
Rectangle - Renders a rectangle.
VerticalLine - Renders a verticalLine.
Pentagon - Renders a pentagon.
InvertedTriangle - Renders a invertedTriangle.
SeriesType - Render a legend shape based on series type.
Triangle - Renders a triangle.
Diamond - Renders a diamond.
Cross - Renders a cross.
HorizontalLine - Renders a horizontalLine.
Image - Renders a image.
Declaration
public PivotViewPivotSeriesBuilder LegendShape(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
Marker(PivotViewPivotChartSeriesMarkerSettings)
Allows options for displaying and customizing markers for individual points in a series.
Declaration
public PivotViewPivotSeriesBuilder Marker(PivotViewPivotChartSeriesMarkerSettings value)
Parameters
Returns
Marker(Action<PivotViewPivotChartSeriesMarkerSettingsBuilder>)
Declaration
public PivotViewPivotSeriesBuilder Marker(Action<PivotViewPivotChartSeriesMarkerSettingsBuilder> marker)
Parameters
Returns
MaxRadius(Double)
Allows to set the maximum radius.
Declaration
public PivotViewPivotSeriesBuilder MaxRadius(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
MinRadius(Double)
Allows to set the minimum radius.
Declaration
public PivotViewPivotSeriesBuilder MinRadius(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
NeckHeight(String)
Allows to defines the height of the funnel chart neck with respect to the chart area.
Declaration
public PivotViewPivotSeriesBuilder NeckHeight(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
NeckWidth(String)
Allows to defines the width of the funnel chart neck with respect to the chart area.
Declaration
public PivotViewPivotSeriesBuilder NeckWidth(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Opacity(Double)
Allows to set the opacity of the series.
Declaration
public PivotViewPivotSeriesBuilder Opacity(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Palettes(String[])
Allows you to draw the chart series points with custom color for the pie, funnel, doughnut and pyramid chart types.
Declaration
public PivotViewPivotSeriesBuilder Palettes(string[] value)
Parameters
| Type |
Name |
Description |
| System.String[] |
value |
|
Returns
PyramidMode(Object)
Defines how the values have to be reflected, whether through height/surface of the segments in pyramid series.
Declaration
public PivotViewPivotSeriesBuilder PyramidMode(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
SegmentAxis(Object)
Allows to set the axis, based on which the line series will be split.
Declaration
public PivotViewPivotSeriesBuilder SegmentAxis(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
Segments(Action<PivotViewSegmentBuilder>)
Declaration
public PivotViewPivotSeriesBuilder Segments(Action<PivotViewSegmentBuilder> segments)
Parameters
Returns
Segments(List<PivotViewSegment>)
Allows to set the collection of regions that helps to differentiate a line series.
Declaration
public PivotViewPivotSeriesBuilder Segments(List<PivotViewSegment> value)
Parameters
Returns
SelectionStyle(String)
Allows to set the custom style for the selected series or points.
Declaration
public PivotViewPivotSeriesBuilder SelectionStyle(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
SplineType(Object)
Allows to set the type of spline to be rendered.
Declaration
public PivotViewPivotSeriesBuilder SplineType(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
StackingGroup(String)
This allows grouping the chart series in stacked column / bar charts.
Any string value can be provided to the stackingGroup property.
If any two or above series have the same value, those series will be grouped together.
Declaration
public PivotViewPivotSeriesBuilder StackingGroup(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
StartAngle(Double)
Allows to defines start angle for the pie, funnel, doughnut and pyramid chart series.
Declaration
public PivotViewPivotSeriesBuilder StartAngle(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Allows to set the provided value will be considered as a Tooltip name
Declaration
public PivotViewPivotSeriesBuilder TooltipMappingName(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Trendlines(Action<PivotViewTrendlineBuilder>)
Declaration
public PivotViewPivotSeriesBuilder Trendlines(Action<PivotViewTrendlineBuilder> trendlines)
Parameters
Returns
Trendlines(List<PivotViewTrendline>)
Allows to set the collection of trendlines that are used to predict the trend
Declaration
public PivotViewPivotSeriesBuilder Trendlines(List<PivotViewTrendline> value)
Parameters
Returns
Type(ChartSeriesType)
Allows to set the type of the series are
Line - Allows to display the pivot chart with line series.
Column - Allows to display the pivot chart with column series.
Area - Allows to display the pivot chart with area series.
Bar - Allows to display the pivot chart with bar series.
StackingColumn - Allows to display the pivot chart with stacked column series.
StackingArea - Allows to display the pivot chart with stacked area series.
StackingBar - Allows to display the pivot chart with stacked bar series.
StepLine - Allows to display the pivot chart with step line series.
StepArea - Allows to display the pivot chart with step area series.
SplineArea - Allows to display the pivot chart with spline area series.
Scatter - Allows to display the pivot chart with scatter series.
Spline - Allows to display the pivot chart with spline series.
StackingColumn100 - Allows to display the pivot chart with 100% stacked column series.
StackingBar100 - Allows to display the pivot chart with 100% stacked bar series.
StackingArea100 - Allows to display the pivot chart with 100% stacked area series.
Bubble - Allows to display the pivot chart with bubble series.
Pareto - Allows to display the pivot chart with pareto series.
Polar - Allows to display the pivot chart with polar series.
Radar - Allows to display the pivot chart with radar series.
Declaration
public PivotViewPivotSeriesBuilder Type(ChartSeriesType value)
Parameters
Returns
Visible(Boolean)
Allows to set the visibility of series.
Declaration
public PivotViewPivotSeriesBuilder Visible(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Width(Double)
Allows to set the stroke width for the series that is applicable only for Line type series.
Declaration
public PivotViewPivotSeriesBuilder Width(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
