Ext JS 4.1.3 Sencha Docs

Ext.chart.axis.Time

Alternate names

Ext.chart.TimeAxis

Hierarchy

Uses

Files

A type of axis whose units are measured in time values. Use this axis for listing dates that you will want to group or dynamically change. If you just want to display dates as categories then use the Category class for axis instead.

For example:

axes: [{
    type: 'Time',
    position: 'bottom',
    fields: 'date',
    title: 'Day',
    dateFormat: 'M d',

    constrain: true,
    fromDate: new Date('1/1/11'),
    toDate: new Date('1/7/11')
}]

In this example we're creating a time axis that has as title Day. The field the axis is bound to is date. The date format to use to display the text for the axis labels is M d which is a three letter month abbreviation followed by the day number. The time axis will show values for dates between fromDate and toDate. Since constrain is set to true all other values for other dates not between the fromDate and toDate will not be displayed.

Available since: 3.4.0

Defined By

Config options

Whether to adjust the label at the end of the axis. ...

Whether to adjust the label at the end of the axis.

Defaults to: true

Available since: 4.1.0

Indicates whether to extend maximum beyond data's maximum to the nearest majorUnit. ...

Indicates whether to extend maximum beyond data's maximum to the nearest majorUnit.

Defaults to: false

Available since: Ext JS 4.1.3

Indicates whether to extend the minimum beyond data's minimum to the nearest majorUnit. ...

Indicates whether to extend the minimum beyond data's minimum to the nearest majorUnit.

Defaults to: false

Available since: Ext JS 4.1.3

Ext.chart.axis.Time
view source
: Boolean
If true, the values of the chart will be rendered only if they belong between the fromDate and toDate. ...

If true, the values of the chart will be rendered only if they belong between the fromDate and toDate. If false, the time axis will adapt to the new values by adding/removing steps.

Defaults to: false

Available since: 4.0.4

Overrides: Ext.chart.axis.Numeric.constrain

The size of the dash marker. ...

The size of the dash marker. Default's 3.

Defaults to: 3

Available since: 4.0.0

Ext.chart.axis.Time
view source
: String/Boolean
Indicates the format the date will be rendered on. ...

Indicates the format the date will be rendered on. For example: 'M d' will render the dates as 'Jan 30', etc. For a list of possible format strings see Date

Defaults to: false

Available since: 4.0.4

The number of decimals to round the value to. ...

The number of decimals to round the value to.

Defaults to: 2

Available since: Ext JS 4.1.3

The fields of model to bind to this axis. ...

The fields of model to bind to this axis.

For example if you have a data set of lap times per car, each having the fields: 'carName', 'avgSpeed', 'maxSpeed'. Then you might want to show the data on chart with ['carName'] on Name axis and ['avgSpeed', 'maxSpeed'] on Speed axis.

Available since: 4.1.0

Ext.chart.axis.Time
view source
: Date
The starting date for the time axis. ...

The starting date for the time axis.

Defaults to: false

Available since: 4.0.4

The grid configuration enables you to set a background grid for an axis. ...

The grid configuration enables you to set a background grid for an axis. If set to true on a vertical axis, vertical lines will be drawn. If set to true on a horizontal axis, horizontal lines will be drawn. If both are set, a proper grid with horizontal and vertical lines will be drawn.

You can set specific options for the grid configuration for odd and/or even lines/rows. Since the rows being drawn are rectangle sprites, you can set to an odd or even property all styles that apply to Ext.draw.Sprite. For more information on all the style properties you can set please take a look at Ext.draw.Sprite. Some useful style properties are opacity, fill, stroke, stroke-width, etc.

The possible values for a grid option are then true, false, or an object with { odd, even } properties where each property contains a sprite style descriptor object that is defined in Ext.draw.Sprite.

For example:

axes: [{
    type: 'Numeric',
    position: 'left',
    fields: ['data1', 'data2', 'data3'],
    title: 'Number of Hits',
    grid: {
        odd: {
            opacity: 1,
            fill: '#ddd',
            stroke: '#bbb',
            'stroke-width': 1
        }
    }
}, {
    type: 'Category',
    position: 'bottom',
    fields: ['name'],
    title: 'Month of the Year',
    grid: true
}]

Available since: 4.0.2

The config for chart label.

The config for chart label.

Available since: 4.1.0

Offset axis position. ...

Offset axis position. Default's 0.

Defaults to: 0

Available since: 4.0.0

If minimum and maximum are specified it forces the number of major ticks to the specified value. ...

If minimum and maximum are specified it forces the number of major ticks to the specified value. If a number of major ticks is forced, it wont search for pretty numbers at the ticks.

Available since: 4.0.0

The maximum value drawn by the axis. ...

The maximum value drawn by the axis. If not set explicitly, the axis maximum will be calculated automatically.

Available since: Ext JS 4.1.3

The minimum value drawn by the axis. ...

The minimum value drawn by the axis. If not set explicitly, the axis minimum will be calculated automatically.

Available since: Ext JS 4.1.3

The number of small ticks between two major ticks. ...

The number of small ticks between two major ticks. Default is zero.

Available since: 4.0.0

Indicates the position of the axis relative to the chart ...

Indicates the position of the axis relative to the chart

Defaults to: 'left'

Available since: 4.0.0

Overrides: Ext.chart.axis.Axis.position

The scaling algorithm to use on this axis. ...

The scaling algorithm to use on this axis. May be "linear" or "logarithmic". Currently only linear scale is implemented.

Defaults to: "linear"

Available since: Ext JS 4.1.3

Ext.chart.axis.Time
view source
: Array
An array with two components: The first is the unit of the step (day, month, year, etc). ...

An array with two components: The first is the unit of the step (day, month, year, etc). The second one is a number. If the number is an integer, it represents the number of units for the step ([Ext.Date.DAY, 2] means "Every other day"). If the number is a fraction, it represents the number of steps per unit ([Ext.Date.DAY, 1/2] means "Twice a day"). If the unit is the month, the steps may be adjusted depending on the month. For instance [Ext.Date.MONTH, 1/3], which means "Three times a month", generates steps on the 1st, the 10th and the 20th of every month regardless of whether a month has 28 days or 31 days. The steps are generated as follows: - [Ext.Date.MONTH, n]: on the current date every 'n' months, maxed to the number of days in the month. - [Ext.Date.MONTH, 1/2]: on the 1st and 15th of every month. - [Ext.Date.MONTH, 1/3]: on the 1st, 10th and 20th of every month. - [Ext.Date.MONTH, 1/4]: on the 1st, 8th, 15th and 22nd of every month.

Defaults to: [Ext.Date.DAY, 1].

Available since: 4.0.4

The title for the Axis

The title for the Axis

Available since: 4.0.4

Ext.chart.axis.Time
view source
: Date
The ending date for the time axis. ...

The ending date for the time axis.

Defaults to: false

Available since: 4.0.4

Offset axis width. ...

Offset axis width. Default's 0.

Defaults to: 0

Available since: 4.0.0

Properties

Defined By

Instance Properties

...

Defaults to: 'Ext.Base'

Available since: 4.1.1

Available since: 4.0.2

...

Defaults to: {}

Available since: 4.1.1

force min/max values from store ...

force min/max values from store

Defaults to: false

Available since: 4.0.1

...

Defaults to: false

Available since: 4.0.2

...

Defaults to: []

Available since: 4.1.1

...

Defaults to: {}

Available since: 4.1.1

...

Defaults to: true

Available since: 4.1.1

...

Defaults to: true

Available since: Ext JS 4.1.3

...

Defaults to: false

Available since: 4.0.0

...

Defaults to: 0

Available since: 4.0.2

...

Defaults to: 0

Available since: 4.0.2

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics for a detailed comparison

Ext.define('My.Cat', {
    statics: {
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        alert(this.self.speciesName); // dependent on 'this'
    },

    clone: function() {
        return new this.self();
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',
    statics: {
        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'
    }
});

var cat = new My.Cat();                     // alerts 'Cat'
var snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'

Available since: 4.0.0

...

Defaults to: false

Available since: 4.0.0

...

Defaults to: 10

Available since: 4.0.2

Ext.chart.axis.Time
view source
: Stringprivate
...

Defaults to: 'Time'

Available since: 3.4.0

Overrides: Ext.chart.axis.Numeric.type

...

Defaults to: 0

Available since: 4.0.2

...

Defaults to: 0

Available since: 4.0.2

Defined By

Static Properties

...

Defaults to: []

Available since: 4.1.1

Methods

Defined By

Instance Methods

Ext.chart.axis.Time
view source
new( [config] ) : Ext.chart.axis.Time
Creates new Axis. ...

Creates new Axis.

Available since: 3.4.0

Parameters

  • config : Object (optional)

    Config options.

Returns

Overrides: Ext.chart.axis.Numeric.constructor

...

Available since: 4.0.2

apply data. ...

apply data.

Available since: 4.0.0

Overrides: Ext.chart.axis.Axis.applyData

Ext.chart.axis.Time
view source
( )private
modifies the store and creates the labels for the axes. ...

modifies the store and creates the labels for the axes.

Available since: 4.0.0

Overrides: Ext.chart.axis.Axis.calcEnds

( args ) : Objectdeprecatedprotected
Call the original method that was previously overridden with override Ext.define('My.Cat', { constructor: functi...

Call the original method that was previously overridden with override

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callOverridden();

        alert("Meeeeoooowwww");
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

This method has been deprecated

as of 4.1. Use callParent instead.

Available since: 4.0.0

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

Returns

  • Object

    Returns the result of calling the overridden method

Call the "parent" method of the current method. ...

Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext.define).

 Ext.define('My.Base', {
     constructor: function (x) {
         this.x = x;
     },

     statics: {
         method: function (x) {
             return x;
         }
     }
 });

 Ext.define('My.Derived', {
     extend: 'My.Base',

     constructor: function () {
         this.callParent([21]);
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // alerts 21

This can be used with an override as follows:

 Ext.define('My.DerivedOverride', {
     override: 'My.Derived',

     constructor: function (x) {
         this.callParent([x*2]); // calls original My.Derived constructor
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // now alerts 42

This also works with static methods.

 Ext.define('My.Derived2', {
     extend: 'My.Base',

     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Base.method
         }
     }
 });

 alert(My.Base.method(10);     // alerts 10
 alert(My.Derived2.method(10); // alerts 20

Lastly, it also works with overridden static methods.

 Ext.define('My.Derived2Override', {
     override: 'My.Derived2',

     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Derived2.method
         }
     }
 });

 alert(My.Derived2.method(10); // now alerts 40

To override a method and replace it and also call the superclass method, use callSuper. This is often done to patch a method to fix a bug.

Available since: 4.0.0

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

Returns

  • Object

    Returns the result of calling the parent method

( args ) : Objectprotected
This method is used by an override to call the superclass method but bypass any overridden method. ...

This method is used by an override to call the superclass method but bypass any overridden method. This is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.

Consider:

 Ext.define('Ext.some.Class', {
     method: function () {
         console.log('Good');
     }
 });

 Ext.define('Ext.some.DerivedClass', {
     method: function () {
         console.log('Bad');

         // ... logic but with a bug ...

         this.callParent();
     }
 });

To patch the bug in DerivedClass.method, the typical solution is to create an override:

 Ext.define('App.paches.DerivedClass', {
     override: 'Ext.some.DerivedClass',

     method: function () {
         console.log('Fixed');

         // ... logic but with bug fixed ...

         this.callSuper();
     }
 });

The patch method cannot use callParent to call the superclass method since that would call the overridden method containing the bug. In other words, the above patch would only produce "Fixed" then "Good" in the console log, whereas, using callParent would produce "Fixed" then "Bad" then "Good".

Available since: Ext JS 4.1.3

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

Returns

  • Object

    Returns the result of calling the superclass method

...

Available since: 4.1.1

constrains to datapoints between minimum and maximum only ...

constrains to datapoints between minimum and maximum only

Available since: 4.1.0

Renders the axis into the screen and updates its position. ...

Renders the axis into the screen and updates its position.

Available since: 4.0.0

Parameters

Overrides: Ext.chart.axis.Abstract.drawAxis

Renders an horizontal and/or vertical grid into the Surface. ...

Renders an horizontal and/or vertical grid into the Surface.

Available since: 4.0.0

...

Available since: 4.0.0

Renders the labels in the axes. ...

Renders the labels in the axes.

Available since: 4.0.0

( maxWidth, maxHeight )private
draws the title for the axis. ...

draws the title for the axis.

Available since: 4.0.0

Parameters

...

Available since: 4.0.0

...

Available since: 4.1.0

Parameters

...

Available since: 4.0.2

Returns the initial configuration passed to constructor when instantiating this class. ...

Returns the initial configuration passed to constructor when instantiating this class.

Available since: 4.1.0

Parameters

  • name : String (optional)

    Name of the config option to return.

Returns

  • Object/Mixed

    The full config object or a single config value when name parameter specified.

...

Available since: 4.0.0

Parameters

...

Available since: 4.0.7

...

Available since: 4.1.0

Parameters

( config ) : Ext.Basechainableprotected
Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

Ext.define('My.awesome.Class', {
    // The default config
    config: {
        name: 'Awesome',
        isAwesome: true
    },

    constructor: function(config) {
        this.initConfig(config);
    }
});

var awesome = new My.awesome.Class({
    name: 'Super Awesome'
});

alert(awesome.getName()); // 'Super Awesome'

Available since: 4.0.0

Parameters

Returns

...

Available since: 4.0.0

Parameters

( names, callback, scope )private
...

Available since: 4.1.0

Parameters

Ext.chart.axis.Time
view source
( )private
Before rendering, set current default step count to be number of records. ...

Before rendering, set current default step count to be number of records.

Available since: 4.0.0

Overrides: Ext.chart.axis.Numeric.processView

...

Available since: 4.0.0

Parameters

...

Available since: 4.0.0

Parameters

( config, applyIfNotSet ) : Ext.Basechainableprivate
...

Available since: 4.0.0

Parameters

Returns

Updates the title of this axis. ...

Updates the title of this axis.

Available since: 4.0.0

Parameters

Get the reference to the class from which this object was instantiated. ...

Get the reference to the class from which this object was instantiated. Note that unlike self, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

Ext.define('My.Cat', {
    statics: {
        totalCreated: 0,
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        var statics = this.statics();

        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                        // equivalent to: My.Cat.speciesName

        alert(this.self.speciesName);   // dependent on 'this'

        statics.totalCreated++;
    },

    clone: function() {
        var cloned = new this.self;                      // dependent on 'this'

        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName

        return cloned;
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',

    statics: {
        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
    },

    constructor: function() {
        this.callParent();
    }
});

var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'

var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
alert(clone.groupName);                 // alerts 'Cat'

alert(My.Cat.totalCreated);             // alerts 3

Available since: 4.0.0

Returns

Defined By

Static Methods

( config )privatestatic
...

Available since: 4.1.1

Parameters

( members )chainableprivatestatic
...

Available since: 4.1.1

Parameters

( name, member )chainableprivatestatic
...

Available since: 4.1.1

Parameters

( members )chainablestatic
Add methods / properties to the prototype of this class. ...

Add methods / properties to the prototype of this class.

Ext.define('My.awesome.Cat', {
    constructor: function() {
        ...
    }
});

 My.awesome.Cat.addMembers({
     meow: function() {
        alert('Meowww...');
     }
 });

 var kitty = new My.awesome.Cat;
 kitty.meow();

Available since: 4.1.0

Parameters

( members ) : Ext.Basechainablestatic
Add / override static properties of this class. ...

Add / override static properties of this class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.addStatics({
    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
});

Available since: 4.0.2

Parameters

Returns

( xtype )chainableprivatestatic
...

Available since: 4.1.1

Parameters

( fromClass, members ) : Ext.Basechainableprivatestatic
Borrow another class' members to the prototype of this class. ...

Borrow another class' members to the prototype of this class.

Ext.define('Bank', {
    money: '$$$',
    printMoney: function() {
        alert('$$$$$$$');
    }
});

Ext.define('Thief', {
    ...
});

Thief.borrow(Bank, ['money', 'printMoney']);

var steve = new Thief();

alert(steve.money); // alerts '$$$'
steve.printMoney(); // alerts '$$$$$$$'

Available since: 4.0.2

Parameters

  • fromClass : Ext.Base

    The class to borrow members from

  • members : Array/String

    The names of the members to borrow

Returns

Create a new instance of this Class. ...

Create a new instance of this Class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.create({
    someConfig: true
});

All parameters are passed to the constructor of the class.

Available since: 4.0.2

Returns

( alias, origin )static
Create aliases for existing prototype methods. ...

Create aliases for existing prototype methods. Example:

Ext.define('My.cool.Class', {
    method1: function() { ... },
    method2: function() { ... }
});

var test = new My.cool.Class();

My.cool.Class.createAlias({
    method3: 'method1',
    method4: 'method2'
});

test.method3(); // test.method1()

My.cool.Class.createAlias('method5', 'method3');

test.method5(); // test.method3() -> test.method1()

Available since: 4.0.2

Parameters

( config )privatestatic
...

Available since: 4.1.1

Parameters

Get the current class' name in string format. ...

Get the current class' name in string format.

Ext.define('My.cool.Class', {
    constructor: function() {
        alert(this.self.getName()); // alerts 'My.cool.Class'
    }
});

My.cool.Class.getName(); // 'My.cool.Class'

Available since: 4.0.4

Returns

( )deprecatedstatic
Adds members to class. ...

Adds members to class.

This method has been deprecated since 4.1

Use addMembers instead.

Available since: 4.0.2

( name, mixinClass )chainableprivatestatic
Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

Available since: 4.1.1

Parameters

( fn, scope )chainableprivatestatic
...

Available since: 4.1.1

Parameters

( members ) : Ext.Basechainabledeprecatedstatic
Override members of this class. ...

Override members of this class. Overridden methods can be invoked via callParent.

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

As of 4.1, direct use of this method is deprecated. Use Ext.define instead:

Ext.define('My.CatOverride', {
    override: 'My.Cat',
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

This method has been deprecated since 4.1.0

Use Ext.define instead

Available since: 4.0.2

Parameters

  • members : Object

    The properties to add to this class. This should be specified as an object literal containing one or more properties.

Returns

...

Available since: 4.1.1