Type class
A plugin that can be used to automatically group small slices on percent charts into a single slice.
Click here for more info
Sources
SliceGrouper can be used (imported) via one of the following packages.
// Import SliceGrouper import * as am5plugins_sliceGrouper from "@amcharts/amcharts5/plugins/sliceGrouper"; am5plugins_sliceGrouper.SliceGrouper.new(root, { // ... config if applicable });
<!-- Load SliceGrouper --> <script src="plugins/sliceGrouper.js"> <script> // Create SliceGrouper am5plugins_sliceGrouper.SliceGrouper.new(root, { // ... config if applicable }); </script>
Inheritance
SliceGrouper extends Entity
.
SliceGrouper is not extended by any other symbol.
Settings
Set these settings on a SliceGrouper object using its set()
and setAll()
methods.
Read about settings concept.
clickBehavior # |
Type What happens when group slice is clicked.
|
---|---|
groupName # |
Type Default Name (category) of the group slice. |
id # |
Type Inherited from A custom string ID for the element. If set, element can be looked up via Will raise error if an element with the same ID already exists. |
legend # |
Type If set, plugin will try to manipulate the items in legend, such as adding group slice, hiding items for small slices, etc. |
limit # |
Type If set, only X first slices will be left as they are. The rest of the slices will be grouped. |
series # |
Type A series that will be used to group slices on. |
stateAnimationDuration # |
Type Inherited from Duration of transition from one state to another. |
stateAnimationEasing # |
Type Inherited from Easing of transition from one state to another. |
themeTags # |
Type Inherited from Tags which can be used by the theme rules. Click here for more info |
themeTagsSelf # |
Type Inherited from 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 Inherited from A list of themes applied to the element. |
threshold # |
Type Default Any slice which has percent value less than this setting will be grouped. |
userData # |
Type Inherited from 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. |
Private settings
These are read-only settings accessible from a SliceGrouper object using its getPrivate()
method.
Read about private settings.
currentPass # |
Read only
Type |
---|---|
currentStep # |
Read only
Type |
groupDataItem # |
Read only
Type |
normalDataItems # |
Read only
Type |
smallDataItems # |
Read only
Type |
Properties
adapters # |
Type Default Inherited from |
---|---|
className # |
Static
Type Default |
classNames # |
Static
Type Default |
events # |
Type Default Inherited from |
root # |
Type Inherited from An instance of @readonly |
states # |
Type Default Inherited from |
template # |
Type Inherited from @todo needs description |
uid # |
Type Default Inherited from Unique ID. |
zoomOutButton # |
Type A button that is shown when chart small buttons are visible. |
There are 6 inherited items currently hidden from this list. |
Methods
animate( options: ) |
Returns Inherited from Animates setting values from current/start values to new ones. Click here for more info |
---|---|
dispose() |
Returns Inherited from Disposes this object. |
get( key: ) |
Returns Inherited from Returns settings value for the specified If there is no value, Click here for more info |
has( key: ) |
Returns Inherited from Returns Click here for more info |
isDisposed() |
Returns Inherited from Returns |
isType( type: ) |
Returns Inherited from Checks if element is of certain class (or inherits one). |
new( root: ) |
Static Returns Inherited from Use this method to create an instance of this class. Click here for more info |
off( key: ) |
Returns Inherited from Removes a callback for when value of a setting changes. Click here for more info |
offPrivate( key: ) |
Returns Inherited from Removes a callback for when value of a private setting changes. Click here for more info |
on( key: ) |
Returns Inherited from Sets a callback function to invoke when specific key of settings changes or is set. Click here for more info |
onPrivate( key: ) |
Returns Inherited from Sets a callback function to invoke when specific key of private settings changes or is set. Click here for more info |
remove( key: ) |
Returns Inherited from Removes a setting value for the specified Click here for more info |
removeAll() |
Returns Inherited from Removes all keys; Click here for more info |
set( key: ) |
Returns Inherited from Sets a setting Click here for more info |
setAll( settings: ) |
Returns Inherited from Sets multiple settings at once. Click here for more info |
setTimeout( fn: () => ) |
Returns Inherited from Creates and returns a "disposable" timeout. |
zoomOut() |
Returns Resets slice setup to original grouping state. |
There are 16 inherited items currently hidden from this list. |
Events
SliceGrouper does not have any events.