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.

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.

See also

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.

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.

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 [].

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

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.

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.

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.

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.

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.

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.

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.

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

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

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

Constructor.

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.

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

Parameters

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

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

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

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

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

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

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

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

Parameters