Morpher

Type class

Morpher can be used to morph one polygon to some other polygon.

Sources

Morpher can be used (imported) via one of the following packages.

TypeScript

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

JavaScript

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

Inheritance

Morpher extends BaseObject.

Morpher is not extended by any other symbol.

Properties

#animations

Type Array <Animation>

Returns a list of morph animations currently being played.

#morphable

Type IMorphable

An element that will be a subject for morphing.

#morphDuration

Type numberDefault 800

Duration of the morphing animation in milliseconds.

#morphEasing

Type (value: number) => numberDefault $ease.cubicOut

An easing function to use for morphing animation.

More info: Ease

#morphProgress

Type $type.Optional <number>

Progress of the morph transition.

Returns the progress of morph transition.

Setting this will also trigger actual transformation.

#morphToSingle

Type booleanDefault true

If set to true, all separate parts of the multi-part polygon will morph into a single circle or polygon when using built-in methods morphToCircle() or morphToPolygon().

Otherwise each separate part of polygon will morph to individual target circle or polgyon.

#scaleRatio

Type numberDefault 1

A ratio to scale morphed object in relation to the source object.

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(morphable: IMorphable)

Returns Morpher

Constructor.

#morphBack(duration?: number,
easing?: (value: number) => number)

Returns Animation

Restores the polygon to its original appearance.

#morphToCircle(radius?: number,
duration?: number,
easing?: (value: number) => number)

Returns Animation

Morphs polygon to a circle (it is actually a polygon which makes a circle).

#morphToPolygon(toPoints: Array <Array <Array <IPoint>>>,
duration?: number,
easing?: (value: number) => number)

Returns Animation

Morphs a polygon to another polygon.

#morphToRectangle(width?: number,
height?: number,
duration?: number,
easing?: (value: number) => number)

Returns Animation

Morphs polygon into a rectangular polygon.

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

Morpher does not have any events.