Touch 1.1.1 Sencha Docs

Ext.data.Store

Hierarchy

Subclasses

Files

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

Creating a Store is easy - we just tell it the Model and the Proxy to use to load and save its data:

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

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

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

Inline data

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

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

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

Additional data can also be loaded locally using add.

Loading Nested Data

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

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

Which would consume a response like this:

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

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

Filtering and Sorting

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

var store = new Ext.data.Store({
    model: 'User',
    sorters: [
        {
            property : 'age',
            direction: 'DESC'
        },
        {
            property : 'firstName',
            direction: 'ASC'
        }
    ],
    
    filters: [
        {
            property: 'firstName',
            value   : /Ed/
        }
    ]
});

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

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

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

Change the sorting at any time by calling sort:

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

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

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

store.sort();

Registering with StoreMgr

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

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

new Ext.List({
    store: 'usersStore',

    //other config goes here
});

new Ext.DataView({
    store: 'usersStore',

    //other config goes here
});

Further Reading

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

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

Available since: 1.1.0

Defined By

Config options

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.

Defaults to: false

Available since: 1.1.0

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

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

Defaults to: false

Available since: 1.1.0

Ext.data.Store
view source
: Boolean
True to empty the store when loading another page via loadPage, nextPage or previousPage (defaults to true). ...

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.

Defaults to: true

Available since: 1.1.0

Ext.data.Store
view source
: Array
Optional array of Model instances or data objects to load locally. ...

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

Available since: 1.1.0

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

(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({
    width: 400,
    height: 200,
    dockedItems: [{
        xtype: 'toolbar'
    }],
    listeners: {
        click: {
            element: 'el', //bind to the underlying el property on the panel
            fn: function(){ console.log('click el'); }
        },
        dblclick: {
            element: 'body', //bind to the underlying body property on the panel
            fn: function(){ console.log('dblclick body'); }
        }
    }
});

Available since: 1.1.0

Ext.data.Store
view source
: String/Ext.data.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 - see setProxy for details.

Available since: 1.1.0

Overrides: Ext.data.AbstractStore.proxy

Ext.data.Store
view source
: 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.

Defaults to: false

Available since: 1.1.0

Ext.data.Store
view source
: 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.

Defaults to: false

Available since: 1.1.0

Ext.data.Store
view source
: Boolean
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

Defaults to: true

Available since: 1.1.0

Optional unique identifier for this store. ...

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

Available since: 1.1.0

Defined By

Properties

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

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

Defaults to: 'operation'

Available since: 1.1.0

Ext.data.Store
view source
: 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

Available since: 1.1.0

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

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

Available since: 1.1.0

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

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

Defaults to: 'memory'

Available since: 1.1.0

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")

Defaults to: "ASC"

Available since: 1.1.0

...

Defaults to: /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate|element|vertical|horizontal)$/

Available since: 1.1.0

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

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

Defaults to: true

Available since: 1.1.0

The collection of Filters currently applied to this Store

The collection of Filters currently applied to this Store

Available since: 1.1.0

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

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

Defaults to: "ASC"

Available since: 1.1.0

Ext.data.Store
view source
: String
The (optional) field by which to group data in the store. ...

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.

Available since: 1.1.0

Ext.data.Store
view source
: 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 constructor instead of a model constructor or name.

Defaults to: false

Available since: 1.1.0

Overrides: Ext.data.AbstractStore.implicitModel

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

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.

Defaults to: false

Available since: 1.1.0

...

Defaults to: true

Available since: 1.1.0

Ext.data.Store
view source
: Booleanprivate
...

Defaults to: true

Available since: 1.1.0

Overrides: Ext.data.AbstractStore.isStore

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

True if the Store is currently loading via its Proxy

Defaults to: false

Available since: 1.1.0

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

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

Available since: 1.1.0

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

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

Defaults to: 25

Available since: 1.1.0

...

Defaults to: false

Available since: 1.1.0

...

Defaults to: false

Available since: 1.1.0

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

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

Defaults to: []

Available since: 1.1.0

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

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

Available since: 1.1.0

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

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

Defaults to: true

Available since: 1.1.0

Stores the current sort direction ('ASC' or 'DESC') for each field. ...

Stores the current sort direction ('ASC' or 'DESC') for each field. Used internally to manage the toggling of sort direction per field. Read only

Defaults to: {}

Available since: 1.1.0

The collection of Sorters currently applied to this Store.

The collection of Sorters currently applied to this Store.

Available since: 1.1.0

Defined By

Methods

Ext.data.Store
view source
new( config ) : Ext.data.Store
documented above ...

documented above

Available since: 1.1.0

Parameters

  • config : Object

Returns

Fires

Overrides: Ext.data.AbstractStore.constructor

Ext.data.Store
view source
( data ) : Array
Adds Model instances to the Store by instantiating them based on a JavaScript object. ...

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'});

Available since: 1.1.0

Parameters

  • data : Object

    The data for each model

Returns

  • Array

    The array of newly created model instances

Fires

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

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

Available since: 1.1.0

Parameters

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

  • Optional : string

    . Event name if multiple event names are being passed as separate parameters. Usage:

    this.addEvents('storeloaded', 'storecleared');
    
( eventName, handler, [scope], [options] )
Appends an event handler to this object. ...

Appends an event handler to this object.

Available since: 1.1.0

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({
        title: 'The title',
        listeners: {
            click: this.handlePanelClick,
            element: 'body'
        }
    });
    

    When added in this way, the options available are the options applicable to Ext.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
    });
    
    .

Fires

    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.

    Available since: 1.1.0

    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.

    Fires

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

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

      Available since: 1.1.0

      Parameters

      Fires

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

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

      Available since: 1.1.0

      Parameters

      Fires

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

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

      Available since: 1.1.0

      Parameters

      Fires

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

      private

      Available since: 1.1.0

      Overrides: Ext.data.AbstractStore.clearData

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

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

      Available since: 1.1.0

      Parameters

      • suppressEvent : Boolean

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

      Fires

      Overrides: Ext.data.AbstractStore.clearFilter

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

      Removes all listeners for this object including the managed listeners

      Available since: 1.1.0

      Fires

        Removes all managed listeners for this object. ...

        Removes all managed listeners for this object.

        Available since: 1.1.0

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

        Collects unique values for a particular dataIndex from this store.

        Available since: 1.1.0

        Parameters

        • dataIndex : String

          The property to collect

        • allowNull : Boolean (optional)

          Pass true to allow null, undefined or empty string values

        • bypassFilter : Boolean (optional)

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

        Returns

        • Array

          An array of the unique values

        saves any phantom records ...

        saves any phantom records

        Available since: 1.1.0

        Parameters

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

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

        Available since: 1.1.0

        Parameters

        • property : String

          The property to create the filter function for

        • value : String/RegExp

          The string/regex to compare the property value to

        • anyMatch : Boolean

          True if we don't care if the filter value is not the full value (defaults to false)

        • caseSensitive : Boolean

          True to create a case-sensitive regex (defaults to false)

        • exactMatch : Boolean

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

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

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

        Available since: 1.1.0

        Parameters

        Returns

        ( field, direction ) : Functionprivate
        Creates and returns a function which sorts an array by the given field and direction ...

        Creates and returns a function which sorts an array by the given field and direction

        Available since: 1.1.0

        Parameters

        • field : String

          The field to create the sorter for

        • direction : String

          The direction to sort by (defaults to "ASC")

        Returns

        • Function

          A function which sorts by the field/direction combination provided

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

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

        Available since: 1.1.0

        Parameters

        • filters : Array

          The filters array

        Returns

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

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

        Available since: 1.1.0

        Parameters

        • sorters : Array

          The sorters array

        Returns

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

        tells the attached proxy to destroy the given records

        Available since: 1.1.0

        Parameters

        • options : Object

        Fires

          ...

          Available since: 1.1.0

          Fires

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

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

            Available since: 1.1.0

            Parameters

            • fn : Function

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

            • scope : Object (optional)

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

            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, {
            //  Add functionality to Field's initComponent to enable the change event to bubble
            initComponent : Ext.createSequence(Ext.form.Field.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');
                }
            }
            });
            

            Available since: 1.1.0

            Parameters

            • events : String/Array

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

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

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

            Available since: 1.1.0

            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)

            Fires

            Overrides: Ext.data.AbstractStore.filter

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

            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.

            Available since: 1.1.0

            Parameters

            • fn : Function

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

              • record : Ext.data.Record

                The record to test for filtering. Access field values using Ext.data.Record.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.

            Fires

            Overrides: Ext.data.AbstractStore.filterBy

            Filter function for dirty records. ...

            Filter function for dirty records.

            Available since: 1.1.0

            Parameters

            • item : Object
            Filter function for new records. ...

            Filter function for new records.

            Available since: 1.1.0

            Parameters

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

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

            Available since: 1.1.0

            Parameters

            • fieldName : String

              The name of the Record field to test.

            • value : String/RegExp

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

            • startIndex : Number (optional)

              The index to start searching at

            • 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 (optional)

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

            Returns

            • Number

              The matched index or -1

            Fires

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

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

              Available since: 1.1.0

              Parameters

              • fn : Function

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

                • record : Ext.data.Record

                  The record to test for filtering. Access field values using Ext.data.Record.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

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

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

              Available since: 1.1.0

              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

              Ext.data.Store
              view source
              ( fieldName, value, [startIndex], [anyMatch], [caseSensitive], [exactMatch] ) : Ext.data.Record
              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.

              Available since: 1.1.0

              Parameters

              • fieldName : String

                The name of the Record field to test.

              • value : String/RegExp

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

              • startIndex : Number (optional)

                The index to start searching at

              • 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 (optional)

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

              Returns

              • Ext.data.Record

                The matched record or null

              Fires

                ( eventName, args ) : Boolean
                Fires the specified event with the passed parameters (minus the event name). ...

                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.

                Available since: 1.1.0

                Parameters

                • eventName : String

                  The name of the event to fire.

                • args : Object...

                  Variable number of parameters are passed to handlers.

                Returns

                • Boolean

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

                Fires

                  Ext.data.Store
                  view source
                  ( ) : 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

                  Available since: 1.1.0

                  Returns

                  • Ext.data.Model/undefined

                    The first model instance in the store, or undefined

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

                  Get the Record at the specified index.

                  Available since: 1.1.0

                  Parameters

                  • index : Number

                    The index of the Record to find.

                  Returns

                  • Ext.data.Model

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

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

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

                  Available since: 1.1.0

                  Returns

                  • Object

                    The listeners object

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

                  Get the Record with the specified id.

                  Available since: 1.1.0

                  Parameters

                  • id : String

                    The id of the Record to find.

                  Returns

                  • Ext.data.Record

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

                  Overrides: Ext.data.AbstractStore.getById

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

                  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.

                  Available since: 1.1.0

                  Returns

                  • Number

                    The number of Records in the Store's cache.

                  Overrides: Ext.data.AbstractStore.getCount

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

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

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

                  Available since: 1.1.0

                  Parameters

                  Returns

                  • String

                    The string to compare when forming groups

                  Ext.data.Store
                  view source
                  ( ) : Array
                  Returns an object containing the result of applying grouping to the records in this store. ...

                  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'
                          ]
                      }
                  ]
                  

                  Available since: 1.1.0

                  Returns

                  Fires

                    Ext.data.Store
                    view source
                    ( ) : Array
                    inherit docs ...

                    inherit docs

                    Available since: 1.1.0

                    Returns

                    • Array

                      The Model instances

                    Overrides: Ext.data.AbstractStore.getNewRecords

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

                    Returns the proxy currently attached to this proxy instance

                    Available since: 1.1.0

                    Returns

                    Ext.data.Store
                    view source
                    ( [startIndex], [endIndex] ) : Ext.data.Model[]
                    Returns a range of Records between specified indices. ...

                    Returns a range of Records between specified indices.

                    Available since: 1.1.0

                    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

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

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

                    Available since: 1.1.0

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

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

                    Available since: 1.1.0

                    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.

                    inherit docs ...

                    inherit docs

                    Available since: 1.1.0

                    Returns

                    • Array

                      The updated Model instances

                    Overrides: Ext.data.AbstractStore.getUpdatedRecords

                    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

                    Available since: 1.1.0

                    Parameters

                    • eventName : String

                      The name of the event to check for

                    Returns

                    • Boolean

                      True if the event is being listened for, else false

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

                    Get the index within the cache of the passed Record.

                    Available since: 1.1.0

                    Parameters

                    Returns

                    • Number

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

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

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

                    Available since: 1.1.0

                    Parameters

                    • id : String

                      The id of the Record to find.

                    Returns

                    • Number

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

                    Ext.data.Store
                    view source
                    ( index, 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. See also add.

                    Available since: 1.1.0

                    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.

                    Fires

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

                    Returns true if this store is currently filtered

                    Available since: 1.1.0

                    Returns

                    • Boolean

                    Overrides: Ext.data.AbstractStore.isFiltered

                    Ext.data.Store
                    view source
                    ( ) : Boolean
                    Returns true if the Store is currently performing a load operation ...

                    Returns true if the Store is currently performing a load operation

                    Available since: 1.1.0

                    Returns

                    • Boolean

                      True if the Store is currently loading

                    Ext.data.Store
                    view source
                    ( ) : 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

                    Available since: 1.1.0

                    Returns

                    • Ext.data.Model/undefined

                      The last model instance in the store, or undefined

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

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

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

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

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

                    Available since: 1.1.0

                    Parameters

                    • options : Object/Function

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

                    Overrides: Ext.data.AbstractStore.load

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

                    Loads an array of data straight into the Store

                    Available since: 1.1.0

                    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

                    Fires

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

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

                    Available since: 1.1.0

                    Parameters

                    • page : Number

                      The number of the page to load

                    Fires

                      Ext.data.Store
                      view source
                      ( records, add )
                      Loads an array of {@Ext.data.Model model} instances into the store, fires the datachanged event. ...

                      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

                      Available since: 1.1.0

                      Parameters

                      • records : Array

                        The array of records to load

                      • add : Boolean

                        True to add these records to the existing records, false to remove the Store's existing records first

                      Fires

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

                      Loads the next 'page' in the current data set

                      Available since: 1.1.0

                      Fires

                        ( eventName, handler, [scope], [options] )
                        Appends an event handler to this object (shorthand for addListener.) ...

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

                        Available since: 1.1.0

                        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.

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

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

                        Available since: 1.1.0

                        Parameters

                        • batch : Object
                        • operation : Object

                        Fires

                        ...

                        Available since: 1.1.0

                        Parameters

                        • batch : Object
                        • operation : Object
                        Attached as the 'operationcomplete' event listener to a proxy's Batch object. ...

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

                        Available since: 1.1.0

                        Parameters

                        • batch : Object
                        • operation : Object

                        Fires

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

                          Called internally when a Proxy has completed a load request

                          Available since: 1.1.0

                          Parameters

                          • operation : Object

                          Fires

                          ...

                          Available since: 1.1.0

                          Ext.data.Store
                          view source
                          ( 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 the updates provided by the Proxy

                          Available since: 1.1.0

                          Parameters

                          • operation : Object

                          Fires

                          Overrides: Ext.data.AbstractStore.onProxyWrite

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

                          Loads the previous 'page' in the current data set

                          Available since: 1.1.0

                          Fires

                            ...

                            Available since: 1.1.0

                            ...

                            Available since: 1.1.0

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

                            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.

                            Available since: 1.1.0

                            Parameters

                            • fn : Function

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

                              • record : Ext.data.Record

                                The record to test for filtering. Access field values using Ext.data.Record.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

                            ...

                            Available since: 1.1.0

                            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.

                            Available since: 1.1.0

                            Parameters

                            • o : Object

                              The Observable whose events this object is to relay.

                            • events : Array

                              Array of event names to relay.

                            Ext.data.Store
                            view source
                            ( records )
                            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.

                            Available since: 1.1.0

                            Parameters

                            Fires

                            Ext.data.Store
                            view source
                            ( silent )private
                            individual substores should implement a "fast" remove and fire a clear event afterwards ...

                            individual substores should implement a "fast" remove and fire a clear event afterwards

                            Available since: 1.1.0

                            Parameters

                            • silent : Object

                            Fires

                            • clear

                            Overrides: Ext.data.AbstractStore.removeAll

                            Ext.data.Store
                            view source
                            ( index )
                            Removes the model instance at the given index ...

                            Removes the model instance at the given index

                            Available since: 1.1.0

                            Parameters

                            • index : Number

                              The record index

                            Fires

                            ( eventName, handler, [scope] )
                            Removes an event handler. ...

                            Removes an event handler.

                            Available since: 1.1.0

                            Parameters

                            • eventName : String

                              The type of event the handler was associated with.

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

                            Fires

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

                              Removes listeners that were added by the mon method.

                              Available since: 1.1.0

                              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.

                              Fires

                                Resume firing events. ...

                                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.

                                Available since: 1.1.0

                                deprecated, will be removed in 5.0 ...

                                deprecated, will be removed in 5.0

                                Available since: 1.1.0

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

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

                                Available since: 1.1.0

                                Parameters

                                Returns

                                Ext.data.Store
                                view source
                                ( sorters, direction )
                                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:

                                //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');
                                

                                Available since: 1.1.0

                                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".

                                Fires

                                Overrides: Ext.data.AbstractStore.sort

                                Ext.data.Store
                                view source
                                ( property, [start], [end] ) : 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.

                                Available since: 1.1.0

                                Parameters

                                • property : String

                                  A field in each record

                                • start : Number (optional)

                                  The record index to start at (defaults to 0)

                                • end : Number (optional)

                                  The last record index to include (defaults to length - 1)

                                Returns

                                • Number

                                  The sum

                                Suspend the firing of all events. ...

                                Suspend the firing of all events. (see resumeEvents)

                                Available since: 1.1.0

                                Parameters

                                • queueSuspended : Boolean

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

                                Synchronizes the Store with its Proxy. ...

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

                                Available since: 1.1.0

                                Fires

                                ( eventName, handler, [scope] )
                                Removes an event handler (shorthand for removeListener.) ...

                                Removes an event handler (shorthand for removeListener.)

                                Available since: 1.1.0

                                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.

                                ...

                                Available since: 1.1.0

                                Parameters

                                • options : Object

                                Fires

                                  Defined By

                                  Events

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

                                  Fired when a Model instance has been added to this Store

                                  Available since: 1.1.0

                                  Parameters

                                  • store : Ext.data.Store

                                    The store

                                  • records : Array

                                    The Model instances that were added

                                  • index : Number

                                    The index at which the instances were inserted

                                  Event description ...

                                  Event description

                                  Available since: 1.1.0

                                  Parameters

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

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

                                  Available since: 1.1.0

                                  Parameters

                                  • options : Object

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

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

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

                                  Available since: 1.1.0

                                  Parameters

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

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

                                  Available since: 1.1.0

                                  Parameters

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

                                    An array of records

                                  • successful : Boolean

                                    True if the operation was successful.

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

                                  Fired when a Model instance has been removed from this Store

                                  Available since: 1.1.0

                                  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

                                  ( this, record, operation )
                                  Fires when a Record has been updated ...

                                  Fires when a Record has been updated

                                  Available since: 1.1.0

                                  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