Type class
A point of inertia is to simulate gradually drecreasing motion even after actual interaction by user, that caused it, has already ended.
Inertia
object will continue triggering the same Sprite
handlers as if the interaction was still happening, gradually reducing shift/angle/scale values until full stop.
Basically, from the target element's point of view, while inertia is playing, it is still being interacted with by user, albeit with a decreasing speed.
Sources
Inertia can be used (imported) via one of the following packages.
/** * -------------------------------------------------------- * Import from: "core.ts" * Use like: am4core.Inertia * -------------------------------------------------------- */ import * as am4core from "@amcharts/amcharts4/core";
/** * -------------------------------------------------------- * Include via: <script src="core.js"></script> * Access items like: am4.Inertia * -------------------------------------------------------- */
Inheritance
Inertia extends BaseObject
.
Inertia is not extended by any other symbol.
Properties
animations # |
Type Default List of animations currently playing. |
---|---|
clonedFrom # |
Type Inherited from Reference to the original object this object was cloned from. We need to keep this so we can disassociate it from source object when this object is disposed. |
config # |
Type Inherited from Use this property to set JSON-based config. When set, triggers processing routine, which will go through all properties, and try to apply values, create instances, etc. Use this with caution, as it is a time-consuming process. It's used for initialchart setup only, not routine operations. |
id # |
Type Inherited from Sets the user-defined id of the element. |
interaction # |
Type An element we're performing animation on. |
point # |
Type Current (simulated) pointer position. |
startPoint # |
Type Starting pointer position. The position of pointer when we "released" the element. |
type # |
Type Holds what type of inertia it is. |
uid # |
Type Inherited from Returns object's internal unique ID. |
x # |
Type Sets current X coordinate. Returns current X coordinate. Will trigger "drag" event for the target element. |
y # |
Type Sets current Y coordinate. Returns current Y coordinate. Will trigger "drag" event for the target element. |
There are 4 inherited items currently hidden from this list. |
Methods
clone( cloneId?: ) |
Returns Inherited from Makes a copy of this object and returns the clone. Try to avoid cloning complex objects like chart, create new instances if you need them. |
---|---|
constructor( interaction: ) |
Returns Constructor |
copyFrom( object: ) |
Returns Inherited from Copies all properties and related data from different element. |
dispose() |
Returns Inherited from Destroys this object and all related data. |
done() |
Returns Finishes up the inertia animation. (removes reference to this animation object) |
getCurrentThemes() |
Returns Inherited from Returns a list of themes that should be applied to this element. It could either be a list of themes set explicitly on this element, or system-wide. |
handleMove() |
Returns Simulates dragging of element. |
isDisposed() |
Returns Inherited from Returns if this object has been already been disposed. |
There are 5 inherited items currently hidden from this list. |
Events
Inertia does not have any events.
Adapters
Inertia does not have any adapters.