ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Hide Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes

Language Reference only
Filters: AIR 32.0 and earlier, Flash Player 32.0 and earlier, Flash Lite 4
Flex 4.6 and earlier, Flash Pro CS6 and earlier
Hide Filters
mx.charts 

DateTimeAxis  - AS3 Flex

Packagesx

Top Level
adobe.utils
air.desktop
air.net
air.update
air.update.events
coldfusion.air
coldfusion.air.errors
coldfusion.air.events
coldfusion.service
coldfusion.service.events
coldfusion.service.mxml
com.adobe.acm.solutions.authoring.domain.extensions
com.adobe.acm.solutions.ccr.domain.extensions
com.adobe.consulting.pst.vo
com.adobe.dct.component
com.adobe.dct.component.datadictionary
com.adobe.dct.component.datadictionaryElement
com.adobe.dct.component.dataElementsPanel
com.adobe.dct.component.toolbars
com.adobe.dct.event
com.adobe.dct.exp
com.adobe.dct.model
com.adobe.dct.service
com.adobe.dct.service.provider
com.adobe.dct.transfer
com.adobe.dct.util
com.adobe.dct.view
com.adobe.ep.taskmanagement.domain
com.adobe.ep.taskmanagement.event
com.adobe.ep.taskmanagement.filter
com.adobe.ep.taskmanagement.services
com.adobe.ep.taskmanagement.util
com.adobe.ep.ux.attachmentlist.component
com.adobe.ep.ux.attachmentlist.domain
com.adobe.ep.ux.attachmentlist.domain.events
com.adobe.ep.ux.attachmentlist.domain.renderers
com.adobe.ep.ux.attachmentlist.skin
com.adobe.ep.ux.attachmentlist.skin.renderers
com.adobe.ep.ux.content.event
com.adobe.ep.ux.content.factory
com.adobe.ep.ux.content.handlers
com.adobe.ep.ux.content.managers
com.adobe.ep.ux.content.model.asset
com.adobe.ep.ux.content.model.preview
com.adobe.ep.ux.content.model.relation
com.adobe.ep.ux.content.model.search
com.adobe.ep.ux.content.model.toolbar
com.adobe.ep.ux.content.search
com.adobe.ep.ux.content.services
com.adobe.ep.ux.content.services.load
com.adobe.ep.ux.content.services.permissions
com.adobe.ep.ux.content.services.preview
com.adobe.ep.ux.content.services.providers
com.adobe.ep.ux.content.services.query
com.adobe.ep.ux.content.services.relationships
com.adobe.ep.ux.content.services.search.lccontent
com.adobe.ep.ux.content.services.version
com.adobe.ep.ux.content.view
com.adobe.ep.ux.content.view.components.activate
com.adobe.ep.ux.content.view.components.grid
com.adobe.ep.ux.content.view.components.grid.hover
com.adobe.ep.ux.content.view.components.grid.hover.component
com.adobe.ep.ux.content.view.components.grid.renderers
com.adobe.ep.ux.content.view.components.relationships
com.adobe.ep.ux.content.view.components.review
com.adobe.ep.ux.content.view.components.search.renderers
com.adobe.ep.ux.content.view.components.searchpod
com.adobe.ep.ux.content.view.components.toolbar
com.adobe.ep.ux.content.view.components.toolbar.controlRenderers
com.adobe.ep.ux.content.view.components.version
com.adobe.ep.ux.documentsubmit.component
com.adobe.ep.ux.documentsubmit.domain
com.adobe.ep.ux.documentsubmit.skin
com.adobe.ep.ux.taskaction.component
com.adobe.ep.ux.taskaction.domain
com.adobe.ep.ux.taskaction.domain.events
com.adobe.ep.ux.taskaction.skin
com.adobe.ep.ux.taskdetails.component
com.adobe.ep.ux.taskdetails.domain
com.adobe.ep.ux.taskdetails.skin
com.adobe.ep.ux.tasklist.component
com.adobe.ep.ux.tasklist.domain
com.adobe.ep.ux.tasklist.skin
com.adobe.ep.ux.webdocumentviewer.domain
com.adobe.exm.expression
com.adobe.exm.expression.error
com.adobe.exm.expression.event
com.adobe.exm.expression.impl
com.adobe.fiber.runtime.lib
com.adobe.fiber.services
com.adobe.fiber.services.wrapper
com.adobe.fiber.styles
com.adobe.fiber.util
com.adobe.fiber.valueobjects
com.adobe.gravity.binding
com.adobe.gravity.context
com.adobe.gravity.flex.bundleloader
com.adobe.gravity.flex.progress
com.adobe.gravity.flex.serviceloader
com.adobe.gravity.framework
com.adobe.gravity.init
com.adobe.gravity.service.bundleloader
com.adobe.gravity.service.logging
com.adobe.gravity.service.manifest
com.adobe.gravity.service.progress
com.adobe.gravity.tracker
com.adobe.gravity.ui
com.adobe.gravity.utility
com.adobe.gravity.utility.async
com.adobe.gravity.utility.error
com.adobe.gravity.utility.events
com.adobe.gravity.utility.factory
com.adobe.gravity.utility.flex.async
com.adobe.gravity.utility.logging
com.adobe.gravity.utility.message
com.adobe.gravity.utility.sequence
com.adobe.gravity.utility.url
com.adobe.guides.control
com.adobe.guides.domain
com.adobe.guides.i18n
com.adobe.guides.spark.components.skins
com.adobe.guides.spark.components.skins.mx
com.adobe.guides.spark.headers.components
com.adobe.guides.spark.headers.skins
com.adobe.guides.spark.layouts.components
com.adobe.guides.spark.layouts.skins
com.adobe.guides.spark.navigators.components
com.adobe.guides.spark.navigators.renderers
com.adobe.guides.spark.navigators.skins
com.adobe.guides.spark.util
com.adobe.guides.spark.wrappers.components
com.adobe.guides.spark.wrappers.skins
com.adobe.guides.submit
com.adobe.icc.dc.domain
com.adobe.icc.dc.domain.factory
com.adobe.icc.editors.events
com.adobe.icc.editors.handlers
com.adobe.icc.editors.managers
com.adobe.icc.editors.model
com.adobe.icc.editors.model.config
com.adobe.icc.editors.model.el
com.adobe.icc.editors.model.el.operands
com.adobe.icc.editors.model.el.operators
com.adobe.icc.enum
com.adobe.icc.external.dc
com.adobe.icc.obj
com.adobe.icc.services
com.adobe.icc.services.category
com.adobe.icc.services.config
com.adobe.icc.services.download
com.adobe.icc.services.export
com.adobe.icc.services.external
com.adobe.icc.services.formbridge
com.adobe.icc.services.fragmentlayout
com.adobe.icc.services.layout
com.adobe.icc.services.letter
com.adobe.icc.services.locator
com.adobe.icc.services.module
com.adobe.icc.services.render
com.adobe.icc.services.submit
com.adobe.icc.services.user
com.adobe.icc.token
com.adobe.icc.vo
com.adobe.icc.vo.render
com.adobe.icomm.assetplacement.controller
com.adobe.icomm.assetplacement.controller.utils
com.adobe.icomm.assetplacement.data
com.adobe.icomm.assetplacement.model
com.adobe.livecycle.assetmanager.client
com.adobe.livecycle.assetmanager.client.event
com.adobe.livecycle.assetmanager.client.handler
com.adobe.livecycle.assetmanager.client.managers
com.adobe.livecycle.assetmanager.client.model
com.adobe.livecycle.assetmanager.client.model.cms
com.adobe.livecycle.assetmanager.client.service
com.adobe.livecycle.assetmanager.client.service.search
com.adobe.livecycle.assetmanager.client.service.search.cms
com.adobe.livecycle.assetmanager.client.utils
com.adobe.livecycle.content
com.adobe.livecycle.rca.model
com.adobe.livecycle.rca.model.constant
com.adobe.livecycle.rca.model.document
com.adobe.livecycle.rca.model.participant
com.adobe.livecycle.rca.model.reminder
com.adobe.livecycle.rca.model.stage
com.adobe.livecycle.rca.service
com.adobe.livecycle.rca.service.core
com.adobe.livecycle.rca.service.core.delegate
com.adobe.livecycle.rca.service.process
com.adobe.livecycle.rca.service.process.delegate
com.adobe.livecycle.rca.token
com.adobe.livecycle.ria.security.api
com.adobe.livecycle.ria.security.service
com.adobe.mosaic.layouts
com.adobe.mosaic.layouts.dragAndDrop
com.adobe.mosaic.layouts.interfaces
com.adobe.mosaic.mxml
com.adobe.mosaic.om.constants
com.adobe.mosaic.om.events
com.adobe.mosaic.om.impl
com.adobe.mosaic.om.interfaces
com.adobe.mosaic.skinning
com.adobe.mosaic.sparklib.editors
com.adobe.mosaic.sparklib.optionMenu
com.adobe.mosaic.sparklib.scrollableMenu
com.adobe.mosaic.sparklib.scrollableMenu.skins
com.adobe.mosaic.sparklib.tabLayout
com.adobe.mosaic.sparklib.tabLayout.events
com.adobe.mosaic.sparklib.tabLayout.layouts
com.adobe.mosaic.sparklib.tabLayout.skins
com.adobe.mosaic.sparklib.text
com.adobe.mosaic.sparklib.util
com.adobe.solutions.acm.authoring.presentation
com.adobe.solutions.acm.authoring.presentation.actionbar
com.adobe.solutions.acm.authoring.presentation.common
com.adobe.solutions.acm.authoring.presentation.events
com.adobe.solutions.acm.authoring.presentation.fragment
com.adobe.solutions.acm.authoring.presentation.letter
com.adobe.solutions.acm.authoring.presentation.letter.data
com.adobe.solutions.acm.authoring.presentation.preview
com.adobe.solutions.acm.authoring.presentation.rte
com.adobe.solutions.acm.ccr.presentation
com.adobe.solutions.acm.ccr.presentation.contentcapture
com.adobe.solutions.acm.ccr.presentation.contentcapture.events
com.adobe.solutions.acm.ccr.presentation.contentcapture.preview
com.adobe.solutions.acm.ccr.presentation.datacapture
com.adobe.solutions.acm.ccr.presentation.datacapture.renderers
com.adobe.solutions.acm.ccr.presentation.pdf
com.adobe.solutions.exm
com.adobe.solutions.exm.authoring
com.adobe.solutions.exm.authoring.components.controls
com.adobe.solutions.exm.authoring.components.toolbars
com.adobe.solutions.exm.authoring.domain
com.adobe.solutions.exm.authoring.domain.expression
com.adobe.solutions.exm.authoring.domain.impl
com.adobe.solutions.exm.authoring.domain.method
com.adobe.solutions.exm.authoring.domain.variable
com.adobe.solutions.exm.authoring.enum
com.adobe.solutions.exm.authoring.events
com.adobe.solutions.exm.authoring.model
com.adobe.solutions.exm.authoring.renderer
com.adobe.solutions.exm.authoring.view
com.adobe.solutions.exm.expression
com.adobe.solutions.exm.impl
com.adobe.solutions.exm.impl.method
com.adobe.solutions.exm.method
com.adobe.solutions.exm.mock
com.adobe.solutions.exm.mock.method
com.adobe.solutions.exm.runtime
com.adobe.solutions.exm.runtime.impl
com.adobe.solutions.exm.variable
com.adobe.solutions.prm.constant
com.adobe.solutions.prm.domain
com.adobe.solutions.prm.domain.factory
com.adobe.solutions.prm.domain.impl
com.adobe.solutions.prm.domain.manager
com.adobe.solutions.prm.presentation.asset
com.adobe.solutions.prm.presentation.constant
com.adobe.solutions.prm.presentation.document
com.adobe.solutions.prm.presentation.event
com.adobe.solutions.prm.presentation.file
com.adobe.solutions.prm.presentation.project
com.adobe.solutions.prm.presentation.team
com.adobe.solutions.prm.presentation.util
com.adobe.solutions.prm.service
com.adobe.solutions.prm.services.impl
com.adobe.solutions.prm.vo
com.adobe.solutions.rca.constant
com.adobe.solutions.rca.domain
com.adobe.solutions.rca.domain.common
com.adobe.solutions.rca.domain.factory
com.adobe.solutions.rca.domain.impl
com.adobe.solutions.rca.domain.impl.manager
com.adobe.solutions.rca.domain.manager
com.adobe.solutions.rca.presentation
com.adobe.solutions.rca.presentation.comment
com.adobe.solutions.rca.presentation.constant
com.adobe.solutions.rca.presentation.event
com.adobe.solutions.rca.presentation.gantt
com.adobe.solutions.rca.presentation.gantt.ruler
com.adobe.solutions.rca.presentation.template
com.adobe.solutions.rca.presentation.template.audit
com.adobe.solutions.rca.presentation.template.definition
com.adobe.solutions.rca.presentation.template.documents
com.adobe.solutions.rca.presentation.template.stages
com.adobe.solutions.rca.presentation.util
com.adobe.solutions.rca.service
com.adobe.solutions.rca.services.impl
com.adobe.solutions.rca.vo
com.adobe.solutions.rca.vo.um
com.adobe.viewsource
fl.accessibility
fl.containers
fl.controls
fl.controls.dataGridClasses
fl.controls.listClasses
fl.controls.progressBarClasses
fl.core
fl.data
fl.display
fl.events
fl.ik
fl.lang
fl.livepreview
fl.managers
fl.motion
fl.motion.easing
fl.rsl
fl.text
fl.transitions
fl.transitions.easing
fl.video
flash.accessibility
flash.concurrent
flash.crypto
flash.data
flash.desktop
flash.display
flash.display3D
flash.display3D.textures
flash.errors
flash.events
flash.external
flash.filesystem
flash.filters
flash.geom
flash.globalization
flash.html
flash.media
flash.net
flash.net.dns
flash.net.drm
flash.notifications
flash.permissions
flash.printing
flash.profiler
flash.sampler
flash.security
flash.sensors
flash.system
flash.text
flash.text.engine
flash.text.ime
flash.ui
flash.utils
flash.xml
flashx.textLayout
flashx.textLayout.compose
flashx.textLayout.container
flashx.textLayout.conversion
flashx.textLayout.edit
flashx.textLayout.elements
flashx.textLayout.events
flashx.textLayout.factory
flashx.textLayout.formats
flashx.textLayout.operations
flashx.textLayout.utils
flashx.undo
ga.controls
ga.layouts
ga.model
ga.uiComponents
ga.util
ga.views
ga.wrappers
lc.foundation
lc.foundation.domain
lc.foundation.events
lc.foundation.ui
lc.foundation.util
lc.preloader
lc.procmgmt
lc.procmgmt.commands
lc.procmgmt.domain
lc.procmgmt.events
lc.procmgmt.formbridge
lc.procmgmt.impl
lc.procmgmt.ui.attachments
lc.procmgmt.ui.controls
lc.procmgmt.ui.controls.card
lc.procmgmt.ui.controls.renderer
lc.procmgmt.ui.help
lc.procmgmt.ui.layout
lc.procmgmt.ui.presentationmodel
lc.procmgmt.ui.process
lc.procmgmt.ui.search
lc.procmgmt.ui.startpoint
lc.procmgmt.ui.task
lc.procmgmt.ui.task.form
lc.procmgmt.ui.task.form.commands
lc.procmgmt.ui.tracking
mx.accessibility
mx.automation
mx.automation.air
mx.automation.delegates
mx.automation.delegates.advancedDataGrid
mx.automation.delegates.charts
mx.automation.delegates.containers
mx.automation.delegates.controls
mx.automation.delegates.controls.dataGridClasses
mx.automation.delegates.controls.fileSystemClasses
mx.automation.delegates.core
mx.automation.delegates.flashflexkit
mx.automation.events
mx.binding
mx.binding.utils
mx.charts
mx.charts.chartClasses
mx.charts.effects
mx.charts.effects.effectClasses
mx.charts.events
mx.charts.renderers
mx.charts.series
mx.charts.series.items
mx.charts.series.renderData
mx.charts.styles
mx.collections
mx.collections.errors
mx.containers
mx.containers.accordionClasses
mx.containers.dividedBoxClasses
mx.containers.errors
mx.containers.utilityClasses
mx.controls
mx.controls.advancedDataGridClasses
mx.controls.dataGridClasses
mx.controls.listClasses
mx.controls.menuClasses
mx.controls.olapDataGridClasses
mx.controls.scrollClasses
mx.controls.sliderClasses
mx.controls.textClasses
mx.controls.treeClasses
mx.controls.videoClasses
mx.core
mx.core.windowClasses
mx.data
mx.data.crypto
mx.data.errors
mx.data.events
mx.data.messages
mx.data.mxml
mx.data.offline.errors
mx.data.utils
mx.effects
mx.effects.easing
mx.effects.effectClasses
mx.events
mx.filters
mx.flash
mx.formatters
mx.geom
mx.graphics
mx.graphics.codec
mx.graphics.shaderClasses
mx.logging
mx.logging.errors
mx.logging.targets
mx.managers
mx.messaging
mx.messaging.channels
mx.messaging.config
mx.messaging.errors
mx.messaging.events
mx.messaging.management
mx.messaging.messages
mx.modules
mx.netmon
mx.olap
mx.olap.aggregators
mx.preloaders
mx.printing
mx.resources
mx.rpc
mx.rpc.events
mx.rpc.http
mx.rpc.http.mxml
mx.rpc.livecycle
mx.rpc.mxml
mx.rpc.remoting
mx.rpc.remoting.mxml
mx.rpc.soap
mx.rpc.soap.mxml
mx.rpc.wsdl
mx.rpc.xml
mx.skins
mx.skins.halo
mx.skins.spark
mx.skins.wireframe
mx.skins.wireframe.windowChrome
mx.states
mx.styles
mx.utils
mx.validators
org.osmf.containers
org.osmf.display
org.osmf.elements
org.osmf.events
org.osmf.layout
org.osmf.logging
org.osmf.media
org.osmf.metadata
org.osmf.net
org.osmf.net.dvr
org.osmf.net.httpstreaming
org.osmf.net.metrics
org.osmf.net.qos
org.osmf.net.rtmpstreaming
org.osmf.net.rules
org.osmf.traits
org.osmf.utils
spark.accessibility
spark.automation.delegates
spark.automation.delegates.components
spark.automation.delegates.components.gridClasses
spark.automation.delegates.components.mediaClasses
spark.automation.delegates.components.supportClasses
spark.automation.delegates.skins.spark
spark.automation.events
spark.collections
spark.components
spark.components.calendarClasses
spark.components.gridClasses
spark.components.mediaClasses
spark.components.supportClasses
spark.components.windowClasses
spark.core
spark.effects
spark.effects.animation
spark.effects.easing
spark.effects.interpolation
spark.effects.supportClasses
spark.events
spark.filters
spark.formatters
spark.formatters.supportClasses
spark.globalization
spark.globalization.supportClasses
spark.layouts
spark.layouts.supportClasses
spark.managers
spark.modules
spark.preloaders
spark.primitives
spark.primitives.supportClasses
spark.skins
spark.skins.mobile
spark.skins.mobile.supportClasses
spark.skins.spark
spark.skins.spark.mediaClasses.fullScreen
spark.skins.spark.mediaClasses.normal
spark.skins.spark.windowChrome
spark.skins.wireframe
spark.skins.wireframe.mediaClasses
spark.skins.wireframe.mediaClasses.fullScreen
spark.transitions
spark.utils
spark.validators
spark.validators.supportClasses
xd.core.axm.enterprise.view.components
xd.core.axm.enterprise.view.skins
xd.core.axm.view.components
xd.core.axm.view.components.support

Language Elements

Global Constants
Global Functions
Operators
Statements, Keywords & Directives
Special Types

Appendixes

What's New
Compiler Errors
Compiler Warnings
Run-Time Errors
Migrating to ActionScript 3
Supported Character Sets
MXML Only Tags
Motion XML Elements
Timed Text Tags
List of deprecated elements
Accessibility Implementation Constants
How to Use ActionScript Examples
Legal notices
Packagemx.charts
Classpublic class DateTimeAxis
InheritanceDateTimeAxis Inheritance NumericAxis Inheritance AxisBase Inheritance EventDispatcher Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The DateTimeAxis class maps time values evenly between a minimum and maximum value along a chart axis. It can plot values represented either as instances of the Date class, as numeric values representing the number of milliseconds since the epoch (midnight on January 1, 1970, GMT), or as String values when you provide a custom parsing function.

The DateTimeAxis chooses the most reasonable units to mark the axis by examining the range between the minimum and maximum values of the axis. The Axis chooses the largest unit that generates a reasonable number of labels for the given range. You can restrict the set of units the chart considers, or specify exactly which units it should use, by setting the labelUnits property.

You can specifiy the minimum and maximum values explicitly, or let the axis automatically determine them by examining the values being renderered in the chart. By default, the DateTimeAxis chooses the smallest possible range to contain all the values represented in the chart. Optionally, you can request that the minimum and maximum values be rounded to whole units (milliseconds, seconds, minutes, hours, days, weeks, months, years) by setting the autoAdjust property to true.

You can specify disabled days of a week and disabled ranges of dates in order to show only working days on the axis but not all days between minimum and maximum. It also filters data and shows only data corresponding to working days on the chart

MXML SyntaxexpandedHide MXML Syntax

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

  <mx:DateTimeAxis
    Properties
    alignLabelsToUnits="true|false"
    dataUnits="milliseconds|seconds|minutes|hours|days|weeks|months|years"
    disabledDays="Array; No default"
    disabledRanges="Array; No default"
    displayLocalTime="false"
    interval="Number"
    labelUnits="milliseconds|seconds|minutes|hours|days|weeks|months|years"
    maximum="Date"
    minimum="Date"
    minorTickInterval="Number"
    minorTickUnits="milliseconds|seconds|minutes|hours|days|weeks|months|years"
  />
  

View the examples

More examples

Learn more

Related API Elements



Public Properties
 PropertyDefined By
  alignLabelsToUnits : Boolean
Determines the placement of labels along the axis.
DateTimeAxis
 InheritedautoAdjust : Boolean
Specifies whether Flex rounds values.
NumericAxis
 InheritedbaseAtZero : Boolean
Specifies whether Flex tries to keep the minimum and maximum values rooted at zero.
NumericAxis
 Inheritedbaseline : Number
[read-only] The computed minimum value for the axis as long as this value is greater than 0.
NumericAxis
 InheritedchartDataProvider : Object
[write-only] The data provider assigned to the enclosing chart.
AxisBase
 InheritedcomputedMaximum : Number
The computed maximum value represented by this axis.
NumericAxis
 InheritedcomputedMinimum : Number
The computed minimum value represented by this axis.
NumericAxis
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  dataInterval : Number
[write-only] Specifies the interval between data in your chart, specified in dataUnits.
DateTimeAxis
  dataUnits : String
Specifies the units that you expect the data in your chart to represent.
DateTimeAxis
 Inheriteddirection : String
Determines the direction in which the axis is rendered.
NumericAxis
  disabledDays : Array
The days to disable in a week.
DateTimeAxis
  disabledRanges : Array
Disables single and multiple days.
DateTimeAxis
  displayLocalTime : Boolean
When set to true, a DateTimeAxis considers all date values to be in the time zone of the client machine running the application.
DateTimeAxis
 InheriteddisplayName : String
The name of the axis.
AxisBase
  interval : Number
Specifies the number of labelUnits between label values along the axis.
DateTimeAxis
 InheritedlabelFunction : Function
Called to format axis values for display as labels.
NumericAxis
  labelUnits : String
The units that the axis uses to generate labels.
DateTimeAxis
  maximum : Date
Specifies the maximum value for an axis label.
DateTimeAxis
  minimum : Date
Specifies the minimum value for an axis label.
DateTimeAxis
  minorTickInterval : Number
Specifies the number of minorTickUnits between minor tick marks along the axis.
DateTimeAxis
 InheritedminorTicks : Array
[read-only] An Array of minor tick marks generated to represent this axis.
NumericAxis
  minorTickUnits : String
The units that the Axis considers when generating minor tick marks.
DateTimeAxis
 Inheritedpadding : Number
Specifies padding that Flex adds to the calculated minimum and maximum values for the axis when rendering the values on the screen.
NumericAxis
  parseFunction : Function
[override] Specifies a method that customizes the value of the data points.
DateTimeAxis
 Inheritedtitle : String
The text for the title displayed along the axis.
AxisBase
  unitSize : Number
[override] [read-only] The width, in pixels, of a single data unit.
DateTimeAxis
Protected Properties
 PropertyDefined By
 InheritedassignedMaximum : Number
The explicitly assigned maximum value.
NumericAxis
 InheritedassignedMinimum : Number
The explicitly assigned minimum value.
NumericAxis
 InheritedcomputedInterval : Number
The computed interval represented by this axis.
NumericAxis
 InheriteddataDescriptions : Array
[read-only] An Array of DataDescription structures describing the data being represented by the chart.
NumericAxis
 InheritedlabelCache : Array
The most recent set of AxisLabel objects generated to represent this axis.
NumericAxis
 InheritedlabelMaximum : Number
The maximum value where a label should be placed.
NumericAxis
 InheritedlabelMinimum : Number
The minimum value where a label should be placed.
NumericAxis
 InheritedminorTickCache : Array
The most recent set of minor tick marks generated to represent this axis.
NumericAxis
  requiredDescribedFields : uint
[override] [read-only] The fields of the DescribeData structure that this axis is interested in.
DateTimeAxis
 Inheritedticks : Array
[read-only] An Array of tick marks for this axis.
NumericAxis
Public Methods
 MethodDefined By
  
Constructor.
DateTimeAxis
 Inherited
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
 Inherited
Triggers events that inform the range object when the chart data has changed.
AxisBase
 Inherited
Dispatches an event into the event flow.
EventDispatcher
  
filterCache(cache:Array, field:String, filteredField:String):void
[override] Filters a set of values of arbitrary type to a set of numbers that can be mapped.
DateTimeAxis
 Inherited
Formats values for display in DataTips.
NumericAxis
 Inherited
Determines the range to estimate what the axis labels should be.
NumericAxis
 Inherited
getLabels(minimumAxisLength:Number):AxisLabelSet
Gets the labels text that is rendered.
NumericAxis
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Maps a position along the axis back to a numeric data value.
NumericAxis
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
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.
NumericAxis
 Inherited
Determines how the axis handles overlapping labels.
NumericAxis
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
  
reduceLabels(intervalStart:AxisLabel, intervalEnd:AxisLabel):AxisLabelSet
[override] 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.
DateTimeAxis
 Inherited
Each DataTransform that makes use of an axis registers itself with that axis.
AxisBase
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
  
transformCache(cache:Array, field:String, convertedField:String):void
[override] Maps a set of values from data space to screen space.
DateTimeAxis
 Inherited
Each DataTransform that makes use of an axis registers itself with that axis.
AxisBase
 Inherited
Updates the chart.
NumericAxis
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
 Inherited
adjustMinMax(minValue:Number, maxValue:Number):void
Adjusts the generated or assigned range of the axis's labels.
NumericAxis
 Inherited
Populates the labelCache property with labels representing the current values of the axis.
NumericAxis
  
[override] Builds an Array of positions for the minor tick marks Array that is generated by this axis.
DateTimeAxis
 Inherited
describeData(requiredFields:uint):Array
Called by the governing DataTransform to obtain a description of the data represented by this IChartElement.
AxisBase
  
The default formatting function used when the axis renders with day-based labelUnits.
DateTimeAxis
  
The default formatting function used when the axis renders with millisecond-based labelUnits.
DateTimeAxis
  
The default formatting function used when the axis renders with minute-based labelUnits.
DateTimeAxis
  
The default formatting function used when the axis renders with month-based labelUnits.
DateTimeAxis
  
The default formatting function used when the axis renders with second-based labelUnits.
DateTimeAxis
  
The default formatting function used when the axis renders with year-based labelUnits.
DateTimeAxis
 Inherited
Protects the range against invalid values for this axis type.
NumericAxis
 Inherited
Invalidates the cached labels and tick marks that represent this axis's values.
NumericAxis
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
Property Detail

alignLabelsToUnits

property
alignLabelsToUnits:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Determines the placement of labels along the axis.

When false, the chart always puts a label at the beginning of the axis. For example, if your labels are every month and your first datapoint is July 14th, your first label will be on July 14th. When true, Flex first calculates the label units, then labels the first whole interval of those units. For example, if your first data point was July 14th, and your label units was months (set explicitly or dynamically calculated), the first label will be on August 1st.

The default value is true.



Implementation
    public function get alignLabelsToUnits():Boolean
    public function set alignLabelsToUnits(value:Boolean):void

dataInterval

property 
dataInterval:Number  [write-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Specifies the interval between data in your chart, specified in dataUnits.

If, for example, the dataUnits property is set to "hours", and dataInterval property is set to 4, the chart assumes your data occurs every four hours. This affects how some series (such as ColumnSeries and CandlestickSeries) render their data. It also affects how labels are automatically chosen.



Implementation
    public function set dataInterval(value:Number):void

Related API Elements

dataUnits

property 
dataUnits:String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Specifies the units that you expect the data in your chart to represent. The value can be one of the following:

  • milliseconds
  • seconds
  • minutes
  • hours
  • days
  • weeks
  • months
  • years

This value is used in two ways. First, when choosing appropriate label units, a DateTimeAxis does not choose any unit smaller than the units represented by the data. If the value of the dataUnits property is days, the chart would not render labels for every hour, no matter what the minmium/maximum range is.

Secondly, the value of the dataUnits property is used by some series to affect their rendering. Specifically, most columnar series (such as ColumnSeries, BarSeries, CandlestickSeries, and HLOCSeries) use the value of the dataUnits property to determine how wide to render their columns.

If, for example, your ColumnChart control's horizontal axis had its labelUnits property set to weeks and its dataUnits property set to days, the ColumnChart renders each column at 1/7th the distance between labels.

When the dataUnits property is set to null, columnar series render their columns as days, but the DateTimeAxis chooses an appropriate unit when it generates the labels.

The default value is null.



Implementation
    public function get dataUnits():String
    public function set dataUnits(value:String):void

disabledDays

property 
disabledDays:Array

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The days to disable in a week. All the dates in a month, for the specified day, are disabled. The elements of this array can have values from 0 (Sunday) to 6 (Saturday). For example, a value of [ 0, 6 ] disables Sunday and Saturday.



Implementation
    public function get disabledDays():Array
    public function set disabledDays(value:Array):void

disabledRanges

property 
disabledRanges:Array

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Disables single and multiple days.

This property accepts an Array of objects as a parameter. Each object in this array is a Date object, specifying a single day to disable; or an object containing either or both of the rangeStart and rangeEnd properties, each of whose values is a Date object. The value of these properties describes the boundaries of the date range. If either is omitted, the range is considered unbounded in that direction. If you specify only rangeStart, all the dates after the specified date are disabled, including the rangeStart date. If you specify only rangeEnd, all the dates before the specified date are disabled, including the rangeEnd date. To disable a single day, use a single Date object specifying a date in the Array.

The following example, disables the following dates: January 11 2006, the range January 23 - February 10 2006, and March 1 2006 and all following dates.

disabledRanges="{[ new Date(2006,0,11), {rangeStart: new Date(2006,0,23), rangeEnd: new Date(2006,1,10)}, {rangeStart: new Date(2006,2,1)} ]}"

The default value is [].



Implementation
    public function get disabledRanges():Array
    public function set disabledRanges(value:Array):void

displayLocalTime

property 
displayLocalTime:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

When set to true, a DateTimeAxis considers all date values to be in the time zone of the client machine running the application. If false, all values are in Universal Time (Greenwich Mean Time).



Implementation
    public function get displayLocalTime():Boolean
    public function set displayLocalTime(value:Boolean):void

interval

property 
interval:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Specifies the number of labelUnits between label values along the axis. Flex calculates the interval if this property is set to null.

The default value is null.



Implementation
    public function get interval():Number
    public function set interval(value:Number):void

labelUnits

property 
labelUnits:String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The units that the axis uses to generate labels. By default, a DateTimeAxis considers all valid units (milliseconds, seconds, minutes, hours, days, weeks, months, or years).

If the labelUnits property is not set, the chart does not use any unit smaller than the value of the dataUnits property to render labels.



Implementation
    public function get labelUnits():String
    public function set labelUnits(value:String):void

maximum

property 
maximum:Date

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Specifies the maximum value for an axis label. If null, Flex determines the minimum value from the data in the chart.

The default value is null.



Implementation
    public function get maximum():Date
    public function set maximum(value:Date):void

minimum

property 
minimum:Date

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Specifies the minimum value for an axis label. If null, Flex determines the minimum value from the data in the chart.

The default value is null.



Implementation
    public function get minimum():Date
    public function set minimum(value:Date):void

minorTickInterval

property 
minorTickInterval:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Specifies the number of minorTickUnits between minor tick marks along the axis. If this is set to NaN, the DateTimeAxis calculates it automatically.

Normally the minorTickInterval property is automatically set to 1. If, however, the minorTickUnits property is the same units as the dataUnits property (either set explicitly or implicitly calculated), then the minorTickInterval property is the maximum of 1, or dataInterval.



Implementation
    public function get minorTickInterval():Number
    public function set minorTickInterval(value:Number):void

minorTickUnits

property 
minorTickUnits:String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The units that the Axis considers when generating minor tick marks. By default, a DateTimeAxis considers all valid units (milliseconds, seconds, minutes, hours, days, weeks, months, or years).

If this property is not set, the chart determines the value of the minorTickUnits property. If the label interval is greater than 1, the minorTickUnits property is set to the value of the labelUnits property, and the minorTickInterval property is set to 1. If the label interval is 1, the minorTickUnits property is set to the next smaller unit from the labelUnits property. If set, the minorTickUnits property can never be smaller than the value of the dataUnits property.



Implementation
    public function get minorTickUnits():String
    public function set minorTickUnits(value:String):void

parseFunction

property 
parseFunction:Function[override]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Specifies a method that customizes the value of the data points. With this property, you specify a method that accepts a value and returns a Date object. The Date object is then used in the DateTimeAxis object of the chart. This lets you provide customizable date input strings and convert them to Date objects, which Flex can then interpret for use in the DateTimeAxis.

Flex passes only one parameter to the parsing method. This parameter is the value of the data point you specified for the series. Typically, it is a String that represents some form of a date. You cannot override this parameter or add additional parameters.

This Date object is immediately converted to a numeric value, so custom parseFunctions can reuse the same Date object for performance reasons. By default, the DateTimeAxis uses the string parsing functionality in the ECMA standard Date.parse() method.

The following example uses a data provider that defines a data object in the format { yyyy, mm, dd }. The method specified by the parseFunction uses these values to create a Date object that the axis can use.
      <mx:Script>
          import mx.collections.ArrayCollection;
          [Bindable] 
          public var aapl:ArrayCollection = new ArrayCollection([ 
              {date: "2005, 8, 1", close: 42.71},
              {date: "2005, 8, 2", close: 42.99},
              {date: "2005, 8, 3", close: 44}
          ]);
          
          public function myParseFunction(s:String):Date { 
              // Get an array of Strings from the comma-separated String passed in.
              var a:Array = s.split(",");
      
              // Create the new Date object. Note that the month argument is 0-based (with 0 being January).
              var newDate:Date = new Date(a[0],a[1]-1,a[2]);
              return newDate;
          }
      </mx:Script>
      <mx:LineChart id="mychart" dataProvider="{aapl}" showDataTips="true">
          <mx:horizontalAxis>
              <mx:DateTimeAxis dataUnits="days" parseFunction="myParseFunction"/>
          </mx:horizontalAxis>
          <mx:series>
              <mx:LineSeries yField="close" xField="date" displayName="AAPL"/>
          </mx:series>
      </mx:LineChart>
      



Implementation
    override public function get parseFunction():Function
    override public function set parseFunction(value:Function):void

requiredDescribedFields

property 
requiredDescribedFields:uint  [read-only] [override]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The fields of the DescribeData structure that this axis is interested in.



Implementation
    override protected function get requiredDescribedFields():uint

unitSize

property 
unitSize:Number  [read-only] [override]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The width, in pixels, of a single data unit. The type of a data unit is determined by the value of the dataUnits property.



Implementation
    override public function get unitSize():Number
Constructor Detail

DateTimeAxis

()Constructor
public function DateTimeAxis()

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Method Detail

buildMinorTickCache

()method
override protected function buildMinorTickCache():Array

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Builds an Array of positions for the minor tick marks Array that is generated by this axis. Subclasses must implement this function. This function is called automatically by the NumericAxis. You should access the minorTicks property instead of calling this function directly.

Returns
Array — An Array of positions from 0 to 1 that represent points between the axis minimum and maximum values where minor tick marks are rendered.

filterCache

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

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

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

Parameters

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.

formatDays

()method 
protected function formatDays(d:Date, previousValue:Date, axis:mx.charts:DateTimeAxis):String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The default formatting function used when the axis renders with day-based labelUnits. If you write a custom DateTimeAxis class, you can override this method to provide alternate default formatting.

You do not call this method directly. Instead, Flex calls this method before it renders the label to get the appropriate String to display.

Parameters

d:Date — The Date object that contains the unit to format.
 
previousValue:Date — The Date object that contains the data point that occurs prior to the current data point.
 
axis:mx.charts:DateTimeAxis — The DateTimeAxis on which the label is rendered.

Returns
String — The formatted label.

formatMilliseconds

()method 
protected function formatMilliseconds(d:Date, previousValue:Date, axis:mx.charts:DateTimeAxis):String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The default formatting function used when the axis renders with millisecond-based labelUnits. If you write a custom DateTimeAxis class, you can override this method to provide alternate default formatting.

You do not call this method directly. Instead, Flex calls this method before it renders the label to get the appropriate String to display.

Parameters

d:Date — The Date object that contains the unit to format.
 
previousValue:Date — The Date object that contains the data point that occurs prior to the current data point.
 
axis:mx.charts:DateTimeAxis — The DateTimeAxis on which the label is rendered.

Returns
String — The formatted label.

formatMinutes

()method 
protected function formatMinutes(d:Date, previousValue:Date, axis:mx.charts:DateTimeAxis):String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The default formatting function used when the axis renders with minute-based labelUnits. If you write a custom DateTimeAxis class, you can override this method to provide alternate default formatting.

You do not call this method directly. Instead, Flex calls this method before it renders the label to get the appropriate String to display.

Parameters

d:Date — The Date object that contains the unit to format.
 
previousValue:Date — The Date object that contains the data point that occurs prior to the current data point.
 
axis:mx.charts:DateTimeAxis — The DateTimeAxis on which the label is rendered.

Returns
String — The formatted label.

formatMonths

()method 
protected function formatMonths(d:Date, previousValue:Date, axis:mx.charts:DateTimeAxis):String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The default formatting function used when the axis renders with month-based labelUnits. If you write a custom DateTimeAxis class, you can override this method to provide alternate default formatting.

You do not call this method directly. Instead, Flex calls this method before it renders the label to get the appropriate String to display.

Parameters

d:Date — The Date object that contains the unit to format.
 
previousValue:Date — The Date object that contains the data point that occurs prior to the current data point.
 
axis:mx.charts:DateTimeAxis — The DateTimeAxis on which the label is rendered.

Returns
String — The formatted label.

formatSeconds

()method 
protected function formatSeconds(d:Date, previousValue:Date, axis:mx.charts:DateTimeAxis):String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The default formatting function used when the axis renders with second-based labelUnits. If you write a custom DateTimeAxis class, you can override this method to provide alternate default formatting.

You do not call this method directly. Instead, Flex calls this method before it renders the label to get the appropriate String to display.

Parameters

d:Date — The Date object that contains the unit to format.
 
previousValue:Date — The Date object that contains the data point that occurs prior to the current data point.
 
axis:mx.charts:DateTimeAxis — The DateTimeAxis on which the label is rendered.

Returns
String — The formatted label.

formatYears

()method 
protected function formatYears(d:Date, previousValue:Date, axis:mx.charts:DateTimeAxis):String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The default formatting function used when the axis renders with year-based labelUnits. If you write a custom DateTimeAxis class, you can override this method to provide alternate default formatting.

You do not call this method directly. Instead, Flex calls this method before it renders the label to get the appropriate String to display.

Parameters

d:Date — The Date object that contains the unit to format.
 
previousValue:Date — The Date object that contains the data point that occurs prior to the current data point.
 
axis:mx.charts:DateTimeAxis — The DateTimeAxis on which the label is rendered.

Returns
String — The formatted label.

reduceLabels

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

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: 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.

Parameters

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

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

transformCache

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

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

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

Parameters

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.

DateTimeAxisExample.mxml
<?xml version="1.0"?>
<!-- Simple example to demonstrate the DateTimeAxis class. -->
<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] 
            public var stockDataAC:ArrayCollection = new ArrayCollection( [
                {date: "2005, 7, 27", close: 41.71},
                {date: "2005, 7, 28", close: 42.21},
                {date: "2005, 7, 29", close: 42.11},
                {date: "2005, 8, 1", close: 42.71},
                {date: "2005, 8, 2", close: 42.99},
                {date: "2005, 8, 3", close: 44} ]);
    
            public function myParseFunction(s:String):Date { 
                // Get an array of Strings from the comma-separated String passed in.
                var a:Array = s.split(",");
                // Create the new Date object. Subtract one from 
                // the month property because months are zero-based in 
                // the Date constructor.
                var newDate:Date = new Date(a[0],a[1]-1,a[2]);
                return newDate;
            }
        ]]>
    </fx:Script>

    <mx:Panel title="DateTimeAxis Example" height="100%" width="100%">
    
        <mx:LineChart id="mychart" height="100%" width="100%"
            paddingRight="5" paddingLeft="5" 
            showDataTips="true" dataProvider="{stockDataAC}">
            
            <mx:horizontalAxis>
                <mx:DateTimeAxis dataUnits="days" parseFunction="myParseFunction"/>
            </mx:horizontalAxis>

            <mx:verticalAxis>
                <mx:LinearAxis baseAtZero="false" />
            </mx:verticalAxis>

            <mx:series>
                <mx:LineSeries yField="close" xField="date" displayName="AAPL"/>
            </mx:series>
        </mx:LineChart>
        
    </mx:Panel>
</s:Application>