Packagemx.charts.chartClasses
Classpublic class CartesianTransform
InheritanceCartesianTransform Inheritance DataTransform Inheritance flash.events.EventDispatcher

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
 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
Public Methods
 MethodDefined By
  
Constructor.
CartesianTransform
 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
getAxis(dimension:String):IAxis
Retrieves the axis instance responsible for transforming the data dimension specified by the dimension parameter.
DataTransform
  
invertTransform(... values):Array
[override] Transforms x and y coordinates relative to the DataTransform coordinate system into a 2-dimensional value in data space.
CartesianTransform
 Inherited
setAxis(dimension:String, v:IAxis):void
Assigns an axis instance to a particular dimension of the transform.
DataTransform
  
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
Events
 Event Summary Defined By
 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
pixelHeightproperty
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
pixelWidthproperty 
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_AXISConstant
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_AXISConstant 
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.