| Package | mx.charts.chartClasses |
| Class | public class AxisBase |
| Inheritance | AxisBase  EventDispatcher Object |
| Subclasses | CategoryAxis, NumericAxis |
Hide MXML Syntax
Flex components inherit the following properties from the AxisBase class:
Show MXML Syntax
<mx:tagname
displayName="No default"
title="No default"
>
| Property | Defined By | ||
|---|---|---|---|
| chartDataProvider : Object
[write-only]
The data provider assigned to the enclosing chart.
| AxisBase | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
| displayName : String
The name of the axis.
| AxisBase | ||
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| title : String
The text for the title displayed along the axis.
| AxisBase | ||
| unitSize : Number
[read-only]
The size of one unit of data as represented by this axis.
| AxisBase | ||
| Method | Defined By | ||
|---|---|---|---|
|
AxisBase()
Constructor.
| AxisBase | ||
|
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 | |
|
Triggers events that inform the range object
when the chart data has changed.
| AxisBase | ||
|
Dispatches an event into the event flow.
| EventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event.
| EventDispatcher | |
|
Indicates whether an object has a specified property defined.
| Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | |
|
Indicates whether the specified property exists and is enumerable.
| Object | |
|
Each DataTransform that makes use of an axis
registers itself with that axis.
| AxisBase | ||
|
Removes a listener from the EventDispatcher object.
| EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations.
| Object | |
|
Returns the string representation of the specified object.
| Object | |
|
Each DataTransform that makes use of an axis
registers itself with that axis.
| AxisBase | ||
|
Returns the primitive value of the specified object.
| Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type.
| EventDispatcher | |
| Method | Defined By | ||
|---|---|---|---|
|
Called by the governing DataTransform to obtain a description
of the data represented by this IChartElement.
| AxisBase | ||
| chartDataProvider | property |
chartDataProvider:Object [write-only]
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).
public function set chartDataProvider(value:Object):void
| displayName | property |
displayName:String [read-write] The name of the axis. If set, Flex uses this name to format DataTip controls.
public function get displayName():String
public function set displayName(value:String):void
| title | property |
title:String [read-write] The text for the title displayed along the axis.
public function get title():String
public function set title(value:String):void
| unitSize | property |
unitSize:Number [read-only]
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.
public function get unitSize():Number
| AxisBase | () | Constructor |
public function AxisBase()
Constructor.
| dataChanged | () | method |
public function dataChanged():void
Triggers events that inform the range object when the chart data has changed.
| describeData | () | method |
protected function describeData(dimension:String, requiredFields:uint):Array
Called by the governing DataTransform to obtain a description
of the data represented by this IChartElement.
Implementors fill out and return an Array of
mx.charts.chartClasses.DataDescription objects
to guarantee that their data is correctly accounted for
by any axes that are autogenerating values
from the displayed data (such as minimum, maximum,
interval, and unitSize).
Most element types return an Array
containing a single DataDescription.
Aggregate elements, such as BarSet and ColumnSet,
might return multiple DataDescription instances
that describe the data displayed by their subelements.
When called, the implementor describes the data
along the axis indicated by the dimension argument.
This function might be called for each axis
supported by the containing chart.
The returned Array for the AxisBase implementation of this method contains BoundedValue objects.
Parameters
dimension:String — Determines the axis to get data descriptions of.
|
|
requiredFields:uint — A bitfield that indicates which values
of the DataDescription object the particular axis cares about.
Implementors can optimize by only calculating the necessary fields.
|
Array — An Array containing the DataDescription instances that describe
the data that is displayed.
|
See also
| registerDataTransform | () | method |
public function registerDataTransform(transform:DataTransform, dimensionName:String):void
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
transform:DataTransform — The DataTransform to register.
|
|
dimensionName:String — The name of the dimension.
|
| unregisterDataTransform | () | method |
public function unregisterDataTransform(transform:DataTransform):void
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
transform:DataTransform — The DataTransform to unregister.
|