Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.charts.chartClasses 
PolarTransform 
Packagemx.charts.chartClasses
Classpublic class PolarTransform
InheritancePolarTransform Inheritance DataTransform Inheritance EventDispatcher Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The PolarTransform object represents a set of axes used to map data values to angle/distance polar coordinates and vice versa.

You typically do not need to interact with the PolarTransform object. Transforms are created automatically by the built-in chart types and are used by the series contained within to transform data into rendering coordinates.



Public Properties
 PropertyDefined By
 Inheritedaxes : Object
[read-only] The set of axes associated with this transform.
DataTransform
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedelements : Array
The elements that are associated with this transform.
DataTransform
  origin : Point
[read-only] The origin of the polar transform.
PolarTransform
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  radius : Number
[read-only] The radius used by the transform to convert data units to polar coordinates.
PolarTransform
Public Methods
 MethodDefined By
  
Constructor.
PolarTransform
 Inherited
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
 Inherited
Informs the DataTransform that some of the underlying data being represented on the chart has changed.
DataTransform
 Inherited
describeData(dimension:String, requiredFields:uint):Array
Collects important displayed values for all elements associated with this data transform.
DataTransform
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
getAxis(dimension:String):IAxis
Retrieves the axis instance responsible for transforming the data dimension specified by the dimension parameter.
DataTransform
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Transforms x and y coordinates relative to the DataTransform coordinate system into a two-dimensional value in data space.
DataTransform
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
setAxis(dimension:String, v:IAxis):void
Assigns an axis instance to a particular dimension of the transform.
DataTransform
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
  
setSize(width:Number, height:Number):void
Sets the width and height that the PolarTransform uses when calculating origin and radius.
PolarTransform
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
  
transformCache(cache:Array, aField:String, aConvertedField:String, rField:String, rConvertedField:String):void
[override] Maps a set of numeric values representing data to screen coordinates.
PolarTransform
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 InheritedDispatched when the transformation from data space to screen space has changed, typically either because the axes that make up the transformation have changed in some way, or the data transform itself has size.DataTransform
Public Constants
 ConstantDefined By
  ANGULAR_AXIS : String = "a"
[static] A string representing the angular axis.
PolarTransform
  RADIAL_AXIS : String = "r"
[static] A string representing the radial axis.
PolarTransform
Property Detail

origin

property
origin:Point  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The origin of the polar transform. This point is used by associated series to convert data units to screen coordinates.



Implementation
    public function get origin():Point

radius

property 
radius:Number  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The radius used by the transform to convert data units to polar coordinates.



Implementation
    public function get radius():Number
Constructor Detail

PolarTransform

()Constructor
public function PolarTransform()

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Method Detail

setSize

()method
public function setSize(width:Number, height:Number):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Sets the width and height that the PolarTransform uses when calculating origin and radius. The containing chart calls this method. You should not generally call this method directly.

Parameters

width:Number — The width, in pixels, of the PolarTransform.
 
height:Number — The height, in pixels, of the PolarTransform.

transformCache

()method 
override public function transformCache(cache:Array, aField:String, aConvertedField:String, rField:String, rConvertedField:String):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Maps a set of numeric values representing data to screen coordinates. This method assumes the values are all numbers, so any non-numeric values must have been previously converted with the mapCache() method.

Parameters

cache:Array — An array of objects containing the data values in their fields. This is also where this function will store the converted numeric values.
 
aField:String — The field where the data values for the x axis can be found.
 
aConvertedField:String — The field where the mapped x screen coordinate will be stored.
 
rField:String — The field where the data values for the y axis can be found.
 
rConvertedField:String — The field where the mapped y screen coordinate will be stored.

Constant Detail

ANGULAR_AXIS

Constant
public static const ANGULAR_AXIS:String = "a"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

A string representing the angular axis.

RADIAL_AXIS

Constant 
public static const RADIAL_AXIS:String = "r"

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

A string representing the radial axis.