Package | mx.charts.effects |
Class | public class SeriesSlide |
Inheritance | SeriesSlide ![]() ![]() ![]() ![]() |
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
direction
property
to specify the location from which the series slides.
If you use SeriesSlide with a hideDataEffect
effect trigger,
the series slides from the current position onscreen to a position
off of the screen, in the indicated direction.
If you use SeriesSlide as a showDataEffect
,
the series slides from offscreen to a position onto the screen,
in the indicated direction.
The <mx:SeriesSlide>
tag
inherits all the properties of its parent classes,
and adds the following properties:
<mx:SeriesSlide Properties direction="left|right|up|down" />
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 | |
direction : String = left
Defines the location from which the series slides. | SeriesSlide | ||
![]() | 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 |
Method | Defined By | ||
---|---|---|---|
SeriesSlide(target:Object = null)
Constructor. | SeriesSlide | ||
![]() | 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 |
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(inst:IEffectInstance):void [override]
Copies properties of the effect to the effect instance. | SeriesSlide | ||
![]() | tweenEventHandler(event:TweenEvent):void
Called when the TweenEffect dispatches a TweenEvent. | TweenEffect |
direction | property |
public var direction:String = left
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Defines the location from which the series slides.
Valid values are "left"
, "right"
,
"up"
, and "down"
.
The default value is "left"
.
SeriesSlide | () | Constructor |
public function SeriesSlide(target:Object = null)
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Constructor.
Parameterstarget:Object (default = null ) — The target of the effect.
|
initInstance | () | method |
override protected function initInstance(inst:IEffectInstance):void
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Copies properties of the effect to the effect instance.
Flex calls this method from the Effect.createInstance()
method; you do not have to call it yourself.
When you create a custom effect, override this method to
copy properties from the Effect class to the effect instance class.
In your override, call super.initInstance()
.
Parameters
inst:IEffectInstance — The effect instance to initialize.
|