Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.charts.effects.effectClasses 
SeriesEffectInstance 
Packagemx.charts.effects.effectClasses
Classpublic class SeriesEffectInstance
InheritanceSeriesEffectInstance Inheritance TweenEffectInstance Inheritance EffectInstance Inheritance EventDispatcher Inheritance Object
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



Public Properties
 PropertyDefined By
 InheritedclassName : String
[read-only] The name of the effect class, such as "FadeInstance".
EffectInstance
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedduration : Number
The duration of the effect, in milliseconds.
EffectInstance
 InheritedeasingFunction : Function
The easing function for the animation.
TweenEffectInstance
 Inheritedeffect : IEffect
The IEffect object that created this IEffectInstance object.
EffectInstance
 InheritedeffectTargetHost : mx.effects: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
 InheritedhideFocusRing : 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
 InheritedplayheadTime : Number
[override] Current time position of the effect.
TweenEffectInstance
 InheritedpropertyChanges : PropertyChanges
Specifies the PropertyChanges object containing the start and end values for the set of properties relevant to the effect's targets.
EffectInstance
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedrepeatCount : int
Number of times to repeat the effect.
EffectInstance
 InheritedrepeatDelay : int
Amount of time, in milliseconds, to wait before repeating the effect.
EffectInstance
 InheritedstartDelay : int
Amount of time, in milliseconds, to wait before starting the effect.
EffectInstance
 InheritedsuspendBackgroundProcessing : Boolean
If true, blocks all background processing while the effect is playing.
EffectInstance
 Inheritedtarget : Object
The UIComponent object to which this effect is applied.
EffectInstance
 InheritedtriggerEvent : Event
The event, if any, which triggered the playing of the effect.
EffectInstance
 Inheritedtween : mx.effects: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
 PropertyDefined By
  interpolationValues : Array
The current position of each chart item being managed by this effect.
SeriesEffectInstance
 InheritedplayCount : int = 0
Number of times that the instance has been played.
EffectInstance
  targetSeries : Series
The series targeted by this instance.
SeriesEffectInstance
Public Methods
 MethodDefined By
  
Constructor.
SeriesEffectInstance
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
[override] Interrupts an effect that is currently playing, and immediately jumps to the end of the effect.
TweenEffectInstance
 Inherited
Called by the end() method when the effect finishes playing.
EffectInstance
 Inherited
Called after each iteration of a repeated effect finishes playing.
EffectInstance
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
This method is called if the effect was triggered by the EffectManager.
EffectInstance
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Callback method that is called when the target should be updated by the effect for the last time.
TweenEffectInstance
 Inherited
Callback method that is called when the target should be updated by the effect.
TweenEffectInstance
 Inherited
Pauses the effect until you call the resume() method.
EffectInstance
 Inherited
Plays the effect instance on the target.
EffectInstance
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Resumes the effect after it has been paused by a call to the pause() method.
EffectInstance
 Inherited
Plays the effect in reverse, starting from the current position of the effect.
EffectInstance
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Plays the effect instance on the target after the startDelay period has elapsed.
EffectInstance
 Inherited
Stops the effect, leaving the target in its current state.
EffectInstance
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined 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
 Inherited
createTween(listener:Object, startValue:Object, endValue:Object, duration:Number = -1, minFps:Number = -1):mx.effects:Tween
Creates a Tween instance, assigns it the start, end, and duration values.
TweenEffectInstance
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
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.