Documentation

SliceGrouper

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 "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 root.entitiesById.

Will raise error if an element with the same ID already exists.
ignoreThemes
#

Type undefined | false | true

Default false

Inherited from IEntitySettings

If set to true the themes will be ignored when applying settings.

@since 5.15.6

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 8 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 undefined | number

currentStep
#

Read only

Type undefined | number

groupDataItem
#

Read only

Type DataItem

normalDataItems
#

Read only

Type DataItem[]

smallDataItems
#

Read only

Type DataItem[]

Properties

adapters
#

Type Adapters

Default new Adapters(this)

Inherited from Entity
className
#

Static

Type string

Default "SliceGrouper"
classNames
#

Static

Type Array

Default "SliceGrouper", "Entity"
enableDispose
#

Type boolean

Default true

Inherited from Settings

If this is set to false then disposing does nothing, it's a no-op.
events
#

Type EventDispatcher

Default this._createEvents()

Inherited from Entity
root
#

Type Root

Inherited from Entity

An instance of Root object.

@readonly
@since 5.0.6

states
#

Type States

Default new States(this)

Inherited from Entity
template
#

Type Template | undefined

Inherited from Entity

@todo needs description

uid
#

Type number

Default ++counter

Inherited from Settings

Unique ID.
zoomOutButton
#

Type Button

A button that is shown when chart small buttons are visible.
There are 7 inherited items currently hidden from this list.

Methods

animate(

options: AnimationOptions

)

#

Returns Animation

Inherited from Settings

Animates setting values from current/start values to new ones.

Click here for more info

dispose()

#

Returns void

Inherited from Settings

Disposes this object.

get(

key: Key,
fallback: F

)

#

Returns NonNullable | F

Inherited from Entity

Returns settings value for the specified key.

If there is no value, fallback is returned instead (if set).

Click here for more info

has(

key: Key

)

#

Returns boolean

Inherited from Settings

Returns true if the setting exists.

Click here for more info

isDisposed()

#

Returns boolean

Inherited from Settings

Returns true if this element is disposed.

isType(

type: string

)

#

Returns this

Inherited from Entity

Checks if element is of certain class (or inherits one).

new(

root: Root,
settings: ITSettings,
template?: Template

)

#

Static

Returns T

Inherited from Entity

Use this method to create an instance of this class.

Click here for more info

off(

key: Key,
callback?: undefined | ( value: [""], target: this, key: Key) => void

)

#

Returns void

Inherited from Settings

Removes a callback for when value of a setting changes.

Click here for more info
@since 5.9.2

offPrivate(

key: Key,
callback?: undefined | ( value: [""], target: this, key: Key) => void

)

#

Returns void

Inherited from Settings

Removes a callback for when value of a private setting changes.

Click here for more info
@since 5.9.2

on(

key: Key,
callback: ( value: [""], target: this, key: Key) => void

)

#

Returns IDisposer

Inherited from Settings

Sets a callback function to invoke when specific key of settings changes or is set.

Click here for more info

onPrivate(

key: Key,
callback: ( value: [""], target: this, key: Key) => void

)

#

Returns IDisposer

Inherited from Settings

Sets a callback function to invoke when specific key of private settings changes or is set.

Click here for more info

remove(

key: Key

)

#

Returns void

Inherited from Entity

Removes a setting value for the specified key.

Click here for more info

removeAll()

#

Returns void

Inherited from Settings

Removes all keys;

Click here for more info

set(

key: Key,
value: Value

)

#

Returns Value

Inherited from Entity

Sets a setting value for the specified key, and returns the same value.

Click here for more info

setAll(

settings: Partial

)

#

Returns void

Inherited from Settings

Sets multiple settings at once.

settings must be an object with key: value pairs.

Click here for more info

setTimeout(

fn: () => void,
delay: number

)

#

Returns IDisposer

Inherited from Entity

Creates and returns a "disposable" timeout.

zoomOut()

#

Returns void

Resets slice setup to original grouping state.
There are 16 inherited items currently hidden from this list.

Events

SliceGrouper does not have any events.