OverlapBuster – amCharts 4 Documentation

Type class

A plugin which automatically groups PercenSeries slices that are smaller than certain percent into one "Other" slice.

By pushing an instance of Annnotation into plugin list of any Chart, it automatically applies the functionality.

Example:

let overlap = chart.plugins.push(new am4plugins_overlapBuster.OverlapBuster());
overlap.targets.push(bullet);

let overlap = chart.plugins.push(new am4plugins_overlapBuster.OverlapBuster());
overlap.targets.push(bullet);

// this plugin does not support JSON config

@since 4.6.2
Click here for more information and usage instructions

Sources

This information about OverlapBuster is provided for reference only and is not available through exported packages and thus should not be imported or used on its own.

Inheritance

OverlapBuster extends Plugin.

OverlapBuster is not extended by any other symbol.

Properties

collapseDelay #	Type `number` Default `500` A delay in milliseconds to postpone collapse of expanded items once they are unhovered.
d3forceSimulation #	Type `Simulation` < `object`, `SimulationLinkDatum` < `SimulationNodeDatum` > > A reference to the `d3.Simulation` instance for fine-grained configuration of node gravitational dynamics. Click here For more info
revealRatio #	Type `number` Default `0.7` How much of the obstructed object should be arevealed approximately. The number is relative (0-1). With `0` meaning the objstructed objects won't be moved at all, `0.5` (default) will make at least half of the object show up, and `1` to reveal object whole.
target #	Type `Optional` < `Sprite` > Inherited from `Plugin` A target object plugin is for.
targets #	Type `List` < `Sprite` > A list of objects to check for overlapping. If you push a list template into this, e.g. bullet from a series, all elements created from that templat will automatically end up in this list.
tolerance #	Type `number` Default `2` How big an area to check for overlapping elements should be checked in relation to hovered items size. `1` (one) means it will affect only elements that are at least partially overlapping with the target element. `2` (two) will check area twice as big. Etc.
There is 1 inherited item currently hidden from this list.

Methods

constructor() #	Returns `OverlapBuster` Constructor
dispose() #	Returns `void` Inherited from `Plugin` Disposes this object and related stuff.
hitTest( target: `Sprite`, sprite: `Sprite` ) #	Returns `boolean` Checks if the this element has any of its parts overlapping with another element. @todo Description (review)
init() #	Returns `void` Initializes plugin.
isDisposed() #	Returns `boolean` Inherited from `Plugin` Returns if this element is already disposed.
There are 2 inherited items currently hidden from this list.

constructor()

Returns OverlapBuster

Constructor

dispose()

Returns void

Inherited from Plugin

Disposes this object and related stuff.

hitTest(

target: Sprite,
sprite: Sprite

)

Returns boolean

Checks if the this element has any of its parts overlapping with another element.

@todo Description (review)

init()

Returns void

Initializes plugin.

isDisposed()

Returns boolean

Inherited from Plugin

Returns if this element is already disposed.

There are 2 inherited items currently hidden from this list.

Events

OverlapBuster does not have any events.

Adapters

OverlapBuster does not have any adapters.