| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The NumericAxis class acts as a common base class
for axis types representing a continuous range of values
between a defined minimum and maximum.
The built-in LinearAxis, LogAxis, and DateTimeAxis
classes all extend this base class.
protected var assignedMaximum:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The explicitly assigned maximum value.
If no value has been assigned, this will be NaN.
Typically, calculations should be performed
with the computedMaximum field.
protected var assignedMinimum:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The explicitly assigned minimum value.
If no value has been assigned, this will be NaN.
Typically calculations should be performed
with the computedMinimum field.
autoAdjust:Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies whether Flex rounds values.
If false, Flex does not round the values
set by the minimum and maximum properties,
or modify the default minimum and
maximum values.
The default value is true.
Implementation public function get autoAdjust():Boolean public function set autoAdjust(value:Boolean):voidbaseAtZero:Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies whether Flex tries to keep the minimum
and maximum values rooted at zero.
If all axis values are positive, the minimum axis value is zero.
If all axis values are negative, the maximum axis value is zero.
The default value is true.
Implementation public function get baseAtZero():Boolean public function set baseAtZero(value:Boolean):voidbaseline:Number [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The computed minimum value for the axis
as long as this value is greater than 0.
If the maximum value is less than or equal to 0,
then the baseline property is the computed maximum.
If neither value is greater than 0,
then the baseline property is 0.
Implementation public function get baseline():Numberprotected var computedInterval:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The computed interval represented by this axis.
The computedInterval is used
by the AxisRenderer and Gridlines classes
to determine where to render tick marks and grid lines.
The NumericAxis base class watches this field for changes
to determine if the chart needs to be re-rendered.
Derived classes are responsible for computing the value
of this field.
public var computedMaximum:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The computed maximum value represented by this axis.
If the user has explicitly assigned a maximum value,
the computedMaximum and
assignedMaximum properties
are usually the same.
Otherwise, the computedMaximum is generated
from the values represented in the chart.
public var computedMinimum:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The computed minimum value represented by this axis.
If the user has explicitly assigned a minimum value,
the computedMinimum and
assignedMinimum properties
are usually be the same.
Otherwise, the computedMinimum is generated
from the values represented in the chart.
dataDescriptions:Array [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
An Array of DataDescription structures describing the data being represented by the chart.
An axis can use this property to generate values for properties, such as its range.
Implementation protected function get dataDescriptions():Arraydirection:String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines the direction in which the axis is rendered.
Possible values are normal,
and inverted.
All derived classes should take care of the way min and max
are set depending on direction.
All series should take care of the way it is rendered
depending on the direction of its underlying axis.
The default value is "normal".
Implementation public function get direction():String public function set direction(value:String):voidprotected var labelCache:Array| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The most recent set of AxisLabel objects
generated to represent this axis.
This property is null if the axis
has been modified and requires new labels.
To guarantee that the value of the labelCache property
is correct, call the buildLabelCache() method
before accessing the labelCache property.
labelFunction:Function| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Called to format axis values for display as labels.
A labelFunction has the following signature:
function function_name(labelValue:Object, previousValue:Object, axis:IAxis):String { ... }
If you know the types of the data your function will be formatting,
you can specify an explicit type for the labelValue
and previousValue parameters.
Implementation public function get labelFunction():Function public function set labelFunction(value:Function):voidprotected var labelMaximum:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The maximum value where a label should be placed.
After computing an adjusted minimum value,
many axis types expand the range of the axis further
to make room for additional rendering artifacts in the chart,
such as labels and borders.
This value represents the maximum value in the chart
before it is adjusted for these artifacts.
Typically axes generate labels to make sure
this value is labeled, rather than the adjusted maximum of the axis.
protected var labelMinimum:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The minimum value where a label should be placed.
After computing an adjusted minimum value,
many axis types expand the range of the axis further
to make room for additional rendering artifacts in the chart,
such as labels and borders.
This value represents the minimum value in the chart
before it is adjusted for these artifacts.
Typically axes will generate labels to make sure
this value is labeled, rather than the adjusted minimum of the axis.
protected var minorTickCache:Array| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The most recent set of minor tick marks generated to represent this axis.
This property may be null if the axis
has been modified and requires new labels and tick marks.
Use the public accessor minorTicks
to build the minor tick marks on demand.
minorTicks:Array [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
An Array of minor tick marks generated to represent this axis.
Implementation public function get minorTicks():Arraypadding:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies padding that Flex adds to the calculated minimum and maximum
values for the axis when rendering the values on the screen.
Implementation public function get padding():Number public function set padding(value:Number):voidparseFunction:Function| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specify a parseFunction to customize how
the values rendered by your chart are converted into numeric values.
A custom parseFunction is passed a data value
and should return a corresponding number representing the same value.
By default, this axis uses the ECMA function parseFloat().
Implementation public function get parseFunction():Function public function set parseFunction(value:Function):voidrequiredDescribedFields:uint [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The fields of the DescribeData structure that this axis is interested in.
Implementation protected function get requiredDescribedFields():uintticks:Array [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
An Array of tick marks for this axis.
Implementation protected function get ticks():Arraypublic function NumericAxis()| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
protected function adjustMinMax(minValue:Number, maxValue:Number):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Adjusts the generated or assigned range of the axis's labels.
This method is called during the update cycle of the axis. Subclasses can override this method
to do special processing on the values. By default, no adjustments are made to the range.
Parameters
| minValue:Number — The computed minimum value.
|
| |
| maxValue:Number — The computed maximum value.
|
protected function buildLabelCache():Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Populates the labelCache property with labels representing the current
values of the axis. Subclasses must implement this function. This function is called
many times, so you should check to see if the labelCache property
is null before performing any calculations.
Returns | Boolean — true if the labels were regenerated.
|
protected function buildMinorTickCache():Array| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Builds an Array of positions for the minor tick marks Array that is generated by this axis.
Subclasses must implement this function. This function is called automatically
by the NumericAxis. You should access the minorTicks property
instead of calling this function directly.
Returns | Array — An Array of positions from 0 to 1 that represent points between the axis
minimum and maximum values where minor tick marks are rendered.
|
public function filterCache(cache:Array, field:String, filteredField: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.
|
| |
| filteredField: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 protected function guardMinMax(min:Number, max:Number):Array| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Protects the range against invalid values for this axis type.
This function is called during the update cycle of the axis to guarantee that invalid
ranges are not generated. Subclasses can override this class and define logic that
is appropriate to their axis type.
Parameters
| min:Number — The computed minimum value.
|
| |
| max:Number — The computed maximum value.
|
Returns | Array — null if no adjustment is necessary, or an Array containing the adjusted
values of the form [min,max].
|
protected function invalidateCache():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Invalidates the cached labels and tick marks that represent this axis's values.
Derived classes should call this function whenever values used in the calculation
of labels and tick marks change.
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 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 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.
AxisBase 
Hide Inherited Public Properties
Show Inherited Public Properties