IAxis - Adobe ActionScript® 3 (AS3 Flex) — dokumentacja interfejsu API

Pakiet	mx.charts.chartClasses
Interfejs	public interface IAxis extends IEventDispatcher
Implementory	CategoryAxis, NumericAxis

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Powiązane elementy interfejsu API

mx.charts.CategoryAxis
mx.charts.LinearAxis

Właściwości publiczne

	Właściwość		Zdefiniowane przez
		baseline : Number [tylko do odczytu] The baseline position for the axis.	IAxis
		chartDataProvider : Object [tylko do zapisu] The data provider assigned to the enclosing chart.	IAxis
		displayName : String [tylko do odczytu] The name of the axis.	IAxis
		title : String [tylko do odczytu] The text for the title displayed along the axis.	IAxis
		unitSize : Number [tylko do odczytu] The size of one unit of data as represented by this axis.	IAxis

Metody publiczne

Ukryj dziedziczone metody publiczne

Pokaż dziedziczone metody publiczne

	Metoda		Zdefiniowane przez
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Rejestruje obiekt detektora zdarzeń w obiekcie EventDispatcher, dzięki czemu detektor będzie otrzymywał powiadomienia o zdarzeniu.	IEventDispatcher
		dataChanged():void Triggers events that inform the range object when the chart data has changed.	IAxis
		dispatchEvent(event:Event):Boolean Wywołuje zdarzenie, tj. kieruje je do przepływu zdarzeń.	IEventDispatcher
		filterCache(cache:Array, field:String, filteredString:String):void Filters a set of values of arbitrary type to a set of numbers that can be mapped.	IAxis
		formatForScreen(value:Object):String Formats values for display in DataTips.	IAxis
		getLabelEstimate():AxisLabelSet Determines the range to estimate what the axis labels should be.	IAxis
		getLabels(minimumAxisLength:Number):AxisLabelSet Gets the labels text that is rendered.	IAxis
		hasEventListener(type:String):Boolean Sprawdza, czy obiekt EventDispatcher zawiera jakiekolwiek detektory zarejestrowane dla konkretnego typu zdarzeń.	IEventDispatcher
		invertTransform(value:Number):Object Maps a position along the axis back to a numeric data value.	IAxis
		mapCache(cache:Array, field:String, convertedField:String, indexValues:Boolean = false):void Converts a set of values of arbitrary type to a set of numbers that can be transformed into screen coordinates.	IAxis
		preferDropLabels():Boolean Determines how the axis handles overlapping labels.	IAxis
		reduceLabels(intervalStart:AxisLabel, intervalEnd:AxisLabel):AxisLabelSet 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.	IAxis
		registerDataTransform(transform:mx.charts.chartClasses:DataTransform, dimensionName:String):void Each DataTransform that makes use of an axis registers itself with that axis.	IAxis
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Usuwa detektor z obiektu EventDispatcher.	IEventDispatcher
		transformCache(cache:Array, field:String, convertedField:String):void Maps a set of values from data space to screen space.	IAxis
		unregisterDataTransform(transform:mx.charts.chartClasses:DataTransform):void Each DataTransform that makes use of an axis registers itself with that axis.	IAxis
		update():void Updates the chart.	IAxis
		willTrigger(type:String):Boolean Sprawdza, czy detektor zdarzeń określonego typu jest zarejestrowany w tym obiekcie EventDispatcher lub jego elementach macierzystych.	IEventDispatcher

Szczegół właściwości

baseline

właściwość

baseline:Number [tylko do odczytu]

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Implementacja
public function get baseline():Number

chartDataProvider

właściwość

chartDataProvider:Object [tylko do zapisu]

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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).

Implementacja
public function set chartDataProvider(value:Object):void

displayName

właściwość

displayName:String [tylko do odczytu]

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

Flash Player 9, AIR 1.1

The name of the axis. If set, Flex uses this name to format DataTip controls.

Implementacja
public function get displayName():String

title

właściwość

title:String [tylko do odczytu]

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

Flash Player 9, AIR 1.1

The text for the title displayed along the axis.

Implementacja
public function get title():String

unitSize

właściwość

unitSize:Number [tylko do odczytu]

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Implementacja
public function get unitSize():Number

Szczegół metody

dataChanged

()

metoda

public function dataChanged():void

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

Flash Player 9, AIR 1.1

Triggers events that inform the range object when the chart data has changed.

filterCache

()

metoda

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

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

Flash Player 9, AIR 1.1

Filters a set of values of arbitrary type to a set of numbers that can be mapped.

Parametry

	`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.

formatForScreen

()

metoda

public function formatForScreen(value:Object):String

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

Flash Player 9, AIR 1.1

Formats values for display in DataTips. Returns a user-readable string.

Parametry

value:Object — The value to convert to a String.

Zwraca

String — The text of the DataTip.

getLabelEstimate

()

metoda

public function getLabelEstimate():AxisLabelSet

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Zwraca

AxisLabelSet — An Array of AxisLabel objects.

getLabels

()

metoda

public function getLabels(minimumAxisLength:Number):AxisLabelSet

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Parametry

minimumAxisLength:Number — The minimum length of the axis, in pixels. The axis can be longer than this value, but not shorter.

Zwraca

AxisLabelSet — An array of AxisLabel objects.

invertTransform

()

metoda

public function invertTransform(value:Number):Object

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

Flash Player 9, AIR 1.1

Maps a position along the axis back to a numeric data value.

Parametry

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.

Zwraca

Object — An object containing the transformed value.

mapCache

()

metoda

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

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Parametry

	`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`) — This parameter is `true` if the values being mapped are index values, and `false` if they are natural data values.

preferDropLabels

()

metoda

public function preferDropLabels():Boolean

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Zwraca

Boolean — true if labels can be dropped without loss of data; otherwise, false.

reduceLabels

()

metoda

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

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Parametry

	`intervalStart:AxisLabel` — The start of the interval where labels overlap.

	`intervalEnd:AxisLabel` — The end of the interval where labels overlap.

Zwraca

AxisLabelSet — A new label set that resolves the overlap by reducing the number of labels.

registerDataTransform

()

metoda

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

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

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.

Parametry

	`transform:mx.charts.chartClasses:DataTransform` — The DataTransform to register.

	`dimensionName:String` — The name of the dimension.

transformCache

()

metoda

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

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

Flash Player 9, AIR 1.1

Maps a set of values from data space to screen space.

Parametry

	`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.

unregisterDataTransform

()

metoda

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

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

Flash Player 9, AIR 1.1

Parametry

transform:mx.charts.chartClasses:DataTransform — The DataTransform to unregister.

update

()

metoda

public function update():void

Wersja języka:

ActionScript 3.0

Wersja produktu:

Flex 3

Wersje środowiska wykonawczego:

Flash Player 9, AIR 1.1

Updates the chart. This can be called multiple times per frame.

Informacje prawne | Zasady prywatności online

IAxis - AS3 Flex

Klasy x

baseline

chartDataProvider

displayName

title

unitSize

dataChanged

filterCache

formatForScreen

getLabelEstimate

getLabels

invertTransform

mapCache

preferDropLabels

reduceLabels

registerDataTransform

transformCache

unregisterDataTransform

update