org.pepstock.charba.client.defaults.global

Class Animation

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.defaults.AbstractItem

org.pepstock.charba.client.defaults.global.Animation

public final class Animation
extends AbstractItem

It animates charts out of the box. A number of options are provided to configure how the animation looks and how long it takes.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
int	getDuration() Returns the number of milliseconds an animation takes.
Easing	getEasing() Returns the animation easing.
boolean	isAnimateRotate() If true, the chart will animate in with a rotation animation.
boolean	isAnimateScale() If true, will animate scaling the chart from the center outwards.
void	setAnimateRotate(boolean animateRotate) If true, the chart will animate in with a rotation animation.
void	setAnimateScale(boolean animateScale) If true, will animate scaling the chart from the center outwards.
void	setDuration(int milliseconds) Sets the number of milliseconds an animation takes.
void	setEasing(Easing easing) Sets the animation easing.

Methods inherited from class org.pepstock.charba.client.defaults.AbstractItem

checkAndAddToParent, hasProperty

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

Method Detail

setEasing

public void setEasing(Easing easing)

Sets the animation easing.

Parameters:

easing - animation easing.

See Also:

Easing

getEasing

public Easing getEasing()

Returns the animation easing.

Returns:

animation easing. Default value is Easing.easeOutQuart.

See Also:

Easing

setDuration

public void setDuration(int milliseconds)

Sets the number of milliseconds an animation takes.

Parameters:

milliseconds - the number of milliseconds an animation takes.

getDuration

public int getDuration()

Returns the number of milliseconds an animation takes.

Returns:

the number of milliseconds an animation takes. Default is 1000 (1 second).

setAnimateRotate

public void setAnimateRotate(boolean animateRotate)

If true, the chart will animate in with a rotation animation.

Parameters:

animateRotate - If true, the chart will animate in with a rotation animation.

isAnimateRotate

public boolean isAnimateRotate()

If true, the chart will animate in with a rotation animation.

Returns:

If true, the chart will animate in with a rotation animation. Default is true.

setAnimateScale

public void setAnimateScale(boolean animateScale)

If true, will animate scaling the chart from the center outwards.

Parameters:

animateScale - If true, will animate scaling the chart from the center outwards.

isAnimateScale

public boolean isAnimateScale()

If true, will animate scaling the chart from the center outwards.

Returns:

If true, will animate scaling the chart from the center outwards. Default is false.