CategoryAxis

Pacote	mx.charts
Classe	public class CategoryAxis
Herança	CategoryAxis AxisBase EventDispatcher Object
Implementações	IAxis

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

The CategoryAxis class lets charts represent data grouped by a set of discrete values along an axis. You typically use the CategoryAxis class to define a set of labels that appear along an axis of a chart. For example, charts that render data according to City, Year, Business unit, and so on.

You are not required to explicitly set the dataProvider property on a CategoryAxis. A CategoryAxis used in a chart inherits its dataProvider property from the containing chart.

While you can use the same data provider to provide data to the chart and categories to the CategoryAxis, a CategoryAxis can optimize rendering if its data provider is relatively static. If possible, ensure that the categories are relatively static and that changing data is stored in separate data providers.

The dataProvider property can accept either an array of strings or an array of records (Objects) with a property that specifies the category name. If you specify a categoryField property, the CategoryAxis assumes that the data provider is an array of Objects. If the value of the categoryField property is null, the CategoryAxis assumes that the data provider is an array of Strings.

Sintaxe MXML expanded

Ocultar sintaxe 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"
  />

Veja os exemplos

Mais exemplos

About the axis classes
About the CategoryAxis class
Adding axis titles
Defining axis labels

Propriedades públicas

Ocultar propriedades públicas herdadas

Mostrar propriedades públicas herdadas

	Propriedade		Definido por
		baseline : Number [somente leitura] The baseline position for the axis.	CategoryAxis
		categoryField : String Specifies the field of the data provider containing the text for the labels.	CategoryAxis
		chartDataProvider : Object [somente gravação] The data provider assigned to the enclosing chart.	AxisBase
		constructor : Object Uma referência ao objeto de classe ou à função de construtor de uma determinada ocorrência de objeto.	Object
		dataFunction : Function Specifies a method that returns the value that should be used as categoryValue for current item.If this property is set, the return value of the custom data function takes precedence over categoryField The custom dataFunction has the following signature: function_name (axis:CategoryAxis, item:Object):Object { ...	CategoryAxis
		dataProvider : Object Specifies the data source containing the label names.	CategoryAxis
		displayName : String The name of the axis.	AxisBase
		labelFunction : Function Specifies a function that defines the labels that are generated for each item in the CategoryAxis's dataProvider.	CategoryAxis
		padding : Number Specifies the padding added to either side of the axis when rendering data on the screen.	CategoryAxis
		ticksBetweenLabels : Boolean Specifies the location of major tick marks on the axis, relative to the category labels.	CategoryAxis
		title : String The text for the title displayed along the axis.	AxisBase
		unitSize : Number [somente leitura] The size of one unit of data as represented by this axis.	AxisBase

Métodos públicos

Ocultar métodos públicos herdados

Mostrar métodos públicos herdados

	Método		Definido por
		CategoryAxis() Constructor.	CategoryAxis
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registra um objeto de ouvinte de evento em um objeto EventDispatcher, de forma que o ouvinte receba a notificação de um evento.	EventDispatcher
		dataChanged():void Triggers events that inform the range object when the chart data has changed.	AxisBase
		dispatchEvent(event:Event):Boolean Envia um evento para o fluxo de eventos.	EventDispatcher
		filterCache(cache:Array, field:String, filteredField:String):void Filters a set of values of arbitrary type to a set of numbers that can be mapped.	CategoryAxis
		formatForScreen(value:Object):String Formats values for display in DataTips.	CategoryAxis
		getLabelEstimate():AxisLabelSet Determines the range to estimate what the axis labels should be.	CategoryAxis
		getLabels(minimumAxisLength:Number):AxisLabelSet Gets the labels text that is rendered.	CategoryAxis
		hasEventListener(type:String):Boolean Verifica se o objeto EventDispatcher tem ouvintes registrados para um tipo específico de evento.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indica se um objeto tem uma propriedade especificada definida.	Object
		invertTransform(value:Number):Object Maps a position along the axis back to a numeric data value.	CategoryAxis
		isPrototypeOf(theClass:Object):Boolean Indica se uma ocorrência da classe Object está na cadeia de protótipos do objeto especificado como o parâmetro.	Object
		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.	CategoryAxis
		preferDropLabels():Boolean Determines how the axis handles overlapping labels.	CategoryAxis
		propertyIsEnumerable(name:String):Boolean Indica se a propriedade especificada existe e é enumerável.	Object
		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.	CategoryAxis
		registerDataTransform(transform:mx.charts.chartClasses:DataTransform, dimensionName:String):void Each DataTransform that makes use of an axis registers itself with that axis.	AxisBase
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Remove um ouvinte do objeto EventDispatcher.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Define a disponibilidade de uma propriedade dinâmica para operações de repetição.	Object
		toLocaleString():String Retorna a representação da string deste objeto, formatado segundo as convenções específicas para a localidade.	Object
		toString():String Retorna a representação de string do objeto especificado.	Object
		transformCache(cache:Array, field:String, convertedField:String):void Maps a set of values from data space to screen space.	CategoryAxis
		unregisterDataTransform(transform:mx.charts.chartClasses:DataTransform):void Each DataTransform that makes use of an axis registers itself with that axis.	AxisBase
		update():void Updates the chart.	CategoryAxis
		valueOf():Object Retorna o valor primitivo do objeto especificado.	Object
		willTrigger(type:String):Boolean Verifica se um ouvinte de evento está registrado nesse objeto EventDispatcher ou em qualquer um de seus ancestrais para o tipo de evento especificado.	EventDispatcher

Métodos protegidos

Ocultar métodos protegidos herdados

Mostrar métodos protegidos herdados

	Método		Definido por
		describeData(requiredFields:uint):Array Called by the governing DataTransform to obtain a description of the data represented by this IChartElement.	AxisBase

Eventos

Clique para obter mais informações sobre eventos

Ocultar eventos herdados

Mostrar eventos herdados

	Evento		Resumo	Definido por
		activate	[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR ganha o foco do sistema operacional e está se tornando inativo.	EventDispatcher
		deactivate	[transmissão de evento] Despachado quando o Flash Player ou o aplicativo do AIR perde o foco do sistema operacional e está se tornando inativo.	EventDispatcher

Detalhes da propriedade

baseline

propriedade

baseline:Number [somente leitura]

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

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.

Implementação
public function get baseline():Number

categoryField

propriedade

categoryField:String

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Specifies the field of the data provider containing the text for the labels. If this property is null, CategoryAxis assumes that the dataProvider contains an array of Strings.

O valor padrão é null.

Implementação
public function get categoryField():String
public function set categoryField(value:String):void

dataFunction

propriedade

dataFunction:Function

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Specifies a method that returns the value that should be used as categoryValue for current item.If this property is set, the return value of the custom data function takes precedence over categoryField

The custom dataFunction has the following signature:

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

axis is the current axis that uses this dataFunction item is the item in the dataProvider that is considered. This function returns an object.

An example usage of a customized dataFunction is to return a value from a dataProvider that has items with nested fields

Implementação
public function get dataFunction():Function
public function set dataFunction(value:Function):void

Exemplo
Como usar este exemplo

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

dataProvider

propriedade

dataProvider:Object

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Specifies the data source containing the label names. The dataProvider can be an Array of Strings, an Array of Objects, or any object that implements the IList or ICollectionView interface. If the dataProvider is an Array of Strings, ensure that the categoryField property is set to null. If the dataProvider is an Array of Objects, set the categoryField property to the name of the field that contains the label text.

Implementação
public function get dataProvider():Object
public function set dataProvider(value:Object):void

labelFunction

propriedade

labelFunction:Function

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Specifies a function that defines the labels that are generated for each item in the CategoryAxis's dataProvider. If no labelFunction is provided, the axis labels default to the value of the category itself.

The labelFunction method for a CategoryAxis has the following signature:

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

Where:

categoryValue is the value of the category to be represented.
previousCategoryValue is the value of the previous category on the axis.
axis is the CategoryAxis being rendered.
categoryItem is the item from the dataProvider that is being represented.

Flex displays the returned String as the axis label.

If the categoryField property is not set, the value will be the same as the categoryValue property.

Implementação
public function get labelFunction():Function
public function set labelFunction(value:Function):void

padding

propriedade

padding:Number

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Specifies the padding added to either side of the axis when rendering data on the screen. Set to 0 to map the first category to the very beginning of the axis and the last category to the end. Set to 0.5 to leave padding of half the width of a category on the axis between the beginning of the axis and the first category and between the last category and the end of the axis.

This is useful for chart types that render beyond the bounds of the category, such as columns and bars. However, when used as the horizontalAxis in a LineChart or AreaChart, it is reset to 0.

O valor padrão é 0.5.

Implementação
public function get padding():Number
public function set padding(value:Number):void

ticksBetweenLabels

propriedade

ticksBetweenLabels:Boolean

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Specifies the location of major tick marks on the axis, relative to the category labels. If true, tick marks (and any associated grid lines) appear between the categories. If false, tick marks appear in the middle of the category, aligned with the label.

Implementação
public function get ticksBetweenLabels():Boolean
public function set ticksBetweenLabels(value:Boolean):void

Detalhes do construtor

()

Construtor

public function CategoryAxis()

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

Constructor.

Detalhes do método

filterCache

()

método

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

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

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

Parâmetros

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

	`filteredField:String` — The field of the objects in the cache Array where filtered values should be stored.

formatForScreen

()

método

public function formatForScreen(value:Object):String

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

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

Parâmetros

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

Retorna

String — The text of the DataTip.

getLabelEstimate

()

método

public function getLabelEstimate():AxisLabelSet

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

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.

Retorna

AxisLabelSet — An Array of AxisLabel objects.

getLabels

()

método

public function getLabels(minimumAxisLength:Number):AxisLabelSet

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

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.

Parâmetros

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

Retorna

AxisLabelSet — An array of AxisLabel objects.

invertTransform

()

método

public function invertTransform(value:Number):Object

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

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

Parâmetros

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.

Retorna

Object — An object containing the transformed value.

mapCache

()

método

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

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

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.

Parâmetros

	`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

()

método

public function preferDropLabels():Boolean

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

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.

Retorna

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

reduceLabels

()

método

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

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

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.

Parâmetros

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

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

Retorna

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

transformCache

()

método

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

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

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

Parâmetros

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

update

()

método

public function update():void

Versão da linguagem:

ActionScript 3.0

Versão de produto:

Flex 3

Versões de runtime:

Flash Player 9, AIR 1.1

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

Exemplos Como usar este exemplo

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>

Aspectos jurídicos | Política de privacidade on-line

CategoryAxis - AS3 Flex

Classes x

baseline

categoryField

dataFunction

dataProvider

labelFunction

padding

ticksBetweenLabels

CategoryAxis

filterCache

formatForScreen

getLabelEstimate

getLabels

invertTransform

mapCache

preferDropLabels

reduceLabels

transformCache

update