public class

SeriesAnimation

extends Animation<T>
java.lang.Object
   ↳ com.shinobicontrols.charts.Animation<T>
     ↳ com.shinobicontrols.charts.SeriesAnimation

This class is deprecated.
as of version 1.9.1, use Animation with suitable Animation.Listeners or utilize helper classes such as SeriesAnimator, SeriesAnimationCreator and DefaultSeriesAnimationCreatorFactory

Class Overview

A SeriesAnimation object determines how a Series is animated.

A series animation consists of curves for X scale, Y scale and alpha, a duration, and origin values for X and Y scaling (the zero values that the animations scale down to).

Depending on the action which an animation is linked to, it may be triggered by different actions:

Entry Animations are triggered upon the initial addition of the series to the chart and when a series is unhidden. Exit Animations are triggered when a series is hidden or removed from the chart.

Summary

Public Constructors
SeriesAnimation()
This constructor is deprecated. as of version 1.9.1, use Animation with suitable Animation.Listeners or utilize helper classes such as SeriesAnimator, SeriesAnimationCreator and DefaultSeriesAnimationCreatorFactory
Public Methods
static SeriesAnimation createFadeAnimation()
This method is deprecated. as of version 1.9.1, use FadeAnimationCreator instead
static SeriesAnimation createGrowAnimation()
This method is deprecated. as of version 1.9.1, use GrowAnimationCreator instead
static SeriesAnimation createGrowHorizontalAnimation()
This method is deprecated. as of version 1.9.1, use GrowHorizontalAnimationCreator instead
static SeriesAnimation createGrowVerticalAnimation()
This method is deprecated. as of version 1.9.1, use GrowVerticalAnimationCreator instead
static SeriesAnimation createTelevisionAnimation()
This method is deprecated. as of version 1.9.1, use HorizontalTelevisionAnimationCreator or VerticalTelevisionAnimationCreator instead
AnimationCurve getAlphaCurve()
This method is deprecated. as of version 1.9.1, when using the SeriesAnimator pass in a suitable SeriesAnimationCreator, or when manually creating Animations use a suitable AnimationCurve, Evaluator and Animation.Listener, the SeriesAlphaAnimationListener can be used to update the alpha property of a Series
Float getXOrigin()
This method is deprecated. as of version 1.9.1, use getPivotX() to obtain the pivotX (or X origin) from the Series directly
AnimationCurve getXScaleCurve()
This method is deprecated. as of version 1.9.1, when using the SeriesAnimator pass in a suitable SeriesAnimationCreator, or when manually creating Animations use a suitable AnimationCurve, Evaluator and Animation.Listener, the SeriesScaleXAnimationListener can be used to update the scaleX property of a Series
Float getYOrigin()
This method is deprecated. as of version 1.9.1, use getPivotY() to obtain the pivotY (or Y origin) from the Series directly
AnimationCurve getYScaleCurve()
This method is deprecated. as of version 1.9.1, when using the SeriesAnimator pass in a suitable SeriesAnimationCreator, or when manually creating Animations use a suitable AnimationCurve, Evaluator and Animation.Listener, the SeriesScaleYAnimationListener can be used to update the scaleY property of a Series
void setAlphaCurve(AnimationCurve curve)
This method is deprecated. as of version 1.9.1, when using the SeriesAnimator pass in a suitable SeriesAnimationCreator, or when manually creating Animations use a suitable AnimationCurve, Evaluator and Animation.Listener, the SeriesAlphaAnimationListener can be used to update the alpha property of a Series
void setXOrigin(Float origin)
This method is deprecated. as of version 1.9.1, use setPivotX(Float) to set the pivotX (or X origin) on the Series directly
void setXScaleCurve(AnimationCurve curve)
This method is deprecated. as of version 1.9.1, when using the SeriesAnimator pass in a suitable SeriesAnimationCreator, or when manually creating Animations use a suitable AnimationCurve, Evaluator and Animation.Listener, the SeriesScaleXAnimationListener can be used to update the scaleX property of a Series
void setYOrigin(Float origin)
This method is deprecated. as of version 1.9.1, use setPivotY(Float) to set the pivotY (or Y origin) on the Series directly
void setYScaleCurve(AnimationCurve curve)
This method is deprecated. as of version 1.9.1, when using the SeriesAnimator pass in a suitable SeriesAnimationCreator, or when manually creating Animations use a suitable AnimationCurve, Evaluator and Animation.Listener, the SeriesScaleYAnimationListener can be used to update the scaleY property of a Series
[Expand]
Inherited Methods
From class com.shinobicontrols.charts.Animation
From class java.lang.Object

Public Constructors

public SeriesAnimation ()

This constructor is deprecated.
as of version 1.9.1, use Animation with suitable Animation.Listeners or utilize helper classes such as SeriesAnimator, SeriesAnimationCreator and DefaultSeriesAnimationCreatorFactory

Constructor

The default animation does nothing, and you are recommended to us one of the predefined create methods. However, it may be useful if you are creating your own specialized animation type.

Public Methods

public static SeriesAnimation createFadeAnimation ()

This method is deprecated.
as of version 1.9.1, use FadeAnimationCreator instead

Creates an animation where the series fades.

Returns
  • An animation where the series fades.

public static SeriesAnimation createGrowAnimation ()

This method is deprecated.
as of version 1.9.1, use GrowAnimationCreator instead

Creates an animation where the series scales from its center (the normalized X and Y are both set to 0.5f). This is the default entry & exit animation for Donut series, and Pie series.

Returns
  • An animation where the series scales from its center

public static SeriesAnimation createGrowHorizontalAnimation ()

This method is deprecated.
as of version 1.9.1, use GrowHorizontalAnimationCreator instead

Creates an animation where the series scales from its leftmost point. This is the default entry & exit animation for Bar series. If a baseline is set on a bar series, the baseline will be used as the origin.

Returns
  • An animation where the series scales from its leftmost point.

public static SeriesAnimation createGrowVerticalAnimation ()

This method is deprecated.
as of version 1.9.1, use GrowVerticalAnimationCreator instead

Creates an animation where the series scales from its lowest point. This is the default entry & exit animation for Column series, OHLC series and Candlestick series. If a baseline is set on a column series the baseline will be used as the origin instead.

Returns
  • An animation where the series scales from its lowest point.

public static SeriesAnimation createTelevisionAnimation ()

This method is deprecated.
as of version 1.9.1, use HorizontalTelevisionAnimationCreator or VerticalTelevisionAnimationCreator instead

Creates an animation where the series scales from its center (the normalized X and Y are both set to 0.5f). This is similar to the Grow animation, but includes a delay element. This is the default entry & exit animation for Line series, and Band series.

Returns
  • An animation where the series scales from its center

public AnimationCurve getAlphaCurve ()

This method is deprecated.
as of version 1.9.1, when using the SeriesAnimator pass in a suitable SeriesAnimationCreator, or when manually creating Animations use a suitable AnimationCurve, Evaluator and Animation.Listener, the SeriesAlphaAnimationListener can be used to update the alpha property of a Series

Gets the animation curve describing how the transparency of the series changes during the animation.

This curve describes how the alpha value of the colors of the series scale from some initial alpha value at the start of the animation to some destination alpha at the end of the animation. We multiply the value returned by this curve with the colors set to the series, therefore a curve value of 0 results in a completely transparent color and a value of 1 results in the final alpha value of the series color. This curve applies to both cartesian and radial series.

Returns
  • The animation curve describing how the transparency of the series changes during the animation.

public Float getXOrigin ()

This method is deprecated.
as of version 1.9.1, use getPivotX() to obtain the pivotX (or X origin) from the Series directly

Returns a normalized point of origin along the X axis for the animation.

This value is normalized using the currently visible range of the X axis associated with the series which the animation is applied to. For example, setting an origin of 0.0f would cause the series to animate from its left-most point. Setting an origin of 1.0f would cause the series to animate from its right-most point.

The origin value may also be null. In this case (useful for Bar series) the series baseline is used as the origin.

Returns
  • A normalized point of origin along the X axis for the animation.

public AnimationCurve getXScaleCurve ()

This method is deprecated.
as of version 1.9.1, when using the SeriesAnimator pass in a suitable SeriesAnimationCreator, or when manually creating Animations use a suitable AnimationCurve, Evaluator and Animation.Listener, the SeriesScaleXAnimationListener can be used to update the scaleX property of a Series

Gets the animation curve describing the transition of the series parallel to the X axis.

This curve describes how the X values of the series scale from some origin along the X axis at the start of the animation to their destination at the end of the animation. A value of 0 maps a point at the animation origin whereas a value of 1 maps the point at its true value.

Returns
  • The animation curve describing the transition of the series parallel to the X axis.

public Float getYOrigin ()

This method is deprecated.
as of version 1.9.1, use getPivotY() to obtain the pivotY (or Y origin) from the Series directly

Returns a normalized point of origin along the Y axis for the animation.

This value is normalized using the currently visible range of the Y axis associated with the series which the animation is applied to. For example, setting an origin of 0.0f would cause the series to animate from its bottom-most point. Setting an origin of 1.0f would cause the series to animate from its top-most point.

The origin value may also be null. In this case (useful for Column series) the series baseline is used as the origin.

Returns
  • A normalized point of origin along the Y axis for the animation.

public AnimationCurve getYScaleCurve ()

This method is deprecated.
as of version 1.9.1, when using the SeriesAnimator pass in a suitable SeriesAnimationCreator, or when manually creating Animations use a suitable AnimationCurve, Evaluator and Animation.Listener, the SeriesScaleYAnimationListener can be used to update the scaleY property of a Series

Gets the animation curve describing the transition of the series parallel to the Y axis. This curve describes how the Y values of the series scale from some origin along the Y axis at the start of the animation to their destination at the end of the animation. A value of 0 maps a point at the animation origin whereas a value of 1 maps the point at its true value.

Returns
  • The animation curve describing the transition of the series parallel to the Y axis.

public void setAlphaCurve (AnimationCurve curve)

This method is deprecated.
as of version 1.9.1, when using the SeriesAnimator pass in a suitable SeriesAnimationCreator, or when manually creating Animations use a suitable AnimationCurve, Evaluator and Animation.Listener, the SeriesAlphaAnimationListener can be used to update the alpha property of a Series

Sets the animation curve describing how the transparency of the series changes during the animation. This curve describes how the alpha value of the colors of the series scale from some initial alpha value at the start of the animation to some destination alpha at the end of the animation. We multiply the value returned by this curve with the colors set to the series, therefore a curve value of 0 results in a completely transparent color and a value of 1 results in the final alpha value of the series color. This curve applies to both cartesian and radial series.

Parameters
curve The animation curve describing how the transparency of the series changes during the animation.
See Also

public void setXOrigin (Float origin)

This method is deprecated.
as of version 1.9.1, use setPivotX(Float) to set the pivotX (or X origin) on the Series directly

Sets a normalized point of origin along the X axis for the animation.

This value is normalized using the currently visible range of the X axis associated with the series which the animation is applied to. For example, setting an origin of 0.0f would cause the series to animate from its left-most point. Setting an origin of 1.0f would cause the series to animate from its right-most point.

The origin value may also be null. In this case (useful for Bar series) the series baseline is used as the origin.

Parameters
origin A normalized point of origin along the Y axis for the animation.
See Also

public void setXScaleCurve (AnimationCurve curve)

This method is deprecated.
as of version 1.9.1, when using the SeriesAnimator pass in a suitable SeriesAnimationCreator, or when manually creating Animations use a suitable AnimationCurve, Evaluator and Animation.Listener, the SeriesScaleXAnimationListener can be used to update the scaleX property of a Series

Sets the animation curve describing the transition of the series parallel to the X axis.

This curve describes how the X values of the series scale from some origin along the X axis at the start of the animation to their destination at the end of the animation. A value of 0 maps a point at the animation origin whereas a value of 1 maps the point at its true value.

Parameters
curve The animation curve describing the transition of the series parallel to the X axis.
See Also

public void setYOrigin (Float origin)

This method is deprecated.
as of version 1.9.1, use setPivotY(Float) to set the pivotY (or Y origin) on the Series directly

Sets a normalized point of origin along the Y axis for the animation.

This value is normalized using the currently visible range of the Y axis associated with the series which the animation is applied to. For example, setting an origin of 0.0f would cause the series to animate from its bottom-most point. Setting an origin of 1.0f would cause the series to animate from its top-most point.

The origin value may also be null. In this case (useful for Column series) the series baseline is used as the origin.

Parameters
origin A normalized point of origin along the Y axis for the animation.
See Also

public void setYScaleCurve (AnimationCurve curve)

This method is deprecated.
as of version 1.9.1, when using the SeriesAnimator pass in a suitable SeriesAnimationCreator, or when manually creating Animations use a suitable AnimationCurve, Evaluator and Animation.Listener, the SeriesScaleYAnimationListener can be used to update the scaleY property of a Series

Sets the animation curve describing the transition of the series parallel to the Y axis. This curve describes how the Y values of the series scale from some origin along the Y axis at the start of the animation to their destination at the end of the animation. A value of 0 maps a point at the animation origin whereas a value of 1 maps the point at its true value.

Parameters
curve The animation curve describing the transition of the series parallel to the Y axis.
See Also