Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
CartesianTransform

Package | mx.charts.chartClasses
Class | public class CartesianTransform
Inheritance | CartesianTransform DataTransform 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
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | axes : Object [read-only] The set of axes associated with this transform. | DataTransform
|  | elements : 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
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | CartesianTransform() Constructor. | CartesianTransform
|  | dataChanged():void Informs the DataTransform that some of the underlying data being represented on the chart has changed. | DataTransform
|  | describeData(dimension:String, requiredFields:uint):Array Collects important displayed values for all elements associated with this data transform. | DataTransform
|  | 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
|  | 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
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | transformChange | Dispatched 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

| Constant | Defined 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.

Sun Mar 5 2017, 03:42 PM +11:00