Collection

Automatically apply filters on item add.

Specify the names or index configs of properties which are to be indexed for fast lookup.

Index configs use the format { property : string, unique : boolean }. Unique indices stores one index per entry, non-unique stores a Set. If left out, unique defaults to true

Specify the name of the property of added objects which provides the lookup key

A Sorter, or Sorter config object, or an array of these, to use to sort this Collection.

The set of all values of this Collection regardless of filters applied.

The number of items in this collection. Note that this honours filtering. See totalCount;

A filter function which encapsulates the Filters for this Collection.

The Collection of Filters for this Collection.

A counter which is incremented whenever the Collection is mutated in a meaningful way.

If a splice call results in no net replacement, removal or addition, then the generation will not be incremented.

The property name used to extract item ids from added objects.

A flag which is true if this Collection has active filters.

A flag which is true if this Collection has active sorters.

The Collection of Sorters for this Collection.

A sorter function which encapsulates the Sorters for this Collection.

The number of items in this collection regardless of filtering.

The set of values of this Collection. If this Collection isFiltered, this yields the filtered data set.

Setting this property replaces the data set.

Adds items to this Collection. Multiple new items may be passed.

By default, new items are appended to the existing values.

Any sorters sorters present are re-run.

Any filters filters present are re-run.

Note that if application functionality requires add and remove, the splice operation is preferred as it performs both operations in an atomic manner

Adds a Filter to the Collection of Filters which are operating on this Collection.

A Filter may be an specified as an instantiated CollectionFilter, or a config object for a CollectionFilter of the form

{
    property : 'age',
    operator : '>=',
    value    : 21
}

Note that by default, a Filter replaces a Filter with the same property to make it easy to change existing Filters. A Filter's id is its property by default. You can avoid this and add multiple Filters for one property by configuring Filters with ids.

A Filter may also be specified as a function which filters candidate objects eg:

candidate => candidate.customerDetails.age >= 21

Adds a Sorter to the Collection of Sorters which are operating on this Collection.

A Sorter may be specified as an instantiated CollectionSorter, or a config object for a CollectionSorter of the form

{
    property  : 'age',
    direction : 'desc'
}

Note that by default, a Sorter replaces a Sorter with the same property to make it easy to change existing Sorters. A Sorter's id is its property by default. You can avoid this and add multiple Sorters for one property by configuring Sorters with ids.

A Sorter may also be specified as a function which compares two objects eg:

(lhs, rhs) => lhs.customerDetails.age - rhs.customerDetails.age

Change the id of an existing member by mutating its idProperty.

Clears this collection.

Compares the content of this Collection with the content of the passed Collection or with the passed array. Order insensitive. This returns true if the two objects passed contain the same set of items.

Returns the first item in this Collection which elicits a truthy return value from the passed function.

Return the index of the item with the specified key having the specified value.

By default, filtering is taken into account and this returns the index in the filtered dataset if present. To bypass this, pass the third parameter as true.

Only useful for indices configured with unique: true.

Return the item with the specified key having the specified value.

By default, filtering is taken into account. To bypass this, pass the third parameter as true.

For indices configured with unique: false, a Set of items will be returned.

Executes the passed function for each item in this Collection, passing in the item, ths index, and the full item array.

Returns the item with the passed id. By default, filtered are honoured, and if the item with the requested id is filtered out, nothing will be returned.

To return the item even if it has been filtered out, pass the second parameter as true.

Returns the item with passed property name equal to the passed value. By default, filtered are honoured, and if the item with the requested id is filtered out, nothing will be returned.

To return the item even if it has been filtered out, pass the third parameter as true.

Returns true if this Collection includes an item with the same id as the passed item.

By default, filtering is honoured, so if the item in question has been added, but is currently filtered out of visibility, false will be returned.

To query inclusion in the master, unfiltered dataset, pass the second parameter as true;

Returns the index of the item with the same id as the passed item.

By default, filtering is honoured, so if the item in question has been added, but is currently filtered out of visibility, -1 will be returned.

To find the index in the master, unfiltered dataset, pass the second parameter as true;

Extracts ths content of this Collection into an array based upon the passed value extraction function.

This method ensures that every item in this Collection is replaced by the matched by id item in the other Collection.

By default, any items in this Collection which are not in the other Collection are removed.

If the second parameter is passed as false, then items which are not in the other Collection are not removed.

This can be used for example when updating a selected record Collection when a new Store or new store dataset arrives. The selected Collection must reference the latest versions of the selected record ids

Moves an individual item, or a block of items to another location.

Returns an accumulated value based on the passed function similar to Array.reduce.

Removes items from this Collection. Multiple items may be passed.

Any sorters sorters present are re-run.

Any filters filters present are re-run.

Note that if application functionality requires add and remove, the splice operation is preferred as it performs both operations in an atomic manner

The core data set mutation method. Removes and adds at the same time. Analogous to the Array splice method.

Note that if items that are specified for removal are also in the toAdd array, then those items are not removed then appended. They remain in the same position relative to all remaining items.

Fired when items are added, replace or removed

Fired when a splice operation is requested but the operation is a no-op and has caused no change to this Collection's dataset. The splice method's parameters are passed for reference.

Called when items are added, replace or removed

Called when a splice operation is requested but the operation is a no-op and has caused no change to this Collection's dataset. The splice method's parameters are passed for reference.