| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The IAxis class is an abstract interface for defining label,
tick mark, and data positioning properties for a chart axis.
Classes implement this interface to provide
range definition functionality.
baseline:Number [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The baseline position for the axis.
Some series, such as ColumnSeries or AreaSeries, use this value to
define the base of a filled region when no minimum value is specified.
Implementation public function get baseline():NumberchartDataProvider:Object [write-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The data provider assigned to the enclosing chart.
Axis types that are data provider-based can choose to inherit
the data provider associated with the enclosing chart.
If an axis is shared among multiple charts,
the value of this property is undefined
(most likely it will be the last data provider assigned
to one of the associated charts).
Implementation public function set chartDataProvider(value:Object):voiddisplayName:String [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The name of the axis.
If set, Flex uses this name to format DataTip controls.
Implementation public function get displayName():Stringtitle:String [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The text for the title displayed along the axis.
Implementation public function get title():StringunitSize:Number [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The size of one unit of data as represented by this axis.
This value is used by various series types to help in rendering.
The ColumnSeries class, for example, uses this value
to determine how wide columns should be rendered.
Different axis types return different values,
sometimes dependent on the data being represented.
The DateTimeAxis class, for example, might return the number
of milliseconds in a day, or a year, depending on the data
that is rendered in the chart.
Because this value is dependant on collecting the represented data,
custom series cannot assume this value is accurate in their
updateData() or updateMapping() methods.
Implementation public function get unitSize():Number public function dataChanged():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Triggers events that inform the range object
when the chart data has changed.
public function filterCache(cache:Array, field:String, filteredString:String):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Filters a set of values of arbitrary type
to a set of numbers that can be mapped.
Parameters
| cache:Array — An Array of objects where converted values
are read from and stored.
|
| |
| field:String — The field of the objects in the cache Array
containing the pre-filtered values.
|
| |
| filteredString:String — The field of the objects in the cache Array
where filtered values should be stored.
|
public function formatForScreen(value:Object):String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Formats values for display in DataTips.
Returns a user-readable string.
Parameters
| value:Object — The value to convert to a String.
|
Returns | String — The text of the DataTip.
|
public function getLabelEstimate():AxisLabelSet| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines the range to estimate what the axis labels should be.
The axis almost immediately calls the getLabels() method
to get the real values.
The axis uses the estimated values to adjust chart margins,
so any difference between the estimated labels and actual labels
(returned from the getLabels() method) results in scaling
the labels to fit.
An axis need only return the minimum and maximum labels
when returning an estimate.
If the label set is fairly static, without depending on the size
of the axis being rendered on screen, an axis can return the entire
label set from this function, and mark the estimate as accurate.
Returns public function getLabels(minimumAxisLength:Number):AxisLabelSet| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Gets the labels text that is rendered.
When Flex calls this method,
the axis has already determined the minimum length of the label.
Parameters
| minimumAxisLength:Number — The minimum length of the axis, in pixels.
The axis can be longer than this value, but not shorter.
|
Returns public function invertTransform(value:Number):Object| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Maps a position along the axis back to a numeric data value.
Parameters
| value:Number — The bound of the axis.
This parameter should be between 0 and 1,
with 0 representing the minimum bound of the axis, and 1 the maximum.
|
Returns | Object — An object containing the transformed value.
|
public function mapCache(cache:Array, field:String, convertedField:String, indexValues:Boolean = false):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Converts a set of values of arbitrary type
to a set of numbers that can be transformed into screen coordinates.
Parameters
| cache:Array — An Array of objects where converted values
are read from and stored.
|
| |
| field:String — The field of the objects in the cache Array
containing the pre-converted values.
|
| |
| convertedField:String — The field of the objects in the cache Array
where converted values should be stored.
|
| |
| indexValues:Boolean (default = false)true if the values being mapped
are index values, and false if they are natural data values.
|
public function preferDropLabels():Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines how the axis handles overlapping labels.
Typically, numeric ranges return true,
while discrete value-based ranges do not.
You can can override this property by setting it directly on the axis.
Returns | Boolean — true if labels can be dropped without loss of data;
otherwise, false.
|
public function reduceLabels(intervalStart:AxisLabel, intervalEnd:AxisLabel):AxisLabelSet| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Invoked when an AxisRenderer is unable to cleanly render
the labels without overlap, and would like the Axis object
to reduce the set of labels.
The method is passed the two labels that are overlapping.
Parameters
| intervalStart:AxisLabel — The start of the interval where labels overlap.
|
| |
| intervalEnd:AxisLabel — The end of the interval where labels overlap.
|
Returns | AxisLabelSet — A new label set that resolves the overlap by reducing
the number of labels.
|
public function registerDataTransform(transform:mx.charts.chartClasses:DataTransform, dimensionName:String):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Each DataTransform that makes use of an axis
registers itself with that axis.
The axis is responsible for informing the transform
when its relevant values have changed.
It should also request values from the transform
when it wants to autogenerate minimum and maximum values.
Parameters
public function transformCache(cache:Array, field:String, convertedField:String):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Maps a set of values from data space to screen space.
Parameters
| cache:Array — An Array of objects where mapped values
are read from and stored.
|
| |
| field:String — The field of the objects in the cache Array
containing the pre-mapped values.
|
| |
| convertedField:String — The field of the objects in the cache Array
where mapped values should be stored.
|
public function unregisterDataTransform(transform:mx.charts.chartClasses:DataTransform):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Each DataTransform that makes use of an axis
registers itself with that axis.
The axis is responsible for informing the transform
when its relevant values have changed.
It should also request values from the transform
when it wants to autogenerate minimum and maximum values.
Parameters
public function update():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Updates the chart.
This can be called multiple times per frame.
Hide Inherited Public Methods
Show Inherited Public Methods