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 [読み取り専用] この軸に表示されるデータの 1 単位のサイズです。	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 DataTips での表示用に値をフォーマットします。	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 です（多くの場合、これが関連付けられたグラフの 1 つに割り当てられる最後のデータプロバイダーとなります）。

実装
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

この軸に表示されるデータの 1 単位のサイズです。この値はさまざまな系列タイプによって使用され、レンダリングに役立ちます。例えば、ColumnSeries クラスは、この値を使用して列の幅を決定します。異なる軸タイプごとに、異なる値が返されます。表示されるデータによって返される値が異なる場合があります。例えば、DateTimeAxis クラスは、グラフにレンダリングされるデータにより、1 日または 1 年間のミリ秒の数を返すことがあります。この値は表示されるデータの収集に依存しているため、カスタム系列はその 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` — フィルターの適用前の値を含む、キャッシュ配列の中のオブジェクトのフィールドです。

	`filteredString:String` — フィルターが適用された値の保管先となる、キャッシュ配列の中のオブジェクトのフィールドです。

formatForScreen

()

メソッド

public function formatForScreen(value:Object):String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

DataTips での表示用に値をフォーマットします。ユーザーが読み取れるストリングを返します。

パラメーター

value:Object — ストリングに変換される値です。

戻り値

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

レンダリングされるラベルテキストを取得します。このメソッドが呼び出されたときは、既に軸によってラベルの最小の長さが決定されています。

パラメーター

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` — 変換前の値を含む、キャッシュ配列の中のオブジェクトのフィールドです。

	`convertedField:String` — 変換された値の保管先となる、キャッシュ配列の中のオブジェクトのフィールドです。

	`indexValues:Boolean` (default = `false`) — このパラメーターは、マップされる値がインデックス値である場合は `true`、自然データ値である場合は `false` です。

preferDropLabels

()

メソッド

public function preferDropLabels():Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

軸による重なるラベルの処理方法を決定します。通常、数値範囲では true が返されますが、個別の値に基づく範囲では 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 オブジェクトによりラベルのセットが減らされるようにする場合に起動されます。重なった 2 つのラベルがメソッドに渡されます。

パラメーター

	`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` — マップされた値の読み取り元および保管先であるオブジェクトの配列です。

	`field:String` — マップ前の値を含む、キャッシュ配列の中のオブジェクトのフィールドです。

	`convertedField:String` — マップされた値の保管先となる、キャッシュ配列の中のオブジェクトのフィールドです。

unregisterDataTransform

()

メソッド

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

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

パラメーター

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