API: charts TimeAxis.js (YUI Library)

# Yahoo! UI Library

### Charts Widget 2.8.2r1

Yahoo! UI Library > charts > TimeAxis.js (source view)
Search:
Filters Show Private Show Protected Show Deprecated

    /**
     * A type of axis whose units are measured in time-based values.
     *
     * @namespace YAHOO.widget
     * @class TimeAxis
     * @constructor
     */
    YAHOO.widget.TimeAxis = function()
    {
    	YAHOO.widget.TimeAxis.superclass.constructor.call(this);
    };

    YAHOO.lang.extend(YAHOO.widget.TimeAxis, YAHOO.widget.Axis,
    {
    	type: "time",

    	/**
    	 * The minimum value drawn by the axis. If not set explicitly, the axis minimum
    	 * will be calculated automatically.
    	 *
    	 * @property minimum
    	 * @type Date
    	 */
    	minimum: null,

    	/**
    	 * The maximum value drawn by the axis. If not set explicitly, the axis maximum
    	 * will be calculated automatically.
    	 *
    	 * @property maximum
    	 * @type Number
    	 */
    	maximum: null,

    	/**
    	 * The spacing between major intervals on this axis.
    	 *
    	 * @property majorUnit
    	 * @type Number
    	 */
    	majorUnit: NaN,

    	/**
    	 * The time unit used by the majorUnit.
    	 *
    	 * @property majorTimeUnit
    	 * @type String
    	 */
    	majorTimeUnit: null,

    	/**
    	 * The spacing between minor intervals on this axis.
    	 *
    	 * @property majorUnit
    	 * @type Number
    	 */
    	minorUnit: NaN,

    	/**
    	 * The time unit used by the minorUnit.
    	 *
    	 * @property majorTimeUnit
    	 * @type String
    	 */
    	minorTimeUnit: null,

    	/**
    	 * If true, the labels, ticks, gridlines, and other objects will snap to
    	 * the nearest major or minor unit. If false, their position will be based
    	 * on the minimum value.
    	 *
    	 * @property snapToUnits
    	 * @type Boolean
    	 */
    	snapToUnits: true,

    	/**
    	 * Series that are stackable will only stack when this value is set to true.
    	 *
    	 * @property stackingEnabled
    	 * @type Boolean
    	 */
    	stackingEnabled: false,

    	/**
    	 * Indicates whether to factor in the size of the labels when calculating a major unit.
    	 *
    	 * @property calculateByLabelSize
    	 * @type Boolean
    	 */
    	calculateByLabelSize: true
    });

Copyright © 2010 Yahoo! Inc. All rights reserved.