Class PivotChartSeries

Allow options to customize the chart series with different settings such as fill color, animation of the series, series width, border, visibility of the series, opacity, chart series types, marker, tooltip, trendlines, etc., in the pivot chart. For example, to display the line type pivot chart, set the property type to** Line**.

Inheritance
System.Object
Syncfusion.Blazor.SfBaseComponent
SfDataBoundComponent
PivotChartSeries
Inherited Members
Namespace: Syncfusion.Blazor.PivotView
Assembly: Syncfusion.Blazor.dll
Syntax
public class PivotChartSeries : SfDataBoundComponent

Constructors

PivotChartSeries()

Declaration
public PivotChartSeries()

Properties

Animation

Allows options to customizing animation for the series.

Declaration
public PivotChartSeriesAnimation Animation { get; set; }
Property Value
Type Description
PivotChartSeriesAnimation

Border

Allows options to customizing the border of the series. This is applicable only for Column and Bar type series.

Declaration
public PivotChartSeriesBorder Border { get; set; }
Property Value
Type Description
PivotChartSeriesBorder

CardinalSplineTension

Allows to set the tension of cardinal spline types.

Declaration
public double CardinalSplineTension { get; set; }
Property Value
Type Description
System.Double

ColumnSpacing

Allows to render the column series points with particular column spacing. It takes value from 0 - 1.

Declaration
public int ColumnSpacing { get; set; }
Property Value
Type Description
System.Int32

ColumnWidth

Allows to render the column series points with particular column width.

Declaration
public double ColumnWidth { get; set; }
Property Value
Type Description
System.Double

CornerRadius

Allows to render the column series points with particular rounded corner.

Declaration
public PivotChartCornerRadius CornerRadius { get; set; }
Property Value
Type Description
PivotChartCornerRadius

DashArray

Allows to set the pattern of dashes and gaps to stroke the lines in Line type series.

Declaration
public string DashArray { get; set; }
Property Value
Type Description
System.String

DataLabel

Allows options to customize data label for the pie, funnel, pyramid, doughnut chart series.

Declaration
public PivotChartDataLabel DataLabel { get; set; }
Property Value
Type Description
PivotChartDataLabel

DrawType

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 PivotChartDrawType DrawType { get; set; }
Property Value
Type Description
PivotChartDrawType

EmptyPointSettings

Allows options to customize the empty points in series.

Declaration
public PivotChartEmptyPointSettings EmptyPointSettings { get; set; }
Property Value
Type Description
PivotChartEmptyPointSettings

EnableTooltip

If set true, the Tooltip for series will be visible.

Declaration
public bool EnableTooltip { get; set; }
Property Value
Type Description
System.Boolean

EndAngle

Allows to set the end angle for the pie and doughnut chart series.

Declaration
public double EndAngle { get; set; }
Property Value
Type Description
System.Double

ErrorBar

Allows options for displaying and customizing error bar for individual point in a series.

Declaration
public PivotChartErrorSettings ErrorBar { get; set; }
Property Value
Type Description
PivotChartErrorSettings

Explode

Allows to enable or disable series point explode on mouse click or touch for pie, funnel, doughnut and pyramid chart.

Declaration
public bool Explode { get; set; }
Property Value
Type Description
System.Boolean

ExplodeAll

Allows to enable or disable all series point explode on mouse click or touch for pie, funnel, doughnut and pyramid chart.

Declaration
public bool ExplodeAll { get; set; }
Property Value
Type Description
System.Boolean

ExplodeIndex

Allows to set Index of the point to be exploded on load for pie, funnel, doughnut and pyramid chart.

Declaration
public double ExplodeIndex { get; set; }
Property Value
Type Description
System.Double

ExplodeOffset

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 string ExplodeOffset { get; set; }
Property Value
Type Description
System.String

Fill

Allows to set the fill color for the series that accepts value in hex and rgba as a valid CSS color string.

Declaration
public string Fill { get; set; }
Property Value
Type Description
System.String

GapRatio

Allows to set the distance between the segments of a funnel/pyramid series. The range will be from 0 to 1.

Declaration
public double GapRatio { get; set; }
Property Value
Type Description
System.Double

GroupMode

Allows to define the mode of grouping for pie, funnel, doughnut and pyramid chart series.

Declaration
public PivotChartGroupModes GroupMode { get; set; }
Property Value
Type Description
PivotChartGroupModes

GroupTo

Allows to combine the y values into slice named other for pie, funnel, doughnut and pyramid chart Series.

Declaration
public string GroupTo { get; set; }
Property Value
Type Description
System.String

InnerRadius

Allows to set inner radius for pie and funnel series chart.

Declaration
public string InnerRadius { get; set; }
Property Value
Type Description
System.String

IsClosed

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 bool IsClosed { get; set; }
Property Value
Type Description
System.Boolean

LegendShape

Allows to set the shape of the legend. Each series has its own legend shape. They are, Circle Rectangle VerticalLine Pentagon InvertedTriangle SeriesType Triangle Diamond Cross HorizontalLine.

Declaration
public PivotChartLegendShape LegendShape { get; set; }
Property Value
Type Description
PivotChartLegendShape

Marker

Allows options for displaying and customizing markers for individual points in a series.

Declaration
public PivotChartMarkerSettings Marker { get; set; }
Property Value
Type Description
PivotChartMarkerSettings

MaxRadius

Allows to set the maximum radius.

Declaration
public double MaxRadius { get; set; }
Property Value
Type Description
System.Double

MinRadius

Allows to set the minimum radius.

Declaration
public double MinRadius { get; set; }
Property Value
Type Description
System.Double

NeckHeight

Allows to defines the height of the funnel chart neck with respect to the chart area.

Declaration
public string NeckHeight { get; set; }
Property Value
Type Description
System.String

NeckWidth

Allows to defines the width of the funnel chart neck with respect to the chart area.

Declaration
public string NeckWidth { get; set; }
Property Value
Type Description
System.String

Opacity

Allows to set the opacity of the series.

Declaration
public double Opacity { get; set; }
Property Value
Type Description
System.Double

PyramidMode

Defines how the values have to be reflected, whether through height/surface of the segments in pyramid series.

Declaration
public PivotChartPyramidModes PyramidMode { get; set; }
Property Value
Type Description
PivotChartPyramidModes

SegmentAxis

Allows to set the axis, based on which the line series will be split.

Declaration
public object SegmentAxis { get; set; }
Property Value
Type Description
System.Object

Segments

Allows to set the collection of regions that helps to differentiate a line series.

Declaration
public List<PivotChartSegment> Segments { get; set; }
Property Value
Type Description
System.Collections.Generic.List<PivotChartSegment>

SelectionStyle

Allows to set the custom style for the selected series or points.

Declaration
public string SelectionStyle { get; set; }
Property Value
Type Description
System.String

SplineType

Allows to set the type of spline to be rendered.

Declaration
public PivotChartSplineType SplineType { get; set; }
Property Value
Type Description
PivotChartSplineType

StackingGroup

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 string StackingGroup { get; set; }
Property Value
Type Description
System.String

StartAngle

Allows to defines start angle for the pie, funnel, doughnut and pyramid chart series.

Declaration
public double StartAngle { get; set; }
Property Value
Type Description
System.Double

TooltipMappingName

Allows to set the provided value will be considered as a Tooltip name.

Declaration
public string TooltipMappingName { get; set; }
Property Value
Type Description
System.String

Trendlines

Allows to set the collection of trendlines that are used to predict the trend.

Declaration
public List<PivotChartTrendline> Trendlines { get; set; }
Property Value
Type Description
System.Collections.Generic.List<PivotChartTrendline>

Type

Allows to set the type of the series are StackingColumn StackingArea StackingBar StepLine Line Column Area Bar StepArea Pareto Bubble Scatter Spline SplineArea StackingColumn100 StackingBar100 StackingArea100 Polar Radar.

Declaration
public ChartSeriesType Type { get; set; }
Property Value
Type Description
ChartSeriesType

Visible

Allows to set the visibility of series.

Declaration
public bool Visible { get; set; }
Property Value
Type Description
System.Boolean

Width

Allows to set the stroke width for the series that is applicable only for Line type series.

Declaration
public double Width { get; set; }
Property Value
Type Description
System.Double

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

OnInitializedAsync()

Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree. Override this method if you will perform an asynchronous operation and want the component to refresh when that operation is completed.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
System.Threading.Tasks.Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
System.Threading.Tasks.Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides