mx.charts.effects.effectClasses.SeriesZoomInstance (Flex™ 2 Language Reference

Public Properties

	Property		Defined by
		className : String 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 Duration of the effect in milliseconds.	EffectInstance
		easingFunction : Function The easing function for the animation.	TweenEffectInstance
		effect : 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
		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 The current position of the effect, in milliseconds.	TweenEffectInstance
		propertyChanges : PropertyChanges	EffectInstance
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		relativeTo : String = "series" Controls the bounding box that Flex uses to calculate the focal point of the zooms.	SeriesZoomInstance
		repeatCount : int	EffectInstance
		repeatDelay : int	EffectInstance
		startDelay : int	EffectInstance
		suspendBackgroundProcessing : Boolean	EffectInstance
		target : Object	EffectInstance
		triggerEvent : Event	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
		verticalFocus : String Defines the location of the focul point of the zoom.	SeriesZoomInstance

	Property	Defined by
		interpolationValues : Array The current position of each chart item being managed by this effect.	SeriesEffectInstance
		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 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
		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
		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
		seek(playheadTime:Number):void Advances the effect to the specified position.	TweenEffectInstance
		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
		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

	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

	Event	Summary	Defined by
		activate	Dispatched when Flash Player gains operating system focus and becomes active.	EventDispatcher
		deactivate	Dispatched when Flash Player loses operating system focus and is becoming inactive.	EventDispatcher

Property detail

horizontalFocus

property

public var horizontalFocus:String

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"

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

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)

Constructor.

Parameters

target:Object

Adobe^® Flex™ 2 Language Reference	All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Frames No Frames
Class SeriesZoomInstance	Properties \| Methods \| Events

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