Help us shape the 2021 DevExtreme Roadmap. Take our 5 minute survey.
Dismiss

smallValuesGrouping

Specifies chart segment grouping properties.

Type:

Object

If you need to group specific chart segments into one, use the properties 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 property. To group all segments with the value less than the value of the threshold property, use a 'smallValueThreshold' mode.

By default, the resulting segment is called "others". To change this name, specify the groupName property.

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 properties of the smallValuesGrouping configuration object. Using the mode property 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 property.

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

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

Use the SmallValuesGroupingMode enum to specify this property when the UI component 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 property.