Documentation

ISliceGrouperSettings

Type interface

Inheritance

ISliceGrouperSettings extends IEntitySettings.

ISliceGrouperSettings is not extended by any other symbol.

Properties

clickBehavior #	Type `"none"` \| `"break"` \| `"zoom"` What happens when group slice is clicked. `"none"` (default) - nothing. `"break"` - underlying small slices are shown. `"zoom"` - series shows only small slies (big ones are hidden).
groupName #	Type `undefined` \| `string` Default `"Other"` Name (category) of the group slice.
id #	Type `undefined` \| `string` Inherited from `IEntitySettings` A custom string ID for the element. If set, element can be looked up via `am5.registry.entitiesById`. Will raise error if an element with the same ID already exists.
legend #	Type `Legend` If set, plugin will try to manipulate the items in legend, such as adding group slice, hiding items for small slices, etc.
limit #	Type `undefined` \| `number` If set, only X first slices will be left as they are. The rest of the slices will be grouped.
series #	Type `PercentSeries` A series that will be used to group slices on.
stateAnimationDuration #	Type `undefined` \| `number` Inherited from `IEntitySettings` Duration of transition from one state to another.
stateAnimationEasing #	Type `$ease.Easing` Inherited from `IEntitySettings` Easing of transition from one state to another.
themeTags #	Type `Array` Inherited from `IEntitySettings` Tags which can be used by the theme rules. Click here for more info
themeTagsSelf #	Type `Array` Inherited from `IEntitySettings` Tags which can be used by the theme rules. These tags only apply to this object, not any children. Click here for more info
themes #	Type `Array` Inherited from `IEntitySettings` A list of themes applied to the element.
threshold #	Type `undefined` \| `number` Default `5` Any slice which has percent value less than this setting will be grouped.
userData #	Type `any` Inherited from `IEntitySettings` A storage for any custom user data that needs to be associated with the element.
There are 7 inherited items currently hidden from this list.