Ext JS 4.2.0 Sencha Docs

Ext.data.Store

Hierarchy

Inherited mixins

Requires

Subclasses

Uses

Files

The Store class encapsulates a client side cache of Model objects. Stores load data via a Proxy, and also provide functions for sorting, filtering and querying the model instances contained within it.

Creating a Store is easy - we just tell it the Model and the Proxy to use for loading and saving its data:

 // Set up a model to use in our Store
 Ext.define('User', {
     extend: 'Ext.data.Model',
     fields: [
         {name: 'firstName', type: 'string'},
         {name: 'lastName',  type: 'string'},
         {name: 'age',       type: 'int'},
         {name: 'eyeColor',  type: 'string'}
     ]
 });

 var myStore = Ext.create('Ext.data.Store', {
     model: 'User',
     proxy: {
         type: 'ajax',
         url: '/users.json',
         reader: {
             type: 'json',
             root: 'users'
         }
     },
     autoLoad: true
 });

In the example above we configured an AJAX proxy to load data from the url '/users.json'. We told our Proxy to use a JsonReader to parse the response from the server into Model object - see the docs on JsonReader for details.

Inline data

Stores can also load data inline. Internally, Store converts each of the objects we pass in as data into Model instances:

 Ext.create('Ext.data.Store', {
     model: 'User',
     data : [
         {firstName: 'Ed',    lastName: 'Spencer'},
         {firstName: 'Tommy', lastName: 'Maintz'},
         {firstName: 'Aaron', lastName: 'Conran'},
         {firstName: 'Jamie', lastName: 'Avins'}
     ]
 });

Loading inline data using the method above is great if the data is in the correct format already (e.g. it doesn't need to be processed by a reader). If your inline data requires processing to decode the data structure, use a MemoryProxy instead (see the MemoryProxy docs for an example).

Additional data can also be loaded locally using add.

Dynamic Loading

Stores can be dynamically updated by calling the load method:

store.load({
    params: {
        group: 3,
        type: 'user'
    },
    callback: function(records, operation, success) {
        // do something after the load finishes
    },
    scope: this
});

Here a bunch of arbitrary parameters is passed along with the load request and a callback function is set up to do something after the loading is over.

Loading Nested Data

Applications often need to load sets of associated data - for example a CRM system might load a User and her Orders. Instead of issuing an AJAX request for the User and a series of additional AJAX requests for each Order, we can load a nested dataset and allow the Reader to automatically populate the associated models. Below is a brief example, see the Ext.data.reader.Reader intro docs for a full explanation:

 var store = Ext.create('Ext.data.Store', {
     autoLoad: true,
     model: "User",
     proxy: {
         type: 'ajax',
         url: 'users.json',
         reader: {
             type: 'json',
             root: 'users'
         }
     }
 });

Which would consume a response like this:

 {
     "users": [{
         "id": 1,
         "name": "Ed",
         "orders": [{
             "id": 10,
             "total": 10.76,
             "status": "invoiced"
        },{
             "id": 11,
             "total": 13.45,
             "status": "shipped"
        }]
     }]
 }

See the Ext.data.reader.Reader intro docs for a full explanation.

Filtering and Sorting

Stores can be sorted and filtered - in both cases either remotely or locally. The sorters and filters are held inside MixedCollection instances to make them easy to manage. Usually it is sufficient to either just specify sorters and filters in the Store configuration or call sort or filter:

 var store = Ext.create('Ext.data.Store', {
     model: 'User',
     sorters: [{
         property: 'age',
         direction: 'DESC'
     }, {
         property: 'firstName',
         direction: 'ASC'
     }],

     filters: [{
         property: 'firstName',
         value: /Ed/
     }]
 });

The new Store will keep the configured sorters and filters in the MixedCollection instances mentioned above. By default, sorting and filtering are both performed locally by the Store - see remoteSort and remoteFilter to allow the server to perform these operations instead.

Filtering and sorting after the Store has been instantiated is also easy. Calling filter adds another filter to the Store and automatically filters the dataset (calling filter with no arguments simply re-applies all existing filters). Note that by default sortOnFilter is set to true, which means that your sorters are automatically reapplied if using local sorting.

store.filter('eyeColor', 'Brown');

Change the sorting at any time by calling sort:

store.sort('height', 'ASC');

Note that all existing sorters will be removed in favor of the new sorter data (if sort is called with no arguments, the existing sorters are just reapplied instead of being removed). To keep existing sorters and add new ones, just add them to the MixedCollection:

store.sorters.add(new Ext.util.Sorter({
    property : 'shoeSize',
    direction: 'ASC'
}));

store.sort();

Registering with StoreManager

Any Store that is instantiated with a storeId will automatically be registered with the StoreManager. This makes it easy to reuse the same store in multiple views:

//this store can be used several times
Ext.create('Ext.data.Store', {
    model: 'User',
    storeId: 'usersStore'
});

new Ext.List({
    store: 'usersStore',
    //other config goes here
});

new Ext.view.View({
    store: 'usersStore',
    //other config goes here
});

Further Reading

Stores are backed up by an ecosystem of classes that enables their operation. To gain a full understanding of these pieces and how they fit together, see:

  • Proxy - overview of what Proxies are and how they are used
  • Model - the core class in the data package
  • Reader - used by any subclass of ServerProxy to read a response

Available since: 1.1.0

Defined By

Config options

When a Store is used by only one DataView, and should only exist for the lifetime of that view, then configure the au...

When a Store is used by only one DataView, and should only exist for the lifetime of that view, then configure the autoDestroy flag as true. This causes the destruction of the view to trigger the destruction of its Store.

Defaults to: false

Available since: 3.4.0

If data is not specified, and if autoLoad is true or an Object, this store's load method is automatically called afte...

If data is not specified, and if autoLoad is true or an Object, this store's load method is automatically called after creation. If the value of autoLoad is an Object, this Object will be passed to the store's load method.

Available since: 2.3.0

True to automatically sync the Store with its Proxy after every edit to one of its Records. ...

True to automatically sync the Store with its Proxy after every edit to one of its Records. Defaults to false.

Defaults to: false

Available since: 4.0.0

Sets the updating behavior based on batch synchronization. ...

Sets the updating behavior based on batch synchronization. 'operation' (the default) will update the Store's internal representation of the data after each operation of the batch has completed, 'complete' will wait until the entire batch has been completed before updating the Store's data. 'complete' is a good choice for local storage proxies, 'operation' is better for remote proxies, where there is a comparatively high latency.

Defaults to: 'operation'

Available since: 4.1.1

Allows the Store to prefetch and cache in a page cache, pages of Records, and to then satisfy loading requirements fr...

Allows the Store to prefetch and cache in a page cache, pages of Records, and to then satisfy loading requirements from this page cache.

To use buffered Stores, initiate the process by loading the first page. The number of rows rendered are determined automatically, and the range of pages needed to keep the cache primed for scrolling is requested and cached. Example:

myStore.loadPage(1); // Load page 1

A BufferedRenderer is instantiated which will monitor the scrolling in the grid, and refresh the view's rows from the page cache as needed. It will also pull new data into the page cache when scrolling of the view draws upon data near either end of the prefetched data.

The margins which trigger view refreshing from the prefetched data are Ext.grid.plugin.BufferedRenderer.numFromEdge, Ext.grid.plugin.BufferedRenderer.leadingBufferZone and Ext.grid.plugin.BufferedRenderer.trailingBufferZone.

The margins which trigger loading more data into the page cache are, leadingBufferZone and trailingBufferZone.

By default, only 5 pages of data are cached in the page cache, with pages "scrolling" out of the buffer as the view moves down through the dataset. Setting this value to zero means that no pages are ever scrolled out of the page cache, and that eventually the whole dataset may become present in the page cache. This is sometimes desirable as long as datasets do not reach astronomical proportions.

Selection state may be maintained across page boundaries by configuring the SelectionModel not to discard records from its collection when those Records cycle out of the Store's primary collection. This is done by configuring the SelectionModel like this:

selModel: {
    pruneRemoved: false
}

Defaults to: false

Available since: 4.0.0

True to empty the store when loading another page via loadPage, nextPage or previousPage. ...

True to empty the store when loading another page via loadPage, nextPage or previousPage. Setting to false keeps existing records, allowing large data sets to be loaded one page at a time but rendered all together.

Defaults to: true

Available since: 4.0.0

true to clear anything in the removed record collection when the store loads. ...

true to clear anything in the removed record collection when the store loads.

Defaults to: true

Available since: 4.1.0

Array of Model instances or data objects to load locally. ...

Array of Model instances or data objects to load locally. See "Inline data" above for details.

Available since: 1.1.0

The default sort direction to use if one is not specified. ...

The default sort direction to use if one is not specified.

Defaults to: "ASC"

Available since: 4.1.3

This may be used in place of specifying a model configuration. ...

This may be used in place of specifying a model configuration. The fields should be a set of Ext.data.Field configuration objects. The store will automatically create a Ext.data.Model with these fields. In general this configuration option should only be used for simple stores like a two-field store of ComboBox. For anything more complicated, such as specifying a particular id property or associations, a Ext.data.Model should be defined and specified for the model config.

Available since: 2.3.0

If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired. ...

If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired. Defaults to true, ignored if remoteFilter is true

Defaults to: true

Available since: 4.1.1

Array of Filters for this store. ...

Array of Filters for this store. Can also be passed array of functions which will be used as the filterFn config for filters:

filters: [
    function(item) {
        return item.weight > 0;
    }
]

To filter after the grid is loaded use the filterBy function.

Available since: 4.1.0

Ext.data.Store
view source
: String
The direction in which sorting should be applied when grouping. ...

The direction in which sorting should be applied when grouping. Supported values are "ASC" and "DESC".

Defaults to: "ASC"

Available since: 4.1.0

The field by which to group data in the store. ...

The field by which to group data in the store. Internally, grouping is very similar to sorting - the groupField and groupDir are injected as the first sorter (see sort). Stores support a single level of grouping, and groups can be fetched via the getGroups method.

Available since: 4.1.0

The collection of Groupers currently applied to this Store.

The collection of Groupers currently applied to this Store.

Available since: 4.1.3

When buffered, the number of extra rows to keep cached on the leading side of scrolling buffer as scrolling proceeds. ...

When buffered, the number of extra rows to keep cached on the leading side of scrolling buffer as scrolling proceeds. A larger number means fewer replenishments from the server.

Defaults to: 200

Available since: 4.1.0

A config object containing one or more event handlers to be added to this object during initialization. ...

A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.

DOM events from Ext JS Components

While some Ext JS Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually only done when extra value can be added. For example the DataView's itemclick event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

new Ext.panel.Panel({
    width: 400,
    height: 200,
    dockedItems: [{
        xtype: 'toolbar'
    }],
    listeners: {
        click: {
            element: 'el', //bind to the underlying el property on the panel
            fn: function(){ console.log('click el'); }
        },
        dblclick: {
            element: 'body', //bind to the underlying body property on the panel
            fn: function(){ console.log('dblclick body'); }
        }
    }
});

Available since: 1.1.0

Name of the Model associated with this store. ...

Name of the Model associated with this store. The string is used as an argument for Ext.ModelManager.getModel.

Available since: 4.0.4

Ext.data.Store
view source
: Number
The number of records considered to form a 'page'. ...

The number of records considered to form a 'page'. This is used to power the built-in paging using the nextPage and previousPage functions when the grid is paged using a PagingToolbar Defaults to 25.

If this Store is buffered, pages are loaded into a page cache before the Store's data is updated from the cache. The pageSize is the number of rows loaded into the cache in one request. This will not affect the rendering of a buffered grid, but a larger page size will mean fewer loads.

In a buffered grid, scrolling is monitored, and the page cache is kept primed with data ahead of the direction of scroll to provide rapid access to data when scrolling causes it to be required. Several pages in advance may be requested depending on various parameters.

It is recommended to tune the pageSize, trailingBufferZone and leadingBufferZone configurations based upon the conditions pertaining in your deployed application.

The provided SDK example examples/grid/infinite-scroll-grid-tuner.html can be used to experiment with different settings including simulating Ajax latency.

Available since: 4.0.1

The Proxy to use for this Store. ...

The Proxy to use for this Store. This can be either a string, a config object or a Proxy instance - see setProxy for details.

Available since: 1.1.0

Overrides: Ext.data.AbstractStore.proxy

Valid only when used with a buffered Store. ...

Valid only when used with a buffered Store.

The number of pages additional to the required buffered range to keep in the prefetch cache before purging least recently used records.

For example, if the height of the view area and the configured trailingBufferZone and leadingBufferZone require that there are three pages in the cache, then a purgePageCount of 5 ensures that up to 8 pages can be in the page cache any any one time.

A value of 0 indicates to never purge the prefetched data.

Defaults to: 5

Available since: 4.0.0

true if the grouping should be performed on the server side, false if it is local only. ...

true if the grouping should be performed on the server side, false if it is local only.

Buffered stores automatically set this to true. Buffered stores contain an abitrary subset of the full dataset which depends upon various configurations and which pages have been requested for rendering. Such sparse datasets are ineligible for local filtering.

Defaults to: false

Available since: 4.0.0

Overrides: Ext.data.AbstractStore.remoteFilter

true if the grouping should apply on the server side, false if it is local only. ...

true if the grouping should apply on the server side, false if it is local only. If the grouping is local, it can be applied immediately to the data. If it is remote, then it will simply act as a helper, automatically sending the grouping information to the server.

Buffered stores automatically set this to true. Buffered stores contain an abitrary subset of the full dataset which depends upon various configurations and which pages have been requested for rendering. Such sparse datasets are ineligible for local grouping.

Defaults to: false

Available since: 4.0.0

true if the sorting should be performed on the server side, false if it is local only. ...

true if the sorting should be performed on the server side, false if it is local only.

Buffered stores automatically set this to true. Buffered stores contain an abitrary subset of the full dataset which depends upon various configurations and which pages have been requested for rendering. Such sparse datasets are ineligible for local sorting.

Defaults to: false

Available since: 1.1.0

Overrides: Ext.data.AbstractStore.remoteSort

For local filtering only, causes sort to be called whenever filter is called, causing the sorters to be reapplied aft...

For local filtering only, causes sort to be called whenever filter is called, causing the sorters to be reapplied after filtering.

Defaults to: true

Available since: 4.0.0

If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired. ...

If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired. Defaults to true, igored if remoteSort is true

Defaults to: true

Available since: 4.1.1

The property in each item that contains the data to sort.

The property in each item that contains the data to sort.

Available since: 4.1.3

The initial set of Sorters

The initial set of Sorters

Available since: 4.1.3

Configure as true to have the filters saved when a client grid saves its state. ...

Configure as true to have the filters saved when a client grid saves its state.

Defaults to: false

Available since: Ext JS 4.2.0

Unique identifier for this store. ...

Unique identifier for this store. If present, this Store will be registered with the Ext.data.StoreManager, making it easy to reuse elsewhere.

Note that when store is instatiated by Controller, the storeId will be overridden by the name of the store.

Available since: 4.0.0

When buffered, the number of extra records to keep cached on the trailing side of scrolling buffer as scrolling proce...

When buffered, the number of extra records to keep cached on the trailing side of scrolling buffer as scrolling proceeds. A larger number means fewer replenishments from the server.

Defaults to: 25

Available since: 4.1.0

Properties

Defined By

Instance properties

...

Defaults to: 'Ext.Base'

Available since: 4.1.1

Ext.data.Store
view source
: Objectprivate
Private. ...

Private. Used as parameter to loadRecords

Defaults to: {addRecords: true}

Available since: 4.1.1

...

Defaults to: {}

Available since: 4.1.1

The page that the Store has most recently loaded (see loadPage) ...

The page that the Store has most recently loaded (see loadPage)

Defaults to: 1

Available since: 4.0.0

When this Store is not buffered, the data property is a MixedCollection which holds this store's local cache of records. ...

When this Store is not buffered, the data property is a MixedCollection which holds this store's local cache of records.

When this store is buffered, the data property is a cache of pages of records used to satisfy load requests from the Store when the associated view scrolls. Depending on how the buffer zone and purgePageCount are configured, pages which are scrolled out of view may be evicted from the cache, and need to be re-requested from the server when scrolled back into view. For this reason, if using buffered, it is recommended that you configure your Model definitions with a unique Ext.data.Model.idProperty so that records which return to the page cache may be matched against previously selected records.

Pages in the direction of scroll are prefetched from the remote server and loaded into this cache before they are needed based upon the buffer zone so that scrolling can proceed without visible pauses for data loading.

Available since: 4.0.0

Ext.data.Store
view source
: Numberprivate
...

Defaults to: 25

Available since: 4.1.0

The string type of the Proxy to create if none is specified. ...

The string type of the Proxy to create if none is specified. This defaults to creating a memory proxy.

Defaults to: 'memory'

Available since: 4.0.0

Ext.data.Store
view source
: Numberprivate
Number of records to load into a buffered grid before it has been bound to a view of known size ...

Number of records to load into a buffered grid before it has been bound to a view of known size

Defaults to: 100

Available since: 4.1.3

Initial suspended call count. ...

Initial suspended call count. Incremented when suspendEvents is called, decremented when resumeEvents is called.

Defaults to: 0

Available since: 4.1.1

The collection of Filters currently applied to this Store

The collection of Filters currently applied to this Store

Available since: 4.0.0

This object holds a key for any event that has a listener. ...

This object holds a key for any event that has a listener. The listener may be set directly on the instance, or on its class or a super class (via observe) or on the MVC EventBus. The values of this object are truthy (a non-zero number) and falsy (0 or undefined). They do not represent an exact count of listeners. The value for an event is truthy if the event must be fired and is falsy if there is no need to fire the event.

The intended use of this property is to avoid the expense of fireEvent calls when there are no listeners. This can be particularly helpful when one would otherwise have to call fireEvent hundreds or thousands of times. It is used like this:

 if (this.hasListeners.foo) {
     this.fireEvent('foo', this, arg1);
 }

Available since: 4.1.0

True if a model was created implicitly for this Store. ...

True if a model was created implicitly for this Store. This happens if a fields array is passed to the Store's constructor instead of a model constructor or name.

Defaults to: false

Available since: 4.0.0

...

Defaults to: []

Available since: 4.1.1

...

Defaults to: {}

Available since: 4.1.1

True if the Store has already been destroyed. ...

True if the Store has already been destroyed. If this is true, the reference to Store should be deleted as it will not function correctly any more.

Defaults to: false

Available since: 3.4.0

...

Defaults to: true

Available since: 4.1.1

true in this class to identify an object as an instantiated Observable, or subclass thereof. ...

true in this class to identify an object as an instantiated Observable, or subclass thereof.

Defaults to: true

Available since: 4.0.0

true in this class to identify an object as an instantiated Sortable, or subclass thereof. ...

true in this class to identify an object as an instantiated Sortable, or subclass thereof.

Defaults to: true

Available since: 4.0.0

true in this class to identify an object as an instantiated Store, or subclass thereof. ...

true in this class to identify an object as an instantiated Store, or subclass thereof.

Defaults to: true

Available since: 4.0.0

Ext.data.Store
view source
: Booleanprivate
true if the Store is currently loading via its Proxy. ...

true if the Store is currently loading via its Proxy.

Defaults to: false

Available since: 4.0.0

A set of default values to be applied to every model instance added via insert or created via createModel. ...

A set of default values to be applied to every model instance added via insert or created via createModel. This is used internally by associations to set foreign keys and other fields. See the Association classes source code for examples. This should not need to be used by application developers.

Available since: 4.0.0

Temporary cache in which removed model instances are kept until successfully synchronised with a Proxy, at which poin...

Temporary cache in which removed model instances are kept until successfully synchronised with a Proxy, at which point this is cleared.

Defaults to: []

Available since: 4.0.0

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

A pristine (unfiltered) collection of the records in this store. ...

A pristine (unfiltered) collection of the records in this store. This is used to reinstate records when a filter is removed or changed

Available since: 4.0.0

The collection of Sorters currently applied to this Store

The collection of Sorters currently applied to this Store

Available since: 4.0.0

Defined By

Static properties

...

Defaults to: []

Available since: 4.1.1

Methods

Defined By

Instance methods

Ext.data.Store
view source
new( [config] ) : Ext.data.Store
Creates the store. ...

Creates the store.

Available since: 1.1.0

Parameters

  • config : Object (optional)

    Config object.

Returns

Fires

Overrides: Ext.data.AbstractStore.constructor, Ext.data.Store.constructor

Ext.data.Store
view source
( model ) : Ext.data.Model[]
Adds Model instance to the Store. ...

Adds Model instance to the Store. This method accepts either:

  • An array of Model instances or Model configuration objects.
  • Any number of Model instance or Model configuration object arguments.

The new Model instances will be added at the end of the existing collection.

Sample usage:

myStore.add({some: 'data'}, {some: 'other data'});

Note that if this Store is sorted, the new Model instances will be inserted at the correct point in the Store to maintain the sort order.

Available since: 1.1.0

Parameters

Returns

Fires

Adds the specified events to the list of events which this Observable may fire. ...

Adds the specified events to the list of events which this Observable may fire.

Available since: 1.1.0

Parameters

  • eventNames : Object/String...

    Either an object with event names as properties with a value of true. For example:

    this.addEvents({
        storeloaded: true,
        storecleared: true
    });
    

    Or any number of event names as separate parameters. For example:

    this.addEvents('storeloaded', 'storecleared');
    
Ext.data.Store
view source
( filters, [applyFilters] )
Adds a new Filter to this Store's filter set and by default, applys the updated filter set to the Store's unfiltered ...

Adds a new Filter to this Store's filter set and by default, applys the updated filter set to the Store's unfiltered dataset.

Available since: Ext JS 4.2.0

Parameters

  • filters : Object[]/Ext.util.Filter[]

    The set of filters to add to the current filter set.

  • applyFilters : Boolean (optional)

    Pass as false to add the filter but not apply the updated filter set.

    Defaults to: true

Fires

( eventName, [fn], [scope], [options] ) : Object
Appends an event handler to this object. ...

Appends an event handler to this object. For example:

myGridPanel.on("mouseover", this.onMouseOver, this);

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

myGridPanel.on({
    cellClick: this.onCellClick,
    mouseover: this.onMouseOver,
    mouseout: this.onMouseOut,
    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

myGridPanel.on({
    cellClick: {fn: this.onCellClick, scope: this, single: true},
    mouseover: {fn: panel.onMouseOver, scope: panel}
});

Names of methods in a specified scope may also be used. Note that scope MUST be specified to use this option:

myGridPanel.on({
    cellClick: {fn: 'onCellClick', scope: this, single: true},
    mouseover: {fn: 'onMouseOver', scope: panel}
});

Available since: 1.1.0

Parameters

  • eventName : String/Object

    The name of the event to listen for. May also be an object who's property names are event names.

  • fn : Function (optional)

    The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to fireEvent plus the options parameter described below.

  • scope : Object (optional)

    The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

  • options : Object (optional)

    An object containing handler configuration.

    Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

    This object may contain any of the following properties:

    • scope : Object

      The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

    • delay : Number

      The number of milliseconds to delay the invocation of the handler after the event fires.

    • single : Boolean

      True to add a handler to handle just the next firing of the event, and then remove itself.

    • buffer : Number

      Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

    • target : Ext.util.Observable

      Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

    • element : String

      This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

      This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

        new Ext.panel.Panel({
            title: 'The title',
            listeners: {
                click: this.handlePanelClick,
                element: 'body'
            }
        });
      
    • destroyable : Boolean (optional)

      When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

      Defaults to: false

    • priority : Number (optional)

      An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code.

      Combining Options

      Using the options argument, it is possible to combine different types of listeners:

      A delayed, one-time listener.

      myPanel.on('hide', this.handleClick, this, {
          single: true,
          delay: 100
      });
      

Returns

  • Object

    Only when the destroyable option is specified.

    A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

    this.btnListeners =  = myButton.on({
        destroyable: true
        mouseover:   function() { console.log('mouseover'); },
        mouseout:    function() { console.log('mouseout'); },
        click:       function() { console.log('click'); }
    });
    

    And when those listeners need to be removed:

    Ext.destroy(this.btnListeners);
    

    or

    this.btnListeners.destroy();
    

Fires

    Overrides: Ext.AbstractComponent.addListener

    ( item, ename, [fn], [scope], [options] ) : Object
    Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destr...

    Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destroyed.

    Available since: 4.0.0

    Parameters

    • item : Ext.util.Observable/Ext.Element

      The item to which to add a listener/listeners.

    • ename : Object/String

      The event name, or an object containing event name properties.

    • fn : Function (optional)

      If the ename parameter was an event name, this is the handler function.

    • scope : Object (optional)

      If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

    • options : Object (optional)

      If the ename parameter was an event name, this is the addListener options.

    Returns

    • Object

      Only when the destroyable option is specified.

      A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

      this.btnListeners =  = myButton.mon({
          destroyable: true
          mouseover:   function() { console.log('mouseover'); },
          mouseout:    function() { console.log('mouseout'); },
          click:       function() { console.log('click'); }
      });
      

      And when those listeners need to be removed:

      Ext.destroy(this.btnListeners);
      

      or

      this.btnListeners.destroy();
      

    Fires

      Ext.data.Store
      view source
      ( record )
      (Local sort only) Inserts the passed Record into the Store at the index where it should go based on the current sort ...

      (Local sort only) Inserts the passed Record into the Store at the index where it should go based on the current sort information.

      Available since: 2.3.0

      Parameters

      Fires

      A model instance should call this method on the Store it has been joined to. ...

      A model instance should call this method on the Store it has been joined to.

      Available since: 3.4.0

      Parameters

      Fires

      ( record, modifiedFieldNames )private
      A model instance should call this method on the Store it has been joined to. ...

      A model instance should call this method on the Store it has been joined to.

      Available since: 3.4.0

      Parameters

      • record : Ext.data.Model

        The model instance that was edited

      • modifiedFieldNames : String[]

        Array of field names changed during edit.

      Fires

      A model instance should call this method on the Store it has been joined to.. ...

      A model instance should call this method on the Store it has been joined to..

      Available since: 3.4.0

      Parameters

      Fires

      Ext.data.Store
      view source
      ( fn, [scope], [grouped], [args] ) : Object
      Runs the aggregate function for all the records in the store. ...

      Runs the aggregate function for all the records in the store.

      When store is filtered, only items within the filter are aggregated.

      Available since: 4.0.0

      Parameters

      • fn : Function

        The function to execute. The function is called with a single parameter, an array of records for that group.

      • scope : Object (optional)

        The scope to execute the function in. Defaults to the store.

      • grouped : Boolean (optional)

        True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the group average being the value. The grouped parameter is only honored if the store has a groupField.

      • args : Array (optional)

        Any arguments to append to the function call

      Returns

      • Object

        An object literal with the group names and their appropriate values.

      Fires

        Restores state to the passed state ...

        Restores state to the passed state

        Available since: Ext JS 4.2.0

        Parameters

        Fires

        • beforesort
        • sort
        Ext.data.Store
        view source
        ( field, [grouped] ) : Object
        Gets the average value in the store. ...

        Gets the average value in the store.

        When store is filtered, only items within the filter are aggregated.

        Available since: 4.0.0

        Parameters

        • field : String

          The field in each record

        • grouped : Boolean (optional)

          True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the group average being the value. The grouped parameter is only honored if the store has a groupField.

        Returns

        • Object

          The average value, if no items exist, 0.

        Fires

          Ext.data.Store
          view source
          ( records, page )private
          Caches the records in the prefetch and stripes them with their server-side index. ...

          Caches the records in the prefetch and stripes them with their server-side index.

          Available since: 4.1.0

          Parameters

          Fires

          • totalcountchange
          ( 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"
          

          Available since: 4.0.0

          This method has been deprecated

          as of 4.1. Use callParent instead.

          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

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

          Ext.data.Store
          view source
          ( isLoad )private
          private ...

          private

          Available since: 3.4.0

          Parameters

          Overrides: Ext.data.AbstractStore.clearData

          Ext.data.Store
          view source
          ( [suppressEvent] )
          Reverts to a view of the Record cache with no filtering applied. ...

          Reverts to a view of the Record cache with no filtering applied.

          Available since: 1.1.0

          Parameters

          • suppressEvent : Boolean (optional)

            If true the filter is cleared silently.

            For a locally filtered Store, this means that the filter collection is cleared without firing the datachanged event.

            For a remotely filtered Store, this means that the filter collection is cleared, but the store is not reloaded from the server.

          Fires

          Overrides: Ext.data.AbstractStore.clearFilter

          Ext.data.Store
          view source
          ( )
          Clear any groupers in the store ...

          Clear any groupers in the store

          Available since: 4.0.0

          Fires

          Removes all listeners for this object including the managed listeners ...

          Removes all listeners for this object including the managed listeners

          Available since: 4.0.0

          Fires

            Removes all managed listeners for this object. ...

            Removes all managed listeners for this object.

            Available since: 4.0.0

            Fires

              Ext.data.Store
              view source
              ( dataIndex, [allowNull], [bypassFilter] ) : Object[]
              Collects unique values for a particular dataIndex from this store. ...

              Collects unique values for a particular dataIndex from this store.

              Available since: 1.1.0

              Parameters

              • dataIndex : String

                The property to collect

              • allowNull : Boolean (optional)

                Pass true to allow null, undefined or empty string values

              • bypassFilter : Boolean (optional)

                Pass true to collect from all records, even ones which are filtered.

              Returns

              • Object[]

                An array of the unique values

              Ext.data.Store
              view source
              ( )
              Commits all Records with outstanding changes. ...

              Commits all Records with outstanding changes. To handle updates for changes, subscribe to the Store's update event, and perform updating when the third parameter is Ext.data.Record.COMMIT.

              Available since: 1.1.0

              Fires

                ...

                Available since: 4.1.1

                Ext.data.Store
                view source
                ( )private
                ...

                Available since: Ext JS 4.2.0

                Fires

                  ( eventName, args, bubbles )private
                  Continue to fire event. ...

                  Continue to fire event.

                  Available since: 4.0.7

                  Parameters

                  Fires

                    Ext.data.Store
                    view source
                    ( [grouped] ) : Number
                    Gets the count of items in the store. ...

                    Gets the count of items in the store.

                    When store is filtered, only items within the filter are counted.

                    Available since: 4.0.0

                    Parameters

                    • grouped : Boolean (optional)

                      True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the count for each group being the value. The grouped parameter is only honored if the store has a groupField.

                    Returns

                    Fires

                      saves any phantom records ...

                      saves any phantom records

                      Available since: 4.0.0

                      Parameters

                      Ext.data.Store
                      view source
                      ( property, value, [anyMatch], [caseSensitive], [exactMatch] )private
                      Returns a filter function used to test a the given property's value. ...

                      Returns a filter function used to test a the given property's value. Defers most of the work to Ext.util.MixedCollection's createValueMatcher function.

                      Available since: 3.4.0

                      Parameters

                      • property : String

                        The property to create the filter function for

                      • value : String/RegExp

                        The string/regex to compare the property value to

                      • anyMatch : Boolean (optional)

                        True if we don't care if the filter value is not the full value.

                        Defaults to: false

                      • caseSensitive : Boolean (optional)

                        True to create a case-sensitive regex.

                        Defaults to: false

                      • exactMatch : Boolean (optional)

                        True to force exact match (^ and $ characters added to the regex). Ignored if anyMatch is true.

                        Defaults to: false

                      Ext.data.Store
                      view source
                      ( record ) : Ext.data.Modelprivate
                      Converts a literal to a model, if it's not a model already ...

                      Converts a literal to a model, if it's not a model already

                      Available since: 4.0.0

                      Parameters

                      Returns

                      Creates an event handling function which refires the event from this object as the passed event name. ...

                      Creates an event handling function which refires the event from this object as the passed event name.

                      Available since: 4.0.0

                      Parameters

                      • newName : String

                        The name under which to refire the passed parameters.

                      • beginEnd : Array (optional)

                        The caller can specify on which indices to slice.

                      Returns

                      Normalizes an array of filter objects, ensuring that they are all Ext.util.Filter instances ...

                      Normalizes an array of filter objects, ensuring that they are all Ext.util.Filter instances

                      Available since: 4.0.0

                      Parameters

                      • filters : Object[]

                        The filters array

                      Returns

                      Ext.data.Store
                      view source
                      ( groupers ) : Ext.util.Grouper[]private
                      Normalizes an array of grouper objects, ensuring that they are all Ext.util.Grouper instances ...

                      Normalizes an array of grouper objects, ensuring that they are all Ext.util.Grouper instances

                      Available since: 4.0.0

                      Parameters

                      • groupers : Object[]

                        The groupers array

                      Returns

                      Normalizes an array of sorter objects, ensuring that they are all Ext.util.Sorter instances ...

                      Normalizes an array of sorter objects, ensuring that they are all Ext.util.Sorter instances

                      Available since: 4.0.0

                      Parameters

                      • sorters : Object[]

                        The sorters array

                      Returns

                      tells the attached proxy to destroy the given records ...

                      tells the attached proxy to destroy the given records

                      Available since: 3.4.0

                      Parameters

                      Fires

                        Overrides: Ext.Base.destroy

                        private ...

                        private

                        Available since: 4.0.0

                        Fires

                          Ext.data.Store
                          view source
                          ( sorterFn )private
                          overriden to provide striping of the indexes as sorting occurs. ...

                          overriden to provide striping of the indexes as sorting occurs. this cannot be done inside of sort because datachanged has already fired and will trigger a repaint of the bound view.

                          Available since: 4.0.0

                          Parameters

                          Fires

                          Overrides: Ext.data.AbstractStore.doSort

                          Ext.data.Store
                          view source
                          ( fn, [scope] )
                          Calls the specified function for each record in the store. ...

                          Calls the specified function for each record in the store.

                          When store is filtered, only loops over the filtered records.

                          Available since: 1.1.0

                          Parameters

                          • fn : Function

                            The function to call. The Record is passed as the first parameter. Returning false aborts and exits the iteration.

                          • scope : Object (optional)

                            The scope (this reference) in which the function is executed. Defaults to the current record in the iteration.

                          ...

                          Available since: 4.1.0

                          Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. ...

                          Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. There is no implementation in the Observable base class.

                          This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.

                          Example:

                          Ext.define('Ext.overrides.form.field.Base', {
                              override: 'Ext.form.field.Base',
                          
                              //  Add functionality to Field's initComponent to enable the change event to bubble
                              initComponent: function () {
                                  this.callParent();
                                  this.enableBubble('change');
                              }
                          });
                          
                          var myForm = Ext.create('Ext.form.Panel', {
                              title: 'User Details',
                              items: [{
                                  ...
                              }],
                              listeners: {
                                  change: function() {
                                      // Title goes red if form has been modified.
                                      myForm.header.setStyle('color', 'red');
                                  }
                              }
                          });
                          

                          Available since: 3.4.0

                          Parameters

                          • eventNames : String/String[]

                            The event name to bubble, or an Array of event names.

                          Ext.data.Store
                          view source
                          ( [filters], [value] )
                          Filters the loaded set of records by a given set of filters. ...

                          Filters the loaded set of records by a given set of filters.

                          By default, the passed filter(s) are added to the collection of filters being used to filter this Store.

                          To remove existing filters before applying a new set of filters use

                          // Clear the filter collection without updating the UI
                          store.clearFilter(true);
                          

                          see clearFilter.

                          Alternatively, if filters are configured with an id, then existing filters store may be replaced by new filters having the same id.

                          Filtering by single field:

                          store.filter("email", /\.com$/);
                          

                          Using multiple filters:

                          store.filter([
                              {property: "email", value: /\.com$/},
                              {filterFn: function(item) { return item.get("age") > 10; }}
                          ]);
                          

                          Using Ext.util.Filter instances instead of config objects (note that we need to specify the root config option in this case):

                          store.filter([
                              Ext.create('Ext.util.Filter', {property: "email", value: /\.com$/, root: 'data'}),
                              Ext.create('Ext.util.Filter', {filterFn: function(item) { return item.get("age") > 10; }, root: 'data'})
                          ]);
                          

                          When store is filtered, most of the methods for accessing store data will be working only within the set of filtered records. Two notable exceptions are queryBy and getById.

                          Available since: 1.1.0

                          Parameters

                          • filters : Object[]/Ext.util.Filter[]/String (optional)

                            The set of filters to apply to the data. These are stored internally on the store, but the filtering itself is done on the Store's MixedCollection. See MixedCollection's filter method for filter syntax. Alternatively, pass in a property string.

                            If no parameters are passed, the Store's existing filter set is applied.

                          • value : String (optional)

                            value to filter by (only if using a property string as the first argument)

                          Fires

                          Overrides: Ext.data.AbstractStore.filter

                          Ext.data.Store
                          view source
                          ( fn, [scope] )
                          Filters by a function. ...

                          Filters by a function. The specified function will be called for each Record in this Store. If the function returns true the Record is included, otherwise it is filtered out.

                          When store is filtered, most of the methods for accessing store data will be working only within the set of filtered records. Two notable exceptions are queryBy and getById.

                          Available since: 1.1.0

                          Parameters

                          • fn : Function

                            The function to be called. It will be passed the following parameters:

                            Parameters

                          • scope : Object (optional)

                            The scope (this reference) in which the function is executed. Defaults to this Store.

                          Fires

                          Overrides: Ext.data.AbstractStore.filterBy

                          Filter function for new records. ...

                          Filter function for new records.

                          Available since: 4.0.0

                          Parameters

                          Ext.data.Store
                          view source
                          ( item )private
                          ...

                          Available since: 4.1.0

                          Parameters

                          Filter function for updated records. ...

                          Filter function for updated records.

                          Available since: 4.0.0

                          Parameters

                          Ext.data.Store
                          view source
                          ( fieldName, value, [startIndex], [anyMatch], [caseSensitive], [exactMatch] ) : Number
                          Finds the index of the first matching Record in this store by a specific field value. ...

                          Finds the index of the first matching Record in this store by a specific field value.

                          When store is filtered, finds records only within filter.

                          Available since: 2.3.0

                          Parameters

                          • fieldName : String

                            The name of the Record field to test.

                          • value : String/RegExp

                            Either a string that the field value should begin with, or a RegExp to test against the field.

                          • startIndex : Number (optional)

                            The index to start searching at

                            Defaults to: 0

                          • anyMatch : Boolean (optional)

                            True to match any part of the string, not just the beginning

                            Defaults to: false

                          • caseSensitive : Boolean (optional)

                            True for case sensitive comparison

                            Defaults to: false

                          • exactMatch : Boolean (optional)

                            True to force exact match (^ and $ characters added to the regex).

                            Defaults to: false

                          Returns

                          • Number

                            The matched index or -1

                          Fires

                            Ext.data.Store
                            view source
                            ( fn, [scope], [startIndex] ) : Number
                            Find the index of the first matching Record in this Store by a function. ...

                            Find the index of the first matching Record in this Store by a function. If the function returns true it is considered a match.

                            When store is filtered, finds records only within filter.

                            Available since: 2.3.0

                            Parameters

                            • fn : Function

                              The function to be called. It will be passed the following parameters:

                              Parameters

                            • scope : Object (optional)

                              The scope (this reference) in which the function is executed. Defaults to this Store.

                            • startIndex : Number (optional)

                              The index to start searching at

                              Defaults to: 0

                            Returns

                            • Number

                              The matched index or -1

                            Ext.data.Store
                            view source
                            ( fieldName, value, [startIndex] ) : Number
                            Finds the index of the first matching Record in this store by a specific field value. ...

                            Finds the index of the first matching Record in this store by a specific field value.

                            When store is filtered, finds records only within filter.

                            Available since: 3.4.0

                            Parameters

                            • fieldName : String

                              The name of the Record field to test.

                            • value : Object

                              The value to match the field against.

                            • startIndex : Number (optional)

                              The index to start searching at

                              Defaults to: 0

                            Returns

                            • Number

                              The matched index or -1

                            Ext.data.Store
                            view source
                            ( fieldName, value, [startIndex], [anyMatch], [caseSensitive], [exactMatch] ) : Ext.data.Model
                            Finds the first matching Record in this store by a specific field value. ...

                            Finds the first matching Record in this store by a specific field value.

                            When store is filtered, finds records only within filter.

                            Available since: 4.0.0

                            Parameters

                            • fieldName : String

                              The name of the Record field to test.

                            • value : String/RegExp

                              Either a string that the field value should begin with, or a RegExp to test against the field.

                            • startIndex : Number (optional)

                              The index to start searching at

                              Defaults to: 0

                            • anyMatch : Boolean (optional)

                              True to match any part of the string, not just the beginning

                              Defaults to: false

                            • caseSensitive : Boolean (optional)

                              True for case sensitive comparison

                              Defaults to: false

                            • exactMatch : Boolean (optional)

                              True to force exact match (^ and $ characters added to the regex).

                              Defaults to: false

                            Returns

                            Fires

                              Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addList...

                              Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addListener).

                              An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble.

                              Available since: 1.1.0

                              Parameters

                              • eventName : String

                                The name of the event to fire.

                              • args : Object...

                                Variable number of parameters are passed to handlers.

                              Returns

                              • Boolean

                                returns false if any of the handlers return false otherwise it returns true.

                              Fires

                                Fires the specified event with the passed parameter list. ...

                                Fires the specified event with the passed parameter list.

                                An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble.

                                Available since: Ext JS 4.2.0

                                Parameters

                                • eventName : String

                                  The name of the event to fire.

                                • args : Object[]

                                  An array of parameters which are passed to handlers.

                                Returns

                                • Boolean

                                  returns false if any of the handlers return false otherwise it returns true.

                                Fires

                                  Ext.data.Store
                                  view source
                                  ( )private
                                  Fires the groupchange event. ...

                                  Fires the groupchange event. Abstracted out so we can use it as a callback

                                  Available since: 4.0.0

                                  Fires

                                  Ext.data.Store
                                  view source
                                  ( [grouped] ) : Ext.data.Model/undefined
                                  Convenience function for getting the first model instance in the store. ...

                                  Convenience function for getting the first model instance in the store.

                                  When store is filtered, will return first item within the filter.

                                  Available since: 4.0.0

                                  Parameters

                                  • grouped : Boolean (optional)

                                    True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the first record being the value. The grouped parameter is only honored if the store has a groupField.

                                  Returns

                                  • Ext.data.Model/undefined

                                    The first model instance in the store, or undefined

                                  Fires

                                    Returns a comparator function which compares two items and returns -1, 0, or 1 depending on the currently defined set...

                                    Returns a comparator function which compares two items and returns -1, 0, or 1 depending on the currently defined set of sorters.

                                    If there are no sorters defined, it returns a function which returns 0 meaning that no sorting will occur.

                                    Available since: 4.1.0

                                    Fires

                                      Ext.data.Store
                                      view source
                                      ( fn, scope, records, args )private
                                      ...

                                      Available since: Ext JS 4.2.0

                                      Parameters

                                      Ext.data.Store
                                      view source
                                      ( index ) : Ext.data.Model
                                      Get the Record at the specified index. ...

                                      Get the Record at the specified index.

                                      The index is effected by filtering.

                                      Available since: 1.1.0

                                      Parameters

                                      • index : Number

                                        The index of the Record to find.

                                      Returns

                                      • Ext.data.Model

                                        The Record at the passed index. Returns undefined if not found.

                                      Ext.data.Store
                                      view source
                                      ( records, field )private
                                      , see average ...

                                      , see average

                                      Available since: 4.0.0

                                      Parameters

                                      Returns an object which is passed in as the listeners argument to proxy.batch inside this.sync. ...

                                      Returns an object which is passed in as the listeners argument to proxy.batch inside this.sync. This is broken out into a separate function to allow for customisation of the listeners

                                      Available since: 4.0.0

                                      Returns

                                      Gets the bubbling parent for an Observable ...

                                      Gets the bubbling parent for an Observable

                                      Available since: 4.0.7

                                      Returns

                                      Fires

                                        Ext.data.Store
                                        view source
                                        ( id ) : Ext.data.Model
                                        Get the Record with the specified id. ...

                                        Get the Record with the specified id.

                                        This method is not effected by filtering, lookup will be performed from all records inside the store, filtered or not.

                                        Available since: 1.1.0

                                        Parameters

                                        • id : Mixed

                                          The id of the Record to find.

                                        Returns

                                        • Ext.data.Model

                                          The Record with the passed id. Returns null if not found.

                                        Overrides: Ext.data.AbstractStore.getById

                                        ...

                                        Available since: 4.1.0

                                        Parameters

                                        Ext.data.Store
                                        view source
                                        ( ) : Number
                                        Gets the number of records in store. ...

                                        Gets the number of records in store.

                                        If using paging, this may not be the total size of the dataset. If the data object used by the Reader contains the dataset size, then the getTotalCount function returns the dataset size. Note: see the Important note in load.

                                        When store is filtered, it's the number of records matching the filter.

                                        Available since: 1.1.0

                                        Returns

                                        • Number

                                          The number of Records in the Store.

                                        Overrides: Ext.data.AbstractStore.getCount

                                        Gets the first sorter from the sorters collection, excluding any groupers that may be in place ...

                                        Gets the first sorter from the sorters collection, excluding any groupers that may be in place

                                        Available since: 4.1.1

                                        Returns

                                        Ext.data.Store
                                        view source
                                        ( [sort] ) : Object[]private
                                        Returns records grouped by the configured grouper configuration. ...

                                        Returns records grouped by the configured grouper configuration. Sample return value (in this case grouping by genre and then author in a fictional books dataset):

                                        [
                                            {
                                                name: 'Fantasy',
                                                depth: 0,
                                                records: [
                                                    //book1, book2, book3, book4
                                                ],
                                                children: [
                                                    {
                                                        name: 'Rowling',
                                                        depth: 1,
                                                        records: [
                                                            //book1, book2
                                                        ]
                                                    },
                                                    {
                                                        name: 'Tolkein',
                                                        depth: 1,
                                                        records: [
                                                            //book3, book4
                                                        ]
                                                    }
                                                ]
                                            }
                                        ]
                                        

                                        Available since: 4.0.0

                                        Parameters

                                        • sort : Boolean (optional)

                                          true to call sort before finding groups. Sorting is required to make grouping function correctly so this should only be set to false if the Store is known to already be sorted correctly.

                                          Defaults to: true

                                        Returns

                                        Fires

                                        • beforesort
                                        Ext.data.Store
                                        view source
                                        ( )private
                                        ...

                                        Available since: Ext JS 4.2.0

                                        Ext.data.Store
                                        view source
                                        ( instance ) : String
                                        Returns the string to group on for a given model instance. ...

                                        Returns the string to group on for a given model instance. The default implementation of this method returns the model's groupField, but this can be overridden to group by an arbitrary string. For example, to group by the first letter of a model's 'name' field, use the following code:

                                        Ext.create('Ext.data.Store', {
                                            groupDir: 'ASC',
                                            getGroupString: function(instance) {
                                                return instance.get('name')[0];
                                            }
                                        });
                                        

                                        Available since: 4.0.0

                                        Parameters

                                        Returns

                                        • String

                                          The string to compare when forming groups

                                        Ext.data.Store
                                        view source
                                        ( [groupName] ) : Object/Object[]
                                        Returns an array containing the result of applying grouping to the records in this store. ...

                                        Returns an array containing the result of applying grouping to the records in this store. See groupField, groupDir and getGroupString. Example for a store containing records with a color field:

                                        var myStore = Ext.create('Ext.data.Store', {
                                            groupField: 'color',
                                            groupDir  : 'DESC'
                                        });
                                        
                                        myStore.getGroups(); // returns:
                                        [
                                            {
                                                name: 'yellow',
                                                children: [
                                                    // all records where the color field is 'yellow'
                                                ]
                                            },
                                            {
                                                name: 'red',
                                                children: [
                                                    // all records where the color field is 'red'
                                                ]
                                            }
                                        ]
                                        

                                        Group contents are effected by filtering.

                                        Available since: 4.0.0

                                        Parameters

                                        • groupName : String (optional)

                                          Pass in an optional groupName argument to access a specific group as defined by getGroupString.

                                        Returns

                                        Fires

                                          Ext.data.Store
                                          view source
                                          ( records, grouper )private
                                          For a given set of records and a Grouper, returns an array of arrays - each of which is the set of records matching a...

                                          For a given set of records and a Grouper, returns an array of arrays - each of which is the set of records matching a certain group.

                                          Available since: 4.0.0

                                          Parameters

                                          Ext.data.Store
                                          view source
                                          ( records, grouperIndex ) : Object[]private
                                          This is used recursively to gather the records into the configured Groupers. ...

                                          This is used recursively to gather the records into the configured Groupers. The data MUST have been sorted for this to work properly (see getGroupData and getGroupsForGrouper) Most of the work is done by getGroupsForGrouper - this function largely just handles the recursion.

                                          Available since: 4.0.0

                                          Parameters

                                          • records : Ext.data.Model[]

                                            The set or subset of records to group

                                          • grouperIndex : Number

                                            The grouper index to retrieve

                                          Returns

                                          Fires

                                            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.

                                            Ext.data.Store
                                            view source
                                            ( records, field )private
                                            , see max ...

                                            , see max

                                            Available since: 4.0.0

                                            Parameters

                                            Ext.data.Store
                                            view source
                                            ( records, field )private
                                            , see min ...

                                            , see min

                                            Available since: 4.0.0

                                            Parameters

                                            Gets all records added or updated since the last commit. ...

                                            Gets all records added or updated since the last commit. Note that the order of records returned is not deterministic and does not indicate the order in which records were modified. Note also that removed records are not included (use getRemovedRecords for that).

                                            Available since: 4.1.0

                                            Returns

                                            Fires

                                              inherit docs ...

                                              inherit docs

                                              Available since: 4.0.0

                                              Returns

                                              Overrides: Ext.data.AbstractStore.getNewRecords

                                              Ext.data.Store
                                              view source
                                              ( index ) : Number
                                              Determines the page from a record index ...

                                              Determines the page from a record index

                                              Available since: 4.0.0

                                              Parameters

                                              • index : Number

                                                The record index

                                              Returns

                                              • Number

                                                The page the record belongs to

                                              Returns the proxy currently attached to this proxy instance ...

                                              Returns the proxy currently attached to this proxy instance

                                              Available since: 4.0.0

                                              Returns

                                              Ext.data.Store
                                              view source
                                              ( start, end, [options] ) : Ext.data.Model[]
                                              Gathers a range of Records between specified indices. ...

                                              Gathers a range of Records between specified indices.

                                              If this store is buffered, the indices are relative to the entire dataset, not the local record cache.

                                              If this store is buffered, then the requested data range may not be immediately available, and will be returned through a passed callback function.

                                              This method is affected by filtering.

                                              Available since: 1.1.0

                                              Parameters

                                              • start : Number

                                                The starting index. Defaults to zero for non buffered Stores.

                                              • end : Number

                                                The ending index. Defaults to the last Record for non buffered Stores.

                                              • options : Object (optional)

                                                Used when the Store is {@link buffered] and the range may not be available synchronously.

                                                • callback : Object

                                                  A function to call when the range becomes available.

                                                  • range : Ext.data.Model[]

                                                    The requested range of records.

                                                  • start : Number

                                                    The delivered start index.

                                                  • end : Number

                                                    The delivered end index

                                                  • options : Number

                                                    The passed options object.

                                              Returns

                                              • Ext.data.Model[]

                                                An array of records if the records are immediately available. For buffered stores, you should pass the callback option unless you know that the range will be present - see rangeCached.

                                              Fires

                                              Ext.data.Store
                                              view source
                                              ( )private
                                              Ideally in the future this will use getModifiedRecords, where there will be a param to getNewRecords & getUpdated...

                                              Ideally in the future this will use getModifiedRecords, where there will be a param to getNewRecords & getUpdatedRecords to indicate whether to get only the valid records or grab all of them

                                              Available since: 4.1.0

                                              Fires

                                                Returns any records that have been removed from the store but not yet destroyed on the proxy. ...

                                                Returns any records that have been removed from the store but not yet destroyed on the proxy.

                                                Available since: 4.0.0

                                                Returns

                                                ...

                                                Available since: 4.0.0

                                                Returns the grouping, sorting and filtered state of this Store. ...

                                                Returns the grouping, sorting and filtered state of this Store.

                                                Available since: Ext JS 4.2.0

                                                Ext.data.Store
                                                view source
                                                ( records, field )private
                                                , see sum ...

                                                , see sum

                                                Available since: 4.0.0

                                                Parameters

                                                Ext.data.Store
                                                view source
                                                ( ) : Number
                                                Returns the total number of Model instances that the Proxy indicates exist. ...

                                                Returns the total number of Model instances that the Proxy indicates exist. This will usually differ from getCount when using paging - getCount returns the number of records loaded into the Store at the moment, getTotalCount returns the number of records that could be loaded into the Store if the Store contained all data

                                                Available since: 1.1.0

                                                Returns

                                                • Number

                                                  The total number of Model instances available via the Proxy. 0 returned if no value has been set via the reader.

                                                inherit docs ...

                                                inherit docs

                                                Available since: 4.0.0

                                                Returns

                                                Overrides: Ext.data.AbstractStore.getUpdatedRecords

                                                Ext.data.Store
                                                view source
                                                ( groupers, [direction] )
                                                Groups data inside the store. ...

                                                Groups data inside the store.

                                                Available since: 4.0.0

                                                Parameters

                                                • groupers : String/Object[]

                                                  Either a string name of one of the fields in this Store's configured Model, or an Array of grouper configurations.

                                                • direction : String (optional)

                                                  The overall direction to group the data by.

                                                  Defaults to: "ASC"

                                                Fires

                                                Ext.data.Store
                                                view source
                                                ( start, end, callback, scope, options )deprecated
                                                Guarantee a specific range, this will load the store with a range (that must be the pageSize or smaller) and take car...

                                                Guarantee a specific range, this will load the store with a range (that must be the pageSize or smaller) and take care of any loading that may be necessary.

                                                Available since: 4.0.0

                                                This method has been deprecated

                                                Use getRange

                                                Parameters

                                                Fires

                                                ...

                                                Available since: 4.1.0

                                                Parameters

                                                Checks to see if this object has any listeners for a specified event, or whether the event bubbles. ...

                                                Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer indicates whether the event needs firing or not.

                                                Available since: 1.1.0

                                                Parameters

                                                • eventName : String

                                                  The name of the event to check for

                                                Returns

                                                • Boolean

                                                  true if the event is being listened for or bubbles, else false

                                                Ext.data.Store
                                                view source
                                                ( record ) : Number
                                                Get the index of the record within the store. ...

                                                Get the index of the record within the store.

                                                When store is filtered, records outside of filter will not be found.

                                                Available since: 1.1.0

                                                Parameters

                                                Returns

                                                • Number

                                                  The index of the passed Record. Returns -1 if not found.

                                                Ext.data.Store
                                                view source
                                                ( id ) : Number
                                                Get the index within the store of the Record with the passed id. ...

                                                Get the index within the store of the Record with the passed id.

                                                Like indexOf, this method is effected by filtering.

                                                Available since: 1.1.0

                                                Parameters

                                                • id : String

                                                  The id of the Record to find.

                                                Returns

                                                • Number

                                                  The index of the Record. Returns -1 if not found.

                                                Fires

                                                  Ext.data.Store
                                                  view source
                                                  ( record ) : Number
                                                  Get the index within the entire dataset. ...

                                                  Get the index within the entire dataset. From 0 to the totalCount.

                                                  Like indexOf, this method is effected by filtering.

                                                  Available since: 4.0.0

                                                  Parameters

                                                  Returns

                                                  • Number

                                                    The index of the passed Record. Returns -1 if not found.

                                                  Fires

                                                    ( 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

                                                    Performs initialization of this mixin. ...

                                                    Performs initialization of this mixin. Component classes using this mixin should call this method during their own initialization.

                                                    Available since: 4.0.0

                                                    Fires

                                                      Ext.data.Store
                                                      view source
                                                      ( index, records ) : Ext.data.Model[]
                                                      Inserts Model instances into the Store at the given index and fires the add event. ...

                                                      Inserts Model instances into the Store at the given index and fires the add event. See also add.

                                                      Available since: 1.1.0

                                                      Parameters

                                                      Returns

                                                      Fires

                                                      Ext.data.Store
                                                      view source
                                                      ( ) : Boolean
                                                      Returns true if this store is currently filtered ...

                                                      Returns true if this store is currently filtered

                                                      Available since: 2.3.0

                                                      Returns

                                                      Overrides: Ext.data.AbstractStore.isFiltered

                                                      Ext.data.Store
                                                      view source
                                                      ( ) : Boolean
                                                      Checks if the store is currently grouped ...

                                                      Checks if the store is currently grouped

                                                      Available since: 4.0.0

                                                      Returns

                                                      • Boolean

                                                        true if the store is grouped.

                                                      Returns true if the Store is currently performing a load operation ...

                                                      Returns true if the Store is currently performing a load operation

                                                      Available since: 4.0.0

                                                      Returns

                                                      • Boolean

                                                        True if the Store is currently loading

                                                      Ext.data.Store
                                                      view source
                                                      ( [grouped] ) : Ext.data.Model/undefined
                                                      Convenience function for getting the last model instance in the store. ...

                                                      Convenience function for getting the last model instance in the store.

                                                      When store is filtered, will return last item within the filter.

                                                      Available since: 4.0.0

                                                      Parameters

                                                      • grouped : Boolean (optional)

                                                        True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the last record being the value. The grouped parameter is only honored if the store has a groupField.

                                                      Returns

                                                      • Ext.data.Model/undefined

                                                        The last model instance in the store, or undefined

                                                      Fires

                                                        Ext.data.Store
                                                        view source
                                                        ( [options] )
                                                        Loads data into the Store via the configured proxy. ...

                                                        Loads data into the Store via the configured proxy. This uses the Proxy to make an asynchronous call to whatever storage backend the Proxy uses, automatically adding the retrieved instances into the Store and calling an optional callback if required. Example usage:

                                                        store.load({
                                                            scope: this,
                                                            callback: function(records, operation, success) {
                                                                // the operation object
                                                                // contains all of the details of the load operation
                                                                console.log(records);
                                                            }
                                                        });
                                                        

                                                        If the callback scope does not need to be set, a function can simply be passed:

                                                        store.load(function(records, operation, success) {
                                                            console.log('loaded records');
                                                        });
                                                        

                                                        Available since: 1.1.0

                                                        Parameters

                                                        • options : Object/Function (optional)

                                                          config object, passed into the Ext.data.Operation object before loading. Additionally addRecords: true can be specified to add these records to the existing records, default is to remove the Store's existing records first.

                                                        Fires

                                                        Overrides: Ext.data.AbstractStore.load

                                                        Ext.data.Store
                                                        view source
                                                        ( data, [append] )
                                                        Loads an array of data straight into the Store. ...

                                                        Loads an array of data straight into the Store.

                                                        Using this method is great if the data is in the correct format already (e.g. it doesn't need to be processed by a reader). If your data requires processing to decode the data structure, use a MemoryProxy or loadRawData.

                                                        Available since: 1.1.0

                                                        Parameters

                                                        • data : Ext.data.Model[]/Object[]

                                                          Array of data to load. Any non-model instances will be cast into model instances first.

                                                        • append : Boolean (optional)

                                                          true to add the records to the existing records in the store, false to remove the old ones first.

                                                          Defaults to: false

                                                        Fires

                                                        Ext.data.Store
                                                        view source
                                                        ( page, [options] )
                                                        Loads a given 'page' of data by setting the start and limit values appropriately. ...

                                                        Loads a given 'page' of data by setting the start and limit values appropriately. Internally this just causes a normal load operation, passing in calculated 'start' and 'limit' params.

                                                        Available since: 4.0.0

                                                        Parameters

                                                        • page : Number

                                                          The number of the page to load.

                                                        • options : Object (optional)

                                                          See options for load.

                                                        Fires

                                                        Ext.data.Store
                                                        view source
                                                        ( data, [append] )
                                                        Loads data via the bound Proxy's reader Use this method if you are attempting to load data and want to utilize the c...

                                                        Loads data via the bound Proxy's reader

                                                        Use this method if you are attempting to load data and want to utilize the configured data reader.

                                                        Available since: 4.0.7

                                                        Parameters

                                                        • data : Object[]

                                                          The full JSON object you'd like to load into the Data store.

                                                        • append : Boolean (optional)

                                                          true to add the records to the existing records in the store, false to remove the old ones first.

                                                          Defaults to: false

                                                        Fires

                                                        Ext.data.Store
                                                        view source
                                                        ( records, options )
                                                        Loads an array of model instances into the store, fires the datachanged event. ...

                                                        Loads an array of model instances into the store, fires the datachanged event. This should only usually be called internally when loading from the Proxy, when adding records manually use add instead

                                                        Available since: 3.4.0

                                                        Parameters

                                                        • records : Ext.data.Model[]

                                                          The array of records to load

                                                        • options : Object
                                                          • addRecords : Boolean (optional)

                                                            Pass true to add these records to the existing records, false to remove the Store's existing records first.

                                                            Defaults to: false

                                                          • start : Number (optional)

                                                            Only used by buffered Stores. The index within the overall dataset of the first record in the array.

                                                        Fires

                                                        Ext.data.Store
                                                        view source
                                                        ( options )private
                                                        ...

                                                        Available since: 4.1.0

                                                        Parameters

                                                        Fires

                                                        Ext.data.Store
                                                        view source
                                                        ( field, [grouped] ) : Object
                                                        Gets the maximum value in the store. ...

                                                        Gets the maximum value in the store.

                                                        When store is filtered, only items within the filter are aggregated.

                                                        Available since: 4.0.0

                                                        Parameters

                                                        • field : String

                                                          The field in each record

                                                        • grouped : Boolean (optional)

                                                          True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the maximum in the group being the value. The grouped parameter is only honored if the store has a groupField.

                                                        Returns

                                                        • Object

                                                          The maximum value, if no items exist, undefined.

                                                        Fires

                                                          Ext.data.Store
                                                          view source
                                                          ( field, [grouped] ) : Object
                                                          Gets the minimum value in the store. ...

                                                          Gets the minimum value in the store.

                                                          When store is filtered, only items within the filter are aggregated.

                                                          Available since: 4.0.0

                                                          Parameters

                                                          • field : String

                                                            The field in each record

                                                          • grouped : Boolean (optional)

                                                            True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the minimum in the group being the value. The grouped parameter is only honored if the store has a groupField.

                                                          Returns

                                                          • Object

                                                            The minimum value, if no items exist, undefined.

                                                          Fires

                                                            ( item, ename, [fn], [scope], [options] ) : Object
                                                            Shorthand for addManagedListener. ...

                                                            Shorthand for addManagedListener.

                                                            Available since: 4.0.2

                                                            Parameters

                                                            • item : Ext.util.Observable/Ext.Element

                                                              The item to which to add a listener/listeners.

                                                            • ename : Object/String

                                                              The event name, or an object containing event name properties.

                                                            • fn : Function (optional)

                                                              If the ename parameter was an event name, this is the handler function.

                                                            • scope : Object (optional)

                                                              If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

                                                            • options : Object (optional)

                                                              If the ename parameter was an event name, this is the addListener options.

                                                            Returns

                                                            • Object

                                                              Only when the destroyable option is specified.

                                                              A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

                                                              this.btnListeners =  = myButton.mon({
                                                                  destroyable: true
                                                                  mouseover:   function() { console.log('mouseover'); },
                                                                  mouseout:    function() { console.log('mouseout'); },
                                                                  click:       function() { console.log('click'); }
                                                              });
                                                              

                                                              And when those listeners need to be removed:

                                                              Ext.destroy(this.btnListeners);
                                                              

                                                              or

                                                              this.btnListeners.destroy();
                                                              
                                                            ( item, ename, [fn], [scope] )
                                                            Shorthand for removeManagedListener. ...

                                                            Shorthand for removeManagedListener.

                                                            Available since: 4.0.2

                                                            Parameters

                                                            • item : Ext.util.Observable/Ext.Element

                                                              The item from which to remove a listener/listeners.

                                                            • ename : Object/String

                                                              The event name, or an object containing event name properties.

                                                            • fn : Function (optional)

                                                              If the ename parameter was an event name, this is the handler function.

                                                            • scope : Object (optional)

                                                              If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

                                                            Ext.data.Store
                                                            view source
                                                            ( options )
                                                            Loads the next 'page' in the current data set ...

                                                            Loads the next 'page' in the current data set

                                                            Available since: 4.0.0

                                                            Parameters

                                                            Fires

                                                            ( eventName, [fn], [scope], [options] ) : Object
                                                            Shorthand for addListener. ...

                                                            Shorthand for addListener.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            • eventName : String/Object

                                                              The name of the event to listen for. May also be an object who's property names are event names.

                                                            • fn : Function (optional)

                                                              The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to fireEvent plus the options parameter described below.

                                                            • scope : Object (optional)

                                                              The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

                                                            • options : Object (optional)

                                                              An object containing handler configuration.

                                                              Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

                                                              This object may contain any of the following properties:

                                                              • scope : Object

                                                                The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

                                                              • delay : Number

                                                                The number of milliseconds to delay the invocation of the handler after the event fires.

                                                              • single : Boolean

                                                                True to add a handler to handle just the next firing of the event, and then remove itself.

                                                              • buffer : Number

                                                                Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

                                                              • target : Ext.util.Observable

                                                                Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

                                                              • element : String

                                                                This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

                                                                This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

                                                                  new Ext.panel.Panel({
                                                                      title: 'The title',
                                                                      listeners: {
                                                                          click: this.handlePanelClick,
                                                                          element: 'body'
                                                                      }
                                                                  });
                                                                
                                                              • destroyable : Boolean (optional)

                                                                When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

                                                                Defaults to: false

                                                              • priority : Number (optional)

                                                                An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code.

                                                                Combining Options

                                                                Using the options argument, it is possible to combine different types of listeners:

                                                                A delayed, one-time listener.

                                                                myPanel.on('hide', this.handleClick, this, {
                                                                    single: true,
                                                                    delay: 100
                                                                });
                                                                

                                                            Returns

                                                            • Object

                                                              Only when the destroyable option is specified.

                                                              A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

                                                              this.btnListeners =  = myButton.on({
                                                                  destroyable: true
                                                                  mouseover:   function() { console.log('mouseover'); },
                                                                  mouseout:    function() { console.log('mouseout'); },
                                                                  click:       function() { console.log('click'); }
                                                              });
                                                              

                                                              And when those listeners need to be removed:

                                                              Ext.destroy(this.btnListeners);
                                                              

                                                              or

                                                              this.btnListeners.destroy();
                                                              
                                                            Attached as the 'complete' event listener to a proxy's Batch object. ...

                                                            Attached as the 'complete' event listener to a proxy's Batch object. Iterates over the batch operations and updates the Store's internal data MixedCollection.

                                                            Available since: 4.0.0

                                                            Parameters

                                                            Fires

                                                            ...

                                                            Available since: 4.0.0

                                                            Parameters

                                                            Attached as the 'operationcomplete' event listener to a proxy's Batch object. ...

                                                            Attached as the 'operationcomplete' event listener to a proxy's Batch object. By default just calls through to onProxyWrite.

                                                            Available since: 4.0.0

                                                            Parameters

                                                            Fires

                                                            Ext.data.Store
                                                            view source
                                                            ( )private
                                                            ...

                                                            Available since: 4.0.0

                                                            Fires

                                                            • beforesort

                                                            Overrides: Ext.util.Sortable.onBeforeSort

                                                            ...

                                                            Available since: 4.1.0

                                                            Parameters

                                                            ( names, callback, scope )private
                                                            ...

                                                            Available since: 4.1.0

                                                            Parameters

                                                            may be implemented by store subclasses ...

                                                            may be implemented by store subclasses

                                                            Available since: 4.1.0

                                                            ( records, operation, success )private
                                                            Removes any records when a write is returned from the server. ...

                                                            Removes any records when a write is returned from the server.

                                                            Available since: 4.1.0

                                                            Parameters

                                                            Ext.data.Store
                                                            view source
                                                            ( options )private
                                                            Handles a guaranteed range being loaded ...

                                                            Handles a guaranteed range being loaded

                                                            Available since: 4.0.0

                                                            Parameters

                                                            Fires

                                                            • guaranteedrange
                                                            Ext.data.Store
                                                            view source
                                                            ( rec, oldId, newId, oldInternalId )private
                                                            ...

                                                            Available since: Ext JS 4.2.0

                                                            Parameters

                                                            Fires

                                                              Overrides: Ext.data.AbstractStore.onIdChanged

                                                              private ...

                                                              private

                                                              Available since: 4.1.0

                                                              Parameters

                                                              Fires

                                                              Ext.data.Store
                                                              view source
                                                              ( )private
                                                              Cancels all pending prefetch requests. ...

                                                              Cancels all pending prefetch requests.

                                                              This is called when the page map is cleared.

                                                              Any requests which still make it through will be for the previous page map generation (generation is incremented upon clear), and so will be rejected upon arrival.

                                                              Available since: 4.1.3

                                                              Fires

                                                              Ext.data.Store
                                                              view source
                                                              ( operation )private
                                                              Called internally when a Proxy has completed a load request ...

                                                              Called internally when a Proxy has completed a load request

                                                              Available since: 4.0.0

                                                              Parameters

                                                              Fires

                                                              Ext.data.Store
                                                              view source
                                                              ( operation )private
                                                              Called after the configured proxy completes a prefetch operation. ...

                                                              Called after the configured proxy completes a prefetch operation.

                                                              Available since: 4.0.0

                                                              Parameters

                                                              Fires

                                                              Callback for any write Operation over the Proxy. ...

                                                              Callback for any write Operation over the Proxy. Updates the Store's MixedCollection to reflect the updates provided by the Proxy

                                                              Available since: 4.0.0

                                                              Parameters

                                                              Fires

                                                              Ext.data.Store
                                                              view source
                                                              ( record, type, modifiedFieldNames )private
                                                              ...

                                                              Available since: Ext JS 4.2.0

                                                              Parameters

                                                              Fires

                                                              Overrides: Ext.data.AbstractStore.onUpdate

                                                              may be implemented by store subclasses ...

                                                              may be implemented by store subclasses

                                                              Available since: 4.1.0

                                                              Ext.data.Store
                                                              view source
                                                              ( page )private
                                                              Determines if the passed page is available in the page cache. ...

                                                              Determines if the passed page is available in the page cache.

                                                              Available since: 4.1.0

                                                              Parameters

                                                              • page : Number

                                                                The page to find in the page cache.

                                                              Ext.data.Store
                                                              view source
                                                              ( [options] )
                                                              Prefetches data into the store using its configured proxy. ...

                                                              Prefetches data into the store using its configured proxy.

                                                              Available since: 4.0.0

                                                              Parameters

                                                              Fires

                                                              Ext.data.Store
                                                              view source
                                                              ( page, [options] )
                                                              Prefetches a page of data. ...

                                                              Prefetches a page of data.

                                                              Available since: 4.0.0

                                                              Parameters

                                                              Fires

                                                              Ext.data.Store
                                                              view source
                                                              ( start, end )
                                                              Ensures that the specified range of rows is present in the cache. ...

                                                              Ensures that the specified range of rows is present in the cache.

                                                              Converts the row range to a page range and then only load pages which are not already present in the page cache.

                                                              Available since: 4.1.0

                                                              Parameters

                                                              Fires

                                                              Prepares a given class for observable instances. ...

                                                              Prepares a given class for observable instances. This method is called when a class derives from this class or uses this class as a mixin.

                                                              Available since: 4.1.2

                                                              Parameters

                                                              • T : Function

                                                                The class constructor to prepare.

                                                              Ext.data.Store
                                                              view source
                                                              ( options )
                                                              Loads the previous 'page' in the current data set ...

                                                              Loads the previous 'page' in the current data set

                                                              Available since: 4.0.0

                                                              Parameters

                                                              Fires

                                                              Ext.data.Store
                                                              view source
                                                              ( start, end, direction )private
                                                              ...

                                                              Available since: Ext JS 4.2.0

                                                              Parameters

                                                              Fires

                                                              Ext.data.Store
                                                              view source
                                                              ( property, value, [anyMatch], [caseSensitive], [exactMatch] ) : Ext.util.MixedCollection
                                                              Query all the cached records in this Store by name/value pair. ...

                                                              Query all the cached records in this Store by name/value pair. The parameters will be used to generated a filter function that is given to the queryBy method.

                                                              This method compliments queryBy by generating the query function automatically.

                                                              Available since: 1.1.0

                                                              Parameters

                                                              • property : String

                                                                The property to create the filter function for

                                                              • value : String/RegExp

                                                                The string/regex to compare the property value to

                                                              • anyMatch : Boolean (optional)

                                                                true if we don't care if the filter value is not the full value.

                                                                Defaults to: false

                                                              • caseSensitive : Boolean (optional)

                                                                true to create a case-sensitive regex.

                                                                Defaults to: false

                                                              • exactMatch : Boolean (optional)

                                                                true to force exact match (^ and $ characters added to the regex). Ignored if anyMatch is true.

                                                                Defaults to: false

                                                              Returns

                                                              Fires

                                                                Ext.data.Store
                                                                view source
                                                                ( fn, [scope] ) : Ext.util.MixedCollection
                                                                Query all the cached records in this Store using a filtering function. ...

                                                                Query all the cached records in this Store using a filtering function. The specified function will be called with each record in this Store. If the function returns true the record is included in the results.

                                                                This method is not effected by filtering, it will always look from all records inside the store no matter if filter is applied or not.

                                                                Available since: 1.1.0

                                                                Parameters

                                                                • fn : Function

                                                                  The function to be called. It will be passed the following parameters:

                                                                  Parameters

                                                                • scope : Object (optional)

                                                                  The scope (this reference) in which the function is executed Defaults to this Store.

                                                                Returns

                                                                Ext.data.Store
                                                                view source
                                                                ( start, end )private
                                                                Determines if the passed range is available in the page cache. ...

                                                                Determines if the passed range is available in the page cache.

                                                                Available since: 4.1.0

                                                                Parameters

                                                                • start : Number

                                                                  The start index

                                                                • end : Number

                                                                  The end index in the range

                                                                Ext.data.Store
                                                                view source
                                                                ( start, end ) : Booleandeprecatedprivate
                                                                Determines if the passed range is available in the page cache. ...

                                                                Determines if the passed range is available in the page cache.

                                                                Available since: 4.0.0

                                                                This method has been deprecated since 4.1.0

                                                                use rangeCached instead

                                                                Parameters

                                                                • start : Number

                                                                  The start index

                                                                • end : Number

                                                                  The end index in the range

                                                                Returns

                                                                Fires

                                                                  ...

                                                                  Available since: 4.0.0

                                                                  Ext.data.Store
                                                                  view source
                                                                  ( )
                                                                  Rejects outstanding changes on all modified records and re-insert any records that were removed locally. ...

                                                                  Rejects outstanding changes on all modified records and re-insert any records that were removed locally. Any phantom records will be removed.

                                                                  Available since: 1.1.0

                                                                  Fires

                                                                  Relays selected events from the specified Observable as if the events were fired by this. ...

                                                                  Relays selected events from the specified Observable as if the events were fired by this.

                                                                  For example if you are extending Grid, you might decide to forward some events from store. So you can do this inside your initComponent:

                                                                  this.relayEvents(this.getStore(), ['load']);
                                                                  

                                                                  The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword.

                                                                  Available since: 2.3.0

                                                                  Parameters

                                                                  • origin : Object

                                                                    The Observable whose events this object is to relay.

                                                                  • events : String[]

                                                                    Array of event names to relay.

                                                                  • prefix : String (optional)

                                                                    A common prefix to prepend to the event names. For example:

                                                                    this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
                                                                    

                                                                    Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.

                                                                  Returns

                                                                  • Object

                                                                    A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:

                                                                    this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
                                                                    

                                                                    Can be undone by calling

                                                                    Ext.destroy(this.storeRelayers);
                                                                    

                                                                    or

                                                                    this.store.relayers.destroy();
                                                                    

                                                                  Fires

                                                                    Ext.data.Store
                                                                    view source
                                                                    ( options )
                                                                    Reloads the store using the last options passed to the load method. ...

                                                                    Reloads the store using the last options passed to the load method.

                                                                    Available since: 1.1.0

                                                                    Parameters

                                                                    Fires

                                                                    Overrides: Ext.data.AbstractStore.reload

                                                                    Ext.data.Store
                                                                    view source
                                                                    ( records )
                                                                    Removes the specified record(s) from the Store, firing the remove event for each instance that is removed. ...

                                                                    Removes the specified record(s) from the Store, firing the remove event for each instance that is removed.

                                                                    A bulkremove event is called at the end passing all removed records and their indices. plus a single 'datachanged' event after removal.

                                                                    Available since: 1.1.0

                                                                    Parameters

                                                                    Fires

                                                                    Ext.data.Store
                                                                    view source
                                                                    ( [silent] )
                                                                    Removes all items from the store. ...

                                                                    Removes all items from the store.

                                                                    Individual record remove events are not fired by this method.

                                                                    Available since: 1.1.0

                                                                    Parameters

                                                                    • silent : Boolean (optional)

                                                                      Pass true to prevent the record bulkremove and clear events from being fired.

                                                                      Defaults to: false

                                                                    Fires

                                                                    Overrides: Ext.data.AbstractStore.removeAll

                                                                    Ext.data.Store
                                                                    view source
                                                                    ( index, [count] )
                                                                    Removes the model instance(s) at the given index ...

                                                                    Removes the model instance(s) at the given index

                                                                    Available since: 2.3.0

                                                                    Parameters

                                                                    • index : Number

                                                                      The record index

                                                                    • count : Number (optional)

                                                                      The number of records to delete

                                                                      Defaults to: 1

                                                                    Fires

                                                                    Ext.data.Store
                                                                    view source
                                                                    ( toRemove, [applyFilters] )
                                                                    Removes an individual Filter from the current filter set using the passed Filter/Filter id and by default, applys the...

                                                                    Removes an individual Filter from the current filter set using the passed Filter/Filter id and by default, applys the updated filter set to the Store's unfiltered dataset.

                                                                    Available since: Ext JS 4.2.0

                                                                    Parameters

                                                                    • toRemove : Mixed

                                                                      The id of a Filter to remove from the filter set, or a Filter instance to remove.

                                                                    • applyFilters : Boolean (optional)

                                                                      Pass as false to remove the filter but not apply the updated filter set.

                                                                      If null is passed, all anonymous Filters (Filters with no id property) will be removed.

                                                                      Defaults to: true

                                                                    Fires

                                                                    Removes an event handler. ...

                                                                    Removes an event handler.

                                                                    Available since: 1.1.0

                                                                    Parameters

                                                                    • eventName : String

                                                                      The type of event the handler was associated with.

                                                                    • fn : Function

                                                                      The handler to remove. This must be a reference to the function passed into the addListener call.

                                                                    • scope : Object (optional)

                                                                      The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

                                                                    Fires

                                                                      Removes listeners that were added by the mon method. ...

                                                                      Removes listeners that were added by the mon method.

                                                                      Available since: 4.0.0

                                                                      Parameters

                                                                      • item : Ext.util.Observable/Ext.Element

                                                                        The item from which to remove a listener/listeners.

                                                                      • ename : Object/String

                                                                        The event name, or an object containing event name properties.

                                                                      • fn : Function (optional)

                                                                        If the ename parameter was an event name, this is the handler function.

                                                                      • scope : Object (optional)

                                                                        If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

                                                                      Fires

                                                                        Remove a single managed listener item ...

                                                                        Remove a single managed listener item

                                                                        Available since: 4.0.1

                                                                        Parameters

                                                                        • isClear : Boolean

                                                                          True if this is being called during a clear

                                                                        • managedListener : Object

                                                                          The managed listener item See removeManagedListener for other args

                                                                        Overrides: Ext.AbstractComponent.removeManagedListenerItem

                                                                        Resumes automatically syncing the Store with its Proxy. ...

                                                                        Resumes automatically syncing the Store with its Proxy. Only applicable if autoSync is true

                                                                        Available since: 4.1.0

                                                                        Resumes firing of the named event(s). ...

                                                                        Resumes firing of the named event(s).

                                                                        After calling this method to resume events, the events will fire when requested to fire.

                                                                        Note that if the suspendEvent method is called multiple times for a certain event, this converse method will have to be called the same number of times for it to resume firing.

                                                                        Available since: Ext JS 4.2.0

                                                                        Parameters

                                                                        • eventName : String...

                                                                          Multiple event names to resume.

                                                                        Resumes firing events (see suspendEvents). ...

                                                                        Resumes firing events (see suspendEvents).

                                                                        If events were suspended using the queueSuspended parameter, then all events fired during event suspension will be sent to any listeners now.

                                                                        Available since: 2.3.0

                                                                        Saves all pending changes via the configured proxy. ...

                                                                        Saves all pending changes via the configured proxy. Use sync instead.

                                                                        Available since: 4.0.0

                                                                        This method has been deprecated since 4.0.0

                                                                        Will be removed in the next major version

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

                                                                        Available since: 4.0.0

                                                                        Parameters

                                                                        Returns

                                                                        Sets the Store's Proxy by string, config object or Proxy instance ...

                                                                        Sets the Store's Proxy by string, config object or Proxy instance

                                                                        Available since: 4.0.0

                                                                        Parameters

                                                                        Returns

                                                                        Ext.data.Store
                                                                        view source
                                                                        ( ) : Ext.util.Sorter[]
                                                                        because prefetchData is stored by index this invalidates all of the prefetchedData ...

                                                                        because prefetchData is stored by index this invalidates all of the prefetchedData

                                                                        Available since: 1.1.0

                                                                        Returns

                                                                        Fires

                                                                        • beforesort

                                                                        Overrides: Ext.util.Sortable.sort

                                                                        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

                                                                        Ext.data.Store
                                                                        view source
                                                                        ( field, [grouped] ) : Number
                                                                        Sums the value of field for each record in store and returns the result. ...

                                                                        Sums the value of field for each record in store and returns the result.

                                                                        When store is filtered, only sums items within the filter.

                                                                        Available since: 1.1.0

                                                                        Parameters

                                                                        • field : String

                                                                          A field in each record

                                                                        • grouped : Boolean (optional)

                                                                          True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the sum for that group being the value. The grouped parameter is only honored if the store has a groupField.

                                                                        Returns

                                                                        Fires

                                                                          Suspends automatically syncing the Store with its Proxy. ...

                                                                          Suspends automatically syncing the Store with its Proxy. Only applicable if autoSync is true

                                                                          Available since: 4.1.0

                                                                          Suspends firing of the named event(s). ...

                                                                          Suspends firing of the named event(s).

                                                                          After calling this method to suspend events, the events will no longer fire when requested to fire.

                                                                          Note that if this is called multiple times for a certain event, the converse method resumeEvent will have to be called the same number of times for it to resume firing.

                                                                          Available since: Ext JS 4.2.0

                                                                          Parameters

                                                                          • eventName : String...

                                                                            Multiple event names to suspend.

                                                                          Suspends the firing of all events. ...

                                                                          Suspends the firing of all events. (see resumeEvents)

                                                                          Available since: 2.3.0

                                                                          Parameters

                                                                          • queueSuspended : Boolean

                                                                            Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events.

                                                                          Synchronizes the store with its proxy. ...

                                                                          Synchronizes the store with its proxy. This asks the proxy to batch together any new, updated and deleted records in the store, updating the store's internal representation of the records as each operation completes.

                                                                          Available since: 4.0.0

                                                                          Parameters

                                                                          • options : Object (optional)

                                                                            Object containing one or more properties supported by the sync method (these get passed along to the underlying proxy's batch method):

                                                                            • batch : Ext.data.Batch/Object (optional)

                                                                              A Ext.data.Batch object (or batch config to apply to the created batch). If unspecified a default batch will be auto-created as needed.

                                                                            • callback : Function (optional)

                                                                              The function to be called upon completion of the sync. The callback is called regardless of success or failure and is passed the following parameters:

                                                                              Parameters

                                                                              • batch : Ext.data.Batch

                                                                                The batch that was processed, containing all operations in their current state after processing

                                                                              • options : Object

                                                                                The options argument that was originally passed into sync

                                                                            • success : Function (optional)

                                                                              The function to be called upon successful completion of the sync. The success function is called only if no exceptions were reported in any operations. If one or more exceptions occurred then the failure function will be called instead. The success function is called with the following parameters:

                                                                              Parameters

                                                                              • batch : Ext.data.Batch

                                                                                The batch that was processed, containing all operations in their current state after processing

                                                                              • options : Object

                                                                                The options argument that was originally passed into sync

                                                                            • failure : Function (optional)

                                                                              The function to be called upon unsuccessful completion of the sync. The failure function is called when one or more operations returns an exception during processing (even if some operations were also successful). In this case you can check the batch's exceptions array to see exactly which operations had exceptions. The failure function is called with the following parameters:

                                                                              Parameters

                                                                              • batch : Ext.data.Batch

                                                                                The Ext.data.Batch that was processed, containing all operations in their current state after processing

                                                                              • options : Object

                                                                                The options argument that was originally passed into sync

                                                                            • scope : Object (optional)

                                                                              The scope in which to execute any callbacks (i.e. the this object inside the callback, success and/or failure functions). Defaults to the store's proxy.

                                                                          Returns

                                                                          Fires

                                                                          ( eventName, fn, [scope] )
                                                                          Shorthand for removeListener. ...

                                                                          Shorthand for removeListener.

                                                                          Available since: 1.1.0

                                                                          Parameters

                                                                          • eventName : String

                                                                            The type of event the handler was associated with.

                                                                          • fn : Function

                                                                            The handler to remove. This must be a reference to the function passed into the addListener call.

                                                                          • scope : Object (optional)

                                                                            The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

                                                                          ...

                                                                          Available since: 4.0.0

                                                                          Parameters

                                                                          Fires

                                                                            Ext.data.Store
                                                                            view source
                                                                            ( records )private
                                                                            ...

                                                                            Available since: Ext JS 4.2.0

                                                                            Parameters

                                                                            Fires

                                                                              Ext.data.Store
                                                                              view source
                                                                              ( records )private
                                                                              ...

                                                                              Available since: Ext JS 4.2.0

                                                                              Parameters

                                                                              Fires

                                                                                Ext.data.Store
                                                                                view source
                                                                                ( record, modifiedFieldNames )private
                                                                                ...

                                                                                Available since: Ext JS 4.2.0

                                                                                Parameters

                                                                                Fires

                                                                                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

                                                                                ( 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

                                                                                Ext.data.Store
                                                                                view source
                                                                                ( group )privatestatic
                                                                                ...

                                                                                Available since: Ext JS 4.2.0

                                                                                Parameters

                                                                                Ext.data.Store
                                                                                view source
                                                                                ( grouper )privatestatic
                                                                                ...

                                                                                Available since: Ext JS 4.2.0

                                                                                Parameters

                                                                                ( )deprecatedstatic
                                                                                Adds members to class. ...

                                                                                Adds members to class.

                                                                                Available since: 4.0.2

                                                                                This method has been deprecated since 4.1

                                                                                Use addMembers instead.

                                                                                ( name, mixinClass )privatestatic
                                                                                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).

                                                                                Available since: 4.0.2

                                                                                This method has been deprecated since 4.1.0

                                                                                Use Ext.define instead

                                                                                Parameters

                                                                                • members : Object

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

                                                                                Returns

                                                                                Ext.data.Store
                                                                                view source
                                                                                ( record )privatestatic
                                                                                ...

                                                                                Available since: 4.1.0

                                                                                Parameters

                                                                                Ext.data.Store
                                                                                view source
                                                                                ( record )privatestatic
                                                                                ...

                                                                                Available since: 4.1.0

                                                                                Parameters

                                                                                ...

                                                                                Available since: 4.1.1

                                                                                Defined By

                                                                                Events

                                                                                ( store, records, index, eOpts )
                                                                                Fired when a Model instance has been added to this Store. ...

                                                                                Fired when a Model instance has been added to this Store.

                                                                                Available since: 1.1.0

                                                                                Parameters

                                                                                Fires before a request is made for a new data object. ...

                                                                                Fires before a request is made for a new data object. If the beforeload handler returns false the load action will be canceled.

                                                                                Available since: 1.1.0

                                                                                Parameters

                                                                                Ext.data.Store
                                                                                view source
                                                                                ( this, operation, eOpts )
                                                                                Fires before a prefetch occurs. ...

                                                                                Fires before a prefetch occurs. Return false to cancel.

                                                                                Available since: 4.0.0

                                                                                Parameters

                                                                                Fired before a call to sync is executed. ...

                                                                                Fired before a call to sync is executed. Return false from any listener to cancel the sync

                                                                                Available since: 4.0.0

                                                                                Parameters

                                                                                ( store, records, indexes, isMove, eOpts )
                                                                                Fired at the end of the remove method when all records in the passed array have been removed. ...

                                                                                Fired at the end of the remove method when all records in the passed array have been removed.

                                                                                If many records may be removed in one go, then it is more efficient to listen for this event and perform any processing for a bulk remove than to listen for many remove events.

                                                                                Available since: 4.1.2

                                                                                Parameters

                                                                                • store : Ext.data.Store

                                                                                  The Store object

                                                                                • records : Ext.data.Model[]

                                                                                  The array of records that were removed (In the order they appear in the Store)

                                                                                • indexes : Number[]

                                                                                  The indexes of the records that were removed

                                                                                • isMove : Boolean

                                                                                  true if the child nodes are being removed so they can be moved to another position in this Store.

                                                                                • eOpts : Object

                                                                                  The options object passed to Ext.util.Observable.addListener.

                                                                                Fired after the removeAll method is called. ...

                                                                                Fired after the removeAll method is called.

                                                                                Available since: 1.1.0

                                                                                Parameters

                                                                                Fires whenever the records in the Store have changed in some way - this could include adding or removing records, or ...

                                                                                Fires whenever the records in the Store have changed in some way - this could include adding or removing records, or updating the data in existing records

                                                                                Available since: 1.1.0

                                                                                Parameters

                                                                                Ext.data.Store
                                                                                view source
                                                                                ( store, filters, eOpts )
                                                                                Fired whenever the filter set changes. ...

                                                                                Fired whenever the filter set changes.

                                                                                Available since: Ext JS 4.2.0

                                                                                Parameters

                                                                                Ext.data.Store
                                                                                view source
                                                                                ( store, groupers, eOpts )
                                                                                Fired whenever the grouping in the grid changes. ...

                                                                                Fired whenever the grouping in the grid changes.

                                                                                Available since: 4.0.0

                                                                                Parameters

                                                                                ( this, records, successful, eOpts )
                                                                                Fires whenever the store reads data from a remote data source. ...

                                                                                Fires whenever the store reads data from a remote data source.

                                                                                Available since: 1.1.0

                                                                                Parameters

                                                                                Fires when this store's underlying reader (available via the proxy) provides new metadata. ...

                                                                                Fires when this store's underlying reader (available via the proxy) provides new metadata. Metadata usually consists of new field definitions, but can include any configuration data required by an application, and can be processed as needed in the event handler. This event is currently only fired for JsonReaders.

                                                                                Available since: 1.1.0

                                                                                Parameters

                                                                                Ext.data.Store
                                                                                view source
                                                                                ( this, records, successful, operation, eOpts )
                                                                                Fires whenever records have been prefetched. ...

                                                                                Fires whenever records have been prefetched.

                                                                                Available since: 4.1.0

                                                                                Parameters

                                                                                Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a widget that i...

                                                                                Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a widget that is using this Store as a Record cache should refresh its view.

                                                                                Available since: 4.1.0

                                                                                Parameters

                                                                                ( store, record, index, isMove, eOpts )
                                                                                Fired when a Model instance has been removed from this Store. ...

                                                                                Fired when a Model instance has been removed from this Store.

                                                                                If many records may be removed in one go, then it is more efficient to listen for the bulkremove event and perform any processing for a bulk remove than to listen for this remove event.

                                                                                Available since: 1.1.0

                                                                                Parameters

                                                                                ( this, record, operation, modifiedFieldNames, eOpts )
                                                                                Fires when a Model instance has been updated. ...

                                                                                Fires when a Model instance has been updated.

                                                                                Available since: 1.1.0

                                                                                Parameters

                                                                                ( store, operation, eOpts )
                                                                                Fires whenever a successful write has been made via the configured Proxy ...

                                                                                Fires whenever a successful write has been made via the configured Proxy

                                                                                Available since: 3.4.0

                                                                                Parameters