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

The onProgress and onComplete 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 and Description
AnimationItem(ConfigurationEnvelop<NativeObject> envelop) Creates the item using an envelop with native java script object which contains all properties. It is called from configuration package.

Method Summary

Modifier and Type	Method and 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() Returns true for the initial animation of the chart.

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

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, 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, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

Methods inherited from class java.lang.Object

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

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 from configuration 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()

Returns true 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.