org.pepstock.charba.client.items

Class AnimationItem

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.items.AnimationItem

public final class AnimationItem
extends JavaScriptObjectContainer

The onProgress and onComplete event are useful for synchronizing an external draw to the chart animation.
This is the CHART.JS item with all needed info.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor and Description
AnimationItem(GenericJavaScriptObject javaScriptObject) Wraps the CHART.JS java script object.

Method Summary

Modifier and Type	Method and Description
double	getCurrentStep() Returns the current Animation frame number.
Easing	getEasing() Returns the animation easing to use.
double	getNumSteps() Returns the total number of animation frames.

Methods inherited from class org.pepstock.charba.client.commons.JavaScriptObjectContainer

checkAndGetDoubleValues, checkAndGetEnumValues, checkAndGetIntegerValues, checkAndGetStringValues, checkAndSetDoubleValues, checkAndSetEnumValues, checkAndSetIntegerValues, checkAndSetStringValues, getDoubleArray, getIntegerArray, getJavaScriptObject, getObjectArray, getStringArray, getValue, getValue, getValue, getValue, getValue, getValue, getValue, has, has, hasToBeRegistered, isEmpty, keys, remove, remove, removeIfExists, setDoubleArray, setEnumValueArray, setIntegerArray, setObjectArray, setStringArray, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AnimationItem

public AnimationItem(GenericJavaScriptObject javaScriptObject)

Wraps the CHART.JS java script object.

Parameters:

javaScriptObject - CHART.JS java script object

Method Detail

getCurrentStep

public double getCurrentStep()

Returns the current Animation frame number.

Returns:

the current Animation frame number. Default is UndefinedValues.DOUBLE.

getNumSteps

public double getNumSteps()

Returns the total number of animation frames.

Returns:

the total number of animation frames. Default is UndefinedValues.DOUBLE.

getEasing

public Easing getEasing()

Returns the animation easing to use.

Returns:

the animation easing to use.

See Also:

Easing