IAxis - Adobe ActionScript® 3 (AS3 Flex) API 参考

包	mx.charts.chartClasses
接口	public interface IAxis extends IEventDispatcher
实现器	CategoryAxis, NumericAxis

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

IAxis 类是用于定义图表轴的标签、刻度线和数据定位属性的抽象接口。

类实现此接口以提供范围定义功能。

公共属性

	属性		由以下参数定义
		baseline : Number [只读] 轴的基线位置。	IAxis
		chartDataProvider : Object [只写] 分配给封闭图表的数据提供程序。	IAxis
		displayName : String [只读] 轴的名称。	IAxis
		title : String [只读] 沿该轴显示的标题文本。	IAxis
		unitSize : Number [只读] 由该轴表示的一个数据单位大小。	IAxis

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。	IEventDispatcher
		dataChanged():void 在图表数据更改时触发通知范围对象的事件。	IAxis
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	IEventDispatcher
		filterCache(cache:Array, field:String, filteredString:String):void 将任意类型的一组值过滤为可以映射的一组数字。	IAxis
		formatForScreen(value:Object):String 格式化值以便在 DataTip 中显示。	IAxis
		getLabelEstimate():AxisLabelSet 确定范围以估计轴标签的内容。	IAxis
		getLabels(minimumAxisLength:Number):AxisLabelSet 获取显示的标签文本。	IAxis
		hasEventListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	IEventDispatcher
		invertTransform(value:Number):Object 沿轴将一个位置映射回数字数据值。	IAxis
		mapCache(cache:Array, field:String, convertedField:String, indexValues:Boolean = false):void 将任意类型的一组值转换为一组可以转换为屏幕坐标的数字。	IAxis
		preferDropLabels():Boolean 确定轴处理重叠标签的方式。	IAxis
		reduceLabels(intervalStart:AxisLabel, intervalEnd:AxisLabel):AxisLabelSet 当在不发生重叠的情况下 AxisRenderer 无法清楚地显示标签时调用，像 Axis 对象减少标签组中标签的数目一样。	IAxis
		registerDataTransform(transform:mx.charts.chartClasses:DataTransform, dimensionName:String):void 使用轴的每个 DataTransform 都将自身注册到该轴。	IAxis
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 从 EventDispatcher 对象中删除侦听器。	IEventDispatcher
		transformCache(cache:Array, field:String, convertedField:String):void 将一组来自数据空间的值映射到屏幕空间。	IAxis
		unregisterDataTransform(transform:mx.charts.chartClasses:DataTransform):void 使用轴的每个 DataTransform 都将自身注册到该轴。	IAxis
		update():void 更新图表。	IAxis
		willTrigger(type:String):Boolean 检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。	IEventDispatcher

属性详细信息

baseline

属性

baseline:Number [只读]

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

轴的基线位置。当未指定最小值时，一些系列（如 ColumnSeries 或 AreaSeries）将使用此值确定填充区域的基础。

实现
public function get baseline():Number

chartDataProvider

属性

chartDataProvider:Object [只写]

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

分配给封闭图表的数据提供程序。基于数据提供程序的轴类型可以继承与封闭图表相关联的数据提供程序。如果在多个图表之间共享一个轴，则此属性的值为 undefined（它很可能是分配到其中一个关联图表的最后一个数据提供程序）。

实现
public function set chartDataProvider(value:Object):void

displayName

属性

displayName:String [只读]

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

轴的名称。如果设置了此属性，Flex 将使用此名称来设置 DataTip 控件格式。

实现
public function get displayName():String

title

属性

title:String [只读]

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

沿该轴显示的标题文本。

实现
public function get title():String

unitSize

属性

unitSize:Number [只读]

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

由该轴表示的一个数据单位大小。此值适用于帮助各种系列类型进行显示。例如，ColumnSeries 类使用此值确定列应显示的宽度。轴类型不同，返回的值也不同（有时取决于表示的数据）。例如，DateTimeAxis 类可能返回一天或一年中的毫秒数，具体取决于图表中显示的数据。此值依赖于收集表示的数据，因此自定义系列无法假定此值在其 updateData() 方法或 updateMapping() 方法中是准确的。

实现
public function get unitSize():Number

方法详细信息

dataChanged

()

方法

public function dataChanged():void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

在图表数据更改时触发通知范围对象的事件。

filterCache

()

方法

public function filterCache(cache:Array, field:String, filteredString:String):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

将任意类型的一组值过滤为可以映射的一组数字。

参数

	`cache:Array` — 可从中读取和存储转换后的值的对象数组。

	`field:String` — 包含过滤之前的值的缓存 Array 中所含的对象域。

	`filteredString:String` — 存储过滤后的值的缓存 Array 中所含的对象域。

formatForScreen

()

方法

public function formatForScreen(value:Object):String

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

格式化值以便在 DataTip 中显示。返回用户可读的字符串。

参数

value:Object — 转换为 String 类型的值。

String — DataTip 的文本。

getLabelEstimate

()

方法

public function getLabelEstimate():AxisLabelSet

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

确定范围以估计轴标签的内容。轴几乎立即调用 getLabels() 方法以获取真实值。轴使用估计的值调整图表边距，因此只要估计的标签和实际标签（由 getLabels() 方法返回）间存在差别，就会调整标签以满足要求。

当返回估计值时，轴只需返回最小和最大标签。如果标签组完全是静态的，不会根据轴大小在屏幕上显示，则轴可通过此函数返回整个标签组，并将估计值标记为准确值。

AxisLabelSet — AxisLabel 对象的数组。

getLabels

()

方法

public function getLabels(minimumAxisLength:Number):AxisLabelSet

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

获取显示的标签文本。当 Flex 调用此方法时，轴已确定标签的最小长度。

参数

minimumAxisLength:Number — 轴的最小长度（以像素为单位）。轴长可以大于此值，但不可以小于此值。

AxisLabelSet — AxisLabel 对象的数组。

invertTransform

()

方法

public function invertTransform(value:Number):Object

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

沿轴将一个位置映射回数字数据值。

参数

value:Number — 轴的范围。此参数应介于 0 和 1 之间，0 表示轴的下限，1 表示轴的上限。

Object — 包含转换后的值的对象。

mapCache

()

方法

public function mapCache(cache:Array, field:String, convertedField:String, indexValues:Boolean = false):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

将任意类型的一组值转换为一组可以转换为屏幕坐标的数字。

参数

	`cache:Array` — 可从中读取和存储转换后的值的对象数组。

	`field:String` — 包含转换之前的值的缓存 Array 中所含的对象域。

	`convertedField:String` — 存储转换后的值的缓存 Array 中所含的对象域。

	`indexValues:Boolean` (default = `false`) — 如果要映射的值是索引值，则此参数为 `true`；如果这些值是自然数据值，则此参数为 `false`。

preferDropLabels

()

方法

public function preferDropLabels():Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

确定轴处理重叠标签的方式。通常，数字范围返回 true，而基于离散值的范围不返回此值。您可以通过直接在轴上设置此属性来覆盖此属性。

Boolean — 如果可以在不丢失数据的情况下删除标签，则为 true；否则为 false。

reduceLabels

()

方法

public function reduceLabels(intervalStart:AxisLabel, intervalEnd:AxisLabel):AxisLabelSet

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

当在不发生重叠的情况下 AxisRenderer 无法清楚地显示标签时调用，像 Axis 对象减少标签组中标签的数目一样。此方法传递重叠的两个标签。

参数

	`intervalStart:AxisLabel` — 标签重叠处间隔的开始位置。

	`intervalEnd:AxisLabel` — 标签重叠处间隔的结束位置。

AxisLabelSet — 通过减少标签的数目来解决重叠问题的新标签组。

registerDataTransform

()

方法

public function registerDataTransform(transform:mx.charts.chartClasses:DataTransform, dimensionName:String):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

使用轴的每个 DataTransform 都将自身注册到该轴。该轴负责在其相关值更改时通知转换。当它要自动生成最小值和最大值时，它还应从转换请求值。

参数

	`transform:mx.charts.chartClasses:DataTransform` — 要注册的 DataTransform。

	`dimensionName:String` — 维度的名称。

transformCache

()

方法

public function transformCache(cache:Array, field:String, convertedField:String):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

将一组来自数据空间的值映射到屏幕空间。

参数

	`cache:Array` — 可从中读取和存储映射后的值的对象 Array。

	`field:String` — 包含映射之前的值的缓存 Array 中所含的对象域。

	`convertedField:String` — 存储映射后的值的缓存 Array 中所含的对象域。

unregisterDataTransform

()

方法

public function unregisterDataTransform(transform:mx.charts.chartClasses:DataTransform):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

使用轴的每个 DataTransform 都将自身注册到该轴。该轴负责在其相关值更改时通知转换。当它要自动生成最小值和最大值时，它还应从转换请求值。

参数

transform:mx.charts.chartClasses:DataTransform — 要取消注册的 DataTransform。

update

()

方法

public function update():void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

更新图表。可在每个帧中多次调用此方法。

法律声明 | 在线隐私策略

IAxis - AS3 Flex

类 x

baseline

chartDataProvider

displayName

title

unitSize

dataChanged

filterCache

formatForScreen

getLabelEstimate

getLabels

invertTransform

mapCache

preferDropLabels

reduceLabels

registerDataTransform

transformCache

unregisterDataTransform

update