Configuration series

Specifies options for the series of the dxPieChart widget.

Type: Object|Array
Default Value: undefined

A series represents a grouping of related data points. The most important characteristic of a series is its type, which determines a particular visual representation of data. You can find more details on each series type in the corresponding topics in the Series help section.
To define a series, assign an object defining the series to the series configuration object. In the series' object, specify the series type, data source fields and other options.

argumentField

Specifies the data source field that provides arguments for series points.

Type: String
Default Value: 'arg'

When defining a series, set the argumentField property to the corresponding field from the data source.

argumentType

Specifies the required type for series arguments.

Type: String
Default Value: undefined
Accepted Values: 'numeric' | 'datetime' | 'string'

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.

border

An object defining the series border configuration options.

Type: Object

To set custom border settings for the series, use the border object within the series configuration object.

color

Specifies a series color.

Type: String
Default Value: undefined

Use this option to paint all pie slices in one color.

hoverMode

Specifies the chart elements to highlight when a series is hovered over.

Type: String
Default Value: 'onlyPoint'
Accepted Values: 'onlyPoint' | 'none'

The following values are available.

  • onlyPoint
    Changes the appearance of the hovered point only.
  • none
    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.

hoverStyle

An object defining configuration options for a hovered series.

Type: Object

To set a custom 'hover' style for the series, use the hoverStyle object within the series configuration object.

innerRadius

Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type.

Type: Number
Default Value: 0.5
This member is exposed by the following entities:

label

An object defining the label configuration options.

Type: Object

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.

maxLabelCount

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.

Type: Number
Default Value: undefined

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.

minSegmentSize

Specifies a minimal size of a displayed pie segment.

Type: Number
Default Value: undefined

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.

segmentsDirection

Specifies the direction in which the dxPieChart's series points are located.

Type: String
Default Value: 'clockwise'
Accepted Values: 'clockwise' | 'anticlockwise'

selectionMode

Specifies the chart elements to highlight when the series is selected.

Type: String
Default Value: 'onlyPoint'
Accepted Values: 'onlyPoint' | 'none'

The dxPieChart 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.

  • onlyPoint
    Changes the appearance of the selected point only.
  • none
    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.

selectionStyle

An object defining configuration options for the series when it is selected.

Type: Object

The dxPieChart 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.

startAngle

Specifies a start angle for a pie chart in arc degrees.

Type: Number
Default Value: 0

tagField

Specifies the name of the data source field that provides data about a point.

Type: String
Default Value: 'tag'

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.

type

Sets the series type.

Type: String
Default Value: 'pie'
Accepted Values: 'pie' | 'doughnut' | 'donut'

See PieChart Series Types for details.

valueField

Specifies the data source field that provides values for series points.

Type: String
Default Value: 'val'

When defining a series, set the valueField property to the corresponding field from the data source.

valueType

Specifies the required type for series values.

Type: String
Default Value: undefined
Accepted Values: 'numeric' | 'datetime' | 'string'

By default, the series values have the same type as the values of a corresponding data source field. If the data source field values are numeric, the series values 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 valueType option.