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

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The SeriesSlideInstance class implements the instance class for the SeriesSlide effect. Flex creates an instance of this class when it plays a SeriesSlide effect; you do not create one yourself.

See also

mx.charts.effects.SeriesSlide

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
|  | direction : String = left Defines the location from which the series slides. | SeriesSlideInstance
|  | 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
--- | --- | ---
|  | SeriesSlideInstance(target:Object) Constructor. | SeriesSlideInstance
|  | 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

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

Constructor Detail

SeriesSlideInstance | () | Constructor

`public function SeriesSlideInstance(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