Ext_data_Store.t

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

Defaults to: 1

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

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

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

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

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

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

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

Sample usage:

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

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

Parameters:

model: _ Js.t
An array of Model instances or Model configuration objects, or variable number of Model instance or config arguments.

Returns:

Ext_data_Model.t Js.js_array Js.t
The model instances that were added

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

Parameters:

filters: _ Js.t
The set of filters to add to the current filter set.
applyFilters: bool Js.t (optional)
Pass as false to add the filter but not apply the updated filter set.
Defaults to: true

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

Parameters:

record: Ext_data_Model.t Js.t

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

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

Parameters:

fn: _ Js.callback
The function to execute. The function is called with a single parameter, an array of records for that group.
scope: _ Js.t (optional)
The scope to execute the function in. Defaults to the store.
grouped: bool Js.t (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: _ Js.js_array Js.t (optional)
Any arguments to append to the function call

Returns:

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

Gets the average value in the store.

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

Parameters:

field: Js.js_string Js.t
The field in each record
grouped: bool Js.t (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:

_ Js.t
The average value, if no items exist, 0.

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

Parameters:

suppressEvent: bool Js.t (optional)
If true the filter is cleared silently.

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

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

Clear any groupers in the store

Collects unique values for a particular dataIndex from this store.

Parameters:

dataIndex: Js.js_string Js.t
The property to collect
allowNull: bool Js.t (optional)
Pass true to allow null, undefined or empty string values
bypassFilter: bool Js.t (optional)
Pass true to collect from all records, even ones which are filtered.

Returns:

_ Js.t Js.js_array Js.t
An array of the unique values

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

Gets the count of items in the store.

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

Parameters:

grouped: bool Js.t (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:

Js.number Js.t
the count

Calls the specified function for each record in the store.

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

Parameters:

fn: _ Js.callback
The function to call. The Record is passed as the first parameter. Returning false aborts and exits the iteration.
scope: _ Js.t (optional)
The scope (this reference) in which the function is executed. Defaults to the current record in the iteration.

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

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

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

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

see clearFilter.

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

Filtering by single field:

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

Using multiple filters:

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

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

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

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

Parameters:

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

If no parameters are passed, the Store's existing filter set is applied.
value: Js.js_string Js.t (optional)
value to filter by (only if using a property string as the first argument)

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

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

Parameters:

fn: _ Js.callback
The function to be called. It will be passed the following parameters:
scope: _ Js.t (optional)
The scope (this reference) in which the function is executed. Defaults to this Store.

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

When store is filtered, finds records only within filter.

**IMPORTANT

If this store is buffered, this can ONLY find records which happen to be cached in the page cache. This will be parts of the dataset around the currently visible zone, or recently visited zones if the pages have not yet been purged from the cache.**

Parameters:

fieldName: Js.js_string Js.t
The name of the Record field to test.
value: _ Js.t
Either a string that the field value should begin with, or a RegExp to test against the field.
startIndex: Js.number Js.t (optional)
The index to start searching at
Defaults to: 0
anyMatch: bool Js.t (optional)
True to match any part of the string, not just the beginning
Defaults to: false
caseSensitive: bool Js.t (optional)
True for case sensitive comparison
Defaults to: false
exactMatch: bool Js.t (optional)
True to force exact match (^ and $ characters added to the regex).
Defaults to: false

Returns:

Js.number Js.t
The matched index or -1

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

When store is filtered, finds records only within filter.

**IMPORTANT

If this store is buffered, this can ONLY find records which happen to be cached in the page cache. This will be parts of the dataset around the currently visible zone, or recently visited zones if the pages have not yet been purged from the cache.**

Parameters:

fn: _ Js.callback
The function to be called. It will be passed the following parameters:
scope: _ Js.t (optional)
The scope (this reference) in which the function is executed. Defaults to this Store.
startIndex: Js.number Js.t (optional)
The index to start searching at
Defaults to: 0

Returns:

Js.number Js.t
The matched index or -1

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

When store is filtered, finds records only within filter.

**IMPORTANT

If this store is buffered, this can ONLY find records which happen to be cached in the page cache. This will be parts of the dataset around the currently visible zone, or recently visited zones if the pages have not yet been purged from the cache.**

Parameters:

fieldName: Js.js_string Js.t
The name of the Record field to test.
value: _ Js.t
The value to match the field against.
startIndex: Js.number Js.t (optional)
The index to start searching at
Defaults to: 0

Returns:

Js.number Js.t
The matched index or -1

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

When store is filtered, finds records only within filter.

**IMPORTANT

If this store is buffered, this can ONLY find records which happen to be cached in the page cache. This will be parts of the dataset around the currently visible zone, or recently visited zones if the pages have not yet been purged from the cache.**

Parameters:

fieldName: Js.js_string Js.t
The name of the Record field to test.
value: _ Js.t
Either a string that the field value should begin with, or a RegExp to test against the field.
startIndex: Js.number Js.t (optional)
The index to start searching at
Defaults to: 0
anyMatch: bool Js.t (optional)
True to match any part of the string, not just the beginning
Defaults to: false
caseSensitive: bool Js.t (optional)
True for case sensitive comparison
Defaults to: false
exactMatch: bool Js.t (optional)
True to force exact match (^ and $ characters added to the regex).
Defaults to: false

Returns:

Ext_data_Model.t Js.t
The matched record or null

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

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

Parameters:

grouped: bool Js.t (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:

_ Js.t
The first model instance in the store, or undefined

Get the Record at the specified index.

The index is effected by filtering.

Parameters:

index: Js.number Js.t
The index of the Record to find.

Returns:

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

Get the Record with the specified id.

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

Parameters:

id: _ Js.t
The id of the Record to find.

Returns:

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

Gets the number of records in store.

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

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

Returns:

Js.number Js.t
The number of Records in the Store.

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

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

Parameters:

instance: Ext_data_Model.t Js.t
The model instance

Returns:

Js.js_string Js.t
The string to compare when forming groups

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

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

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

Group contents are effected by filtering.

Parameters:

groupName: Js.js_string Js.t (optional)
Pass in an optional groupName argument to access a specific group as defined by getGroupString.

Returns:

_ Js.t
The grouped data

inherit docs

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:

Ext_data_Model.t Js.js_array Js.t
The Model instances

Determines the page from a record index

Parameters:

index: Js.number Js.t
The record index

Returns:

Js.number Js.t
The page the record belongs to

Gathers a range of Records between specified indices.

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

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

This method is affected by filtering.

Parameters:

start: Js.number Js.t
The starting index. Defaults to zero for non buffered Stores.
_end: Js.number Js.t
The ending index. Defaults to the last Record for non buffered Stores.
options: _ Js.t (optional)
Used when the Store is {@link buffered] and the range may not be available synchronously.

Returns:

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

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:

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

inherit docs

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

Returns:

Ext_data_Model.t Js.js_array Js.t
The updated Model instances

Groups data inside the store.

Parameters:

groupers: _ Js.t
Either a string name of one of the fields in this Store's configured Model, or an Array of grouper configurations.
direction: Js.js_string Js.t (optional)
The overall direction to group the data by.
Defaults to: "ASC"

Get the index of the record within the store.

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

Parameters:

record: Ext_data_Model.t Js.t
The Ext.data.Model object to find.

Returns:

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

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

Like indexOf, this method is effected by filtering.

Parameters:

id: Js.js_string Js.t
The id of the Record to find.

Returns:

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

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

Like indexOf, this method is effected by filtering.

Parameters:

record: Ext_data_Model.t Js.t
The Ext.data.Model object to find.

Returns:

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

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

Parameters:

index: Js.number Js.t
The start index at which to insert the passed Records.
records: Ext_data_Model.t Js.js_array Js.t
An Array of Ext.data.Model objects to add to the store.

Returns:

Ext_data_Model.t Js.js_array Js.t
records The added records

Returns true if this store is currently filtered

Checks if the store is currently grouped

Returns:

bool Js.t
true if the store is grouped.

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

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

Parameters:

grouped: bool Js.t (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:

_ Js.t
The last model instance in the store, or undefined

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: _ Js.t (optional)
config object, passed into the Ext.data.Operation object before loading. Additionally addRecords: true can be specified to add these records to the existing records, default is to remove the Store's existing records first.

Loads an array of data straight into the Store.

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

Parameters:

data: _ Js.t
Array of data to load. Any non-model instances will be cast into model instances first.
append: bool Js.t (optional)
true to add the records to the existing records in the store, false to remove the old ones first.
Defaults to: false

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: Js.number Js.t
The number of the page to load.
options: _ Js.t (optional)
See options for load.

Loads data via the bound Proxy's reader

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

Parameters:

data: _ Js.t Js.js_array Js.t
The full JSON object you'd like to load into the Data store.
append: bool Js.t (optional)
true to add the records to the existing records in the store, false to remove the old ones first.
Defaults to: false

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

Parameters:

records: Ext_data_Model.t Js.js_array Js.t
The array of records to load
options: _ Js.t

Gets the maximum value in the store.

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

Parameters:

field: Js.js_string Js.t
The field in each record
grouped: bool Js.t (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:

_ Js.t
The maximum value, if no items exist, undefined.

Gets the minimum value in the store.

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

Parameters:

field: Js.js_string Js.t
The field in each record
grouped: bool Js.t (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:

_ Js.t
The minimum value, if no items exist, undefined.

Loads the next 'page' in the current data set

Parameters:

options: _ Js.t
See options for load

Prefetches data into the store using its configured proxy.

Parameters:

options: _ Js.t (optional)
config object, passed into the Ext.data.Operation object before loading. See load

Prefetches a page of data.

Parameters:

page: Js.number Js.t
The page to prefetch
options: _ Js.t (optional)
config object, passed into the Ext.data.Operation object before loading. See load

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

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

Parameters:

start: _ Js.t
_end: _ Js.t

Loads the previous 'page' in the current data set

Parameters:

options: _ Js.t
See options for load

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

This method compliments queryBy by generating the query function automatically.

Parameters:

property: Js.js_string Js.t
The property to create the filter function for
value: _ Js.t
The string/regex to compare the property value to
anyMatch: bool Js.t (optional)
true if we don't care if the filter value is not the full value.
Defaults to: false
caseSensitive: bool Js.t (optional)
true to create a case-sensitive regex.
Defaults to: false
exactMatch: bool Js.t (optional)
true to force exact match (^ and $ characters added to the regex). Ignored if anyMatch is true.
Defaults to: false

Returns:

Ext_util_MixedCollection.t Js.t
Returns an Ext.util.MixedCollection of the matched records

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

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

Parameters:

fn: _ Js.callback
The function to be called. It will be passed the following parameters:
scope: _ Js.t (optional)
The scope (this reference) in which the function is executed Defaults to this Store.

Returns:

Ext_util_MixedCollection.t Js.t
Returns an Ext.util.MixedCollection of the matched records

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

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

Parameters:

options: _ Js.t
A config object which contains options which may override the options passed to the previous load call.

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

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

Parameters:

records: _ Js.t
Model instance or array of instances to remove or an array of indices from which to remove records.

Removes all items from the store.

Individual record remove events are not fired by this method.

Parameters:

silent: bool Js.t (optional)
Pass true to prevent the record bulkremove and clear events from being fired.
Defaults to: false

Removes the model instance(s) at the given index

Parameters:

index: Js.number Js.t
The record index
count: Js.number Js.t (optional)
The number of records to delete
Defaults to: 1

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

Parameters:

toRemove: _ Js.t
The id of a Filter to remove from the filter set, or a Filter instance to remove.
applyFilters: bool Js.t (optional)
Pass as false to remove the filter but not apply the updated filter set.

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

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

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: _ Js.t (optional)
Either a string name of one of the fields in this Store's configured Model, or an array of sorter configurations.
direction: Js.js_string Js.t (optional)
The overall direction to sort the data by.
Defaults to: "ASC"

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

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

Parameters:

field: Js.js_string Js.t
A field in each record
grouped: bool Js.t (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:

Js.number Js.t
The sum

Class type Ext_data_Store.t