For up to date documentation and features, visit http://docs.sencha.com/ext-js/4-0

Sencha Documentation

Hierarchy

Mixins

Small helper class to create an Ext.data.Store configured with an Ext.data.proxy.Direct and Ext.data.reader.Json to make interacting with an Ext.Direct Server-side Provider easier. To create a different proxy/reader combination create a basic Ext.data.Store configured as needed.

*Note: Although they are not listed, this class inherits all of the config options of:

Defined By

Config Options

Other Configs

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

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

 

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

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

 
Allow the store to buffer and pre-fetch pages of records. This is to be used in conjunction with a view will tell the...

Allow the store to buffer and pre-fetch pages of records. This is to be used in conjunction with a view will tell the store to pre-fetch records ahead of a time.

 
True to empty the store when loading another page via loadPage, nextPage or previousPage (defaults to true). Setting ...

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

 

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

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

 
This may be used in place of specifying a model configuration. The fields should be a set of Ext.data.Field configura...

This may be used in place of specifying a model configuration. The fields should be a set of Ext.data.Field configuration objects. The store will automatically create a Ext.data.Model with these fields. In general this configuration option should be avoided, it exists for the purposes of backwards compatibility. For anything more complicated, such as specifying a particular id property or assocations, a Ext.data.Model should be defined and specified for the model config.

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

(optional)

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


DOM events from ExtJs Components


While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this

is usually only done when extra value can be added. For example the DataView's click event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

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

 

The Ext.data.Model associated with this store

The Ext.data.Model associated with this store

 
proxy : String/Ext.data.proxy.Proxy/Object
The Proxy to use for this Store. This can be either a string, a config object or a Proxy instance - see setProxy for ...

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

 
The number of pages to keep in the cache before purging additional records. A value of 0 indicates to never purge the...

The number of pages to keep in the cache before purging additional records. A value of 0 indicates to never purge the prefetched data. This option is only relevant when the buffered option is set to true.

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

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

 
True if the grouping should apply on the server side, false if it is local only (defaults to false). If the grouping...

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

 

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

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

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

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

 
Optional unique identifier for this store. If present, this Store will be registered with the Ext.data.StoreManager, ...

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

Defined By

Properties

 
Loop over each record returned from the server. Assume they are returned in order of how they were sent. If we find a...

Loop over each record returned from the server. Assume they are returned in order of how they were sent. If we find a matching record, replace it with the newly created one.

 
Sets the updating behavior based on batch synchronization. 'operation' (the default) will update the Store's internal...

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

 

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

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

 
data : Ext.util.MixedCollection

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

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

 

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

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

 

The default sort direction to use if one is not specified (defaults to "ASC")

The default sort direction to use if one is not specified (defaults to "ASC")

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

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

 
filters : Ext.util.MixedCollection

The collection of Filters currently applied to this Store

The collection of Filters currently applied to this Store

 

The direction in which sorting should be applied when grouping. Defaults to "ASC" - the other supported value is "DESC"

The direction in which sorting should be applied when grouping. Defaults to "ASC" - the other supported value is "DESC"

 
The (optional) field by which to group data in the store. Internally, grouping is very similar to sorting - the group...

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

 
groupers : Ext.util.MixedCollection

The collection of Groupers currently applied to this Store

The collection of Groupers currently applied to this Store

 
True if the Store has already been destroyed via destroyStore. If this is true, the reference to Store should be dele...

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

 

Flag denoting that this object is sortable. Always true.

Flag denoting that this object is sortable. Always true.

 
The number of records considered to form a 'page'. This is used to power the built-in paging using the nextPage and p...

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

 
Removes all records from the store. This method does a "fast remove", individual remove events are not called. The cl...

Removes all records from the store. This method does a "fast remove", individual remove events are not called. The clear event is fired upon completion.

 
snapshot : Ext.util.MixedCollection
A pristine (unfiltered) collection of the records in this store. This is used to reinstate records when a filter is r...

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

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

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

 

The property in each item that contains the data to sort. (defaults to null)

The property in each item that contains the data to sort. (defaults to null)

 
sorters : Ext.util.MixedCollection

The collection of Sorters currently applied to this Store

The collection of Sorters currently applied to this Store

Defined By

Methods

 

 

Parameters

  • config : Object

Returns

  • void   
 
add( Object data) : Array
Adds Model instances to the Store by instantiating them based on a JavaScript object. When adding already- instantiat...

Adds Model instances to the Store by instantiating them based on a JavaScript object. When adding already- instantiated Models, use insert instead. The instances will be added at the end of the existing collection. This method accepts either a single argument array of Model instances or any number of model instance arguments. Sample usage:

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

Parameters

  • data : Object

    The data for each model

Returns

  • Array   

    The array of newly created model instances

 
addEvents( Object/String o, String ) : void

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

  • o : Object/String

    Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters.

  • : String

    [additional] Optional additional event names if multiple event names are being passed as separate parameters. Usage:

    this.addEvents('storeloaded', 'storecleared');
    

Returns

  • void   
 
addListener( String eventName, Function handler, [Object scope], [Object options]) : void

Appends an event handler to this object.

Appends an event handler to this object.

Parameters

  • eventName : String

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

  • handler : Function

    The method the event invokes.

  • scope : Object

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

  • options : Object

    (optional) An object containing handler configuration. properties. This may contain any of the following properties:

    • scope : Object
      The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.
    • delay : Number
      The number of milliseconds to delay the invocation of the handler after the event fires.
    • single : Boolean
      True to add a handler to handle just the next firing of the event, and then remove itself.
    • buffer : Number
      Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
    • target : Observable
      Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
    • element : String
      This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

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

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

      When added in this way, the options available are the options applicable to Ext.core.Element.addListener


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

    A delayed, one-time listener.

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

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

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

Returns

  • void   
 
addManagedListener( Observable/Element item, Object/String ename, Function fn, Object scope, Object opt) : void

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

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

Parameters

  • item : Observable/Element

    The item to which to add a listener/listeners.

  • ename : Object/String

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

  • fn : Function

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

  • scope : Object

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

  • opt : Object

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

Returns

  • void   
 
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.

Parameters

  • fn : Function

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

  • scope : Object

    (optional) The scope to execute the function in. Defaults to the store.

  • grouped : Boolean

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

  • args : Array

    (optional) Any arguments to append to the function call

Returns

  • Object   

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

 
average( String field, Boolean grouped) : Mixed/undefined

Gets the average value in the store.

Gets the average value in the store.

Parameters

  • field : String

    The field in each record

  • grouped : Boolean

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

Returns

  • Mixed/undefined   

    The average value, if no items exist, 0.

 
capture( Observable o, Function fn, [Object scope]) : void
Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + ...

Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + standard signature of the event before the event is fired. If the supplied function returns false, the event will not fire.

Parameters

  • o : Observable

    The Observable to capture events from.

  • fn : Function

    The function to call when an event is fired.

  • scope : Object

    (optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.

Returns

  • void   
 
clearFilter( Boolean suppressEvent) : void

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

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

Parameters

  • suppressEvent : Boolean

    If true the filter is cleared silently without firing the datachanged event.

Returns

  • void   
 

Clear any groupers in the store

Clear any groupers in the store

Returns

  • void   
 

Removes all listeners for this object including the managed listeners

Removes all listeners for this object including the managed listeners

Returns

  • void   
 

Removes all managed listeners for this object.

Removes all managed listeners for this object.

Returns

  • void   
 
collect( String dataIndex, [Boolean allowNull], [Boolean bypassFilter]) : Array

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

  • allowNull : Boolean

    (optional) Pass true to allow null, undefined or empty string values

  • bypassFilter : Boolean

    (optional) Pass true to collect from all records, even ones which are filtered

Returns

  • Array   

    An array of the unique values

 
count( Boolean grouped) : Number

Gets the count of items in the store.

Gets the count of items in the store.

Parameters

  • grouped : Boolean

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

Returns

  • Number   

    the count

 
each( Function fn, [Object scope]) : void

Calls the specified function for each of the Records in the cache.

Calls the specified function for each of the Records in the cache.

Parameters

  • fn : Function

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

  • scope : Object

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

Returns

  • void   
 
enableBubble( String/Array events) : void
Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present....

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

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

Example:

Ext.override(Ext.form.field.Base, {
//  Add functionality to Field's initComponent to enable the change event to bubble
initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
    this.enableBubble('change');
}),

//  We know that we want Field's events to bubble directly to the FormPanel.
getBubbleTarget : function() {
    if (!this.formPanel) {
        this.formPanel = this.findParentByType('form');
    }
    return this.formPanel;
}
});

var myForm = new Ext.formPanel({
title: 'User Details',
items: [{
    ...
}],
listeners: {
    change: function() {
        // Title goes red if form has been modified.
        myForm.header.setStyle('color', 'red');
    }
}
});

Parameters

  • events : String/Array

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

Returns

  • void   
 
filter( Mixed filters, String value) : void

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

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

Parameters

  • filters : Mixed

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

  • value : String

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

Returns

  • void   
 
filterBy( Function fn, [Object scope]) : void
Filter by a function. The specified function will be called for each Record in this Store. If the function returns tr...

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

Parameters

  • fn : Function

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

    • record : Ext.data.Model

      The record to test for filtering. Access field values using Ext.data.Model.get.

    • id : Object

      The ID of the Record passed.

  • scope : Object

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

Returns

  • void   
 
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.

Parameters

  • fieldName : String

    The name of the Record field to test.

  • value : String/RegExp

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

  • startIndex : Number

    (optional) The index to start searching at

  • anyMatch : Boolean

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

  • caseSensitive : Boolean

    (optional) True for case sensitive comparison

  • exactMatch : Boolean

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

Returns

  • Number   

    The matched index or -1

 
findBy( Function fn, [Object scope], [Number startIndex]) : Number
Find the index of the first matching Record in this Store by a function. If the function returns true it is considere...

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

Parameters

  • fn : Function

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

    • record : Ext.data.Model

      The record to test for filtering. Access field values using Ext.data.Model.get.

    • id : Object

      The ID of the Record passed.

  • scope : Object

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

  • startIndex : Number

    (optional) The index to start searching at

Returns

  • Number   

    The matched index or -1

 
findExact( String fieldName, Mixed 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.

Parameters

  • fieldName : String

    The name of the Record field to test.

  • value : Mixed

    The value to match the field against.

  • startIndex : Number

    (optional) The index to start searching at

Returns

  • Number   

    The matched index or -1

 
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.

Parameters

  • fieldName : String

    The name of the Record field to test.

  • value : String/RegExp

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

  • startIndex : Number

    (optional) The index to start searching at

  • anyMatch : Boolean

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

  • caseSensitive : Boolean

    (optional) True for case sensitive comparison

  • exactMatch : Boolean

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

Returns

  • Ext.data.Model   

    The matched record or null

 
fireEvent( String eventName, Object... args) : Boolean
Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Ob...

Fires the specified event with the passed parameters (minus the event name).

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

Parameters

  • eventName : String

    The name of the event to fire.

  • args : Object...

    Variable number of parameters are passed to handlers.

Returns

  • Boolean   

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

 
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

Parameters

  • grouped : Boolean

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

Returns

  • Ext.data.Model/undefined   

    The first model instance in the store, or undefined

 
getAt( Number index) : Ext.data.Model

Get the Record at the specified index.

Get the Record at the specified index.

Parameters

  • index : Number

    The index of the Record to find.

Returns

  • Ext.data.Model   

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

 
getById( String id) : Ext.data.Model

Get the Record with the specified id.

Get the Record with the specified id.

Parameters

  • id : String

    The id of the Record to find.

Returns

  • Ext.data.Model   

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

 
Gets the number of cached records. If using paging, this may not be the total size of the dataset. If the data objec...

Gets the number of cached records.

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

Returns

  • Number   

    The number of Records in the Store's cache.

 
getGroupString( Ext.data.Model instance) : String
Returns the string to group on for a given model instance. The default implementation of this method returns the mode...

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

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

Parameters

  • instance : Ext.data.Model

    The model instance

Returns

  • String   

    The string to compare when forming groups

 
getGroups( String groupName) : Array
Returns an object containing the result of applying grouping to the records in this store. See groupField, groupDir a...

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

var myStore = new Ext.data.Store({
    groupField: 'color',
    groupDir  : 'DESC'
});

myStore.getGroups(); //returns:
[
    {
        name: 'yellow',
        children: [
            //all records where the color field is 'yellow'
        ]
    },
    {
        name: 'red',
        children: [
            //all records where the color field is 'red'
        ]
    }
]

Parameters

  • groupName : String

    (Optional) Pass in an optional groupName argument to access a specific group as defined by getGroupString

Returns

  • Array   

    The grouped data

 
Returns all Model instances that are either currently a phantom (e.g. have no id), or have an ID but have not yet bee...

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

Returns

  • Array   

    The Model instances

 

Determines the page from a record index

Determines the page from a record index

Parameters

  • index : Number

    The record index

Returns

  • Number   

    The page the record belongs to

 

Returns the proxy currently attached to this proxy instance

Returns the proxy currently attached to this proxy instance

Returns

  • Ext.data.proxy.Proxy   

    The Proxy instance

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

Returns a range of Records between specified indices.

Returns a range of Records between specified indices.

Parameters

  • startIndex : Number

    (optional) The starting index (defaults to 0)

  • endIndex : Number

    (optional) The ending index (defaults to the last Record in the Store)

Returns

  • Ext.data.Model[]   

    An array of Records

 

Returns an object describing the current sort state of this Store.

Returns an object describing the current sort state of this Store.

Returns

  • Object   

    The sort state of the Store. An object with two properties:

    • field : String

      The name of the field by which the Records are sorted.

    • direction : String

      The sort order, 'ASC' or 'DESC' (case-sensitive).

    See sortInfo for additional details.

 
Returns the total number of Model instances that the Proxy indicates exist. This will usually differ from getCount wh...

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

Returns

  • Number   

    The total number of Model instances available via the Proxy

 

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

  • Array   

    The updated Model instances

 
group( String|Array groupers, String direction) : void

Group data in the store

Group data in the store

Parameters

  • groupers : String|Array

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

  • direction : String

    The overall direction to group the data by. Defaults to "ASC".

Returns

  • void   
 
guaranteeRange( Object start, Object end, Object cb, Object scope) : void
Guarantee a specific range, this will load the store with a range (that must be the pageSize or smaller) and take car...

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

Parameters

  • start : Object
  • end : Object
  • cb : Object
  • scope : Object

Returns

  • void   
 
hasListener( String eventName) : Boolean

Checks to see if this object has any listeners for a specified event

Checks to see if this object has any listeners for a specified event

Parameters

  • eventName : String

    The name of the event to check for

Returns

  • Boolean   

    True if the event is being listened for, else false

 

Returns the number of pending requests out.

Returns the number of pending requests out.

Returns

  • void   
 
indexOf( Ext.data.Model record) : Number

Get the index within the cache of the passed Record.

Get the index within the cache of the passed Record.

Parameters

Returns

  • Number   

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

 

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

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

Parameters

  • id : String

    The id of the Record to find.

Returns

  • Number   

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

 
indexOfTotal( Ext.data.Model record) : Number

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

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

Parameters

Returns

  • Number   

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

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

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

Returns

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

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

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

Parameters

  • index : Number

    The start index at which to insert the passed Records.

  • records : Ext.data.Model[]

    An Array of Ext.data.Model objects to add to the cache.

Returns

  • void   
 

Returns true if this store is currently filtered

Returns true if this store is currently filtered

Returns

  • Boolean   
 

Checks if the store is currently grouped

Checks if the store is currently grouped

Returns

  • Boolean   

    True if the store is grouped.

 

Returns true if the Store is currently performing a load operation

Returns true if the Store is currently performing a load operation

Returns

  • Boolean   

    True if the Store is currently loading

 
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

Parameters

  • grouped : Boolean

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

Returns

  • Ext.data.Model/undefined   

    The last model instance in the store, or undefined

 
load( Object/Function options) : void
Loads data into the Store via the configured proxy. This uses the Proxy to make an asynchronous call to whatever stor...

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

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

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

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

Parameters

  • options : Object/Function

    Optional config object, passed into the Ext.data.Operation object before loading.

Returns

  • void   
 
loadData( Array data, Boolean append) : void

Loads an array of data straight into the Store

Loads an array of data straight into the Store

Parameters

  • data : Array

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

  • append : Boolean

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

Returns

  • void   
 
Loads a given 'page' of data by setting the start and limit values appropriately. Internally this just causes a norma...

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

Parameters

  • page : Number

    The number of the page to load

Returns

  • void   
 
loadRecords( Array records, Object options) : void
Loads an array of {@Ext.data.Model model} instances into the store, fires the datachanged event. This should only usu...

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

Parameters

  • records : Array

    The array of records to load

  • options : Object

    {addRecords: true} to add these records to the existing records, false to remove the Store's existing records first

Returns

  • void   
 
max( String field, Boolean grouped) : Mixed/undefined

Gets the maximum value in the store.

Gets the maximum value in the store.

Parameters

  • field : String

    The field in each record

  • grouped : Boolean

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

Returns

  • Mixed/undefined   

    The maximum value, if no items exist, undefined.

 
min( String field, Boolean grouped) : Mixed/undefined

Gets the minimum value in the store.

Gets the minimum value in the store.

Parameters

  • field : String

    The field in each record

  • grouped : Boolean

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

Returns

  • Mixed/undefined   

    The minimum value, if no items exist, undefined.

 

Loads the next 'page' in the current data set

Loads the next 'page' in the current data set

Returns

  • void   
 
observe( Function c, Object listeners) : void
Sets observability on the passed class constructor. This makes any event fired on any instance of the passed class a...

Sets observability on the passed class constructor.

This makes any event fired on any instance of the passed class also fire a single event through the class allowing for central handling of events on many instances at once.

Usage:

Ext.util.Observable.observe(Ext.data.Connection);
Ext.data.Connection.on('beforerequest', function(con, options) {
    console.log('Ajax request made to ' + options.url);
});

Parameters

  • c : Function

    The class constructor to make observable.

  • listeners : Object

    An object containing a series of listeners to add. See addListener.

Returns

  • void   
 
on( String eventName, Function handler, [Object scope], [Object options]) : void

Appends an event handler to this object (shorthand for addListener.)

Appends an event handler to this object (shorthand for addListener.)

Parameters

  • eventName : String

    The type of event to listen for

  • handler : Function

    The method the event invokes

  • scope : Object

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

  • options : Object

    (optional) An object containing handler configuration.

Returns

  • void   
 
prefetch( Object options) : void

Prefetches data the Store using its configured proxy.

Prefetches data the Store using its configured proxy.

Parameters

Returns

  • void   
 
prefetchPage( Number page, Object options, Object ) : void

Prefetches a page of data.

Prefetches a page of data.

Parameters

  • page : Number

    The page to prefetch

  • options : Object

    Optional config object, passed into the Ext.data.Operation object before loading. See load

  • : Object

Returns

  • void   
 

Loads the previous 'page' in the current data set

Loads the previous 'page' in the current data set

Returns

  • void   
 

Purge the least recently used records in the prefetch if the purgeCount has been exceeded.

Purge the least recently used records in the prefetch if the purgeCount has been exceeded.

Returns

  • void   
 
queryBy( Function fn, [Object scope]) : MixedCollection
Query the cached records in this Store using a filtering function. The specified function will be called with each re...

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

Parameters

  • fn : Function

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

    • record : Ext.data.Model

      The record to test for filtering. Access field values using Ext.data.Model.get.

    • id : Object

      The ID of the Record passed.

  • scope : Object

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

Returns

 
relayEvents( Object origin, Array events, Object prefix) : void

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.

Parameters

  • origin : Object

    The Observable whose events this object is to relay.

  • events : Array

    Array of event names to relay.

  • prefix : Object

Returns

  • void   
 

Removes all added captures from the Observable.

Removes all added captures from the Observable.

Parameters

  • o : Observable

    The Observable to release

Returns

  • void   
 
remove( Ext.data.Model/Array records, Object isMove) : void
Removes the given record from the Store, firing the 'remove' event for each instance that is removed, plus a single '...

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

Parameters

  • records : Ext.data.Model/Array

    The Ext.data.Model instance or array of instances to remove

  • isMove : Object

Returns

  • void   
 
removeAll( Boolean silent) : void

Remove all items from the store.

Remove all items from the store.

Parameters

  • silent : Boolean

    Prevent the clear event from being fired.

Returns

  • void   
 
removeAt( Number index) : void

Removes the model instance at the given index

Removes the model instance at the given index

Parameters

  • index : Number

    The record index

Returns

  • void   
 
removeListener( String eventName, Function handler, [Object scope]) : void

Removes an event handler.

Removes an event handler.

Parameters

  • eventName : String

    The type of event the handler was associated with.

  • handler : Function

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

  • scope : Object

    (optional) The scope originally specified for the handler.

Returns

  • void   
 
removeManagedListener( Observable|Element item, Object|String ename, Function fn, Object scope) : void

Removes listeners that were added by the mon method.

Removes listeners that were added by the mon method.

Parameters

  • item : Observable|Element

    The item from which to remove a listener/listeners.

  • ename : Object|String

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

  • fn : Function

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

  • scope : Object

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

Returns

  • void   
 
Resume firing events. (see suspendEvents) If events were suspended using the queueSuspended parameter, then all event...

Resume firing events. (see suspendEvents) If events were suspended using the queueSuspended parameter, then all events fired during event suspension will be sent to any listeners now.

Returns

  • void   
 
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 or an Ext.data.proxy.Proxy instance

Returns

  • Ext.data.proxy.Proxy   

    The attached Proxy object

 
sort( String|Array sorters, String direction, Object where, Object doSort) : void
Sorts the data in the Store by one or more of its properties. Example usage: //sort by a single field myStore.sort(...

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

//sort by a single field
myStore.sort('myField', 'DESC');

//sorting by multiple fields
myStore.sort([
    {
        property : 'age',
        direction: 'ASC'
    },
    {
        property : 'name',
        direction: 'DESC'
    }
]);

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

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

store.sort('myField');
store.sort('myField');
     

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

store.sort('myField', 'ASC');
store.sort('myField', 'DESC');

Parameters

  • sorters : String|Array

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

  • direction : String

    The overall direction to sort the data by. Defaults to "ASC".

  • where : Object
  • doSort : Object

Returns

  • void   
 
sum( String field, Boolean grouped) : Number

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

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

Parameters

  • field : String

    A field in each record

  • grouped : Boolean

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

Returns

  • Number   

    The sum

 
suspendEvents( Boolean queueSuspended) : void

Suspend the firing of all events. (see resumeEvents)

Suspend the firing of all events. (see resumeEvents)

Parameters

  • queueSuspended : Boolean

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

Returns

  • void   
 
Synchronizes the Store with its Proxy. This asks the Proxy to batch together any new, updated and deleted records in ...

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

Returns

  • void   
 
un( String eventName, Function handler, [Object scope]) : void

Removes an event handler (shorthand for removeListener.)

Removes an event handler (shorthand for removeListener.)

Parameters

  • eventName : String

    The type of event the handler was associated with.

  • handler : Function

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

  • scope : Object

    (optional) The scope originally specified for the handler.

Returns

  • void   
Defined By

Events

 
add( Ext.data.Store store, Array records, Number index)

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

  • records : Array

    The Model instances that were added

  • index : Number

    The index at which the instances were inserted

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

Event description

Event description

Parameters

  • store : Ext.data.Store

    This Store

  • operation : Ext.data.Operation

    The Ext.data.Operation object that will be passed to the Proxy to load the Store

 
beforeprefetch( Ext.data.store this, Ext.data.Operation operation)

Fires before a prefetch occurs. Return false to cancel.

Fires before a prefetch occurs. Return false to cancel.

Parameters

  • this : Ext.data.store
  • operation : Ext.data.Operation

    The associated operation

 

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

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

Parameters

  • options : Object

    Hash of all records to be synchronized, broken down into create, update and destroy

 

Fired after the removeAll method is called.

Fired after the removeAll method is called.

Parameters

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

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

Parameters

  • this : Ext.data.Store

    The data store

 
groupchange( Ext.data.Store store, Array groupers)

Fired whenever the grouping in the grid changes

Fired whenever the grouping in the grid changes

Parameters

  • store : Ext.data.Store

    The store

  • groupers : Array

    The array of grouper objects

 
load( Ext.data.store this, Array records, Boolean successful, Ext.data.Operation operation)

Fires whenever records have been prefetched

Fires whenever records have been prefetched

Parameters

  • this : Ext.data.store
  • records : Array

    An array of records

  • successful : Boolean

    True if the operation was successful.

  • operation : Ext.data.Operation

    The associated operation

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

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

  • record : Ext.data.Model

    The record that was removed

  • index : Number

    The index of the record that was removed

 
update( Store this, Ext.data.Model record, String operation)

Fires when a Record has been updated

Fires when a Record has been updated

Parameters

  • this : Store
  • record : Ext.data.Model

    The Model instance that was updated

  • operation : String

    The update operation being performed. Value may be one of:

                   Ext.data.Model.EDIT
                   Ext.data.Model.REJECT
                   Ext.data.Model.COMMIT