| Package | mx.charts.effects |
| Class | public class SeriesZoom |
| Inheritance | SeriesZoom  SeriesEffect TweenEffect Effect flash.events.EventDispatcher |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
showDataEffect or hideDataEffect effect trigger.
MXML Syntax
Hide MXML SyntaxThe <mx:SeriesZoom> tag
inherits all the properties of its parent classes,
and adds the following properties:
Show MXML Syntax
<mx:SeriesZoom
Properties
horizontalFocus="center|left|right|null"
relativeTo="series|chart"
verticalFocus="top|center|bottom|null"
/>
| 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 | |
| horizontalFocus : String
Defines the location of the focul point of the zoom. | SeriesZoom | ||
| 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 | |
| relativeTo : String = series
Controls the bounding box that Flex uses to calculate
the focal point of the zooms. | SeriesZoom | ||
| 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 | |
| verticalFocus : String
Defines the location of the focal point of the zoom. | SeriesZoom | ||
| Method | Defined By | ||
|---|---|---|---|
SeriesZoom(target:Object = null)
Constructor. | SeriesZoom | ||
| 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 | |
| horizontalFocus | property |
public var horizontalFocus:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Defines the location of the focul point of the zoom.
Valid values of the horizontalFocus property are "left",
"center", "right",
and null.
You combine the horizontalFocus and
verticalFocus properties to define
where the data series zooms in and out from.
For example, set the horizontalFocus property to "left"
and the verticalFocus property to "top" to zoom
the series data to and from the top left corner of either
the element or the chart (depending on the setting of the
relativeTo property).
If you specify only one of these two properties,
then the focus is a horizontal or vertical line rather than a point.
For example, when you set horizontalFocus
to "left" but verticalFocus
to null, the element zooms to and from
a vertical line along the left edge of its bounding box.
Set the verticalFocus property to "center"
to zoom chart elements to and from a horizontal line
along the middle of the chart's bounding box.
The default value is "center".
| relativeTo | property |
public var relativeTo:String = series| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Controls the bounding box that Flex uses to calculate the focal point of the zooms.
Valid values for the relativeTo property are
"series" and "chart".
Set to "series" to zoom each element
relative to itself.
For example, each column of a ColumnChart zooms from the top left
of the column, the center of the column, and so on.
Set to "chart" to zoom each element
relative to the chart area.
For example, each column zooms from the top left of the axes,
the center of the axes, and so on.
The default value is "series".
| verticalFocus | property |
public var verticalFocus:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Defines the location of the focal point of the zoom.
For more information, see the description of the
horizontalFocus property.
Valid values of verticalFocus are
"top", "center", "bottom",
and null.
The default value is "center".
| SeriesZoom | () | Constructor |
public function SeriesZoom(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) |
<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!-- 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:SeriesZoom id="zoomIn" duration="1000"/>
<mx:SeriesZoom id="zoomOut" duration="1000"/>
</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="{zoomIn}"
hideDataEffect="{zoomOut}"/>
</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>