Package org.pepstock.charba.client.items
Class AnimationItem
- java.lang.Object
-
- org.pepstock.charba.client.commons.NativeObjectContainer
-
- org.pepstock.charba.client.items.AnimationItem
-
public final class AnimationItem extends NativeObjectContainer
TheonProgress
andonComplete
events are useful for synchronizing an external draw to the chart animation.
This is a wrapper of the CHART.JS item with all needed info.- Author:
- Andrea "Stock" Stocchero
-
-
Constructor Summary
Constructors Constructor Description AnimationItem(ConfigurationEnvelop<NativeObject> envelop)
Creates the item using an envelop with native java script object which contains all properties.
It is called fromconfiguration
package.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IsChart
getChart()
Returns the CHARBA chart instance.double
getCurrentStep()
Returns the current animation frame number.double
getNumSteps()
Returns the total number of animation frames.boolean
isInitial()
Returnstrue
for the initial animation of the chart.-
Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer
checkAndGetColor, checkDefaultValuesArgument, empty, getArrayValue, getElement, getIncrementalId, getNativeChart, getNativeEvent, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, isType, keys, loadNativeObject, remove, remove, setArrayValue, setArrayValue, setArrayValue, setElement, setEmptyValue, setNewIncrementalId, setNewIncrementalId, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type
-
-
-
-
Constructor Detail
-
AnimationItem
public AnimationItem(ConfigurationEnvelop<NativeObject> envelop)
Creates the item using an envelop with native java script object which contains all properties.
It is called fromconfiguration
package.- Parameters:
envelop
- envelop with native java script object which contains all properties.
-
-
Method Detail
-
getChart
public IsChart getChart()
Returns the CHARBA chart instance.- Returns:
- the CHARBA chart instance
-
isInitial
public boolean isInitial()
Returnstrue
for the initial animation of the chart.- Returns:
true
for the initial animation of the chart
-
getCurrentStep
public double getCurrentStep()
Returns the current animation frame number.- Returns:
- the current animation frame number.
-
getNumSteps
public double getNumSteps()
Returns the total number of animation frames.- Returns:
- the total number of animation frames.
-
-