Docs Help

Terms, Icons, and Labels Access Levels Member Types Member Syntax Member Flags Class Icons Member Icons Navigation and Features Class Member Quick-Nav Menu Getter and Setter Methods History Bar Search and Filters API Doc Class Metadata Expanding and Collapsing Examples and Class Members Desktop -vs- Mobile View Viewing the Class Source

Terms, Icons, and Labels

Many classes have shortcut names used when creating (instantiating) a class with a configuration object. The shortcut name is referred to as an alias (or xtype if the class extends Ext.Component). The alias/xtype is listed next to the class name of applicable classes for quick reference.

Access Levels

Framework classes or their members may be specified as private or protected. Else, the class / member is public. Public, protected, and private are access descriptors used to convey how and when the class or class member should be used.

Public classes and class members are available for use by any other class or application code and may be relied upon as a stable and persistent within major product versions. Public classes and members may safely be extended via a subclass.
Protected class members are stable public members intended to be used by the owning class or its subclasses. Protected members may safely be extended via a subclass.
Private classes and class members are used internally by the framework and are not intended to be used by application developers. Private classes and members may change or be omitted from the framework at any time without notice and should not be relied upon in application logic.

Member Types

Config - The configuration options for a class.
Property - Set once a class is instantiated. *See Read Only below.
Method - Actions that can be performed by a class. Methods should be read as instance methods and can only be called from a instance of a given class. Static methods that can be called directly from the class itself will have a static label next to the method name. *See Static below.
Event - Events are specific to the framework event system allowing for classes to programmatically raise an event to be handled by one or more event handler methods. DOM events, while handled by the framework event system, are not specifically described within the API documentation. *For DOM events refer to the event reference page from MDN.
Theme Variable - Variables used by the visual theme engine employed by the framework.
Theme Mixin - Functions used by the visual theme engine employed by the framework and may use values set in various Theme Variables.

Member Syntax

Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).

Ext.container.Container

view source

lookupComponent ( item ) : Ext.Component

protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item : Object

The config object being added.

Returns

Ext.Component

The component to be added.

Let's look at each part of the member row:

Expand/Collapse - On the left-hand size of the member row is a control used to expand and collapse each member row to show / hide member details.
Member Name - The name of the class member (lookupComponent in this example)
Method Param - Any required or optional params used by a method (or passed to an event handler method) will be listed next to the method name within parenthesis (( item ) in this example)
Return type - The class instance or javascript object returned by the method or property (Ext.Component in this case). This may be omitted for methods that do not return anything other than undefined or may display as multiple possible values separated by a forward slash / signifying that what is returned may depend on the results of the method call (i.e. a method may return a Component if a get method calls is successful or false if unsuccessful which would be displayed as Ext.Component/Boolean).
Flags - Any flags applicable to the member will be displayed next (PROTECTED in this example - see the Flags section below)
Member Origin - On the right-hand side of the member row is the class where the member was initially described (Ext.container.Container in this example). The source class will be displayed as a blue link if the member originates from the current class and gray if it is inherited from an ancestor or mixed-in class.
Member Source - On the right-hand side below the member origin class is a link to view the member's source (view source in the example)
Params List - Each param for a class method will be listed using the same name found above in parenthesis, the type of class or object expected, and a description of the param (item : Object in the example).
Returns - If a class returns a value other than undefined a "Returns" section will note the type of class or object returned and a description (Ext.Component in the example)
Since (not shown in the example) - Some members will show which version of the product the member was first introduced (i.e. Available since 3.4.0 - not pictured in the example) just after the member description
Default (not shown in the example) - Configs often show the default config value to be applied to a class instance if not overridden (i.e. Defaults to: false)

Member Flags

The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.

Required - Required config when instantiating a class
Bindable - The config has a setter which allows this config to be set via ViewModel binding
Read Only - The property may be read, but cannot be used to configure / re-configure a class instance at runtime
Singleton - Singleton classes are instantiated immediately once defined and may not be instantiated manually
Static - A static method or property is a method or property belonging to the class itself, not an instance of the class
Chainable - Refers to methods that return the class instance back when called.
This enables chained method calls like: classInstance.method1().method2().etc();
Deprecated - A class or member that is scheduled for removal in a future framework version and is provided in the current version for backwards compatibility.
Deprecated classes and members will have a message directing you to the preferred class / method going forward.
Removed - A removed class or member that exists in documentation only as a reference for users upgrading between framework versions
Template - A method defined within a base class designed to be overridden by subclasses
Abstract - A class or member may be be defined as abstract. Abstract classes and members establish a class structure and provide limited, if any, code. Class-specific code will be furnished via overrides in subclasses.
Preventable - Events marked preventable will not fire if false is returned from an event handler

Class Icons

- Indicates a framework class

- A singleton framework class. *See the singleton flag for more information

- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)

- Indicates that the class, member, or guide is new in the currently viewed version

Member Icons

- Indicates a class member of type config

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

- Indicates that the class, member, or guide is new in the currently viewed version

Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.

Getter and Setter Methods

Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.

History Bar

Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.

Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.

If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.

Search and Filters

Both API docs and guides can be searched for using the search field at the top of the page.

On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.

The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.

Clicking on an empty search field will show your last 10 searches for quick navigation.

API Doc Class Metadata

Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:

Alternate Name - One or more additional class name synonymns (in Ext JS 6.0.0 the Ext.button.Button class has an alternate class name of Ext.Button). Alternate class names are commonly maintained for backward compatibility.
Hierarchy - The hierararchy view lists the inheritance chain of the current class up through its ancestor classes up to the root base class.
Mixins - A list of classes that are mixed into the current class
Inherited Mixins - A list of classes that are mixed into an ancestor of the current class
Requires - All classes required to be defined for the class to be instantiated
Uses - A list of classes potentially used by the class at some point in its lifecycle, but not necessarily requried for the class to initially be instantiated
Subclasses - Classes that extend the current class

Expanding and Collapsing Examples and Class Members

Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.

Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.

Desktop -vs- Mobile View

Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:

Global navigation will be located in a menu on the left-hand side accessible via the hamburger menu icon. The menu houses the following (on most pages):
- The name of the current product (as a link to the product landing page)
- The Sencha icon used to navigate back to the documentation home page
- The product menu drop-down button
- Tabs of navigation trees for the API docs and guides
Current context navigation and tools is located on the right-hand side accessible via the gear icon. The context menu houses teh following:
- The global search input field
- (API doc) A "Filters" tab with the member filter, expand / collapse all examples button, expand / collapse all member rows button, the access level filter checkboxes, and the counts of each member
- (API doc) A "Related Classes" tab containing the menu of metadata related to the current class
- (Guides) The table of contents for the guide

Viewing the Class Source

The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.

Ext JS 6.6.0 - Classic Toolkit

Show private classes

top

Date

Hierarchy

Date

Summary

Creates Date instances which let you work with dates and times.

If you supply no arguments, the constructor creates a Date object for today's date and time according to local time. If you supply some arguments but not others, the missing arguments are set to 0. If you supply any arguments, you must supply at least the year, month, and day. You can omit the hours, minutes, seconds, and milliseconds.

The date is measured in milliseconds since midnight 01 January, 1970 UTC. A day holds 86,400,000 milliseconds. The Date object range is -100,000,000 days to 100,000,000 days relative to 01 January, 1970 UTC.

The Date object provides uniform behavior across platforms.

The Date object supports a number of UTC (universal) methods, as well as local time methods. UTC, also known as Greenwich Mean Time (GMT), refers to the time as set by the World Time Standard. The local time is the time known to the computer where JavaScript is executed.

Invoking Date in a non-constructor context (i.e., without the new operator) will return a string representing the current time.

Note that Date objects can only be instantiated by calling Date or using it as a constructor; unlike other JavaScript object types, Date objects have no literal syntax.

Several ways to assign dates

The following example shows several ways to assign dates:

today = new Date();
birthday = new Date("December 19, 1989 03:24:00");
birthday = new Date(1989,11,19);
birthday = new Date(1989,11,17,3,24,0);

Calculating elapsed time

The following examples show how to determine the elapsed time between two dates:

// using static methods
var start = Date.now();
// the event you'd like to time goes here:
doSomethingForALongTime();
var end = Date.now();
var elapsed = end - start; // time in milliseconds

// if you have Date objects
var start = new Date();
// the event you'd like to time goes here:
doSomethingForALongTime();
var end = new Date();
var elapsed = end.getTime() - start.getTime(); // time in milliseconds

// if you want to test a function and get back its return
function printElapsedTime (fTest) {
    var nStartTime = Date.now(), vReturn = fTest(), nEndTime = Date.now();
    alert("Elapsed time: " + String(nEndTime - nStartTime) + "
    milliseconds");
    return vReturn;
}

yourFunctionReturn = printElapsedTime(yourFunction);

ISO 8601 formatted dates

The following example shows how to formate a date in an ISO 8601 format using UTC:

// use a function for the exact format desired...
function ISODateString(d){
function pad(n){return n<10 ? '0'+n : n}
return d.getUTCFullYear()+'-'
    + pad(d.getUTCMonth()+1)+'-'
    + pad(d.getUTCDate())+'T'
    + pad(d.getUTCHours())+':'
    + pad(d.getUTCMinutes())+':'
    + pad(d.getUTCSeconds())+'Z'}

var d = new Date();
print(ISODateString(d)); // prints something like 2009-09-28T19:03:12Z

Documentation for this class comes from [MDN](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Date) and is available under [Creative Commons: Attribution-Sharealike license](http://creativecommons.org/licenses/by-sa/2.0/).

No members found using the current filters

properties

methods

Instance Methods

Date

view source

constructor ( [year], [month], [day], [hour], [minute], [second], [millisecond] )

Creates new Date object.

Parameters

year : Number/String (optional)

Either UNIX timestamp, date string, or year (when month and day parameters also provided):

Integer value representing the number of milliseconds since 1 January 1970 00:00:00 UTC (Unix Epoch).
String value representing a date. The string should be in a format recognized by the parse method (IETF-compliant RFC 1123 timestamps).
Integer value representing the year. For compatibility (in order to avoid the Y2K problem), you should always specify the year in full; use 1998, rather than 98.

month : Number (optional)

Integer value representing the month, beginning with 0 for January to 11 for December.

day : Number (optional)

Integer value representing the day of the month (1-31).

hour : Number (optional)

Integer value representing the hour of the day (0-23).

minute : Number (optional)

Integer value representing the minute segment (0-59) of a time reading.

second : Number (optional)

Integer value representing the second segment (0-59) of a time reading.

millisecond : Number (optional)

Integer value representing the millisecond segment (0-999) of a time reading.

Date

view source

getDate Number

Returns the day of the month for the specified date according to local time.

The second statement below assigns the value 25 to the variable day, based on the value of the Date object Xmas95.

Xmas95 = new Date("December 25, 1995 23:15:00")
day = Xmas95.getDate()

Returns

:Number

Value between 1 and 31.

Date

view source

getDay Number

Returns the day of the week for the specified date according to local time.

The value returned by getDay is an integer corresponding to the day of the week: 0 for Sunday, 1 for Monday, 2 for Tuesday, and so on.

The second statement below assigns the value 1 to weekday, based on the value of the Date object Xmas95. December 25, 1995, is a Monday.

Xmas95 = new Date("December 25, 1995 23:15:00");
weekday = Xmas95.getDay();

Returns

:Number

A numeric representation of the day from Sunday (0) to Saturday (6).

Date

view source

getFullYear Number

Returns the year of the specified date according to local time.

The value returned by getFullYear is an absolute number. For dates between the years 1000 and 9999, getFullYear returns a four-digit number, for example, 1995. Use this function to make sure a year is compliant with years after 2000.

Use this method instead of the getYear method.

The following example assigns the four-digit value of the current year to the variable yr.

var today = new Date();
var yr = today.getFullYear();

Returns

:Number

Four digit representation of the year.

Date

view source

getHours Number

Returns the hour for the specified date according to local time.

The second statement below assigns the value 23 to the variable hours, based on the value of the Date object Xmas95.

Xmas95 = new Date("December 25, 1995 23:15:00")
hours = Xmas95.getHours()

Returns

:Number

Value between 0 and 23, using 24-hour clock.

Date

view source

getMilliseconds Number

Returns the milliseconds in the specified date according to local time.

The following example assigns the milliseconds portion of the current time to the variable ms.

var ms;
Today = new Date();
ms = Today.getMilliseconds();

Returns

:Number

A number between 0 and 999.

Date

view source

getMinutes Number

Returns the minutes in the specified date according to local time.

The second statement below assigns the value 15 to the variable minutes, based on the value of the Date object Xmas95.

Xmas95 = new Date("December 25, 1995 23:15:00")
minutes = Xmas95.getMinutes()

Returns

:Number

Value between 0 and 59.

Date

view source

getMonth Number

Returns the month in the specified date according to local time.

The second statement below assigns the value 11 to the variable month, based on the value of the Date object Xmas95.

Xmas95 = new Date("December 25, 1995 23:15:00")
month = Xmas95.getMonth()

Returns

:Number

An integer between 0 and 11. 0 corresponds to January, 1 to February, and so on.

Date

view source

getSeconds Number

Returns the seconds in the specified date according to local time.

The second statement below assigns the value 30 to the variable secs, based on the value of the Date object Xmas95.

Xmas95 = new Date("December 25, 1995 23:15:30")
secs = Xmas95.getSeconds()

Returns

:Number

Value between 0 and 59.

Date

view source

getTime Number

Returns the numeric value corresponding to the time for the specified date according to universal time.

The value returned by the getTime method is the number of milliseconds since 1 January 1970 00:00:00 UTC. You can use this method to help assign a date and time to another Date object.

This method is functionally equivalent to the valueOf method.

Using getTime for copying dates

Constructing a date object with the identical time value.

var birthday = new Date(1994, 12, 10);
var copy = new Date();
copy.setTime(birthday.getTime());

Measuring execution time

Subtracting two subsequent getTime calls on newly generated Date objects, give the time span between these two calls. This can be used to calculate the executing time of some operations.

var end, start;

start = new Date();
for (var i = 0; i < 1000; i++)
    Math.sqrt(i);
end = new Date();

console.log("Operation took " + (end.getTime() - start.getTime()) + " msec");

Returns

:Number

Number of milliseconds since 1/1/1970 (GMT).

Date

view source

getTimezoneOffset Number

Returns the time-zone offset from UTC, in minutes, for the current locale.

The time-zone offset is the difference, in minutes, between UTC and local time. Note that this means that the offset is positive if the local timezone is behind UTC and negative if it is ahead. For example, if your time zone is UTC+10 (Australian Eastern Standard Time), -600 will be returned. Daylight savings time prevents this value from being a constant even for a given locale

x = new Date()
currentTimeZoneOffsetInHours = x.getTimezoneOffset()/60

Returns

:Number

Minutes between GMT and local time.

Date

view source

getUTCDate Number

Returns the day (date) of the month in the specified date according to universal time.

The following example assigns the day portion of the current date to the variable d.

var d;
Today = new Date();
d = Today.getUTCDate();

Returns

:Number

Integer between 1 and 31 representing the day.

Date

view source

getUTCDay Number

Returns the day of the week in the specified date according to universal time.

The following example assigns the weekday portion of the current date to the variable weekday.

var weekday;
Today = new Date()
weekday = Today.getUTCDay()

Returns

:Number

A numeric representation of the day from Sunday (0) to Saturday (6).

Date

view source

getUTCFullYear Number

Returns the year in the specified date according to universal time.

The following example assigns the four-digit value of the current year to the variable yr.

var yr;
Today = new Date();
yr = Today.getUTCFullYear();

Returns

:Number

Four digit representation of the year.

Date

view source

getUTCHours Number

Returns the hours in the specified date according to universal time.

The following example assigns the hours portion of the current time to the variable hrs.

var hrs;
Today = new Date();
hrs = Today.getUTCHours();

Returns

:Number

Value between 0 and 23.

Date

view source

getUTCMilliseconds Number

Returns the milliseconds in the specified date according to universal time.

The following example assigns the milliseconds portion of the current time to the variable ms.

var ms;
Today = new Date();
ms = Today.getUTCMilliseconds();

Returns

:Number

Milliseconds portion of the Date.

Date

view source

getUTCMinutes Number

Returns the minutes in the specified date according to universal time.

The following example assigns the minutes portion of the current time to the variable min.

var min;
Today = new Date();
min = Today.getUTCMinutes();

Returns

:Number

Value between 0 and 59.

Date

view source

getUTCMonth Number

Returns the month of the specified date according to universal time.

The following example assigns the month portion of the current date to the variable mon.

var mon;
Today = new Date();
mon = Today.getUTCMonth();

Returns

:Number

Value between 0 (January) and 11 (December).

Date

view source

getUTCSeconds Number

Returns the seconds in the specified date according to universal time.

The following example assigns the seconds portion of the current time to the variable sec.

var sec;
Today = new Date();
sec = Today.getUTCSeconds();

Returns

:Number

Value between 0 and 59.

Date

view source

setDate ( dayValue ) : Number

Sets the day of the month (1-31) for a specified date according to local time.

If the parameter you specify is outside of the expected range, setDate attempts to update the date information in the Date object accordingly. For example, if you use 0 for dayValue, the date will be set to the last day of the previous month.

The second statement below changes the day for theBigDay to July 24 from its original value.

theBigDay = new Date("July 27, 1962 23:30:00")
theBigDay.setDate(24)

Parameters

dayValue : Number

An integer from 1 to 31, representing the day of the month.

Returns

:Number

New date represented as milliseconds.

Date

view source

setFullYear ( yearValue, monthValue, dayValue ) : Number

Sets the full year (4 digits for 4-digit years) for a specified date according to local time.

If you do not specify the monthValue and dayValue parameters, the values returned from the getMonth and getDate methods are used.

If a parameter you specify is outside of the expected range, setFullYear attempts to update the other parameters and the date information in the Date object accordingly. For example, if you specify 15 for monthValue, the year is incremented by 1 (year + 1), and 3 is used for the month.

theBigDay = new Date(); theBigDay.setFullYear(1997);

Parameters

yearValue : Number

An integer specifying the numeric value of the year, for example, 1995.

monthValue : Number

An integer between 0 and 11 representing the months January through December.

dayValue : Number

An integer between 1 and 31 representing the day of the month. If you specify the dayValue parameter, you must also specify the monthValue.

Returns

:Number

New date represented as milliseconds.

Date

view source

setHours ( hoursValue, minutesValue, secondsValue, msValue ) : Number

Sets the hours (0-23) for a specified date according to local time.

If you do not specify the minutesValue, secondsValue, and msValue parameters, the values returned from the getUTCMinutes, getUTCSeconds, and getMilliseconds methods are used.

If a parameter you specify is outside of the expected range, setHours attempts to update the date information in the Date object accordingly. For example, if you use 100 for secondsValue, the minutes will be incremented by 1 (min + 1), and 40 will be used for seconds.

theBigDay.setHours(7)

Parameters

hoursValue : Number

An integer between 0 and 23, representing the hour.

minutesValue : Number

An integer between 0 and 59, representing the minutes.

secondsValue : Number

An integer between 0 and 59, representing the seconds. If you specify the secondsValue parameter, you must also specify the minutesValue.

msValue : Number

A number between 0 and 999, representing the milliseconds. If you specify the msValue parameter, you must also specify the minutesValue and secondsValue.

Returns

:Number

New date represented as milliseconds.

Date

view source

setMilliseconds ( millisecondsValue ) : Number

Sets the milliseconds (0-999) for a specified date according to local time.

If you specify a number outside the expected range, the date information in the Date object is updated accordingly. For example, if you specify 1005, the number of seconds is incremented by 1, and 5 is used for the milliseconds.

theBigDay = new Date();
theBigDay.setMilliseconds(100);

Parameters

millisecondsValue : Number

A number between 0 and 999, representing the milliseconds.

Returns

:Number

New date represented as milliseconds.

Date

view source

setMinutes ( minutesValue, secondsValue, msValue ) : Number

Sets the minutes (0-59) for a specified date according to local time.

If you do not specify the secondsValue and msValue parameters, the values returned from getSeconds and getMilliseconds methods are used.

If a parameter you specify is outside of the expected range, setMinutes attempts to update the date information in the Date object accordingly. For example, if you use 100 for secondsValue, the minutes (minutesValue) will be incremented by 1 (minutesValue + 1), and 40 will be used for seconds.

theBigDay.setMinutes(45)

Parameters

minutesValue : Number

An integer between 0 and 59, representing the minutes.

secondsValue : Number

An integer between 0 and 59, representing the seconds. If you specify the secondsValue parameter, you must also specify the minutesValue.

msValue : Number

A number between 0 and 999, representing the milliseconds. If you specify the msValue parameter, you must also specify the minutesValue and secondsValue.

Returns

:Number

New date represented as milliseconds.

Date

view source

setMonth ( monthValue, dayValue ) : Number

Sets the month (0-11) for a specified date according to local time.

If you do not specify the dayValue parameter, the value returned from the getDate method is used.

If a parameter you specify is outside of the expected range, setMonth attempts to update the date information in the Date object accordingly. For example, if you use 15 for monthValue, the year will be incremented by 1 (year + 1), and 3 will be used for month.

theBigDay.setMonth(6)

Parameters

monthValue : Number

An integer between 0 and 11 (representing the months January through December).

dayValue : Number

An integer from 1 to 31, representing the day of the month.

Returns

:Number

New date represented as milliseconds.

Date

view source

setSeconds ( secondsValue, msValue ) : Number

Sets the seconds (0-59) for a specified date according to local time.

If you do not specify the msValue parameter, the value returned from the getMilliseconds method is used.

If a parameter you specify is outside of the expected range, setSeconds attempts to update the date information in the Date object accordingly. For example, if you use 100 for secondsValue, the minutes stored in the Date object will be incremented by 1, and 40 will be used for seconds.

theBigDay.setSeconds(30)

Parameters

secondsValue : Number

An integer between 0 and 59.

msValue : Number

A number between 0 and 999, representing the milliseconds. If you specify themsValue parameter, you must also specify the minutesValue and secondsValue.

Returns

:Number

New date represented as milliseconds.

Date

view source

setTime ( timeValue ) : Number

Sets the Date object to the time represented by a number of milliseconds since January 1, 1970, 00:00:00 UTC, allowing for negative numbers for times prior.

Use the setTime method to help assign a date and time to another Date object.

theBigDay = new Date("July 1, 1999")
sameAsBigDay = new Date()
sameAsBigDay.setTime(theBigDay.getTime())

Parameters

timeValue : Number

An integer representing the number of milliseconds since 1 January 1970, 00:00:00 UTC.

Returns

:Number

New date represented as milliseconds.

Date

view source

setUTCDate ( dayValue ) : Number

Sets the day of the month (1-31) for a specified date according to universal time.

If a parameter you specify is outside of the expected range, setUTCDate attempts to update the date information in the Date object accordingly. For example, if you use 40 for dayValue, and the month stored in the Date object is June, the day will be changed to 10 and the month will be incremented to July.

theBigDay = new Date();
theBigDay.setUTCDate(20);

Parameters

dayValue : Number

An integer from 1 to 31, representing the day of the month.

Returns

:Number

New date represented as milliseconds.

Date

view source

setUTCFullYear ( yearValue, monthValue, dayValue ) : Number

Sets the full year (4 digits for 4-digit years) for a specified date according to universal time.

If you do not specify the monthValue and dayValue parameters, the values returned from the getMonth and getDate methods are used.

If a parameter you specify is outside of the expected range, setUTCFullYear attempts to update the other parameters and the date information in the Date object accordingly. For example, if you specify 15 for monthValue, the year is incremented by 1 (year + 1), and 3 is used for the month.

theBigDay = new Date();
theBigDay.setUTCFullYear(1997);

Parameters

yearValue : Number

An integer specifying the numeric value of the year, for example, 1995.

monthValue : Number

An integer between 0 and 11 representing the months January through December.

dayValue : Number

An integer between 1 and 31 representing the day of the month. If you specify the dayValue parameter, you must also specify the monthValue.

Returns

:Number

New date represented as milliseconds.

Date

view source

setUTCHours ( hoursValue, minutesValue, secondsValue, msValue ) : Number

Sets the hour (0-23) for a specified date according to universal time.

If you do not specify the minutesValue, secondsValue, and msValue parameters, the values returned from the getUTCMinutes, getUTCSeconds, and getUTCMilliseconds methods are used.

If a parameter you specify is outside of the expected range, setUTCHours attempts to update the date information in the Date object accordingly. For example, if you use 100 for secondsValue, the minutes will be incremented by 1 (min + 1), and 40 will be used for seconds.

theBigDay = new Date();
theBigDay.setUTCHours(8);

Parameters

hoursValue : Number

An integer between 0 and 23, representing the hour.

minutesValue : Number

An integer between 0 and 59, representing the minutes.

secondsValue : Number

An integer between 0 and 59, representing the seconds. If you specify the secondsValue parameter, you must also specify the minutesValue.

msValue : Number

A number between 0 and 999, representing the milliseconds. If you specify the msValue parameter, you must also specify the minutesValue and secondsValue.

Returns

:Number

New date represented as milliseconds.

Date

view source

setUTCMilliseconds ( millisecondsValue ) : Number

Sets the milliseconds (0-999) for a specified date according to universal time.

If a parameter you specify is outside of the expected range, setUTCMilliseconds attempts to update the date information in the Date object accordingly. For example, if you use 1100 for millisecondsValue, the seconds stored in the Date object will be incremented by 1, and 100 will be used for milliseconds.

theBigDay = new Date();
theBigDay.setUTCMilliseconds(500);

Parameters

millisecondsValue : Number

A number between 0 and 999, representing the milliseconds.

Returns

:Number

New date represented as milliseconds.

Date

view source

setUTCMinutes ( minutesValue, secondsValue, msValue ) : Number

Sets the minutes (0-59) for a specified date according to universal time.

If you do not specify the secondsValue and msValue parameters, the values returned from getUTCSeconds and getUTCMilliseconds methods are used.

If a parameter you specify is outside of the expected range, setUTCMinutes attempts to update the date information in the Date object accordingly. For example, if you use 100 for secondsValue, the minutes (minutesValue) will be incremented by 1 (minutesValue + 1), and 40 will be used for seconds.

theBigDay = new Date();
theBigDay.setUTCMinutes(43);

Parameters

minutesValue : Number

An integer between 0 and 59, representing the minutes.

Returns the "date" portion of the Date as a string, using the current locale's conventions.

The toLocaleDateString method relies on the underlying operating system in formatting dates. It converts the date to a string using the formatting convention of the operating system where the script is running. For example, in the United States, the month appears before the date (04/15/98), whereas in Germany the date appears before the month (15.04.98). If the operating system is not year-2000 compliant and does not use the full year for years before 1900 or over 2000, toLocaleDateString returns a string that is not year-2000 compliant. toLocaleDateString behaves similarly to toString when converting a year that the operating system does not properly format.

Methods such as getDate, getMonth, and getFullYear give more portable results than toLocaleDateString. Use toLocaleDateString when the intent is to display to the user a string formatted using the regional format chosen by the user. Be aware that this method, due to its nature, behaves differently depending on the operating system and on the user's settings.

In the following example, today is a Date object:

today = new Date(95,11,18,17,28,35) //months are represented by 0 to 11
today.toLocaleDateString()

In this example, toLocaleDateString returns a string value that is similar to the following form. The exact format depends on the platform, locale and user's settings.

12/18/95

You shouldn't use this method in contexts where you rely on a particular format or locale.

"Last visit: " + someDate.toLocaleDateString(); // Good example
"Last visit was at " + someDate.toLocaleDateString(); // Bad example

Returns

:String

Human-readable string that may be formatted differently depending on the country.

Date

view source

toLocaleString String

Converts a date to a string, using the current locale's conventions. Overrides the Object.toLocaleString method.

The toLocaleString method relies on the underlying operating system in formatting dates. It converts the date to a string using the formatting convention of the operating system where the script is running. For example, in the United States, the month appears before the date (04/15/98), whereas in Germany the date appears before the month (15.04.98). If the operating system is not year-2000 compliant and does not use the full year for years before 1900 or over 2000, toLocaleString returns a string that is not year-2000 compliant. toLocaleString behaves similarly to toString when converting a year that the operating system does not properly format.

Methods such as getDate, getMonth, getFullYear, getHours, getMinutes, and getSeconds give more portable results than toLocaleString. Use toLocaleString when the intent is to display to the user a string formatted using the regional format chosen by the user. Be aware that this method, due to its nature, behaves differently depending on the operating system and on the user's settings.

In the following example, today is a Date object:

today = new Date(95,11,18,17,28,35); //months are represented by 0 to 11
today.toLocaleString();

In this example, toLocaleString returns a string value that is similar to the following form. The exact format depends on the platform, locale and user's settings.

12/18/95 17:28:35

You shouldn't use this method in contexts where you rely on a particular format or locale.

"Last visit: " + someDate.toLocaleString(); // Good example
"Last visit was at " + someDate.toLocaleString(); // Bad example

Returns

:String

Human-readable string that may be formatted differently depending on the country.

Date

view source

toLocaleTimeString String

Returns the "time" portion of the Date as a string, using the current locale's conventions.

The toLocaleTimeString method relies on the underlying operating system in formatting dates. It converts the date to a string using the formatting convention of the operating system where the script is running. For example, in the United States, the month appears before the date (04/15/98), whereas in Germany the date appears before the month (15.04.98).

Methods such as getHours, getMinutes, and getSeconds give more consistent results than toLocaleTimeString. Use toLocaleTimeString when the intent is to display to the user a string formatted using the regional format chosen by the user. Be aware that this method, due to its nature, behaves differently depending on the operating system and on the user's settings.

In the following example, today is a Date object:

today = new Date(95,11,18,17,28,35) //months are represented by 0 to 11
today.toLocaleTimeString()

In this example, toLocaleTimeString returns a string value that is similar to the following form. The exact format depends on the platform.

17:28:35

You shouldn't use this method in contexts where you rely on a particular format or locale.

"Last visit: " + someDate.toLocaleTimeString(); // Good example
"Last visit was at " + someDate.toLocaleTimeString(); // Bad example

Returns

:String

Human-readable string that may be formatted differently depending on the country.

Date

view source

toString String

Returns a string representing the specified Date object. Overrides the Object.prototype.toString method.

The Date object overrides the toString method of the Object object; it does not inherit Object.toString. For Date objects, the toString method returns a string representation of the object.

toString always returns a string representation of the date in American English.

JavaScript calls the toString method automatically when a date is to be represented as a text value or when a date is referred to in a string concatenation.

The following assigns the toString value of a Date object to myVar:

x = new Date();
myVar=x.toString();   //assigns a value to myVar similar to:
//Mon Sep 28 1998 14:36:22 GMT-0700 (Pacific Daylight Time)

Returns

:String

Human-readable string of the date in local time.

Date

view source

toTimeString String

Returns the "time" portion of the Date as a human-readable string.

Date instances refer to a specific point in time. Calling toString will return the date formatted in a human readable form in American English. In SpiderMonkey, this consists of the date portion (day, month, and year) followed by the time portion (hours, minutes, seconds, and time zone). Sometimes it is desirable to obtain a string of the time portion; such a thing can be accomplished with the toTimeString method.

The toTimeString method is especially useful because compliant engines implementing ECMA-262 may differ in the string obtained from toString for Date objects, as the format is implementation- dependent; simple string slicing approaches may not produce consistent results across multiple engines.

var d = new Date(1993, 6, 28, 14, 39, 7);
println(d.toString()); // prints Wed Jul 28 1993 14:39:07 GMT-0600 (PDT)
println(d.toTimeString()); // prints 14:39:07 GMT-0600 (PDT)

Returns

:String

Human-readable string of the date in local time.

Date

view source

toUTCString String

Converts a date to a string, using the universal time convention.

The value returned by toUTCString is a readable string in American English in the UTC time zone. The format of the return value may vary according to the platform.

var today = new Date();
var UTCstring = today.toUTCString();
// Mon, 03 Jul 2006 21:44:38 GMT

Returns

:String

String of the date in UTC.

Date

view source

valueOf Number

Returns the primitive value of a Date object. Overrides the Object.prototype.valueOf method.

The valueOf method returns the primitive value of a Date object as a number data type, the number of milliseconds since midnight 01 January, 1970 UTC.

This method is functionally equivalent to the getTime method.

This method is usually called internally by JavaScript and not explicitly in code.

x = new Date(56, 6, 17);
myVar = x.valueOf();      //assigns -424713600000 to myVar

Returns

:Number

Date represented as milliseconds.

Static Methods

Date

view source

now Number
static sta

Returns the numeric value corresponding to the current time.

The now method returns the milliseconds elapsed since 1 January 1970 00:00:00 UTC up until now as a number.

When using now to create timestamps or unique IDs, keep in mind that the resolution may be 15 milliseconds on Windows, so you could end up with several equal values if now is called multiple times within a short time span.

Returns

:Number

Returns the number of milliseconds elapsed since 1 January 1970 00:00:00 UTC.

Date

view source

parse ( dateString ) : Number
static sta

Parses a string representation of a date, and returns the number of milliseconds since January 1, 1970, 00:00:00, local time.

The parse method takes a date string (such as "Dec 25, 1995") and returns the number of milliseconds since January 1, 1970, 00:00:00 UTC. The local time zone is used to interpret arguments that do not contain time zone information. This function is useful for setting date values based on string values, for example in conjunction with the setTime method and the Date object.

Given a string representing a time, parse returns the time value. It accepts the IETF standard (RFC 1123 Section 5.2.14 and elsewhere) date syntax: "Mon, 25 Dec 1995 13:30:00 GMT". It understands the continental US time-zone abbreviations, but for general use, use a time-zone offset, for example, "Mon, 25 Dec 1995 13:30:00 GMT+0430" (4 hours, 30 minutes east of the Greenwich meridian). If you do not specify a time zone, the local time zone is assumed. GMT and UTC are considered equivalent.

Using parse

If IPOdate is an existing Date object, then you can set it to August 9, 1995 (local time) as follows:

IPOdate.setTime(Date.parse("Aug 9, 1995"));

Some other examples:

// Returns 807937200000 in time zone GMT-0300, and other values in other
// timezones, since the argument does not specify a time zone.
Date.parse("Aug 9, 1995");

// Returns 807926400000 no matter the local time zone.
Date.parse("Wed, 09 Aug 1995 00:00:00 GMT");

// Returns 807937200000 in timezone GMT-0300, and other values in other
// timezones, since there is no time zone specifier in the argument.
Date.parse("Wed, 09 Aug 1995 00:00:00");

// Returns 0 no matter the local time zone.
Date.parse("Thu, 01 Jan 1970 00:00:00 GMT");

// Returns 14400000 in timezone GMT-0400, and other values in other
// timezones, since there is no time zone specifier in the argument.
Date.parse("Thu, 01 Jan 1970 00:00:00");

// Returns 14400000 no matter the local time zone.
Date.parse("Thu, 01 Jan 1970 00:00:00 GMT-0400");

Parameters

dateString : String

A string representing a date.

Returns

:Number

Number of milliseconds since January 1, 1970, 00:00:00, local time.

Date

view source

UTC ( year, month, date, hrs, min, sec, ms ) : Number
static sta

Accepts the same parameters as the longest form of the constructor, and returns the number of milliseconds in a Date object since January 1, 1970, 00:00:00, universal time.

UTC takes comma-delimited date parameters and returns the number of milliseconds between January 1, 1970, 00:00:00, universal time and the time you specified.

You should specify a full year for the year; for example, 1998. If a year between 0 and 99 is specified, the method converts the year to a year in the 20th century (1900 + year); for example, if you specify 95, the year 1995 is used.

The UTC method differs from the Date constructor in two ways.

Date.UTC uses universal time instead of the local time.
Date.UTC returns a time value as a number instead of creating a Date object.

If a parameter you specify is outside of the expected range, the UTC method updates the other parameters to allow for your number. For example, if you use 15 for month, the year will be incremented by 1 (year + 1), and 3 will be used for the month.

Because UTC is a static method of Date, you always use it as Date.UTC(), rather than as a method of a Date object you created. The following statement creates a Date object using GMT instead of local time:

gmtDate = new Date(Date.UTC(96, 11, 1, 0, 0, 0));

Parameters

year : Number

A year after 1900.

month : Number

An integer between 0 and 11 representing the month.

date : Number

An integer between 1 and 31 representing the day of the month.

hrs : Number

An integer between 0 and 23 representing the hours.

min : Number

An integer between 0 and 59 representing the minutes.

sec : Number

An integer between 0 and 59 representing the seconds.

ms : Number

An integer between 0 and 999 representing the milliseconds.

Returns

:Number

Number of milliseconds since January 1, 1970, 00:00:00, universal time.

Contents

Terms, Icons, and Labels

Access Levels

Member Types

Member Syntax

Member Flags

Class Icons

Member Icons

Navigation and Features

Class Member Quick-Nav Menu

Getter and Setter Methods

History Bar

Search and Filters

API Doc Class Metadata

Expanding and Collapsing Examples and Class Members

Desktop -vs- Mobile View

Viewing the Class Source

Ext JS 6.6.0 - Classic Toolkit

Date

Hierarchy

Summary

Several ways to assign dates

Calculating elapsed time

ISO 8601 formatted dates

properties

methods

constructor ( [year], [month], [day], [hour], [minute], [second], [millisecond] )

Parameters

getDate Number

Returns

getDay Number

Returns

getFullYear Number

Returns

getHours Number

Returns

getMilliseconds Number

Returns

getMinutes Number

Returns

getMonth Number

Returns

getSeconds Number

Returns

getTime Number

Returns

getTimezoneOffset Number

Returns

getUTCDate Number

Returns

getUTCDay Number

Returns

getUTCFullYear Number

Returns

getUTCHours Number

Returns

getUTCMilliseconds Number

Returns

getUTCMinutes Number

Returns

getUTCMonth Number

Returns

getUTCSeconds Number

Returns

setDate ( dayValue ) : Number

Parameters

Returns

setFullYear ( yearValue, monthValue, dayValue ) : Number

Parameters

Returns

setHours ( hoursValue, minutesValue, secondsValue, msValue ) : Number

Parameters

Returns

setMilliseconds ( millisecondsValue ) : Number

Parameters

Returns

setMinutes ( minutesValue, secondsValue, msValue ) : Number

Parameters

Returns

setMonth ( monthValue, dayValue ) : Number

now Number
static sta

parse ( dateString ) : Number
static sta

UTC ( year, month, date, hrs, min, sec, ms ) : Number
static sta