Inertia

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.

TypeScript

/**
 * Import from: "core.ts"
 * Use like: am4core.Inertia
 */
import * as am4core from "@amcharts/amcharts4/core";

JavaScript

/**
 * Include via: <script src="core.js"></script>
 * Access items like: am4core.Inertia
 */

Inheritance

Inertia extends BaseObject.

Inertia is not extended by any other symbol.

Properties

#animations

Type Array <Animation>Default []

List of animations currently playing.

#interaction

Type InteractionObject

An element we're performing animation on.

#point

Type IPoint

Current (simulated) pointer position.

#startPoint

Type IPoint

Starting pointer position. The position of pointer when we "released" the element.

#type

Type InertiaTypes

Holds what type of inertia it is.

#x

Type number

Sets current X coordinate.

Returns current X coordinate.

Will trigger "drag" event for the target element.

#y

Type number

Sets current Y coordinate.

Returns current Y coordinate.

Will trigger "drag" event for the target element.

4 inherited items

#clonedFrom

Type $type.Optional <this>Inherited from BaseObject

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 objectInherited from BaseObject

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 $type.Optional <string>Inherited from BaseObject

Sets the user-defined id of the element.

#uid

Type stringInherited from BaseObject

Returns object's internal unique ID.

Methods

#constructor(interaction: InteractionObject,
type: InertiaTypes,
point: IPoint,
startPoint: IPoint)

Returns Inertia

Constructor

#done()

Returns void

Finishes up the inertia animation. (removes reference to this animation object)

#handleMove()

Returns void

Simulates dragging of element.

5 inherited items

#clone(cloneId?: string)

Returns thisInherited from BaseObject

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.

#copyFrom(object: this)

Returns voidInherited from BaseObject

Copies all properties and related data from different element.

#dispose()

Returns voidInherited from BaseObject

Destroys this object and all related data.

#getCurrentThemes()

Returns ITheme[]Inherited from BaseObject

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.

#isDisposed()

Returns booleanInherited from BaseObject

Returns if this object has been already been disposed.

Events

Inertia does not have any events.