org.dashbuilder.renderer.chartjs.lib.options.HasAnimation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dashbuilder-renderer-chartjs Show documentation

Dashbuilder Renderer for the Chart JS API

The newest version!

package org.dashbuilder.renderer.chartjs.lib.options;

/**
 * Enum contains types of easing of chart animation
 */
public interface HasAnimation{

    final String ANIMATION = "animation";
    final String ANIMATION_STEPS = "animationSteps";
    final String ANIMATION_EASING = "animationEasing";


    /**
     * Specify should chart be animated or not
     * Default value is true
     * @param enabled
     */
    public void setAnimationEnabled(boolean enabled);

    /**
     * Particularly specify quality of animation
     * Default value is 60
     * @param steps
     */
    public void setAnimationSteps(int steps);

    /**
     * Specify animation easing
     * Default value is {@link Type#EASE_OUT_QUART}
     * @param type
     */
    public void setAnimationType(Type type);

    /**
     * Add animation callback to handle animation state changes
     * @param callback
     */
    public void addAnimationCallback(AnimationCallback callback);

}