Specifies options for the series of the PieChart widget.
A series represents a group of related data points. To configure a series, assign an object to the series option. If PieChart must contain several series, assign an array of such objects to the same option. Refer to the Series topic to learn the basics of what a series is, what it does, and how it helps.
The definitive characteristic of a series is its type. The PieChart widget provides two series types - Pie and Doughnut. In the PieChart Series Type guide, you can find information about distinctive features of both series types.
When you have a multi-series pie, settings that are common for all series can be specified all together. Use the commonSeriesSettings object to do this.
Specifies the data source field that provides arguments for series points.
When defining a series, set the argumentField property to the corresponding field from the data source.
Specifies the required type for series arguments.
By default, the series arguments have the same type as the values of a corresponding data source field. If the data source field values are numeric, the series arguments will also be numeric, etc. However, you can convert the data source values to another type. In this instance, specify the required type using the argumentType option.
An object defining the series border configuration options.
To set custom border settings for the series, use the border object within the series configuration object.
Specifies a series color.
Use this option to paint all pie slices in one color.
Specifies the chart elements to highlight when a series is hovered over.
The following values are available.
Changes the appearance of the hovered point only.
The appearance of the hovered series is not changed.
To set custom options for the 'hover' style (which is applied when a series is hovered over), use the hoverStyle configuration object.
An object defining configuration options for a hovered series.
To set a custom 'hover' style for the series, use the hoverStyle object within the series configuration object.
Use the innerRadius option instead.
Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type.
An object defining the label configuration options.
Each series point can be accompanied by a text label that represents data related to the point. These are called series point labels. Use the label object's properties to set label options for the series.
Specifies how many points are acceptable to be in a series to display all labels for these points. Otherwise, the labels will not be displayed.
When there is a series with a large number of points, the point labels may overlap each other and make a chart difficult to read. In this instance, it is better to display the point labels depending on their quantity. To specify the maximum amount of the labels to be displayed, set the required number to the maxLabelCount field. If the number of the points on a series exceeded the number assigned to the maxLabelCount field, the point labels for this series will not be displayed.
Specifies a minimal size of a displayed pie segment.
When you visualize data with small and large numbers, the small numbers are represented by very small pie slices. It makes them difficult to click, select or hover over. In this case, use the minSegmentSize option to set the minimal size of a displayed pie segment.
Specifies the name that identifies the series.
The series name is used to represent the series in the legend. If this property is not specified, a default name will be generated automatically.
Use the segmentsDirection option instead.
Specifies the direction in which the PieChart series points are located.
Specifies the chart elements to highlight when the series is selected.
The **PieChart** widget comes with an API that allows you to select a series or a particular point in code. Use the selectionMode property to specify which series elements to select when the series is selected.
Changes the appearance of the selected point only.
The appearance of the selected series is not changed.
To set custom options for the 'selected' style (which is applied when a series is selected), use the selectionStyle configuration object.
An object defining configuration options for the series when it is selected.
The PieChart widget comes with API members that allow you to select the series in code. To set a custom 'selected' style for the series, use the selectionStyle object within the series configuration object.
Specifies chart segment grouping options.
If you need to group specific chart segments into one, use the options of the smallValuesGrouping configuration object.
You can group segments in two different modes. Use a 'topN' mode to group all segments that have an index that is equal to or greater than the value of the topCount option. To group all segments with the value less than the value of the threshold option, use a 'smallValueThreshold' mode.
By default, the resulting segment is called "others". To change this name, specify the groupName option.
Use the startAngle option instead.
Specifies a start angle for a pie chart in arc degrees.
Specifies data about a series.
To associate information about a series with the series instance, set the tag property of the series object defined within the series array. In this instance, when clicking a series in the pie chart, you can access the data associated with it using the series' instance.
Specifies the name of the data source field that provides data about a point.
When setting a data source, you can pass extra information about a point. For this purpose, add a separate field to the data source in addition to the argument and value fields. To set specified data to the point instance, set the series' tagField property to the name of the field with the information. In this instance, when clicking/hovering/selecting a point in the chart, you can access the data associated with this point using the point's instance.
Use the type option instead.
Sets the series type.
See PieChart Series Types for details.
Specifies the data source field that provides values for series points.
When defining a series, set the valueField property to the corresponding field from the data source.