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

Package | mx.charts.effects
Class | public class SeriesEffect
Inheritance | SeriesEffect TweenEffect Effect flash.events.EventDispatcher
Subclasses | SeriesInterpolate, SeriesSlide, SeriesZoom

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The base class for chart effects.

MXML Syntax Show MXML Syntax
Hide MXML Syntax

The `<mx:SeriesEffect>` tag inherits the tag attributes of its superclass, and adds the following tag attributes:

      <mx:tagname
        Properties
        elementOffset="20"
        minimumElementDuration="0"
        offset="0"
        type="show|hide (Default value is set by chart)"
      >

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 "Fade". | Effect
|  | customFilter : EffectTargetFilter Specifies a custom filter object, of type EffectTargetFilter, used by the effect to determine the targets on which to play the effect. | Effect
|  | duration : Number Duration of the effect in milliseconds. | Effect
|  | easingFunction : Function = null The easing function for the animation. | TweenEffect
|  | effectTargetHost : IEffectTargetHost A property that lets you access the target list-based control of a data effect. | Effect
|  | elementOffset : Number = 20 Specifies the amount of time, in milliseconds, that Flex delays the start of the effect on each element in the series. | SeriesEffect
|  | filter : String Specifies an algorithm for filtering targets for an effect. | Effect
|  | hideFocusRing : Boolean Determines whether the effect should hide the focus ring when starting the effect. | Effect
|  | instanceClass : Class An object of type Class that specifies the effect instance class class for this effect class. | Effect
|  | isPlaying : Boolean [read-only] A read-only flag which is true if any instances of the effect are currently playing, and false if none are. | Effect
|  | minimumElementDuration : Number = 0 Specifies the amount of time, in milliseconds, that an individual element should take to complete the effect. | SeriesEffect
|  | offset : Number = 0 Specifies the amount of time, in milliseconds, that Flex delays the effect. | SeriesEffect
|  | perElementOffset : Number Additional delay, in milliseconds, for effect targets after the first target of the effect. | Effect
|  | playheadTime : Number Current time position of the effect. | Effect
|  | relevantProperties : Array An Array of property names to use when performing filtering. | Effect
|  | relevantStyles : Array An Array of style names to use when performing filtering. | Effect
|  | repeatCount : int = 1 Number of times to repeat the effect. | Effect
|  | repeatDelay : int = 0 Amount of time, in milliseconds, to wait before repeating the effect. | Effect
|  | startDelay : int = 0 Amount of time, in milliseconds, to wait before starting the effect. | Effect
|  | suspendBackgroundProcessing : Boolean = false If true, blocks all background processing while the effect is playing. | Effect
|  | target : Object The object to which this effect is applied. | Effect
|  | targets : Array An Array of objects that are targets for the effect. | Effect
|  | triggerEvent : Event The Event object passed to this Effect by the EffectManager when an effect is triggered, or null if the effect is not being played by the EffectManager. | Effect
|  | type : String = show The type of transition this effect is being used for. | SeriesEffect

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | applyTransitionEndProperties : Boolean This flag controls whether the effect, when run in a transition, automatically applies the property values according to the end state, as opposed to leaving values as set by the effect itself. | Effect
|  | endValuesCaptured : Boolean = false A flag containing true if the end values of an effect have already been determined, or false if they should be acquired from the current properties of the effect targets when the effect runs. | Effect

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | SeriesEffect(target:Object) Constructor. | SeriesEffect
|  | captureEndValues():void Captures the current values of the relevant properties on the effect's targets and saves them as end values. | Effect
|  | captureMoreStartValues(targets:Array):void Captures the current values of the relevant properties of an additional set of targets Flex uses this function when a data change effect is run. | Effect
|  | captureStartValues():void Captures the current values of the relevant properties on the effect's targets. | Effect
|  | createInstance(target:Object = null):IEffectInstance Creates a single effect instance and initializes it. | Effect
|  | createInstances(targets:Array = null):Array Takes an Array of target objects and invokes the createInstance() method on each target. | Effect
|  | deleteInstance(instance:IEffectInstance):void Removes event listeners from an instance and removes it from the list of instances. | Effect
|  | end(effectInstance:IEffectInstance = null):void Interrupts an effect that is currently playing, and jumps immediately to the end of the effect. | Effect
|  | getAffectedProperties():Array Returns an Array of Strings, where each String is the name of a property changed by this effect. | Effect
|  | pause():void Pauses the effect until you call the resume() method. | Effect
|  | play(targets:Array = null, playReversedFromEnd:Boolean = false):Array Begins playing the effect. | Effect
|  | resume():void Resumes the effect after it has been paused by a call to the pause() method. | Effect
|  | reverse():void Plays the effect in reverse, if the effect is currently playing, starting from the current position of the effect. | Effect
|  | stop():void Stops the effect, leaving the effect targets in their current state. | Effect

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | applyValueToTarget(target:Object, property:String, value:*, props:Object):void Used internally by the Effect infrastructure. | Effect
|  | effectEndHandler(event:EffectEvent):void Called when an effect instance has finished playing. | Effect
|  | effectStartHandler(event:EffectEvent):void This method is called when the effect instance starts playing. | Effect
|  | effectStopHandler(event:EffectEvent):void Called when an effect instance has stopped by a call to the stop() method. | Effect
|  | filterInstance(propChanges:Array, target:Object):Boolean Determines the logic for filtering out an effect instance. | Effect
|  | getValueFromTarget(target:Object, property:String):* Called by the captureStartValues() method to get the value of a property from the target. | Effect
|  | initInstance(instance:IEffectInstance):void Copies properties of the effect to the effect instance. | Effect
|  | tweenEventHandler(event:TweenEvent):void Called when the TweenEffect dispatches a TweenEvent. | TweenEffect

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | effectEnd | Dispatched when one of the effect's instances finishes playing, either when the instance finishes playing or when the effect is interrupted by a call to the end() method. | Effect
|  | effectStart | Dispatched when the effect starts playing. | Effect
|  | effectStop | Dispatched when the effect has been stopped, which only occurs when the effect is interrupted by a call to the stop() method. | Effect
|  | tweenEnd | Dispatched when the tween effect ends. | TweenEffect
|  | tweenStart | Dispatched when the tween effect starts, which corresponds to the first call to the onTweenUpdate() method. | TweenEffect
|  | tweenUpdate | Dispatched every time the tween effect updates the target. | TweenEffect

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`.

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`.

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 this property is set to `hide`, and on screen when this property is set to `show`. This property is set by the chart, based on whether the effect as assigned to the ShowDataEffect or HideDataEffect style.

Constructor Detail

SeriesEffect | () | Constructor

`public function SeriesEffect(target:Object)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Parameters

| `target:Object` — The target of the effect.

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