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

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

The CartesianTransform object represents a set of axes that maps data values to x/y Cartesian screen coordinates and vice versa.

When using charts in your applications, you typically will not need to interact with the CartesianTransform object. Transforms are created automatically by the built-in chart types and used by the series contained within so that they can 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
  pixelHeight : Number
[write-only] The height of the data area that the CartesianTransform represents, in pixels.
CartesianTransform
  pixelWidth : Number
[write-only] The width of the data area that the CartesianTransform represents, in pixels.
CartesianTransform
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
Public Methods
 MethodDefined By
  
Constructor.
CartesianTransform
 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
  
[override] Transforms x and y coordinates relative to the DataTransform coordinate system into a 2-dimensional value in data space.
CartesianTransform
 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
 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, xField:String, xConvertedField:String, yField:String, yConvertedField:String):void
[override] Maps a set of numeric values representing data to screen coordinates.
CartesianTransform
 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
  HORIZONTAL_AXIS : String = "h"
[static] A String representing the horizontal axis.
CartesianTransform
  VERTICAL_AXIS : String = "v"
[static] A String representing the vertical axis.
CartesianTransform
Property Detail

pixelHeight

property
pixelHeight:Number  [write-only]

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

The height of the data area that the CartesianTransform represents, in pixels. The containing chart sets this property explicitly during layout. The CartesianTransform uses this property to map data values to screen coordinates.



Implementation
    public function set pixelHeight(value:Number):void

pixelWidth

property 
pixelWidth:Number  [write-only]

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

The width of the data area that the CartesianTransform represents, in pixels. The containing chart sets this property explicitly during layout. The CartesianTransform uses this property to map data values to screen coordinates.



Implementation
    public function set pixelWidth(value:Number):void
Constructor Detail

CartesianTransform

()Constructor
public function CartesianTransform()

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

Constructor.

Method Detail

invertTransform

()method
override public function invertTransform(... values):Array

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

Transforms x and y coordinates relative to the DataTransform coordinate system into a 2-dimensional value in data space.

Parameters

... values — The x and y positions (in that order).

Returns
Array — An Array containing the transformed values.

transformCache

()method 
override public function transformCache(cache:Array, xField:String, xConvertedField:String, yField:String, yConvertedField: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 stores the converted numeric values.
 
xField:String — The field where the data values for the x axis are stored.
 
xConvertedField:String — The field where the mapped x screen coordinate is stored.
 
yField:String — The field where the data values for the y axis are stored.
 
yConvertedField:String — The field where the mapped y screen coordinate is stored.

Constant Detail

HORIZONTAL_AXIS

Constant
public static const HORIZONTAL_AXIS:String = "h"

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

A String representing the horizontal axis.

VERTICAL_AXIS

Constant 
public static const VERTICAL_AXIS:String = "v"

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

A String representing the vertical axis.