CategoryAxis

(Preview)

Package	mx.charts
Class	public class CategoryAxis
Inheritance	CategoryAxis AxisBase EventDispatcher Object
Implements	IAxis

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

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.

MXML Syntax expanded

Hide MXML Syntax

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

View the examples

More examples

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

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		baseline : Number [read-only] 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 [write-only] The data provider assigned to the enclosing chart.	AxisBase
		constructor : Object A reference to the class object or constructor function for a given object instance.	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 [read-only] The size of one unit of data as represented by this axis.	AxisBase

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		CategoryAxis() Constructor.	CategoryAxis
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		dataChanged():void Triggers events that inform the range object when the chart data has changed.	AxisBase
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	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 Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		invertTransform(value:Number):Object Maps a position along the axis back to a numeric data value.	CategoryAxis
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	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 Indicates whether the specified property exists and is enumerable.	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 Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	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 Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		describeData(requiredFields:uint):Array Called by the governing DataTransform to obtain a description of the data represented by this IChartElement.	AxisBase

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Property Detail

Constructor Detail

Method Detail

Examples How to use this example

HLOCChartExample.mxml

Copy

<?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>

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

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

CategoryAxis - AS3 Flex

Packagesx

Language Elements

Appendixes

Package mx.charts

baseline

categoryField

dataFunction

dataProvider

labelFunction

padding

ticksBetweenLabels

filterCache

formatForScreen

getLabelEstimate

getLabels

invertTransform

mapCache

preferDropLabels

reduceLabels

transformCache

update

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

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

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