autoLoad : Boolean/Object

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

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

autoSync : Boolean

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

batchUpdateMode : String

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

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

Defaults to: "operation"

buffered : Boolean

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

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

\n\n

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

\n\n

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

\n\n

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

\n\n

The margins which trigger view refreshing from the prefetched data are Ext.grid.PagingScroller.numFromEdge,\nExt.grid.PagingScroller.leadingBufferZone and Ext.grid.PagingScroller.trailingBufferZone.

\n\n

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

\n\n

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

\n\n

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

\n\n

selModel: {

\n\n

   pruneRemoved: false\n

\n\n

}

Defaults to: false

clearOnPageLoad : Boolean

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

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

Defaults to: true

clearRemovedOnLoad : Boolean

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

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

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.

fields : Object[]

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\nset of Ext.data.Field configuration objects. The store will automatically create a Ext.data.Model\nwith these fields. In general this configuration option should only be used for simple stores like\na two-field store of ComboBox. For anything more complicated, such as specifying a particular id property or\nassociations, a Ext.data.Model should be defined and specified for the model\nconfig.

filterOnLoad : Boolean

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.\nDefaults to true, ignored if remoteFilter is true

Defaults to: true

filters : Object[]/Function[]

Array of Filters for this store. ...

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

\n\n

filters: [\n    function(item) {\n        return item.internalId > 0;\n    }\n]\n

\n\n

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

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

groupField : String

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\ngroupField and groupDir are injected as the first sorter (see sort). Stores support a single\nlevel of grouping, and groups can be fetched via the getGroups method.

leadingBufferZone : Number

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

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

Defaults to: 200

listeners : Object

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\nshould be a valid listeners config object as specified in the addListener example for attaching multiple\nhandlers at once.

\n\n

DOM events from Ext JS Components

\n\n

While some Ext JS Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly 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\nchild element of a Component, we need to specify the element option to identify the Component property to add a\nDOM listener to:

\n\n

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

model : String

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

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

pageSize : 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\npaging using the nextPage and previousPage functions when the grid is paged using a\nPagingScroller Defaults to 25.

\n\n

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

\n\n

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

\n\n

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

\n\n

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

proxy : String/Ext.data.proxy.Proxy/Object

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 -\nsee setProxy for details.

Overrides: Ext.data.AbstractStore.proxy

purgePageCount : Number

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

Valid only when used with a buffered Store.

\n\n

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

\n\n

For example, if the height of the view area and the configured trailingBufferZone and leadingBufferZone require that there\nare 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.

\n\n

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

Defaults to: 5

remoteFilter : Boolean

True to defer any filtering operation to the server. ...

True to defer any filtering operation to the server. If false, filtering is done locally on the client.

Defaults to: false

remoteGroup : Boolean

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\ngrouping is local, it can be applied immediately to the data. If it is remote, then it will simply act as a\nhelper, automatically sending the grouping information to the server.

Defaults to: false

remoteSort : Boolean

True to defer any sorting operation to the server. ...

True to defer any sorting operation to the server. If false, sorting is done locally on the client.

Defaults to: false

sortOnFilter : Boolean

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

For local filtering only, causes sort to be called whenever filter is called,\ncausing the sorters to be reapplied after filtering. Defaults to true

Defaults to: true

sortOnLoad : Boolean

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.\nDefaults to true, igored if remoteSort is true

Defaults to: true

storeId : String

Unique identifier for this store. ...

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

\n\n

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

trailingBufferZone : Number

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

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

Defaults to: 25

Properties

Defined By

Instance Properties

$className : Stringprivate

...

Defaults to: "Ext.Base"

configMap : Objectprivate

...

Defaults to: {}

currentPage : Number

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

data : Ext.util.MixedCollection

The MixedCollection that holds this store's local cache of records.

defaultProxyType : String

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\nmemory proxy.

Defaults to: "memory"

defaultSortDirection : String

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"

eventsSuspended : Numberprivate

Initial suspended call count. ...

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

Defaults to: 0

filters : Ext.util.MixedCollection

The collection of Filters currently applied to this Store

groupers : Ext.util.MixedCollection

The collection of Groupers currently applied to this Store.

hasListeners : Objectreadonly

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\ndirectly on the instance, or on its class or a super class (via observe) or\non the MVC EventBus. The values of this object are truthy\n(a non-zero number) and falsy (0 or undefined). They do not represent an exact count\nof listeners. The value for an event is truthy if the event must be fired and is\nfalsy if there is no need to fire the event.

\n\n

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

\n\n

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

implicitModel : Booleanprivate

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\nconstructor instead of a model constructor or name.

Defaults to: false

initConfigList : Arrayprivate

...

Defaults to: []

initConfigMap : Objectprivate

...

Defaults to: {}

isDestroyed : Boolean

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\nas it will not function correctly any more.

Defaults to: false

isInstance : Booleanprivate

...

Defaults to: true

isObservable : Boolean

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

isSortable : Boolean

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

isStore : Boolean

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

loading : Booleanprivate

True if the Store is currently loading via its Proxy ...

True if the Store is currently loading via its Proxy

Defaults to: false

modelDefaults : Objectprivate

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

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

pageMap : Ext.data.Store.PageMapprivate

Internal PageMap instance.

removed : Ext.data.Model[]protected

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

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

Defaults to: []

self : Ext.Classprotected

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,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison

\n\n

Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); // dependent on 'this'\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n

snapshot : Ext.util.MixedCollection

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\nrecords when a filter is removed or changed

sortRoot : String

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

sorters : Ext.util.MixedCollection

The collection of Sorters currently applied to this Store

Defined By

Static Properties

$onExtended : Arrayprivatestatic

...

Defaults to: []

Methods

Defined By

Instance Methods

newExt.data.JsonStore( [Object config] ) : Object

Creates the store. ...

Creates the store.

Parameters

config : Object (optional)
Config object
\n

Returns

Object
\n

add( Ext.data.Model[]/Ext.data.Model... model ) : Ext.data.Model[]

Adds Model instance to the Store. ...

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

\n\n

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

\n\n\n

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

\n\n

Sample usage:

\n\n

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

\n\n

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

Parameters

model : Ext.data.Model[]/Ext.data.Model...
An array of Model instances\nor Model configuration objects, or variable number of Model instance or config arguments.
\n

Returns

Ext.data.Model[]
The model instances that were added
\n

addEvents( Object/String... eventNames )

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.

Parameters

eventNames : Object/String...
Either an object with event names as properties with\na value of true. For example:
\n\n
```
this.addEvents({\n    storeloaded: true,\n    storecleared: true\n});\n
```
\n\n
Or any number of event names as separate parameters. For example:
\n\n
```
this.addEvents('storeloaded', 'storecleared');\n
```
\n

addListener( String/Object eventName, [Function fn], [Object scope], [Object options] )

Appends an event handler to this object. ...

Appends an event handler to this object. For example:

\n\n

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

\n\n

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

\n\n

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

\n\n

One can also specify options for each event handler separately:

\n\n

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

\n\n

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

\n\n

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

Parameters

eventName : String/Object
The name of the event to listen for.\nMay also be an object who's property names are event names.
\n\n
fn : Function (optional)
The method the event invokes, or if scope is specified, the name* of the method within\nthe specified scope. Will be called with arguments\ngiven to fireEvent plus the options parameter described below.
\n\n
scope : Object (optional)
The scope (this reference) in which the handler function is\nexecuted. If omitted, defaults to the object which fired the event.
\n\n
options : Object (optional)
An object containing handler configuration.
\n\n\n\n\n
Note: Unlike in ExtJS 3.x, the options object will also be passed as the last\nargument to every event handler.
\n\n\n\n\n
This object may contain any of the following properties:
\n\n
- scope : Object
  The scope (this reference) in which the handler function is executed. If omitted,\n defaults to the object which fired the event.
  \n\n
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the event fires.
  \n\n
- single : Boolean
  True to add a handler to handle just the next firing of the event, and then remove itself.
  \n\n
- buffer : Number
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\n by the specified number of milliseconds. If the event fires again within that time,\n the original handler is not invoked, but the new handler is scheduled in its place.
  \n\n
- target : Ext.util.Observable
  Only call the handler if the event was fired on the target Observable, not if the event\n was bubbled up from a child Observable.
  \n\n
- element : String
  This option is only valid for listeners bound to Components.\n The name of a Component property which references an element to add a listener to.
  \n\n\n\n\n
  This option is useful during Component construction to add DOM event listeners to elements of\n Components which will exist only after the Component is rendered.\n For example, to add a click listener to a Panel's body:
  \n\n\n\n\n
```
  new Ext.panel.Panel({\n      title: 'The title',\n      listeners: {\n          click: this.handlePanelClick,\n          element: 'body'\n      }\n  });\n
```
  \n\n\n\n\n
  Combining Options
  \n\n\n\n\n
  Using the options argument, it is possible to combine different types of listeners:
  \n\n\n\n\n
  A delayed, one-time listener.
  \n\n\n\n\n
```
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
```
  \n\n

addManagedListener( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope], [Object opt] )

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

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

Parameters

item : Ext.util.Observable/Ext.Element
The item to which to add a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n
opt : Object (optional)
If the ename parameter was an event name, this is the\naddListener options.
\n\n

addSorted( Ext.data.Record record )

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

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

Parameters

record : Ext.data.Record
\n

afterCommit( Ext.data.Model record )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.

Parameters

record : Ext.data.Model
The model instance that was edited
\n

afterEdit( Ext.data.Model record, String[] 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.

Parameters

record : Ext.data.Model
The model instance that was edited
\n
modifiedFieldNames : String[]
Array of field names changed during edit.
\n

afterReject( Ext.data.Model record )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..

Parameters

record : Ext.data.Model
The model instance that was edited
\n

aggregate( Function fn, [Object scope], [Boolean grouped], [Array args] ) : Object

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

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

\n\n

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

Parameters

fn : Function
The function to execute. The function is called with a single parameter,\nan array of records for that group.
\n
scope : Object (optional)
The scope to execute the function in. Defaults to the store.
\n
grouped : Boolean (optional)
True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the group average being the value. The grouped parameter is only honored if\nthe store has a groupField.
\n
args : Array (optional)
Any arguments to append to the function call
\n

Returns

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

average( String field, [Boolean grouped] ) : Object

Gets the average value in the store. ...

Gets the average value in the store.

\n\n

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

Parameters

field : String
The field in each record
\n
grouped : Boolean (optional)
True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the group average being the value. The grouped parameter is only honored if\nthe store has a groupField.
\n

Returns

Object
The average value, if no items exist, 0.
\n

cachePage( Ext.data.Model[] records, Ext.data.Operation The )private

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

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

Parameters

records : Ext.data.Model[]
The records to cache
\n
The : Ext.data.Operation
associated operation
\n

callOverridden( Array/Arguments args ) : Objectdeprecatedprotected

Call the original method that was previously overridden with override\n\nExt.define('My.Cat', {\n constructor: functi...

Call the original method that was previously overridden with override

\n\n

Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n

This method has been deprecated

as of 4.1. Use callParent instead.

\n\n

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callOverridden(arguments)
\n

Returns

Object
Returns the result of calling the overridden method
\n

callParent( Array/Arguments args ) : Objectprotected

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

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

\n\n

 Ext.define('My.Base', {\n     constructor: function (x) {\n         this.x = x;\n     },\n\n     statics: {\n         method: function (x) {\n             return x;\n         }\n     }\n });\n\n Ext.define('My.Derived', {\n     extend: 'My.Base',\n\n     constructor: function () {\n         this.callParent([21]);\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // alerts 21\n

\n\n

This can be used with an override as follows:

\n\n

 Ext.define('My.DerivedOverride', {\n     override: 'My.Derived',\n\n     constructor: function (x) {\n         this.callParent([x*2]); // calls original My.Derived constructor\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // now alerts 42\n

\n\n

This also works with static methods.

\n\n

 Ext.define('My.Derived2', {\n     extend: 'My.Base',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Base.method\n         }\n     }\n });\n\n alert(My.Base.method(10);     // alerts 10\n alert(My.Derived2.method(10); // alerts 20\n

\n\n

Lastly, it also works with overridden static methods.

\n\n

 Ext.define('My.Derived2Override', {\n     override: 'My.Derived2',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Derived2.method\n         }\n     }\n });\n\n alert(My.Derived2.method(10); // now alerts 40\n

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)
\n

Returns

Object
Returns the result of calling the parent method
\n

cancelAllPrefetches( )private

Cancels all pending prefetch requests. ...

Cancels all pending prefetch requests.

\n\n

This is called when the page map is cleared.

\n\n

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

clearFilter( Boolean 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.

Parameters

suppressEvent : Boolean
If true the filter is cleared silently.
\n\n
For a locally filtered Store, this means that the filter collection is cleared without firing the\ndatachanged event.
\n\n
For a remotely filtered Store, this means that the filter collection is cleared, but the store\nis not reloaded from the server.
\n

clearGrouping( )

Clear any groupers in the store ...

Clear any groupers in the store

clearListeners( )

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

Removes all listeners for this object including the managed listeners

clearManagedListeners( )

Removes all managed listeners for this object. ...

Removes all managed listeners for this object.

collect( String dataIndex, [Boolean allowNull], [Boolean bypassFilter] ) : Object[]

Collects unique values for a particular dataIndex from this store. ...

Collects unique values for a particular dataIndex from this store.

Parameters

dataIndex : String
The property to collect
\n
allowNull : Boolean (optional)
Pass true to allow null, undefined or empty string values
\n
bypassFilter : Boolean (optional)
Pass true to collect from all records, even ones which are filtered.
\n

Returns

Object[]
An array of the unique values
\n

commitChanges( )

Commits all Records with outstanding changes. ...

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

configClass( )private

...

continueFireEvent( String eventName, Array args, Boolean bubbles )private

Continue to fire event. ...

Continue to fire event.

Parameters

eventName : String
\n
args : Array
\n
bubbles : Boolean
\n

count( [Boolean grouped] ) : Number

Gets the count of items in the store. ...

Gets the count of items in the store.

\n\n

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

Parameters

grouped : Boolean (optional)
True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the count for each group being the value. The grouped parameter is only honored if\nthe store has a groupField.
\n

Returns

Number
the count
\n

createFilterFn( String property, String/RegExp value, [Boolean anyMatch], [Boolean caseSensitive], [Boolean 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\nExt.util.MixedCollection's createValueMatcher function.

Parameters

property : String
The property to create the filter function for
\n
value : String/RegExp
The string/regex to compare the property value to
\n
anyMatch : Boolean (optional)
True if we don't care if the filter value is not the full value.
\n
Defaults to: false
caseSensitive : Boolean (optional)
True to create a case-sensitive regex.
\n
Defaults to: false
exactMatch : Boolean (optional)
True to force exact match (^ and $ characters added to the regex).\nIgnored if anyMatch is true.
\n
Defaults to: false

createModel( Ext.data.Model/Object 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

Parameters

record : Ext.data.Model/Object
The record to create
\n

Returns

Ext.data.Model
\n

createRelayer( Object newName, [Array beginEnd] ) : Functionprivate

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.

Parameters

newName : Object
\n
beginEnd : Array (optional)
The caller can specify on which indices to slice
\n

Returns

Function
\n

decodeFilters( Object[] filters ) : Ext.util.Filter[]private

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

Parameters

filters : Object[]
The filters array
\n

Returns

Ext.util.Filter[]
Array of Ext.util.Filter objects
\n

decodeGroupers( Object[] 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

Parameters

groupers : Object[]
The groupers array
\n

Returns

Ext.util.Grouper[]
Array of Ext.util.Grouper objects
\n

decodeSorters( Object[] sorters ) : Ext.util.Sorter[]private

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

Parameters

sorters : Object[]
The sorters array
\n

Returns

Ext.util.Sorter[]
Array of Ext.util.Sorter objects
\n

destroy( )private

...

Overrides: Ext.AbstractComponent.destroy, Ext.AbstractPlugin.destroy, Ext.layout.Layout.destroy

each( Function fn, [Object scope] )

Calls the specified function for each record in the store. ...

Calls the specified function for each record in the store.

\n\n

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

Parameters

fn : Function
The function to call. The Record is passed as the first parameter.\nReturning false aborts and exits the iteration.
\n
scope : Object (optional)
The scope (this reference) in which the function is executed.\nDefaults to the current record in the iteration.
\n

enableBubble( String/String[] eventNames )

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

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

\n\n

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

\n\n

Example:

\n\n

Ext.override(Ext.form.field.Base, {\n    //  Add functionality to Field's initComponent to enable the change event to bubble\n    initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n        this.enableBubble('change');\n    }),\n\n    //  We know that we want Field's events to bubble directly to the FormPanel.\n    getBubbleTarget : function() {\n        if (!this.formPanel) {\n            this.formPanel = this.findParentByType('form');\n        }\n        return this.formPanel;\n    }\n});\n\nvar myForm = new Ext.formPanel({\n    title: 'User Details',\n    items: [{\n        ...\n    }],\n    listeners: {\n        change: function() {\n            // Title goes red if form has been modified.\n            myForm.header.setStyle('color', 'red');\n        }\n    }\n});\n

Parameters

eventNames : String/String[]
The event name to bubble, or an Array of event names.
\n

filter( Object[]/Ext.util.Filter[]/String filters, [String 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.

\n\n

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

\n\n

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

\n\n

// Clear the filter collection without updating the UI\nstore.clearFilter(true);\n

\n\n

see clearFilter.

\n\n

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

\n\n

Filtering by single field:

\n\n

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

\n\n

Using multiple filters:

\n\n

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

\n\n

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

\n\n

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

\n\n

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

Parameters

filters : Object[]/Ext.util.Filter[]/String
The set of filters to apply to the data.\nThese are stored internally on the store, but the filtering itself is done on the Store's\nMixedCollection. See MixedCollection's\nfilter method for filter syntax.\nAlternatively, pass in a property string
\n
value : String (optional)
value to filter by (only if using a property string as the first argument)
\n

filterBy( Function fn, [Object scope] )

Filters by a function. ...

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

\n\n

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

Parameters

fn : Function
The function to be called. It will be passed the following parameters:
\n
Parameters
- record : Ext.data.Model
  The record to test for filtering. Access field values\n using Ext.data.Model.get.
  \n
- id : Object
  The ID of the Record passed.
  \n
scope : Object (optional)
The scope (this reference) in which the function is executed.\nDefaults to this Store.
\n

filterNew( Object item )private

Filter function for new records. ...

Filter function for new records.

Parameters

item : Object
\n

filterUpdated( Object item )private

Filter function for updated records. ...

Filter function for updated records.

Parameters

item : Object
\n

find( String fieldName, String/RegExp value, [Number startIndex], [Boolean anyMatch], [Boolean caseSensitive], [Boolean 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.

\n\n

When store is filtered, finds records only within filter.

Parameters

fieldName : String
The name of the Record field to test.
\n
value : String/RegExp
Either a string that the field value\nshould begin with, or a RegExp to test against the field.
\n
startIndex : Number (optional)
The index to start searching at
\n
Defaults to: 0
anyMatch : Boolean (optional)
True to match any part of the string, not just the beginning
\n
Defaults to: false
caseSensitive : Boolean (optional)
True for case sensitive comparison
\n
Defaults to: false
exactMatch : Boolean (optional)
True to force exact match (^ and $ characters added to the regex).
\n
Defaults to: false

Returns

Number
The matched index or -1
\n

findBy( Function fn, [Object scope], [Number 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.\nIf the function returns true it is considered a match.

\n\n

When store is filtered, finds records only within filter.

Parameters

fn : Function
The function to be called. It will be passed the following parameters:
\n
Parameters
- record : Ext.data.Model
  The record to test for filtering. Access field values\n using Ext.data.Model.get.
  \n
- id : Object
  The ID of the Record passed.
  \n
scope : Object (optional)
The scope (this reference) in which the function is executed.\nDefaults to this Store.
\n
startIndex : Number (optional)
The index to start searching at
\n
Defaults to: 0

Returns

Number
The matched index or -1
\n

findExact( String fieldName, Object value, [Number 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.

\n\n

When store is filtered, finds records only within filter.

Parameters

fieldName : String
The name of the Record field to test.
\n
value : Object
The value to match the field against.
\n
startIndex : Number (optional)
The index to start searching at
\n
Defaults to: 0

Returns

Number
The matched index or -1
\n

findRecord( String fieldName, String/RegExp value, [Number startIndex], [Boolean anyMatch], [Boolean caseSensitive], [Boolean 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.

\n\n

When store is filtered, finds records only within filter.

Parameters

fieldName : String
The name of the Record field to test.
\n
value : String/RegExp
Either a string that the field value\nshould begin with, or a RegExp to test against the field.
\n
startIndex : Number (optional)
The index to start searching at
\n
Defaults to: 0
anyMatch : Boolean (optional)
True to match any part of the string, not just the beginning
\n
Defaults to: false
caseSensitive : Boolean (optional)
True for case sensitive comparison
\n
Defaults to: false
exactMatch : Boolean (optional)
True to force exact match (^ and $ characters added to the regex).
\n
Defaults to: false

Returns

Ext.data.Model
The matched record or null
\n

fireEvent( String eventName, Object... args ) : Boolean

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

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

\n\n

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

Parameters

eventName : String
The name of the event to fire.
\n
args : Object...
Variable number of parameters are passed to handlers.
\n

Returns

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

fireGroupChange( )private

Fires the groupchange event. ...

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

first( [Boolean 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.

\n\n

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

Parameters

grouped : Boolean (optional)
True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the first record being the value. The grouped parameter is only honored if\nthe store has a groupField.
\n

Returns

Ext.data.Model/undefined
The first model instance in the store, or undefined
\n

generateComparator( )

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

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

\n\n\n

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

\n\n

getAt( Number index ) : Ext.data.Model

Get the Record at the specified index. ...

Get the Record at the specified index.

\n\n

The index is effected by filtering.

Parameters

index : Number
The index of the Record to find.
\n

Returns

Ext.data.Model
The Record at the passed index. Returns undefined if not found.
\n

getBatchListeners( ) : Objectprivate

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.\nThis is broken out into a separate function to allow for customisation of the listeners

Returns

Object
The listeners object
\n

getBubbleParent( ) : Ext.util.Observableprivate

Gets the bubbling parent for an Observable ...

Gets the bubbling parent for an Observable

Returns

Ext.util.Observable
The bubble parent. null is returned if no bubble target exists
\n

getById( Mixed id ) : Ext.data.Model

Get the Record with the specified id. ...

Get the Record with the specified id.

\n\n

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

Parameters

id : Mixed
The id of the Record to find.
\n

Returns

Ext.data.Model
The Record with the passed id. Returns null if not found.
\n

getConfig( Object name )private

...

Parameters

name : Object
\n

getCount( ) : Number

Gets the number of records in store. ...

Gets the number of records in store.

\n\n

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

\n\n

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

Returns

Number
The number of Records in the Store.
\n

getFirstSorter( ) : Ext.util.Sorterprotected

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

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

Returns

Ext.util.Sorter
The sorter, null if none exist
\n

getGroupData( [Boolean sort] ) : Object[]private

Returns records grouped by the configured grouper configuration. ...

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

\n\n

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

Parameters

sort : Boolean (optional)
True to call sort before finding groups. Sorting is required to make grouping\nfunction correctly so this should only be set to false if the Store is known to already be sorted correctly.
\n
Defaults to: true

Returns

Object[]
The group data
\n

getGroupString( Ext.data.Model 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\nthe model's groupField, but this can be overridden to group by an arbitrary string. For example, to\ngroup by the first letter of a model's 'name' field, use the following code:

\n\n

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

Parameters

instance : Ext.data.Model
The model instance
\n

Returns

String
The string to compare when forming groups
\n

getGroups( [String 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.\nSee groupField, groupDir and getGroupString. Example for a store\ncontaining records with a color field:

\n\n

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

\n\n

Group contents are effected by filtering.

Parameters

groupName : String (optional)
Pass in an optional groupName argument to access a specific\ngroup as defined by getGroupString.
\n

Returns

Object/Object[]
The grouped data
\n

getGroupsForGrouper( Object records, Object grouper )private

For a given set of records and a Grouper, returns an array of arrays - each of which is the set of records\nmatching a...

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

Parameters

records : Object
\n
grouper : Object
\n

getGroupsForGrouperIndex( Ext.data.Model[] records, Number 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\nthis to work properly (see getGroupData and getGroupsForGrouper) Most of the work is done by\ngetGroupsForGrouper - this function largely just handles the recursion.

Parameters

records : Ext.data.Model[]
The set or subset of records to group
\n
grouperIndex : Number
The grouper index to retrieve
\n

Returns

Object[]
The grouped records
\n

getInitialConfig( [String name] ) : Object/Mixed

Returns the initial configuration passed to constructor when instantiating\nthis class. ...

Returns the initial configuration passed to constructor when instantiating\nthis class.

Parameters

name : String (optional)
Name of the config option to return.
\n

Returns

Object/Mixed
The full config object or a single config value\nwhen name parameter specified.
\n

getModifiedRecords( ) : Ext.data.Model[]

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\nreturned is not deterministic and does not indicate the order in which records were modified. Note also that\nremoved records are not included (use getRemovedRecords for that).

Returns

Ext.data.Model[]
The added and updated Model instances
\n

getNewRecords( ) : Ext.data.Model[]

Returns all Model instances that are either currently a phantom (e.g. ...

Returns all Model instances that are either currently a phantom (e.g. have no id), or have an ID but have not\nyet been saved on this Store (this happens when adding a non-phantom record from another Store into this one)

Returns

Ext.data.Model[]
The Model instances
\n

getPageFromRecordIndex( Number index ) : Number

Determines the page from a record index ...

Determines the page from a record index

Parameters

index : Number
The record index
\n

Returns

Number
The page the record belongs to
\n

getProxy( ) : Ext.data.proxy.Proxy

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

Returns the proxy currently attached to this proxy instance

Returns

Ext.data.proxy.Proxy
The Proxy instance
\n

getRange( [Number startIndex], [Number endIndex] ) : Ext.data.Model[]

Returns a range of Records between specified indices. ...

Returns a range of Records between specified indices.

\n\n

This method is effected by filtering.

Parameters

startIndex : Number (optional)
The starting index
\n
Defaults to: 0
endIndex : Number (optional)
The ending index. Defaults to the last Record in the Store.
\n

Returns

Ext.data.Model[]
An array of Records
\n

getRemovedRecords( ) : Ext.data.Model[]

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.

Returns

Ext.data.Model[]
The removed Model instances
\n

getTotalCount( ) : Number

Returns the total number of Model instances that the Proxy\nindicates exist. ...

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

Returns

Number
The total number of Model instances available via the Proxy. 0 returned if\nno value has been set via the reader.
\n

getUpdatedRecords( ) : Ext.data.Model[]

Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy ...

Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy

Returns

Ext.data.Model[]
The updated Model instances
\n

group( String/Object[] groupers, [String direction] )

Groups data inside the store. ...

Groups data inside the store.

Parameters

groupers : String/Object[]
Either a string name of one of the fields in this Store's\nconfigured Model, or an Array of grouper configurations.
\n
direction : String (optional)
The overall direction to group the data by.
\n
Defaults to: "ASC"

guaranteeRange( Object start, Object end, Object cb, Object scope )

Guarantee a specific range, this will load the store with a range (that\nmust be the pageSize or smaller) and take car...

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

Parameters

start : Object
\n
end : Object
\n
cb : Object
\n
scope : Object
\n

hasConfig( Object config )private

...

Parameters

config : Object
\n

hasListener( String eventName ) : Boolean

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\nindicates whether the event needs firing or not.

Parameters

eventName : String
The name of the event to check for
\n

Returns

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

indexOf( Ext.data.Model record ) : Number

Get the index of the record within the store. ...

Get the index of the record within the store.

\n\n

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

Parameters

record : Ext.data.Model
The Ext.data.Model object to find.
\n

Returns

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

indexOfId( String 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.

\n\n

Like indexOf, this method is effected by filtering.

Parameters

id : String
The id of the Record to find.
\n

Returns

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

indexOfTotal( Ext.data.Model record ) : Number

Get the index within the entire dataset. ...

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

\n\n

Like indexOf, this method is effected by filtering.

Parameters

record : Ext.data.Model
The Ext.data.Model object to find.
\n

Returns

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

initConfig( Object config ) : Ext.Baseprotected

Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

\n\n

Ext.define('My.awesome.Class', {\n    // The default config\n    config: {\n        name: 'Awesome',\n        isAwesome: true\n    },\n\n    constructor: function(config) {\n        this.initConfig(config);\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n

Parameters

config : Object
\n

Returns

Ext.Base
this
\n

initSortable( )

Performs initialization of this mixin. ...

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

insert( Number index, Ext.data.Model[] records )

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.\nSee also add.

Parameters

index : Number
The start index at which to insert the passed Records.
\n
records : Ext.data.Model[]
An Array of Ext.data.Model objects to add to the store.
\n

isFiltered( ) : Boolean

Returns true if this store is currently filtered ...

Returns true if this store is currently filtered

Returns

Boolean
\n

isGrouped( ) : Boolean

Checks if the store is currently grouped ...

Checks if the store is currently grouped

Returns

Boolean
True if the store is grouped.
\n

isLoading( ) : Boolean

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

Returns true if the Store is currently performing a load operation

Returns

Boolean
True if the Store is currently loading
\n

last( [Boolean 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.

\n\n

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

Parameters

grouped : Boolean (optional)
True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the last record being the value. The grouped parameter is only honored if\nthe store has a groupField.
\n

Returns

Ext.data.Model/undefined
The last model instance in the store, or undefined
\n

load( [Object/Function 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\nasynchronous call to whatever storage backend the Proxy uses, automatically adding the retrieved\ninstances into the Store and calling an optional callback if required. Example usage:

\n\n

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

\n\n

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

\n\n

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

Parameters

options : Object/Function (optional)
config object, passed into the Ext.data.Operation object before loading.\nAdditionally addRecords: true can be specified to add these records to the existing records, default is\nto remove the Store's existing records first.
\n

Overrides: Ext.data.AbstractStore.load

loadData( Ext.data.Model[]/Object[] data, [Boolean append] )

Loads an array of data straight into the Store. ...

Loads an array of data straight into the Store.

\n\n

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

Parameters

data : Ext.data.Model[]/Object[]
Array of data to load. Any non-model instances will be cast\ninto model instances first.
\n
append : Boolean (optional)
True to add the records to the existing records in the store, false\nto remove the old ones first.
\n
Defaults to: false

loadPage( Number page, Object 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\nload operation, passing in calculated 'start' and 'limit' params

Parameters

page : Number
The number of the page to load
\n
options : Object
See options for load
\n

loadRawData( Object[] data, [Boolean append] )

Loads data via the bound Proxy's reader\n\nUse this method if you are attempting to load data and want to utilize the c...

Loads data via the bound Proxy's reader

\n\n

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

Parameters

data : Object[]
The full JSON object you'd like to load into the Data store.
\n
append : Boolean (optional)
True to add the records to the existing records in the store, false\nto remove the old ones first.
\n
Defaults to: false

loadRecords( Ext.data.Model[] records, Object 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\nbe called internally when loading from the Proxy, when adding records manually use add instead

Parameters

records : Ext.data.Model[]
The array of records to load
\n
options : Object
\n
- addRecords : Boolean (optional)
  Pass true to add these records to the existing records, false to remove the Store's existing records first.
  \n
  Defaults to: false
- start : Number (optional)
  Only used by buffered Stores. The index within the overall dataset of the first record in the array.
  \n

max( String field, [Boolean grouped] ) : Object

Gets the maximum value in the store. ...

Gets the maximum value in the store.

\n\n

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

Parameters

field : String
The field in each record
\n
grouped : Boolean (optional)
True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the maximum in the group being the value. The grouped parameter is only honored if\nthe store has a groupField.
\n

Returns

Object
The maximum value, if no items exist, undefined.
\n

min( String field, [Boolean grouped] ) : Object

Gets the minimum value in the store. ...

Gets the minimum value in the store.

\n\n

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

Parameters

field : String
The field in each record
\n
grouped : Boolean (optional)
True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the minimum in the group being the value. The grouped parameter is only honored if\nthe store has a groupField.
\n

Returns

Object
The minimum value, if no items exist, undefined.
\n

mon( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope], [Object opt] )

Shorthand for addManagedListener. ...

Shorthand for addManagedListener.

\n\n

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

Parameters

item : Ext.util.Observable/Ext.Element
The item to which to add a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n
opt : Object (optional)
If the ename parameter was an event name, this is the\naddListener options.
\n\n

mun( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope] )

Shorthand for removeManagedListener. ...

Shorthand for removeManagedListener.

\n\n

Removes listeners that were added by the mon method.

Parameters

item : Ext.util.Observable/Ext.Element
The item from which to remove a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n

nextPage( Object options )

Loads the next 'page' in the current data set ...

Loads the next 'page' in the current data set

Parameters

options : Object
See options for load
\n

on( String/Object eventName, [Function fn], [Object scope], [Object options] )

Shorthand for addListener. ...

Shorthand for addListener.

\n\n

Appends an event handler to this object. For example:

\n\n

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

\n\n

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

\n\n

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

\n\n

One can also specify options for each event handler separately:

\n\n

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

\n\n

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

\n\n

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

Parameters

eventName : String/Object
The name of the event to listen for.\nMay also be an object who's property names are event names.
\n\n
fn : Function (optional)
The method the event invokes, or if scope is specified, the name* of the method within\nthe specified scope. Will be called with arguments\ngiven to fireEvent plus the options parameter described below.
\n\n
scope : Object (optional)
The scope (this reference) in which the handler function is\nexecuted. If omitted, defaults to the object which fired the event.
\n\n
options : Object (optional)
An object containing handler configuration.
\n\n\n\n\n
Note: Unlike in ExtJS 3.x, the options object will also be passed as the last\nargument to every event handler.
\n\n\n\n\n
This object may contain any of the following properties:
\n\n
- scope : Object
  The scope (this reference) in which the handler function is executed. If omitted,\n defaults to the object which fired the event.
  \n\n
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the event fires.
  \n\n
- single : Boolean
  True to add a handler to handle just the next firing of the event, and then remove itself.
  \n\n
- buffer : Number
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\n by the specified number of milliseconds. If the event fires again within that time,\n the original handler is not invoked, but the new handler is scheduled in its place.
  \n\n
- target : Ext.util.Observable
  Only call the handler if the event was fired on the target Observable, not if the event\n was bubbled up from a child Observable.
  \n\n
- element : String
  This option is only valid for listeners bound to Components.\n The name of a Component property which references an element to add a listener to.
  \n\n\n\n\n
  This option is useful during Component construction to add DOM event listeners to elements of\n Components which will exist only after the Component is rendered.\n For example, to add a click listener to a Panel's body:
  \n\n\n\n\n
```
  new Ext.panel.Panel({\n      title: 'The title',\n      listeners: {\n          click: this.handlePanelClick,\n          element: 'body'\n      }\n  });\n
```
  \n\n\n\n\n
  Combining Options
  \n\n\n\n\n
  Using the options argument, it is possible to combine different types of listeners:
  \n\n\n\n\n
  A delayed, one-time listener.
  \n\n\n\n\n
```
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
```
  \n\n

onBatchComplete( Object batch, Object operation )private

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\nand updates the Store's internal data MixedCollection.

Parameters

batch : Object
\n
operation : Object
\n

onBatchException( Object batch, Object operation )private

...

Parameters

batch : Object
\n
operation : Object
\n

onBatchOperationComplete( Object batch, Object operation )private

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\nto onProxyWrite.

Parameters

batch : Object
\n
operation : Object
\n

onConfigUpdate( Object names, Object callback, Object scope )private

...

Parameters

names : Object
\n
callback : Object
\n
scope : Object
\n

onDestroyRecords( Ext.data.Model[] records, Ext.data.Operation operation, Boolean success )private

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

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

Parameters

records : Ext.data.Model[]
The array of removed records
\n
operation : Ext.data.Operation
The operation that just completed
\n
success : Boolean
True if the operation was successful
\n

onGuaranteedRange( Object options )private

Handles a guaranteed range being loaded ...

Handles a guaranteed range being loaded

Parameters

options : Object
\n

onProxyLoad( Object operation )private

Called internally when a Proxy has completed a load request ...

Called internally when a Proxy has completed a load request

Parameters

operation : Object
\n

onProxyPrefetch( Ext.data.Operation operation )private

Called after the configured proxy completes a prefetch operation. ...

Called after the configured proxy completes a prefetch operation.

Parameters

operation : Ext.data.Operation
The operation that completed
\n

onProxyWrite( Object operation )private

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

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

Parameters

operation : Object
\n

pageCached( Number page )private

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

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

Parameters

page : Number
The page to find in the page cache.
\n

prefetch( [Object options] )

Prefetches data into the store using its configured proxy. ...

Prefetches data into the store using its configured proxy.

Parameters

options : Object (optional)
config object, passed into the Ext.data.Operation object before loading.\nSee load
\n

prefetchPage( Number page, [Object options] )

Prefetches a page of data. ...

Prefetches a page of data.

Parameters

page : Number
The page to prefetch
\n
options : Object (optional)
config object, passed into the Ext.data.Operation object before loading.\nSee load
\n

prefetchRange( Object start, Object 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.

\n\n

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

Parameters

start : Object
\n
end : Object
\n

prepareClass( Function T )private

Prepares a given class for observable instances. ...

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

Parameters

T : Function
The class constructor to prepare.
\n

previousPage( Object options )

Loads the previous 'page' in the current data set ...

Loads the previous 'page' in the current data set

Parameters

options : Object
See options for load
\n

query( String property, String/RegExp value, [Boolean anyMatch], [Boolean caseSensitive], [Boolean 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.\nThe parameters will be used to generated a filter function that is given\nto the queryBy method.

\n\n

This method compliments queryBy by generating the query function automatically.

Parameters

property : String
The property to create the filter function for
\n
value : String/RegExp
The string/regex to compare the property value to
\n
anyMatch : Boolean (optional)
True if we don't care if the filter value is not the full value.
\n
Defaults to: false
caseSensitive : Boolean (optional)
True to create a case-sensitive regex.
\n
Defaults to: false
exactMatch : Boolean (optional)
True to force exact match (^ and $ characters added to the regex).\nIgnored if anyMatch is true.
\n
Defaults to: false

Returns

Ext.util.MixedCollection
Returns an Ext.util.MixedCollection of the matched records
\n

queryBy( Function fn, [Object 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\nwill be called with each record in this Store. If the function returns true the record is\nincluded in the results.

\n\n

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

Parameters

fn : Function
The function to be called. It will be passed the following parameters:
\n
Parameters
- record : Ext.data.Model
  The record to test for filtering. Access field values\n using Ext.data.Model.get.
  \n
- id : Object
  The ID of the Record passed.
  \n
scope : Object (optional)
The scope (this reference) in which the function is executed\nDefaults to this Store.
\n

Returns

Ext.util.MixedCollection
Returns an Ext.util.MixedCollection of the matched records
\n

rangeCached( Number start, Number end )private

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

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

Parameters

start : Number
The start index
\n
end : Number
The end index in the range
\n

rangeSatisfied( Number start, Number end )deprecatedprivate

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

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

This method has been deprecated since 4.1.0

use rangeCached instead

\n\n

Parameters

start : Number
The start index
\n
end : Number
The end index in the range
\n

rejectChanges( )

Rejects outstanding changes on all modified records\nand re-insert any records that were removed locally. ...

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

relayEvents( Object origin, String[] events, [String prefix] )

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.

\n\n

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

\n\n

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

\n\n

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

Parameters

origin : Object
The Observable whose events this object is to relay.
\n
events : String[]
Array of event names to relay.
\n
prefix : String (optional)
A common prefix to prepend to the event names. For example:
\n\n
```
this.relayEvents(this.getStore(), ['load', 'clear'], 'store');\n
```
\n\n
Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.
\n

reload( Object 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.

Parameters

options : Object
A config object which contains options which may override the options passed to the previous load call.
\n

remove( Ext.data.Model/Ext.data.Model[] records )

Removes the given record from the Store, firing the 'remove' event for each instance that is removed,\nplus a single '...

Removes the given record from the Store, firing the 'remove' event for each instance that is removed,\nplus a single 'datachanged' event after removal.

Parameters

records : Ext.data.Model/Ext.data.Model[]
Model instance or array of instances to remove.
\n

removeAll( Boolean silent )

Removes all items from the store. ...

Removes all items from the store.

Parameters

silent : Boolean
Prevent the clear event from being fired.
\n

Overrides: Ext.data.AbstractStore.removeAll

removeAt( Number index )

Removes the model instance at the given index ...

Removes the model instance at the given index

Parameters

index : Number
The record index
\n

removeListener( String eventName, Function fn, [Object scope] )

Removes an event handler. ...

Removes an event handler.

Parameters

eventName : String
The type of event the handler was associated with.
\n\n
fn : Function
The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\n
scope : Object (optional)
The scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\n

removeManagedListener( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope] )

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

Removes listeners that were added by the mon method.

Parameters

item : Ext.util.Observable/Ext.Element
The item from which to remove a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n

removeManagedListenerItem( Boolean isClear, Object managedListener )private

Remove a single managed listener item ...

Remove a single managed listener item

Parameters

isClear : Boolean
True if this is being called during a clear
\n
managedListener : Object
The managed listener item\nSee removeManagedListener for other args
\n

resumeAutoSync( )

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

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

resumeEvents( )

Resumes firing events (see suspendEvents). ...

Resumes firing events (see suspendEvents).

\n\n

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

save( )deprecated

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

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

This method has been deprecated since 4.0.0

Will be removed in the next major version

\n\n

setConfig( Object config, Object applyIfNotSet )private

...

Parameters

config : Object
\n
applyIfNotSet : Object
\n

setProxy( String/Object/Ext.data.proxy.Proxy proxy ) : Ext.data.proxy.Proxy

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

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

Parameters

proxy : String/Object/Ext.data.proxy.Proxy
The new Proxy, which can be either a type string, a configuration object\nor an Ext.data.proxy.Proxy instance
\n

Returns

Ext.data.proxy.Proxy
The attached Proxy object
\n

sort( [String/Ext.util.Sorter[] sorters], [String direction] ) : Ext.util.Sorter[]

Sorts the data in the Store by one or more of its properties. ...

Sorts the data in the Store by one or more of its properties. Example usage:

\n\n

//sort by a single field\nmyStore.sort('myField', 'DESC');\n\n//sorting by multiple fields\nmyStore.sort([\n    {\n        property : 'age',\n        direction: 'ASC'\n    },\n    {\n        property : 'name',\n        direction: 'DESC'\n    }\n]);\n

\n\n

Internally, Store converts the passed arguments into an array of Ext.util.Sorter instances, and delegates\nthe actual sorting to its internal Ext.util.MixedCollection.

\n\n

When passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:

\n\n

store.sort('myField');\nstore.sort('myField');\n

\n\n

Is equivalent to this code, because Store handles the toggling automatically:

\n\n

store.sort('myField', 'ASC');\nstore.sort('myField', 'DESC');\n

Parameters

sorters : String/Ext.util.Sorter[] (optional)
Either a string name of one of the fields in this Store's configured\nModel, or an array of sorter configurations.
\n
direction : String (optional)
The overall direction to sort the data by.
\n
Defaults to: "ASC"

Returns

Ext.util.Sorter[]
\n

statics( ) : Ext.Classprotected

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,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time

\n\n

Ext.define('My.Cat', {\n    statics: {\n        totalCreated: 0,\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        var statics = this.statics();\n\n        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to\n                                        // equivalent to: My.Cat.speciesName\n\n        alert(this.self.speciesName);   // dependent on 'this'\n\n        statics.totalCreated++;\n    },\n\n    clone: function() {\n        var cloned = new this.self;                      // dependent on 'this'\n\n        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName\n\n        return cloned;\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n\n    statics: {\n        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'\n    },\n\n    constructor: function() {\n        this.callParent();\n    }\n});\n\nvar cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'\nalert(clone.groupName);                 // alerts 'Cat'\n\nalert(My.Cat.totalCreated);             // alerts 3\n

Returns

Ext.Class
\n

sum( String field, [Boolean grouped] ) : Number

Sums the value of property for each record between start\nand end and returns the result. ...

Sums the value of property for each record between start\nand end and returns the result.

\n\n

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

Parameters

field : String
A field in each record
\n
grouped : Boolean (optional)
True to perform the operation for each group\nin the store. The value returned will be an object literal with the key being the group\nname and the sum for that group being the value. The grouped parameter is only honored if\nthe store has a groupField.
\n

Returns

Number
The sum
\n

suspendAutoSync( )

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

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

suspendEvents( Boolean queueSuspended )

Suspends the firing of all events. ...

Suspends the firing of all events. (see resumeEvents)

Parameters

queueSuspended : Boolean
Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\n

sync( [Object options] ) : Ext.data.Store

Synchronizes the store with its proxy. ...

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

Parameters

options : Object (optional)
Object containing one or more properties supported by the sync method (these get\npassed along to the underlying proxy's batch method):
\n
- batch : Ext.data.Batch/Object (optional)
  A Ext.data.Batch object (or batch config to apply\nto the created batch). If unspecified a default batch will be auto-created as needed.
  \n
- callback : Function (optional)
  The function to be called upon completion of the sync.\nThe callback is called regardless of success or failure and is passed the following parameters:
  \n
  Parameters
  - batch : Ext.data.Batch
    The batch that was processed,\ncontaining all operations in their current state after processing
    \n
  - options : Object
    The options argument that was originally passed into sync
    \n
- success : Function (optional)
  The function to be called upon successful completion of the sync. The\nsuccess function is called only if no exceptions were reported in any operations. If one or more exceptions\noccurred then the failure function will be called instead. The success function is called\nwith the following parameters:
  \n
  Parameters
  - batch : Ext.data.Batch
    The batch that was processed,\ncontaining all operations in their current state after processing
    \n
  - options : Object
    The options argument that was originally passed into sync
    \n
- failure : Function (optional)
  The function to be called upon unsuccessful completion of the sync. The\nfailure function is called when one or more operations returns an exception during processing (even if some\noperations 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\nfollowing parameters:
  \n
  Parameters
  - batch : Ext.data.Batch
    The Ext.data.Batch that was processed, containing all\noperations in their current state after processing
    \n
  - options : Object
    The options argument that was originally passed into sync
    \n
- scope : Object (optional)
  The scope in which to execute any callbacks (i.e. the this object inside\nthe callback, success and/or failure functions). Defaults to the store's proxy.
  \n

Returns

Ext.data.Store
this
\n

un( String eventName, Function fn, [Object scope] )

Shorthand for removeListener. ...

Shorthand for removeListener.

\n\n

Removes an event handler.

Parameters

eventName : String
The type of event the handler was associated with.
\n\n
fn : Function
The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\n
scope : Object (optional)
The scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\n

Defined By

Static Methods

addConfig( Object config )privatestatic

...

Parameters

config : Object
\n

addInheritableStatics( Object members )privatestatic

...

Parameters

members : Object
\n

addMember( Object name, Object member )privatestatic

...

Parameters

name : Object
\n
member : Object
\n

addMembers( Object members )static

Add methods / properties to the prototype of this class. ...

Add methods / properties to the prototype of this class.

\n\n

Ext.define('My.awesome.Cat', {\n    constructor: function() {\n        ...\n    }\n});\n\n My.awesome.Cat.addMembers({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n

Parameters

members : Object
\n

addStatics( Object members ) : Ext.Basestatic

Add / override static properties of this class. ...

Add / override static properties of this class.

\n\n

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

Parameters

members : Object
\n

Returns

Ext.Base
this
\n

addXtype( Object xtype )privatestatic

...

Parameters

xtype : Object
\n

borrow( Ext.Base fromClass, Array/String members ) : Ext.Baseprivatestatic

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

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

\n\n

Ext.define('Bank', {\n    money: '$$$',\n    printMoney: function() {\n        alert('$$$$$$$');\n    }\n});\n\nExt.define('Thief', {\n    ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n

Parameters

fromClass : Ext.Base
The class to borrow members from
\n
members : Array/String
The names of the members to borrow
\n

Returns

Ext.Base
this
\n

createAlias( String/Object alias, String/Object origin )static

Create aliases for existing prototype methods. ...

Create aliases for existing prototype methods. Example:

\n\n

Ext.define('My.cool.Class', {\n    method1: function() { ... },\n    method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n    method3: 'method1',\n    method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n

Parameters

alias : String/Object
The new method name, or an object to set multiple aliases. See\nflexSetter
\n
origin : String/Object
The original method name
\n

extend( Object config )privatestatic

...

Parameters

config : Object
\n

getName( ) : Stringstatic

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

Get the current class' name in string format.

\n\n

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

Returns

String
className
\n

implement( )deprecatedstatic

Adds members to class. ...

Adds members to class.

This method has been deprecated since 4.1

Use addMembers instead.

\n\n

mixin( Object name, Object mixinClass )privatestatic

Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

Parameters

name : Object
\n
mixinClass : Object
\n

onExtended( Object fn, Object scope )privatestatic

...

Parameters

fn : Object
\n
scope : Object
\n

override( Object members ) : Ext.Basedeprecatedstatic

Override members of this class. ...

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

\n\n

Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n

\n\n

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

\n\n

Ext.define('My.CatOverride', {\n    override: 'My.Cat',\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n

\n\n

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

This method has been deprecated since 4.1.0

Use Ext.define instead

\n\n

Parameters

members : Object
The properties to add to this class. This should be\nspecified as an object literal containing one or more properties.
\n

Returns

Ext.Base
this class
\n

triggerExtended( )privatestatic

...

Defined By

Events

add( Ext.data.Store store, Ext.data.Model[] records, Number index, Object eOpts )

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

Fired when a Model instance has been added to this Store

Parameters

store : Ext.data.Store
The store
\n
records : Ext.data.Model[]
The Model instances that were added
\n
index : Number
The index at which the instances were inserted
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforeload( Ext.data.Store store, Ext.data.Operation operation, Object eOpts )

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\naction will be canceled.

Parameters

store : Ext.data.Store
This Store
\n
operation : Ext.data.Operation
The Ext.data.Operation object that will be passed to the Proxy to\nload the Store
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforeprefetch( Ext.data.Store this, Ext.data.Operation operation, Object eOpts )

Fires before a prefetch occurs. ...

Fires before a prefetch occurs. Return false to cancel.

Parameters

this : Ext.data.Store
\n
operation : Ext.data.Operation
The associated operation
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforesync( Object options, Object eOpts )

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

Parameters

options : Object
Hash of all records to be synchronized, broken down into create, update and destroy
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

clear( Ext.data.Store this, Object eOpts )

Fired after the removeAll method is called. ...

Fired after the removeAll method is called.

Parameters

this : Ext.data.Store
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

datachanged( Ext.data.Store this, Object eOpts )

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

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

Parameters

this : Ext.data.Store
The data store
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

groupchange( Ext.data.Store store, Ext.util.Grouper[] groupers, Object eOpts )

Fired whenever the grouping in the grid changes ...

Fired whenever the grouping in the grid changes

Parameters

store : Ext.data.Store
The store
\n
groupers : Ext.util.Grouper[]
The array of grouper objects
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

load( Ext.data.Store this, Ext.data.Model[] records, Boolean successful, Object eOpts )

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

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

Parameters

this : Ext.data.Store
\n
records : Ext.data.Model[]
An array of records
\n
successful : Boolean
True if the operation was successful.
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

metachange( Ext.data.Store this, Object meta, Object eOpts )

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.\nMetadata usually consists of new field definitions, but can include any configuration data\nrequired by an application, and can be processed as needed in the event handler.\nThis event is currently only fired for JsonReaders.

Parameters

this : Ext.data.Store
\n
meta : Object
The JSON metadata
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

prefetch( Ext.data.Store this, Ext.data.Model[] records, Boolean successful, Ext.data.Operation operation, Object eOpts )

Fires whenever records have been prefetched ...

Fires whenever records have been prefetched

Parameters

this : Ext.data.Store
\n
records : Ext.data.Model[]
An array of records.
\n
successful : Boolean
True if the operation was successful.
\n
operation : Ext.data.Operation
The associated operation
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

refresh( Ext.data.Store this, Object eOpts )

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

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

Parameters

this : Ext.data.Store
The data store
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

remove( Ext.data.Store store, Ext.data.Model record, Number index, Object eOpts )

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

Fired when a Model instance has been removed from this Store

Parameters

store : Ext.data.Store
The Store object
\n
record : Ext.data.Model
The record that was removed
\n
index : Number
The index of the record that was removed
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

update( Ext.data.Store this, Ext.data.Model record, String operation, String[] modifiedFieldNames, Object eOpts )

Fires when a Model instance has been updated ...

Fires when a Model instance has been updated

Parameters

this : Ext.data.Store
\n
record : Ext.data.Model
The Model instance that was updated
\n
operation : String
The update operation being performed. Value may be one of:
\n\n
```
Ext.data.Model.EDIT\nExt.data.Model.REJECT\nExt.data.Model.COMMIT\n
```
\n
modifiedFieldNames : String[]
Array of field names changed during edit.
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n