org.pepstock.charba.client.configuration

Interface HasAnimation

All Known Implementing Classes:

AbstractPieOptions, BarOptions, BubbleMapOptions, BubbleOptions, ChoroplethOptions, ConfigurationOptions, DoughnutOptions, GaugeOptions, HorizontalBarOptions, LineOptions, MatrixOptions, MeterOptions, PieOptions, PolarAreaOptions, RadarOptions, SankeyOptions, ScalesOptions, ScatterOptions, StackedOptions, TimeSeriesBarOptions, TimeSeriesLineOptions, Tooltips, TreeMapOptions, TypedDataset, VerticalLineOptions

public interface HasAnimation

Defines a configuration element which is managing the ANIMATION options.
It has being used in the options and datasets instances where ANIMATION is required.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
default Animation	getAnimation() Returns the animation element.
AnimationContainer	getAnimationContainer() Returns an animation container instance to use in the default methods of this interface.
default Animations	getAnimations() Returns the animations collection element.
default Transitions	getTransitions() Returns the animation transition element.
default boolean	isAnimationEnabled() Returns true if animation is enabled, otherwise false.
default void	setAnimationEnabled(boolean enabled) Enables or disables the animation.

Method Detail

getAnimationContainer

AnimationContainer getAnimationContainer()

Returns an animation container instance to use in the default methods of this interface.

Returns:

an animation container instance

getAnimation

default Animation getAnimation()

Returns the animation element.

Returns:

the animation

getAnimations

default Animations getAnimations()

Returns the animations collection element.

Returns:

the animations collection

getTransitions

default Transitions getTransitions()

Returns the animation transition element.

Returns:

the animation transition

setAnimationEnabled

default void setAnimationEnabled(boolean enabled)

Enables or disables the animation.

Parameters:

enabled - if true the animation is enabled otherwise false to disable it.

isAnimationEnabled

default boolean isAnimationEnabled()

Returns true if animation is enabled, otherwise false.

Returns:

true if animation is enabled, otherwise false