All docs
V19.2
24.1
The page you are viewing does not exist in version 24.1.
23.2
The page you are viewing does not exist in version 23.2.
23.1
The page you are viewing does not exist in version 23.1.
22.2
The page you are viewing does not exist in version 22.2.
22.1
The page you are viewing does not exist in version 22.1.
21.2
The page you are viewing does not exist in version 21.2.
21.1
The page you are viewing does not exist in version 21.1.
20.2
The page you are viewing does not exist in version 20.2.
20.1
The page you are viewing does not exist in version 20.1.
19.2
19.1
18.2
18.1
17.2
Box
Map
Vue
A newer version of this page is available. Switch to the current version.

jQuery PieChart - series.smallValuesGrouping

Specifies chart segment grouping options.

Type:

Object

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.

View Demo

groupName

Specifies the name of the grouped chart segment. This name represents the segment in the chart legend.

Type:

String

Default Value: 'others'

mode

Specifies the segment grouping mode.

Type:

String

Default Value: 'none'
Accepted Values: 'none' | 'smallValueThreshold' | 'topN'

If you need to group specific chart segments into one, set the options of the smallValuesGrouping configuration object. Using the mode option of this object, you can define the grouping mode.

Use a 'topN' mode to group all segments with an index that is equal to or greater than the value of the topCount option.

To group all segments with a value less than the value of the threshold option, set a 'smallValueThreshold' mode.

To switch the grouping off, assign 'none' to the mode option.

Use the SmallValuesGroupingMode enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: TopN, SmallValueThreshold, and None.

View Demo

threshold

Specifies a threshold for segment values.

Type:

Number

Default Value: undefined

When you use the 'smallValueThreshold' grouping mode, specify a value that will serve as a threshold for chart segments. All segments with a value less than the threshold will be grouped into the "others" segment.

topCount

Specifies how many segments must not be grouped.

Type:

Number

Default Value: undefined

In the 'topN' grouping mode, PieChart displays the top N segments separated while the rest are grouped into one. To specify the N number, use the topCount option.