Interface IStoreMgr

Hierarchy

Index

Properties

Methods

Properties

optional public alias?: Array<string>

[Config Option] (String[])

optional public all?: Array<any>

[Property] (Array)

optional public alternateClassName?: any

[Config Option] (String/String[])

optional public config?: any

[Config Option] (Object)

optional public currentSortFn?: any

[Property] (Object)

optional public defaultSortDirection?: string

[Config Option] (String)

optional public dirtyFilterFn?: boolean

[Property] (Boolean)

optional public dirtySortFn?: boolean

[Property] (Boolean)

optional public extend?: string

[Config Option] (String)

optional public filterRoot?: string

[Config Option] (String)

optional public filtered?: boolean

[Property] (Boolean)

optional public filters?: Array<any>

[Config Option] (Object[])

optional public indices?: any

[Property] (Object)

optional public inheritableStatics?: any

[Config Option] (Object)

optional public items?: Array<any>

[Property] (Array)

optional public keys?: Array<any>

[Property] (Array)

optional public length?: number

[Property] (Number)

optional public map?: any

[Property] (Object)

optional public mixins?: any

[Config Option] (Object)

optional public platformConfig?: any

[Config Option] (Object)

optional public self?: IClass

[Property] (Ext.Class)

optional public singleton?: boolean

[Config Option] (Boolean)

optional public sortRoot?: string

[Config Option] (String)

optional public sorted?: boolean

[Property] (Boolean)

optional public sorters?: Array<any>

[Config Option] (Object[])

optional public statics?: any

[Config Option] (Object)

optional public uses?: Array<string>

[Config Option] (String[])

Methods

optional public add(key?: string, item?: any): any

[Method] Adds an item to the collection

Parameters

  • key?: string optional

    String The key to associate with the item, or the new item. If a getKey implementation was specified for this MixedCollection, or if the key of the stored items is in a property called id, the MixedCollection will be able to derive the key for the new item. In this case just pass the new item in this parameter.

  • item?: any optional

    Object The item to add.

Returns

any

Object The item added.

optional public addAll(addItems?: any)

[Method] Adds all elements of an Array or an Object to the collection

Parameters

  • addItems?: any optional

    Object/Array An Object containing properties which will be added to the collection, or an Array of values, each of which are added to the collection. Functions references will be added to the collection if {@link} Ext.util.MixedCollection.allowFunctions allowFunctions} has been set to true.

optional public addFilter(filter?: any)

[Method] This method adds a filter

Parameters

  • filter?: any optional

    Ext.util.Sorter/Function/Object Can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function.

optional public addFilters(filters?: any): any

[Method] This method adds all the filters in a passed array

Parameters

  • filters?: any optional

    Object

Returns

any

Object

optional public addSorter(sorter?: any, defaultDirection?: string)

[Method] This method adds a sorter

Parameters

  • sorter?: any optional

    Ext.util.Sorter/String/Function/Object Can be an instance of Ext.util.Sorter, a string indicating a property name, an object representing an Ext.util.Sorter configuration, or a sort function.

  • defaultDirection?: string optional

    String The default direction for each sorter in the array. Defaults to the value of defaultSortDirection. Can be either 'ASC' or 'DESC'.

optional public addSorters(sorters?: Array<any>, defaultDirection?: string)

[Method] This method adds all the sorters in a passed array

Parameters

  • sorters?: Array<any> optional

    Array An array with sorters. A sorter can be an instance of Ext.util.Sorter, a string indicating a property name, an object representing an Ext.util.Sorter configuration, or a sort function.

  • defaultDirection?: string optional

    String The default direction for each sorter in the array. Defaults to the value of defaultSortDirection. Can be either 'ASC' or 'DESC'.

optional public callOverridden(args?: any): any

[Method] Call the original method that was previously overridden with override This method is deprecated as callParent does

Parameters

  • args?: any optional

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

Returns

any

Object Returns the result of calling the overridden method

optional public callOverridden(args?: any): any

[Method] Call the original method that was previously overridden with override This method is deprecated as callParent does

Parameters

  • args?: any optional

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

Returns

any

Object Returns the result of calling the overridden method

optional public callOverridden(args?: any): any

[Method] Call the original method that was previously overridden with override This method is deprecated as callParent does

Parameters

  • args?: any optional

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

Returns

any

Object Returns the result of calling the overridden method

optional public callParent(args?: any): any

[Method] Call the parent method of the current method

Parameters

  • args?: any optional

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

Returns

any

Object Returns the result of calling the parent method

optional public callParent(args?: any): any

[Method] Call the parent method of the current method

Parameters

  • args?: any optional

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

Returns

any

Object Returns the result of calling the parent method

optional public callParent(args?: any): any

[Method] Call the parent method of the current method

Parameters

  • args?: any optional

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

Returns

any

Object Returns the result of calling the parent method

optional public callSuper(args?: any): any

[Method] This method is used by an override to call the superclass method but bypass any overridden method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

Returns

any

Object Returns the result of calling the superclass method

optional public callSuper(args?: any): any

[Method] This method is used by an override to call the superclass method but bypass any overridden method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

Returns

any

Object Returns the result of calling the superclass method

optional public callSuper(args?: any): any

[Method] This method is used by an override to call the superclass method but bypass any overridden method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

Returns

any

Object Returns the result of calling the superclass method

optional public clear()

[Method] Removes all items from the collection

optional public clone(): IMixedCollection

[Method] Creates a shallow copy of this collection

Returns

IMixedCollection

Ext.util.MixedCollection

optional public contains(item?: any): boolean

[Method] Returns true if the collection contains the passed Object as an item

Parameters

  • item?: any optional

    Object The Object to look for in the collection.

Returns

boolean

Boolean true if the collection contains the Object as an item.

optional public containsKey(key?: string): boolean

[Method] Returns true if the collection contains the passed Object as a key

Parameters

  • key?: string optional

    String The key to look for in the collection.

Returns

boolean

Boolean true if the collection contains the Object as a key.

optional public destroy()

[Method]

optional public each(fn?: any, scope?: any)

[Method] Executes the specified function once for every item in the collection

Parameters

  • fn?: any optional

    Function The function to execute for each item.

  • scope?: any optional

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

optional public eachKey(fn?: any, scope?: any)

[Method] Executes the specified function once for every key in the collection passing each key and its associated item as th

Parameters

  • fn?: any optional

    Function The function to execute for each item.

  • scope?: any optional

    Object The scope (this reference) in which the function is executed. Defaults to the browser window.

optional public filter(property?: any, value?: any, anyMatch?: any, caseSensitive?: any): Array<any>

[Method] This method will sort a collection based on the currently configured sorters

Parameters

  • property?: any optional

    Object

  • value?: any optional

    Object

  • anyMatch?: any optional

    Object

  • caseSensitive?: any optional

    Object

Returns

Array<any>

Array

optional public filterBy(fn?: any, scope?: any): IMixedCollection

[Method] Filter by a function

Parameters

  • fn?: any optional

    Function The function to be called.

  • scope?: any optional

    Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection.

Returns

IMixedCollection

Ext.util.MixedCollection The new filtered collection

optional public findBy(fn?: any, scope?: any): any

[Method] Returns the first item in the collection which elicits a true return value from the passed selection function

Parameters

  • fn?: any optional

    Function The selection function to execute for each item.

  • scope?: any optional

    Object The scope (this reference) in which the function is executed. Defaults to the browser window.

Returns

any

Object The first item in the collection which returned true from the selection function.

optional public findIndexBy(fn?: any, scope?: any, start?: number): number

[Method] Find the index of the first matching object in this collection by a function

Parameters

  • fn?: any optional

    Function The function to be called.

  • scope?: any optional

    Object The scope (this reference) in which the function is executed. Defaults to this MixedCollection.

  • start?: number optional

    Number The index to start searching at.

Returns

number

Number The matched index, or -1 if the item was not found.

optional public findInsertionIndex(items?: Array<any>, item?: any): number

[Method] This method returns the index that a given item would be inserted into a given array based on the current sorters

Parameters

  • items?: Array<any> optional

    Array The array that you want to insert the item into.

  • item?: any optional

    Mixed The item that you want to insert into the items array.

Returns

number

Number The index for the given item in the given array based on the current sorters.

optional public first(): any

[Method] Returns the first item in the collection

Returns

any

Object the first item in the collection.

optional public get(key?: any): any

[Method] Returns the item associated with the passed key OR index

Parameters

  • key?: any optional

    String/Number The key or index of the item.

Returns

any

Object If the item is found, returns the item. If the item was not found, returns undefined. If an item was found, but is a Class, returns null.

optional public getAt(index?: number): any

[Method] Returns the item at the specified index

Parameters

  • index?: number optional

    Number The index of the item.

Returns

any

Object The item at the specified index.

optional public getAutoFilter(): boolean

[Method] Returns the value of autoFilter

Returns

boolean

Boolean

optional public getAutoSort(): boolean

[Method] Returns the value of autoSort

Returns

boolean

Boolean

optional public getByKey(key?: any): any

[Method] Returns the item associated with the passed key

Parameters

  • key?: any optional

    String/Number The key of the item.

Returns

any

Object The item associated with the passed key.

optional public getCount(): number

[Method] Returns the number of items in the collection

Returns

number

Number the number of items in the collection.

optional public getDefaultSortDirection(): string

[Method] Returns the value of defaultSortDirection

Returns

string

String

optional public getFilterFn(): any

[Method] Returns an up to date sort function

Returns

any

Function sortFn The sort function.

optional public getFilterRoot(): string

[Method] Returns the value of filterRoot

Returns

string

String

optional public getFilters(): Array<any>

[Method] Returns the value of filters

Returns

Array<any>

Array

optional public getInitialConfig(name?: string): any

[Method] Returns the initial configuration passed to constructor

Parameters

  • name?: string optional

    String When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

Returns

any

Object/Mixed

optional public getInitialConfig(name?: string): any

[Method] Returns the initial configuration passed to constructor

Parameters

  • name?: string optional

    String When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

Returns

any

Object/Mixed

optional public getInitialConfig(name?: string): any

[Method] Returns the initial configuration passed to constructor

Parameters

  • name?: string optional

    String When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

Returns

any

Object/Mixed

optional public getKey(item?: any): any

[Method] MixedCollection has a generic way to fetch keys if you implement getKey

Parameters

  • item?: any optional

    Object The item for which to find the key.

Returns

any

Object The key for the passed item.

optional public getRange(start?: number, end?: number): Array<any>

[Method] Returns a range of items in this collection

Parameters

  • start?: number optional

    Number The starting index.

  • end?: number optional

    Number The ending index. Defaults to the last item.

Returns

Array<any>

Array An array of items.

optional public getSortFn(): any

[Method] Returns an up to date sort function

Returns

any

Function The sort function.

optional public getSortRoot(): string

[Method] Returns the value of sortRoot

Returns

string

String

optional public getSorters(): Array<any>

[Method] Returns the value of sorters

Returns

Array<any>

Array

optional public indexOf(item?: any): number

[Method] Returns index within the collection of the passed Object

Parameters

  • item?: any optional

    Object The item to find the index of.

Returns

number

Number Index of the item. Returns -1 if not found.

optional public indexOfKey(key?: string): number

[Method] Returns index within the collection of the passed key

Parameters

  • key?: string optional

    String The key to find the index of.

Returns

number

Number Index of the key.

optional public initConfig(instanceConfig?: any): any

[Method] Initialize configuration for this class

Parameters

  • instanceConfig?: any optional

    Object

Returns

any

Object mixins The mixin prototypes as key - value pairs

optional public initConfig(instanceConfig?: any): any

[Method] Initialize configuration for this class

Parameters

  • instanceConfig?: any optional

    Object

Returns

any

Object mixins The mixin prototypes as key - value pairs

optional public initConfig(instanceConfig?: any): any

[Method] Initialize configuration for this class

Parameters

  • instanceConfig?: any optional

    Object

Returns

any

Object mixins The mixin prototypes as key - value pairs

optional public insert(index?: number, key?: string, item?: any): any

[Method] Inserts an item at the specified index in the collection

Parameters

  • index?: number optional

    Number The index to insert the item at.

  • key?: string optional

    String The key to associate with the new item, or the item itself.

  • item?: any optional

    Object If the second parameter was a key, the new item.

Returns

any

Object The item inserted.

optional public insertFilter(index?: number, filter?: any): any

[Method] This method adds a filter at a given index

Parameters

  • index?: number optional

    Number The index at which to insert the filter.

  • filter?: any optional

    Ext.util.Sorter/Function/Object Can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function.

Returns

any

Object

optional public insertFilters(index?: number, filters?: Array<any>): Array<any>

[Method] This method inserts all the filters in the passed array at the given index

Parameters

  • index?: number optional

    Number The index at which to insert the filters.

  • filters?: Array<any> optional

    Array Each filter can be an instance of Ext.util.Filter, an object representing an Ext.util.Filter configuration, or a filter function.

Returns

Array<any>

Array

optional public insertSorter(index?: number, sorter?: any, defaultDirection?: string)

[Method] This method adds a sorter at a given index

Parameters

  • index?: number optional

    Number The index at which to insert the sorter.

  • sorter?: any optional

    Ext.util.Sorter/String/Function/Object Can be an instance of Ext.util.Sorter, a string indicating a property name, an object representing an Ext.util.Sorter configuration, or a sort function.

  • defaultDirection?: string optional

    String The default direction for each sorter in the array. Defaults to the value of defaultSortDirection. Can be either 'ASC' or 'DESC'.

optional public insertSorters(): ICollection

[Method] This method inserts all the sorters in the passed array at the given index

Returns

ICollection

Ext.util.Collection this

optional public last(): any

[Method] Returns the last item in the collection

Returns

any

Object the last item in the collection.

optional public remove(item?: any): any

[Method] Remove an item from the collection

Parameters

  • item?: any optional

    Object The item to remove.

Returns

any

Object The item removed or false if no item was removed.

optional public removeAll(items?: Array<any>): IMixedCollection

[Method] Remove all items in the passed array from the collection

Parameters

  • items?: Array<any> optional

    Array An array of items to be removed.

Returns

IMixedCollection

Ext.util.MixedCollection this object

optional public removeAt(index?: number): any

[Method] Remove an item from a specified index in the collection

Parameters

  • index?: number optional

    Number The index within the collection of the item to remove.

Returns

any

Object The item removed or false if no item was removed.

optional public removeAtKey(key?: string): any

[Method] Removed an item associated with the passed key from the collection

Parameters

  • key?: string optional

    String The key of the item to remove.

Returns

any

Object/Boolean The item removed or false if no item was removed.

optional public removeFilters(filters?: any): ICollection

[Method] This method removes all the filters in a passed array

Parameters

  • filters?: any optional

    Object

Returns

ICollection

Ext.util.Collection this

optional public removeSorter(sorter?: any)

[Method] This method removes a sorter

Parameters

  • sorter?: any optional

    Ext.util.Sorter/String/Function/Object Can be an instance of Ext.util.Sorter, a string indicating a property name, an object representing an Ext.util.Sorter configuration, or a sort function.

optional public removeSorters(sorters?: any): ICollection

[Method] This method removes all the sorters in a passed array

Parameters

  • sorters?: any optional

    Object

Returns

ICollection

Ext.util.Collection this

optional public replace(oldKey?: string, item?: any): any

[Method] Replaces an item in the collection

Parameters

  • oldKey?: string optional

    String The key associated with the item to replace, or the replacement item. If you supplied a getKey implementation for this MixedCollection, or if the key of your stored items is in a property called id, then the MixedCollection will be able to derive the key of the replacement item. If you want to replace an item with one having the same key value, then just pass the replacement item in this parameter.

  • item?: any optional

    Object {Object} item (optional) If the first parameter passed was a key, the item to associate with that key.

Returns

any

Object The new item.

optional public setAutoFilter(autoFilter?: boolean)

[Method] Sets the value of autoFilter

Parameters

  • autoFilter?: boolean optional

    Boolean

optional public setAutoSort(autoSort?: boolean)

[Method] Sets the value of autoSort

Parameters

  • autoSort?: boolean optional

    Boolean

optional public setDefaultSortDirection(defaultSortDirection?: string)

[Method] Sets the value of defaultSortDirection

Parameters

  • defaultSortDirection?: string optional

    String

optional public setFilterRoot(filterRoot?: string)

[Method] Sets the value of filterRoot

Parameters

  • filterRoot?: string optional

    String

optional public setFilters(filters?: Array<any>)

[Method] Sets the value of filters

Parameters

  • filters?: Array<any> optional

    Array

optional public setSortRoot(sortRoot?: string)

[Method] Sets the value of sortRoot

Parameters

  • sortRoot?: string optional

    String

optional public setSorters(sorters?: Array<any>)

[Method] Sets the value of sorters

Parameters

  • sorters?: Array<any> optional

    Array

optional public sort(sorters?: any, defaultDirection?: any): Array<any>

[Method] This method will sort an array based on the currently configured sorters

Parameters

  • sorters?: any optional

    Object

  • defaultDirection?: any optional

    Object

Returns

Array<any>

Array The array you passed after it is sorted.