Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
SeriesEffectInstance

Package | mx.charts.effects.effectClasses
Class | public class SeriesEffectInstance
Inheritance | SeriesEffectInstance TweenEffectInstance EffectInstance flash.events.EventDispatcher
Subclasses | SeriesInterpolateInstance, SeriesSlideInstance, SeriesZoomInstance

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The SeriesEffectInstance class implements the base instance class for the chart series effects.

See also

mx.charts.effects.SeriesEffect

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | className : String [read-only] The name of the effect class, such as "FadeInstance". | EffectInstance
|  | duration : Number The duration of the effect, in milliseconds. | EffectInstance
|  | easingFunction : Function The easing function for the animation. | TweenEffectInstance
|  | effect : IEffect The IEffect object that created this IEffectInstance object. | EffectInstance
|  | effectTargetHost : IEffectTargetHost A property that lets you access the target list-based control of a data effect. | EffectInstance
|  | elementOffset : Number = 20 Specifies the amount of time, in milliseconds, that Flex delays the start of the effect on each element in the series. | SeriesEffectInstance
|  | hideFocusRing : Boolean Determines whether the effect should hide the focus ring when starting the effect. | EffectInstance
|  | minimumElementDuration : Number = 0 Specifies the amount of time, in milliseconds, that an individual element should take to complete the effect. | SeriesEffectInstance
|  | offset : Number = 0 Specifies the amount of time, in milliseconds, that Flex delays the effect. | SeriesEffectInstance
|  | playheadTime : Number [override] Current time position of the effect. | TweenEffectInstance
|  | propertyChanges : PropertyChanges Specifies the PropertyChanges object containing the start and end values for the set of properties relevant to the effect's targets. | EffectInstance
|  | repeatCount : int Number of times to repeat the effect. | EffectInstance
|  | repeatDelay : int Amount of time, in milliseconds, to wait before repeating the effect. | EffectInstance
|  | startDelay : int Amount of time, in milliseconds, to wait before starting the effect. | EffectInstance
|  | suspendBackgroundProcessing : Boolean If true, blocks all background processing while the effect is playing. | EffectInstance
|  | target : Object The UIComponent object to which this effect is applied. | EffectInstance
|  | triggerEvent : Event The event, if any, which triggered the playing of the effect. | EffectInstance
|  | tween : Tween The Tween object, which determines the animation. | TweenEffectInstance
|  | type : String = show The type of transition this effect is being used for. | SeriesEffectInstance

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | interpolationValues : Array The current position of each chart item being managed by this effect. | SeriesEffectInstance
|  | playCount : int = 0 Number of times that the instance has been played. | EffectInstance
|  | targetSeries : Series The series targeted by this instance. | SeriesEffectInstance

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | SeriesEffectInstance(target:Object = null) Constructor. | SeriesEffectInstance
|  | end():void [override] Interrupts an effect that is currently playing, and immediately jumps to the end of the effect. | TweenEffectInstance
|  | finishEffect():void Called by the end() method when the effect finishes playing. | EffectInstance
|  | finishRepeat():void Called after each iteration of a repeated effect finishes playing. | EffectInstance
|  | initEffect(event:Event):void This method is called if the effect was triggered by the EffectManager. | EffectInstance
|  | onTweenEnd(value:Object):void Callback method that is called when the target should be updated by the effect for the last time. | TweenEffectInstance
|  | onTweenUpdate(value:Object):void Callback method that is called when the target should be updated by the effect. | TweenEffectInstance
|  | pause():void Pauses the effect until you call the resume() method. | EffectInstance
|  | play():void Plays the effect instance on the target. | EffectInstance
|  | resume():void Resumes the effect after it has been paused by a call to the pause() method. | EffectInstance
|  | reverse():void Plays the effect in reverse, starting from the current position of the effect. | EffectInstance
|  | startEffect():void Plays the effect instance on the target after the startDelay period has elapsed. | EffectInstance
|  | stop():void Stops the effect, leaving the target in its current state. | EffectInstance

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | beginTween(elementCount:int):void Initializes the tweening calculations and sets up the interpolationValues Array for the number of items equal to the elementCount property. | SeriesEffectInstance
|  | createTween(listener:Object, startValue:Object, endValue:Object, duration:Number = -1, minFps:Number = -1):Tween Creates a Tween instance, assigns it the start, end, and duration values. | TweenEffectInstance

Property Detail

elementOffset | property

`public var elementOffset:Number = 20`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Specifies the amount of time, in milliseconds, that Flex delays the start of the effect on each element in the series.

Set `elementOffset` to `0` to affect all elements of the series at the same time. They start the effect at the same time and end it at the same time.

Set `elementOffset` to a positive integer (such as `30`) to stagger the effect on each element by that amount of time. For example, with a slide effect, the first element slides in immediately, then the next element begins 30 milliseconds later, and so on. The amount of time for the effect to execute is the same for each element, but the overall duration of the effect is longer.

Set `elementOffset` to a negative value to have the effect begin from the last element and move backwards through the list.

The default is `20`.

interpolationValues | property |

`protected var interpolationValues:Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The current position of each chart item being managed by this effect. This is an array of values between 0 and 1 indicating how far the effect should render each item in the series between its starting and ending values. These values are calculated based on the duration, number of elements, element offset, minimum element duration, and easing function.

minimumElementDuration | property |

`public var minimumElementDuration:Number = 0`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Specifies the amount of time, in milliseconds, that an individual element should take to complete the effect.

Charts with a variable number of data points in the series cannot reliably create smooth effects with only the `duration` property. For example, an effect with a `duration` of `1000` and an `elementOffset` of `100` takes 900 milliseconds per element to complete an effect if you have two elements in the series. This is because the start of each effect is offset by 100 and each effect finishes in 1000 milliseconds.

If there are four elements in the series, each element takes 700 milliseconds to complete (the last effect starts 300 milliseconds after the first and must be completed within 1000 milliseconds). With 10 elements, each element has only 100 milliseconds

to complete the effect.

The `minimumElementDuration` value sets a minimal duration for each element. No element of the series takes less than this amount of time (in milliseconds) to execute the effect, regardless of the number of elements in the series and the value of the `duration` property. As a result, it is possible for an effect to take longer than a specified `duration` if at least two of the following three properties are specified: `duration`, `offset`, and `minimumElementDuration`.

The default is `0`.

offset | property |

`public var offset:Number = 0`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Specifies the amount of time, in milliseconds, that Flex delays the effect.

Use this property to stagger effects on multiple series.

The default is `0`.

targetSeries | property |

`protected var targetSeries:Series`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The series targeted by this instance.

type | property |

`public var type:String = show`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The type of transition this effect is being used for. Some series effects define different behavior based on whether they are being used during the show or hide portion of a chart transition. The SeriesSlide effect, for example, slides elements from their position off screen when type is set to `hide`, and on screen when set to `show`. This property is set automatically by the chart, based on whether the effect is assigned to the ShowDataEffect or HideDataEffect style.

Constructor Detail

SeriesEffectInstance | () | Constructor

`public function SeriesEffectInstance(target:Object = null)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Parameters

| `target:Object` (default = `null`)`` — The target of the effect.

Method Detail

beginTween | () | method

`protected function beginTween(elementCount:int):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Initializes the tweening calculations and sets up the `interpolationValues` Array for the number of items equal to the `elementCount` property. Derived classes should call this function in their `play()` method.

Parameters

| `elementCount:int` — The number of elements to generate interpolation values for.

Sun Mar 5 2017, 03:42 PM +11:00