CategoryAxis

Пакет	mx.charts
Класс	public class CategoryAxis
Наследование	CategoryAxis AxisBase EventDispatcher Object
Реализует	IAxis

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Класс CategoryAxis позволяет диаграммам представлять данные, сгруппированные в наборы дискретных значений, по определенной оси. Как правило, класс CategoryAxis используется для определения набора меток, отображаемых по оси диаграммы. Например, диаграммы, отображающие данные в соответствии с объектами «Город», «Год», «Филиал» и т. д.

Явное задание значения свойства dataProvider в CategoryAxis не требуется. Класс CategoryAxis, используемый в диаграмме, наследует свойство dataProvider из вышестоящей диаграммы.

Один и тот же поставщик данных может использоваться для предоставления данных для диаграммы и категорий для CategoryAxis, класс CategoryAxis позволяет оптимизировать визуализацию, если его поставщик данных является относительно статическим. По возможности следует обеспечить относительную статичность категорий и сохранение измененных данных в отдельных поставщиках данных.

Свойство dataProvider может принимать либо массив строк, либо массив записей (объектов) со свойством, указывающим имя категории. Если определено свойство categoryField, класс CategoryAxis предполагает, что поставщиком данных является массив объектов. Если для свойства categoryField задано значение null, класс CategoryAxis предполагает, что поставщиком данных является массив строк.

Синтаксис MXML expanded

Скрыть синтаксис MXML

The <mx:CategoryAxis> tag inherits all the properties of its parent classes and adds the following properties:

  <mx:CategoryAxis
    Properties
    categoryField="null"
    dataFunction="No default"
    dataProvider="No default"
    labelFunction="No default"
    padding="Default depends on chart type"
    ticksBetweenLabels="true"
  />

Посмотреть примеры

Общедоступные свойства

Скрыть унаследованные общедоступные свойства

Показать унаследованные общедоступные свойства

	Свойство		Определено
		baseline : Number [только для чтения] Положение базовой линии оси.	CategoryAxis
		categoryField : String Указывает поле поставщика данных, содержащее текст для меток.	CategoryAxis
		chartDataProvider : Object [только для записи] Поставщик данных, присвоенный диаграмме с вложениями.	AxisBase
		constructor : Object Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.	Object
		dataFunction : Function Указывает метод, возвращающий значение, которое должно использоваться в качестве categoryValue для текущего элемента. Если это свойство установлено, возвращаемое значение пользовательской функции данных имеет приоритет над categoryField. Пользовательская dataFunction имеет следующую подпись: function_name (axis:CategoryAxis, item:Object):Object { ...	CategoryAxis
		dataProvider : Object Указывает источник данных, содержащий имена меток.	CategoryAxis
		displayName : String Имя оси.	AxisBase
		labelFunction : Function Указывает функцию, определяющую метки, которые генерируются для каждого элемента в dataProvider класса CategoryAxis.	CategoryAxis
		padding : Number Определяет заполнение, добавляемое к любой из сторон оси во время визуализации данных на экране.	CategoryAxis
		ticksBetweenLabels : Boolean Указывает местоположение основных делений на оси относительно меток категории.	CategoryAxis
		title : String Текст заголовка, отображаемый вдоль оси.	AxisBase
		unitSize : Number [только для чтения] Размер одной единицы данных, как представлено этой осью.	AxisBase

Общедоступные методы

Скрыть унаследованные общедоступные методы

Показать унаследованные общедоступные методы

	Метод		Определено
		CategoryAxis() Конструктор.	CategoryAxis
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии.	EventDispatcher
		dataChanged():void Инициирует события, информирующие объект диапазона о времени изменения данных диаграммы.	AxisBase
		dispatchEvent(event:Event):Boolean Посылает событие в поток событий.	EventDispatcher
		filterCache(cache:Array, field:String, filteredField:String):void Отфильтровывает набор значений произвольного типа до набора чисел, которые могут быть отображены.	CategoryAxis
		formatForScreen(value:Object):String Форматирует значения для отображения в элементах DataTip.	CategoryAxis
		getLabelEstimate():AxisLabelSet Определяет диапазон для оценки того, какими должны быть метки оси.	CategoryAxis
		getLabels(minimumAxisLength:Number):AxisLabelSet Получает текст визуализированных меток.	CategoryAxis
		hasEventListener(type:String):Boolean Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события.	EventDispatcher
		hasOwnProperty(name:String):Boolean Показывает, определено ли заданное свойство для объекта.	Object
		invertTransform(value:Number):Object Сопоставляет положение по оси обратно с числовым значением данных.	CategoryAxis
		isPrototypeOf(theClass:Object):Boolean Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра.	Object
		mapCache(cache:Array, field:String, convertedField:String, indexValues:Boolean = false):void Преобразует набор значений произвольного типа в набор чисел, которые могут быть преобразованы в экранные координаты.	CategoryAxis
		preferDropLabels():Boolean Определяет поведение оси при наличии перекрывающихся меток.	CategoryAxis
		propertyIsEnumerable(name:String):Boolean Показывает наличие заданного свойства и его перечисляемость.	Object
		reduceLabels(intervalStart:AxisLabel, intervalEnd:AxisLabel):AxisLabelSet Вызывается, если AxisRenderer не может выполнить чистую визуализацию меток без наложения и если требуется сокращение набора меток с помощью объекта Axis.	CategoryAxis
		registerDataTransform(transform:mx.charts.chartClasses:DataTransform, dimensionName:String):void Каждое свойство DataTransform, использующее ось, регистрирует себя вместе с этой осью.	AxisBase
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Удаляет прослушиватель из объекта EventDispatcher.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Задает доступность динамического свойства для операций цикла.	Object
		toLocaleString():String Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали.	Object
		toString():String Возвращает строковое представление заданного объекта.	Object
		transformCache(cache:Array, field:String, convertedField:String):void Преобразует набор значений из области данных в область экрана.	CategoryAxis
		unregisterDataTransform(transform:mx.charts.chartClasses:DataTransform):void Каждое свойство DataTransform, использующее ось, регистрирует себя вместе с этой осью.	AxisBase
		update():void Обновляет диаграмму.	CategoryAxis
		valueOf():Object Возвращает элементарное значение заданного объекта.	Object
		willTrigger(type:String):Boolean Проверяет, зарегистрирован ли прослушиватель события для указанного типа события с данным объектом EventDispatcher или любым его предшественником.	EventDispatcher

Защищенные методы

Скрыть унаследованные защищенные методы

Показать унаследованные защищенные методы

	Метод		Определено
		describeData(requiredFields:uint):Array Вызывается управляющим элементом DataTransform для получения описания данных, представляемых этим элементом IChartElement.	AxisBase

События

Дополнительные сведения о событиях

Скрыть унаследованные события

Показать унаследованные события

	Событие		Сводка	Определено
		activate	[многоадресное событие] Отправляется, когда проигрыватель Flash Player или приложение AIR перемещается в фокус операционной системы и становится активным.	EventDispatcher
		deactivate	[многоадресное событие] Отправляется, когда проигрыватель Flash Player или приложение AIR теряет фокус системы и становится неактивным.	EventDispatcher

Сведения о свойстве

baseline

свойство

baseline:Number [только для чтения]

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Положение базовой линии оси. Некоторые серии, например ColumnSeries или AreaSeries, используют это значение для определения основания заполненной области, если не указано минимальное значение.

Реализация
public function get baseline():Number

categoryField

свойство

categoryField:String

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Указывает поле поставщика данных, содержащее текст для меток. Если это свойство имеет значение null, класс CategoryAxis предполагает, что dataProvider содержит массив строк.

Значением по умолчанию является null.

Реализация
public function get categoryField():String
public function set categoryField(value:String):void

dataFunction

свойство

dataFunction:Function

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Указывает метод, возвращающий значение, которое должно использоваться в качестве categoryValue для текущего элемента. Если это свойство установлено, возвращаемое значение пользовательской функции данных имеет приоритет над categoryField

Пользовательская функция dataFunction имеет следующую подпись:

     function_name (axis:CategoryAxis, item:Object):Object { ... }

axis является текущей осью, которая использует эту dataFunction, item является рассматриваемым элементом dataProvider. Эта функция возвращает объект.

Примером использования пользовательской функции dataFunction является возврат значения из dataProvider, имеющего элементы с вложенными полями

Реализация
public function get dataFunction():Function
public function set dataFunction(value:Function):void

Пример
Использование этого примера

     public function myFunction(axis:CategoryAxis,item:Object):Object {
          return(item.Country.State);
     }

dataProvider

свойство

dataProvider:Object

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Указывает источник данных, содержащий имена меток. dataProvider может быть массивом строк, массивом объектов или любым объектом, реализующий интерфейс ICollectionView или IList. Если значением свойства dataProvider является массив строк, необходимо убедиться в том, что свойство categoryField имеет значение null. Если значением свойства dataProvider является массив объектов, в качестве значения свойства categoryField следует установить имя поля, содержащего текст метки.

Реализация
public function get dataProvider():Object
public function set dataProvider(value:Object):void

labelFunction

свойство

labelFunction:Function

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Указывает функцию, определяющую метки, которые генерируются для каждого элемента в dataProvider класса CategoryAxis. Если значение labelFunction не предоставляется, метки оси по умолчанию используют непосредственно значение категории.

Метод labelFunction для CategoryAxis имеет следующую подпись:

      function function_name(categoryValue:Object, previousCategoryValue:Object, axis:CategoryAxis, categoryItem:Object):String { ... }

Где:

categoryValue является значением представляемой категории.
previousCategoryValue является значением предыдущей категории на оси.
ось является визуализируемым классом CategoryAxis.
categoryItem является элементом из представляемого dataProvider.

Flex отображает возвращенную строку как метку оси.

Если свойство categoryField не установлено, то его значение совпадет со значением свойства categoryValue.

Реализация
public function get labelFunction():Function
public function set labelFunction(value:Function):void

padding

свойство

padding:Number

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Определяет заполнение, добавляемое к любой из сторон оси во время визуализации данных на экране. Значение 0 означает, что первая категория соответствует началу оси, а последняя категория – ее концу. Значение 0,5 соответствует заполнению половины ширины категории на оси между началом оси и первой категорией, а также между последней категорией и концом оси.

Это применимо для типов диаграмм, отображение которых выходит за пределы категории, например столбцов и полос. Однако при использовании в качестве горизонтальной оси в LineChart или AreaChart это значение сбрасывается на 0.

Значением по умолчанию является 0.5.

Реализация
public function get padding():Number
public function set padding(value:Number):void

ticksBetweenLabels

свойство

ticksBetweenLabels:Boolean

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Указывает местоположение основных делений на оси относительно меток категории. Если задано значение true, деления (и любые связанные линии сетки) отображаются между категориями. Если задано значение false, деления отображаются в середине категории, выровненные относительно метки.

Реализация
public function get ticksBetweenLabels():Boolean
public function set ticksBetweenLabels(value:Boolean):void

Сведения о конструкторе

()

Конструктор

public function CategoryAxis()

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Конструктор.

Сведения о методе

filterCache

()

метод

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

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Отфильтровывает набор значений произвольного типа до набора чисел, которые могут быть отображены.

Параметры

	`cache:Array` — Массив объектов, из которого считываются и в котором сохраняются преобразованные значения.

	`field:String` — Поле объектов в массиве кэша, содержащем предварительно отфильтрованные значения.

	`filteredField:String` — Поле объектов в массиве кэша, где должны быть сохранены отфильтрованные значения.

formatForScreen

()

метод

public function formatForScreen(value:Object):String

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Форматирует значения для отображения в элементах DataTip. Возвращает строку, доступную для чтения пользователем.

Параметры

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

Получает текст визуализированных меток. При вызове этого метода программой 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` — Поле объектов в массиве кэша, содержащем предварительно преобразованные значения.

	`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, в то время как дискретные диапазоны на основе значения не возвращают это значение. Это свойство можно переопределить путем установки его непосредственно на оси.

Возвращает

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 — Новый набор меток, используемый для разрешения проблемы наложения путем уменьшения количества меток.

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` — Поле объектов в массиве кэша, где должны сохраняться преобразованные значения.

update

()

метод

public function update():void

Язык версии:

ActionScript 3.0

Версия продукта:

Flex 3

Версии среды выполнения:

Flash Player 9, AIR 1.1

Обновляет диаграмму. Можно вызвать несколько раз за цикл.

Примеры Использование этого примера

HLOCChartExample.mxml

<?xml version="1.0"?>
<!-- Simple example to demonstrate the HLOCChart control. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
    xmlns:s="library://ns.adobe.com/flex/spark" 
    xmlns:mx="library://ns.adobe.com/flex/mx">
    <fx:Script>
        <![CDATA[          
        import mx.collections.ArrayCollection;

        [Bindable]
        private var stockDataAC:ArrayCollection = new ArrayCollection( [
            { Date: "25-Jul", Open: 40.55,  High: 40.75, Low: 40.24, Close:40.31},
            { Date: "26-Jul", Open: 40.15,  High: 40.78, Low: 39.97, Close:40.34},
            { Date: "27-Jul", Open: 40.38,  High: 40.66, Low: 40, Close:40.63},
            { Date: "28-Jul", Open: 40.49,  High: 40.99, Low: 40.3, Close:40.98},
            { Date: "29-Jul", Open: 40.13,  High: 40.4, Low: 39.65, Close:39.95},
            { Date: "1-Aug", Open: 39.00,  High: 39.50, Low: 38.7, Close:38.6}, 
            { Date: "2-Aug", Open: 38.68,  High: 39.34, Low: 37.75, Close:38.84}, 
            { Date: "3-Aug", Open: 38.76,  High: 38.76, Low: 38.03, Close:38.12}, 
            { Date: "4-Aug", Open: 37.98,  High: 37.98, Low: 36.56, Close:36.69},                       
            { Date: "5-Aug", Open: 36.61,  High: 37, Low: 36.48, Close:36.86} ]); 
        ]]>
    </fx:Script>

    <fx:Declarations>
        <!-- Define custom Stroke for the wick and ticks. -->
        <mx:SolidColorStroke id="s1" color="0x000000" weight="5" joints="bevel" caps="square"/>
    </fx:Declarations>

    <mx:Panel title="HLOCChart Control Example" height="100%" width="100%">
        <mx:HLOCChart id="hlocchart" height="100%" width="100%"
            paddingRight="5" paddingLeft="5" 
            showDataTips="true" dataProvider="{stockDataAC}">
            
            <mx:verticalAxis>
                <mx:LinearAxis id="vaxis" baseAtZero="false" title="Price"/>
            </mx:verticalAxis>

            <mx:horizontalAxis>
                <mx:CategoryAxis id="haxis" categoryField="Date" title="Date"/>
            </mx:horizontalAxis>

            <mx:horizontalAxisRenderers>
                <mx:AxisRenderer axis="{haxis}" canDropLabels="true"/>
            </mx:horizontalAxisRenderers>

            <mx:series>
                <mx:HLOCSeries 
                    openField="Open" 
                    highField="High" 
                    lowField="Low" 
                    closeField="Close"
                    stroke="{s1}"
                    openTickStroke="{s1}"
                    closeTickStroke="{s1}"
                    openTickLength="7"
                    closeTickLength="7"
                />
            </mx:series>
        </mx:HLOCChart>
    </mx:Panel>
</s:Application>

Юридическая информация | Политика конфиденциальности онлайн

CategoryAxis - AS3 Flex

Классы x

baseline

categoryField

dataFunction

dataProvider

labelFunction

padding

ticksBetweenLabels

CategoryAxis

filterCache

formatForScreen

getLabelEstimate

getLabels

invertTransform

mapCache

preferDropLabels

reduceLabels

transformCache

update