mx.charts.effects.effectClasses

# SeriesZoomInstance - AS3 Flex

Package | mx.charts.effects.effectClasses
Class | public class SeriesZoomInstance
Inheritance | SeriesZoomInstance SeriesEffectInstance TweenEffectInstance EffectInstance EventDispatcher Object

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

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

Related API Elements

mx.charts.effects.SeriesZoom

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
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | 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 : mx.effects: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
|  | horizontalFocus : String Defines the location of the focul point of the zoom. | SeriesZoomInstance
|  | 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
|  | relativeTo : String = "series" Controls the bounding box that Flex uses to calculate the focal point of the zooms. | SeriesZoomInstance
|  | 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 : mx.effects:Tween The Tween object, which determines the animation. | TweenEffectInstance
|  | type : String = "show" The type of transition this effect is being used for. | SeriesEffectInstance
|  | verticalFocus : String Defines the location of the focul point of the zoom. | SeriesZoomInstance

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
--- | --- | ---
|  | SeriesZoomInstance(target:Object) Constructor. | SeriesZoomInstance
|  | 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
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | EventDispatcher
|  | 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
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | EventDispatcher
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | initEffect(event:Event):void This method is called if the effect was triggered by the EffectManager. | EffectInstance
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | 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
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | EventDispatcher
|  | 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
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | 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
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object
|  | willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | EventDispatcher

Protected Methods
Hide 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):mx.effects:Tween Creates a Tween instance, assigns it the start, end, and duration values. | TweenEffectInstance

Events
Click for more information on events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | activate | [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher
|  | deactivate | [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher

Property Detail

### 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 `horizontalFocus` are `"left"`, `"center"`, `"right"`, and `null`.

The default value is `"center"`.

You combine the `horizontalFocus` and `verticalFocus` properties to define where the data series zooms in and out from. For example, set `horizontalFocus` to `"left"` and `verticalFocus` 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 `verticalFocus` to `"center"` to zoom chart elements to and from a horizontal line along the middle of the chart's bounding box.

### 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 `relativeTo` are `"series"` and `"chart"`. The default value is `"series"`.

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.

### 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 focul point of the zoom.

Valid values of `verticalFocus` are `"top"`, `"center"`, `"bottom"`, and `null`. The default value is `"center"`.

For more information, see the description of the `horizontalFocus` property.

Constructor Detail

### SeriesZoomInstance

()
Constructor

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

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00