(Preview)
| Package | mx.charts.effects |
| Class | public class SeriesSlide |
| Inheritance | SeriesSlide  SeriesEffect TweenEffect Effect EventDispatcher Object |
| 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.
Show MXML Syntax
Hide MXML SyntaxThe <mx:SeriesSlide> tag
inherits all the properties of its parent classes,
and adds the following properties:
<mx:SeriesSlide
Properties
direction="left|right|up|down"
/>
More examples
Public Properties
| Property | Defined By | ||
|---|---|---|---|
 | className : String [read-only]
The name of the effect class, such as "Fade". | Effect | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| customFilter : mx.effects: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 : mx.effects: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
Public Methods
| Method | Defined By | ||
|---|---|---|---|
SeriesSlide(target:Object = null)
Constructor. | SeriesSlide | ||
| 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 | |
|
Captures the current values of the relevant properties
on the effect's targets and saves them as end values. | Effect | |
|
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 | |
|
Captures the current values of the relevant properties
on the effect's targets. | Effect | |
|
Creates a single effect instance and initializes it. | Effect | |
|
Takes an Array of target objects and invokes the
createInstance() method on each target. | Effect | |
|
Removes event listeners from an instance
and removes it from the list of instances. | Effect | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Interrupts an effect that is currently playing,
and jumps immediately to the end of the effect. | Effect | |
|
Returns an Array of Strings, where each String is the name
of a property changed by this effect. | Effect | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Pauses the effect until you call the resume() method. | Effect | |
|
Begins playing the effect. | Effect | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Resumes the effect after it has been paused
by a call to the pause() method. | Effect | |
|
Plays the effect in reverse, if the effect is currently playing,
starting from the current position of the effect. | Effect | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Stops the effect, leaving the effect targets in their current state. | Effect | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
| Method | Defined By | ||
|---|---|---|---|
|
Used internally by the Effect infrastructure. | Effect | |
|
Called when an effect instance has finished playing. | Effect | |
|
This method is called when the effect instance starts playing. | Effect | |
|
Called when an effect instance has stopped by a call
to the stop() method. | Effect | |
|
Determines the logic for filtering out an effect instance. | Effect | |
|
Called by the captureStartValues() method to get the value
of a property from the target. | Effect | |
[override]
Copies properties of the effect to the effect instance. | SeriesSlide | ||
|
Called when the TweenEffect dispatches a TweenEvent. | TweenEffect | |
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
SeriesSlide | () | Constructor |
Method Detail
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.
|
Examples How to use this example
SeriesSlideExample.mxml
<?xml version="1.0"?>
<!-- Simple example to demonstrate the CandlestickChart control. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:s="library://ns.adobe.com/flex/spark"
xmlns:mx="library://ns.adobe.com/flex/mx">
<fx:Script>
<![CDATA[
import mx.collections.ArrayCollection;
[Bindable]
private var companyAAC:ArrayCollection = new ArrayCollection( [
{ Date: "25-Jul", Open: 40.75, High: 40.75, Low: 40.24, Close:40.31},
{ Date: "26-Jul", Open: 39.98, High: 40.78, Low: 39.97, Close:40.34},
{ Date: "27-Jul", Open: 40.38, High: 40.66, Low: 40, Close:40.63},
{ Date: "28-Jul", Open: 40.49, High: 40.99, Low: 40.3, Close:40.98},
{ Date: "29-Jul", Open: 40.13, High: 40.4, Low: 39.65, Close:39.95},
{ Date: "1-Aug", Open: 39.00, High: 39.50, Low: 38.7, Close:38.6},
{ Date: "2-Aug", Open: 38.68, High: 39.34, Low: 37.75, Close:38.84},
{ Date: "3-Aug", Open: 38.76, High: 38.76, Low: 38.03, Close:38.12},
{ Date: "4-Aug", Open: 37.98, High: 37.98, Low: 36.56, Close:36.69},
{ Date: "5-Aug", Open: 36.61, High: 37, Low: 36.48, Close:36.86} ]);
[Bindable]
private var companyBAC:ArrayCollection = new ArrayCollection( [
{ Date: "25-Jul", Open: 18.50, High: 19, Low: 18.48, Close:18.86},
{ Date: "26-Jul", Open: 19.56, High: 19.98, Low: 18.6, Close:18.69},
{ Date: "27-Jul", Open: 20.81, High: 20.99, Low: 20.03, Close:20.12},
{ Date: "28-Jul", Open: 20.70, High: 21.00, Low: 19.5, Close:20.84},
{ Date: "29-Jul", Open: 21.7, High: 21.79, Low: 20.45, Close:20.6},
{ Date: "1-Aug", Open: 22.45, High: 22.65, Low: 21.65, Close:21.95},
{ Date: "2-Aug", Open: 22.56, High: 22.6, Low: 22.05, Close:22.98},
{ Date: "3-Aug", Open: 22.42, High: 22.70, Low: 22.1, Close:22.63},
{ Date: "4-Aug", Open: 21.67, High: 22.82, Low: 21.67, Close:22.34},
{ Date: "5-Aug", Open: 22.44, High: 22.85, Low: 22.12, Close:22.31} ]);
]]>
</fx:Script>
<fx:Declarations>
<mx:SeriesSlide id="slideIn" duration="1000" direction="up"/>
<mx:SeriesSlide id="slideOut" duration="1000" direction="down"/>
</fx:Declarations>
<mx:Panel title="CandlestickChart Control Example" height="100%" width="100%"
paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">
<mx:CandlestickChart id="candlestickchart" height="100%" width="100%"
paddingRight="5" paddingLeft="5"
showDataTips="true" dataProvider="{companyAAC}">
<mx:verticalAxis>
<mx:LinearAxis id="vaxis" baseAtZero="false" title="Price"/>
</mx:verticalAxis>
<mx:horizontalAxis>
<mx:CategoryAxis id="haxis" categoryField="Date" title="Date"/>
</mx:horizontalAxis>
<mx:horizontalAxisRenderers>
<mx:AxisRenderer axis="{haxis}" canDropLabels="true"/>
</mx:horizontalAxisRenderers>
<mx:series>
<mx:CandlestickSeries
openField="Open" highField="High"
lowField="Low" closeField="Close"
showDataEffect="{slideIn}"
hideDataEffect="{slideOut}"/>
</mx:series>
</mx:CandlestickChart>
<mx:Label width="100%" color="blue"
text="Choose a company to view recent stock data."/>
<mx:HBox>
<mx:RadioButton groupName="stocks" label="View Company A"
selected="true" click="candlestickchart.dataProvider=companyAAC;"/>
<mx:RadioButton groupName="stocks" label="View Company B"
click="candlestickchart.dataProvider=companyBAC;"/>
</mx:HBox>
</mx:Panel>
</s:Application>
Wed Nov 21 2018, 06:34 AM -08:00