Interface INodeStore

Hierarchy

Index

Properties

Methods

Properties

optional public alias?: Array<string>

[Config Option] (String[])

optional public alternateClassName?: any

[Config Option] (String/String[])

optional public autoLoad?: any

[Config Option] (Boolean/Object)

optional public autoSync?: boolean

[Config Option] (Boolean)

optional public bubbleEvents?: any

[Config Option] (String/String[])

optional public clearOnPageLoad?: boolean

[Config Option] (Boolean)

optional public config?: any

[Config Option] (Object)

optional public currentPage?: number

[Property] (Number)

optional public data?: any

[Config Option] (Object[]/Ext.data.Model[])

optional public destroyRemovedRecords?: boolean

[Config Option] (Boolean)

optional public extend?: string

[Config Option] (String)

optional public fields?: Array<any>

[Config Option] (Object[])

optional public filters?: Array<any>

[Config Option] (Object[])

optional public folderSort?: boolean

[Config Option] (Boolean)

optional public getGroupString?: any

[Config Option] (Function)

optional public groupDir?: string

[Config Option] (String)

optional public groupField?: string

[Config Option] (String)

optional public grouper?: any

[Config Option] (Object)

optional public inheritableStatics?: any

[Config Option] (Object)

optional public listeners?: any

[Config Option] (Object)

optional public mixins?: any

[Config Option] (Object)

optional public model?: string

[Config Option] (String)

optional public node?: IModel

[Config Option] (Ext.data.Model)

optional public pageSize?: number

[Config Option] (Number)

optional public platformConfig?: any

[Config Option] (Object)

optional public proxy?: any

[Config Option] (String/Ext.data.proxy.Proxy/Object)

optional public recursive?: boolean

[Config Option] (Boolean)

optional public remoteFilter?: boolean

[Config Option] (Boolean)

optional public remoteGroup?: boolean

[Config Option] (Boolean)

optional public remoteSort?: boolean

[Config Option] (Boolean)

optional public rootVisible?: boolean

[Config Option] (Boolean)

optional public self?: IClass

[Property] (Ext.Class)

optional public singleton?: boolean

[Config Option] (Boolean)

optional public sorters?: Array<any>

[Config Option] (Object[])

optional public statics?: any

[Config Option] (Object)

optional public storeId?: string

[Config Option] (String)

optional public syncRemovedRecords?: boolean

[Config Option] (Boolean)

optional public totalCount?: number

[Config Option] (Number)

optional public uses?: Array<string>

[Config Option] (String[])

Methods

optional public add(model?: any): IModel[]

[Method] Adds Model instance to the Store

Parameters

  • model?: any optional

    Ext.data.Model[]/Ext.data.Model... An array of Model instances or Model configuration objects, or variable number of Model instance or config arguments.

Returns

IModel[]

Ext.data.Model[] The model instances that were added.

optional public addAfterListener(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Appends an after event handler

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for.

  • fn?: any optional

    Function/String The method the event invokes.

  • scope?: any optional

    Object The scope for fn.

  • options?: any optional

    Object An object containing handler configuration.

optional public addBeforeListener(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Appends a before event handler

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for.

  • fn?: any optional

    Function/String The method the event invokes.

  • scope?: any optional

    Object The scope for fn.

  • options?: any optional

    Object An object containing handler configuration.

optional public addEvents(eventNames?: any)

[Method] Adds the specified events to the list of events which this Observable may fire

Parameters

  • eventNames?: any optional

    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 public addListener(eventName?: any, fn?: any, scope?: any, options?: any, order?: string)

[Method] Appends an event handler to this object

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names.

  • fn?: any optional

    Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below.

  • scope?: any optional

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

  • options?: any optional

    Object An object containing handler configuration. This object may contain any of the following properties:

  • order?: string optional

    String The order of when the listener should be added into the listener queue. Possible values are before, current and after.

optional public addManagedListener(object?: any, eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed

Parameters

  • object?: any optional

    Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners.

  • eventName?: any optional

    Object/String The event name, or an object containing event name properties.

  • fn?: any optional

    Function If the eventName parameter was an event name, this is the handler function.

  • scope?: any optional

    Object If the eventName parameter was an event name, this is the scope in which the handler function is executed.

  • options?: any optional

    Object If the eventName parameter was an event name, this is the addListener options.

optional public applyData(data?: any)

[Method] We are using applyData so that we can return nothing and prevent the this data property to be overridden

Parameters

  • data?: any optional

    Object

optional public average(field?: string): number

[Method] Gets the average value in the store

Parameters

  • field?: string optional

    String The field in each record you want to get the average for.

Returns

number

Number The average value, if no items exist, 0.

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 clearFilter(suppressEvent?: boolean)

[Method] Reverts to a view of the Record cache with no filtering applied

Parameters

  • suppressEvent?: boolean optional

    Boolean true to clear silently without firing the refresh event.

optional public clearListeners()

[Method] Removes all listeners for this object

optional public destroy()

[Method]

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

[Method] Calls the specified function for each of the Records in the cache

Parameters

  • fn?: any optional

    Function The function to call. Returning false aborts and exits the iteration.

  • scope?: any optional

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

optional public enableBubble(events?: any)

[Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present

Parameters

  • events?: any optional

    String/String[] The event name to bubble, or an Array of event names.

optional public filter(filters?: any, value?: string, anyMatch?: boolean, caseSensitive?: boolean)

[Method] Filters the loaded set of records by a given set of filters

Parameters

  • filters?: any optional

    Object[]/Ext.util.Filter[]/String 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

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

  • anyMatch?: boolean optional

    Boolean true to allow any match, false to anchor regex beginning with ^.

  • caseSensitive?: boolean optional

    Boolean true to make the filtering regex case sensitive.

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

[Method] Filter by a function

Parameters

  • fn?: any optional

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

  • scope?: any optional

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

optional public find(fieldName?: string, value?: any, startIndex?: number, anyMatch?: boolean, caseSensitive?: boolean, exactMatch?: boolean): number

[Method] Finds the index of the first matching Record in this store by a specific field value

Parameters

  • fieldName?: string optional

    String The name of the Record field to test.

  • value?: any optional

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

  • startIndex?: number optional

    Number The index to start searching at.

  • anyMatch?: boolean optional

    Boolean true to match any part of the string, not just the beginning.

  • caseSensitive?: boolean optional

    Boolean true for case sensitive comparison.

  • exactMatch?: boolean optional

    Boolean true to force exact match (^ and $ characters added to the regex).

Returns

number

Number The matched index or -1

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

[Method] Find the index of the first matching Record in this Store by a function

Parameters

  • fn?: any optional

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

  • scope?: any optional

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

  • startIndex?: number optional

    Number The index to start searching at.

Returns

number

Number The matched index or -1.

optional public findExact(fieldName?: string, value?: any, startIndex?: number): number

[Method] Finds the index of the first matching Record in this store by a specific field value

Parameters

  • fieldName?: string optional

    String The name of the Record field to test.

  • value?: any optional

    Object The value to match the field against.

  • startIndex?: number optional

    Number The index to start searching at.

Returns

number

Number The matched index or -1.

optional public findRecord(fieldName?: string, value?: any, startIndex?: number, anyMatch?: boolean, caseSensitive?: boolean, exactMatch?: boolean): IModel

[Method] Finds the first matching Record in this store by a specific field value

Parameters

  • fieldName?: string optional

    String The name of the Record field to test.

  • value?: any optional

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

  • startIndex?: number optional

    Number The index to start searching at.

  • anyMatch?: boolean optional

    Boolean true to match any part of the string, not just the beginning.

  • caseSensitive?: boolean optional

    Boolean true for case sensitive comparison.

  • exactMatch?: boolean optional

    Boolean true to force exact match (^ and $ characters added to the regex).

Returns

IModel

Ext.data.Model The matched record or null.

optional public fireAction(eventName?: string, args?: Array<any>, fn?: any, scope?: any): any

[Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste

Parameters

  • eventName?: string optional

    String The name of the event to fire.

  • args?: Array<any> optional

    Array Arguments to pass to handers.

  • fn?: any optional

    Function Action.

  • scope?: any optional

    Object Scope of fn.

Returns

any

Object

optional public fireEvent(eventName: string, args?: Array<any>): boolean

[Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList

Parameters

  • eventName: string

    String The name of the event to fire.

  • args?: Array<any> optional

    Object... Variable number of parameters are passed to handlers.

Returns

boolean

Boolean Returns false if any of the handlers return false.

optional public first(): any

[Method] Convenience function for getting the first model instance in the store

Returns

any

Ext.data.Model/undefined The first model instance in the store, or undefined.

optional public getAllCount(): number

[Method] Gets the number of all cached records including the ones currently filtered

Returns

number

Number The number of all Records in the Store's cache.

optional public getAt(index?: number): any

[Method] Get the Record at the specified index

Parameters

  • index?: number optional

    Number The index of the Record to find.

Returns

any

Ext.data.Model/undefined The Record at the passed index. Returns undefined if not found.

optional public getAutoLoad(): any

[Method] Returns the value of autoLoad

Returns

any

Boolean/Object

optional public getAutoSync(): boolean

[Method] Returns the value of autoSync

Returns

boolean

Boolean

optional public getBubbleEvents(): any

[Method] Returns the value of bubbleEvents

Returns

any

String/String[]

optional public getById(id?: string): any

[Method] Get the Record with the specified id

Parameters

  • id?: string optional

    String The id of the Record to find.

Returns

any

Ext.data.Model/undefined The Record with the passed id. Returns undefined if not found.

optional public getClearOnPageLoad(): boolean

[Method] Returns the value of clearOnPageLoad

Returns

boolean

Boolean

optional public getCount(): number

[Method] Gets the number of cached records

Returns

number

Number The number of Records in the Store's cache.

optional public getData(): any

[Method] Returns the value of data

Returns

any

Object[]/Ext.data.Model[]

optional public getDestroyRemovedRecords(): boolean

[Method] Returns the value of destroyRemovedRecords

Returns

boolean

Boolean

optional public getFields(): Array<any>

[Method] Returns the value of fields

Returns

Array<any>

Object[]

optional public getFilters(): any

[Method] Returns the value of filters

Returns

any

Object

optional public getFolderSort(): boolean

[Method] Returns the value of folderSort

Returns

boolean

Boolean

optional public getGetGroupString(): any

[Method] Returns the value of getGroupString

Returns

any

Function

optional public getGroupDir(): string

[Method] Returns the value of groupDir

Returns

string

String

optional public getGroupField(): string

[Method] Returns the value of groupField

Returns

string

String

optional public getGrouper(): any

[Method] Returns the value of grouper

Returns

any

Object

optional public getGroups(groupName?: string): any

[Method] Returns an array containing the result of applying the grouper to the records in this store

Parameters

  • groupName?: string optional

    String Pass in an optional groupName argument to access a specific group as defined by grouper.

Returns

any

Object/Object[] The grouped data.

optional public getId(): any

[Method] Retrieves the id of this component

Returns

any

any id

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 getListeners(): any

[Method] Returns the value of listeners

Returns

any

Object

optional public getModel(): string

[Method] Returns the value of model

Returns

string

String

optional public getModelDefaults(): any

[Method] Returns the value of modelDefaults

Returns

any

Object

optional public getNewRecords(): IModel[]

[Method] Returns all Model instances that are either currently a phantom e g

Returns

IModel[]

Ext.data.Model[] The Model instances.

optional public getNode(): IModel

[Method] Returns the value of node

Returns

IModel

Ext.data.Model

optional public getPageSize(): number

[Method] Returns the value of pageSize

Returns

number

Number

optional public getProxy(): any

[Method] Returns the value of proxy

Returns

any

String/Ext.data.proxy.Proxy/Object

optional public getRange(startIndex?: number, endIndex?: number): IModel[]

[Method] Returns a range of Records between specified indices

Parameters

  • startIndex?: number optional

    Number The starting index.

  • endIndex?: number optional

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

Returns

IModel[]

Ext.data.Model[] An array of Records.

optional public getRecursive(): boolean

[Method] Returns the value of recursive

Returns

boolean

Boolean

optional public getRemoteFilter(): boolean

[Method] Returns the value of remoteFilter

Returns

boolean

Boolean

optional public getRemoteGroup(): boolean

[Method] Returns the value of remoteGroup

Returns

boolean

Boolean

optional public getRemoteSort(): boolean

[Method] Returns the value of remoteSort

Returns

boolean

Boolean

optional public getRemovedRecords(): IModel[]

[Method] Returns any records that have been removed from the store but not yet destroyed on the proxy

Returns

IModel[]

Ext.data.Model[] The removed Model instances.

optional public getRootVisible(): boolean

[Method] Returns the value of rootVisible

Returns

boolean

Boolean

optional public getSorters(): any

[Method] Returns the value of sorters

Returns

any

Object

optional public getStoreId(): string

[Method] Returns the value of storeId

Returns

string

String

optional public getSyncRemovedRecords(): boolean

[Method] Returns the value of syncRemovedRecords

Returns

boolean

Boolean

optional public getTotalCount(): number

[Method] Returns the value of totalCount

Returns

number

Number

optional public getUpdatedRecords(): IModel[]

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

Returns

IModel[]

Ext.data.Model[] The updated Model instances.

optional public hasListener(eventName?: string): boolean

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

Parameters

  • eventName?: string optional

    String The name of the event to check for

Returns

boolean

Boolean True if the event is being listened for, else false

optional public indexOf(record?: IModel): number

[Method] Get the index within the cache of the passed Record

Parameters

  • record?: IModel optional

    Ext.data.Model The Ext.data.Model object to find.

Returns

number

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

optional public indexOfId(id?: string): number

[Method] Get the index within the cache of the Record with the passed id

Parameters

  • id?: string optional

    String The id of the Record to find.

Returns

number

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

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, records?: IModel[]): any

[Method] Inserts Model instances into the Store at the given index and fires the add event

Parameters

  • index?: number optional

    Number The start index at which to insert the passed Records.

  • records?: IModel[] optional

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

Returns

any

Object

optional public isAutoLoading(): boolean

[Method] Returns true if the Store is set to autoLoad or is a type which loads upon instantiation

Returns

boolean

Boolean

optional public isFiltered(): boolean

[Method] Returns true if this store is currently filtered

Returns

boolean

Boolean

optional public isGrouped(): boolean

[Method] This method tells you if this store has a grouper defined on it

Returns

boolean

Boolean true if this store has a grouper defined.

optional public isLoaded(): boolean

[Method] Returns true if the Store has been loaded

Returns

boolean

Boolean true if the Store has been loaded.

optional public isLoading(): boolean

[Method] Returns true if the Store is currently performing a load operation

Returns

boolean

Boolean true if the Store is currently loading.

optional public isSorted(): boolean

[Method] Returns true if this store is currently sorted

Returns

boolean

Boolean

optional public isVisible(node?: any): boolean

[Method]

Parameters

  • node?: any optional

    Object

Returns

boolean

Boolean

optional public last(): any

[Method] Convenience function for getting the last model instance in the store

Returns

any

Ext.data.Model/undefined The last model instance in the store, or undefined.

optional public load(options?: any, scope?: any): any

[Method] Loads data into the Store via the configured proxy

Parameters

  • options?: any optional

    Object/Function config object, passed into the Ext.data.Operation object before loading.

  • scope?: any optional

    Object Scope for the function.

Returns

any

Object

optional public loadData(data?: any, append?: boolean)

[Method] Loads an array of data straight into the Store

Parameters

  • data?: any optional

    Ext.data.Model[]/Object[] Array of data to load. Any non-model instances will be cast into model instances first.

  • append?: boolean optional

    Boolean true to add the records to the existing records in the store, false to remove the old ones first.

optional public loadPage(page?: number, options?: any, scope?: any)

[Method] Loads a given page of data by setting the start and limit values appropriately

Parameters

  • page?: number optional

    Number The number of the page to load.

  • options?: any optional

    Object See options for load.

  • scope?: any optional

    Object

optional public loadRecords(model?: any): IModel[]

[Method] Adds Model instance to the Store

Parameters

  • model?: any optional

    Ext.data.Model[]/Ext.data.Model... An array of Model instances or Model configuration objects, or variable number of Model instance or config arguments.

Returns

IModel[]

Ext.data.Model[] The model instances that were added.

optional public max(field?: string): any

[Method] Gets the maximum value in the store

Parameters

  • field?: string optional

    String The field in each record.

Returns

any

Object/undefined The maximum value, if no items exist, undefined.

optional public min(field?: string): any

[Method] Gets the minimum value in the store

Parameters

  • field?: string optional

    String The field in each record.

Returns

any

Object/undefined The minimum value, if no items exist, undefined.

optional public mon(object?: any, eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for addManagedListener

Parameters

  • object?: any optional

    Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners.

  • eventName?: any optional

    Object/String The event name, or an object containing event name properties.

  • fn?: any optional

    Function If the eventName parameter was an event name, this is the handler function.

  • scope?: any optional

    Object If the eventName parameter was an event name, this is the scope in which the handler function is executed.

  • options?: any optional

    Object If the eventName parameter was an event name, this is the addListener options.

optional public mun(object?: any, eventName?: any, fn?: any, scope?: any)

[Method] Alias for removeManagedListener

Parameters

  • object?: any optional

    Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners.

  • eventName?: any optional

    Object/String The event name, or an object containing event name properties.

  • fn?: any optional

    Function If the eventName parameter was an event name, this is the handler function.

  • scope?: any optional

    Object If the eventName parameter was an event name, this is the scope in which the handler function is executed.

optional public nextPage(options?: any)

[Method] Loads the next page in the current data set

Parameters

  • options?: any optional

    Object See options for load.

optional public on(eventName?: any, fn?: any, scope?: any, options?: any, order?: string)

[Method] Alias for addListener

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names.

  • fn?: any optional

    Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below.

  • scope?: any optional

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

  • options?: any optional

    Object An object containing handler configuration. This object may contain any of the following properties:

  • order?: string optional

    String The order of when the listener should be added into the listener queue. Possible values are before, current and after.

optional public onAfter(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for addAfterListener

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for.

  • fn?: any optional

    Function/String The method the event invokes.

  • scope?: any optional

    Object The scope for fn.

  • options?: any optional

    Object An object containing handler configuration.

optional public onBefore(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for addBeforeListener

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for.

  • fn?: any optional

    Function/String The method the event invokes.

  • scope?: any optional

    Object The scope for fn.

  • options?: any optional

    Object An object containing handler configuration.

optional public previousPage(options?: any)

[Method] Loads the previous page in the current data set

Parameters

  • options?: any optional

    Object See options for load.

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

[Method] Query the cached records in this Store using a filtering function

Parameters

  • fn?: any optional

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

  • scope?: any optional

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

Returns

IMixedCollection

Ext.util.MixedCollection Returns an Ext.util.MixedCollection of the matched records.

optional public relayEvents(object?: any, events?: any): IObservable

[Method] Relays selected events from the specified Observable as if the events were fired by this

Parameters

  • object?: any optional

    Object The Observable whose events this object is to relay.

  • events?: any optional

    String/Array/Object Array of event names to relay.

Returns

IObservable

Ext.mixin.Observable this

optional public remove(records?: any)

[Method] Removes the given record from the Store firing the removerecords event passing all the instances that are removed

Parameters

  • records?: any optional

    Ext.data.Model/Ext.data.Model[] Model instance or array of instances to remove.

optional public removeAfterListener(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Removes a before event handler

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove.

  • scope?: any optional

    Object The scope originally specified for fn.

  • options?: any optional

    Object Extra options object.

optional public removeAll(silent?: boolean)

[Method] Remove all items from the store

Parameters

  • silent?: boolean optional

    Boolean Prevent the clear event from being fired.

optional public removeAt(index?: number)

[Method] Removes the model instance at the given index

Parameters

  • index?: number optional

    Number The record index.

optional public removeBeforeListener(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Removes a before event handler

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove.

  • scope?: any optional

    Object The scope originally specified for fn.

  • options?: any optional

    Object Extra options object.

optional public removeListener(eventName?: any, fn?: any, scope?: any, options?: any, order?: string)

[Method] Removes an event handler

Parameters

  • eventName?: any optional

    String/String[]/Object The type of event the handler was associated with.

  • fn?: any optional

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

  • scope?: any optional

    Object The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

  • options?: any optional

    Object Extra options object. See addListener for details.

  • order?: string optional

    String The order of the listener to remove. Possible values are before, current and after.

optional public removeManagedListener(object?: any, eventName?: any, fn?: any, scope?: any)

[Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed

Parameters

  • object?: any optional

    Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners.

  • eventName?: any optional

    Object/String The event name, or an object containing event name properties.

  • fn?: any optional

    Function If the eventName parameter was an event name, this is the handler function.

  • scope?: any optional

    Object If the eventName parameter was an event name, this is the scope in which the handler function is executed.

optional public resumeEvents(discardQueuedEvents?: boolean)

[Method] Resumes firing events see suspendEvents

Parameters

  • discardQueuedEvents?: boolean optional

    Boolean Pass as true to discard any queued events.

optional public setAutoLoad(autoLoad?: any)

[Method] Sets the value of autoLoad

Parameters

  • autoLoad?: any optional

    Boolean/Object

optional public setAutoSync(autoSync?: boolean)

[Method] Sets the value of autoSync

Parameters

  • autoSync?: boolean optional

    Boolean

optional public setBubbleEvents(bubbleEvents?: any)

[Method] Sets the value of bubbleEvents

Parameters

  • bubbleEvents?: any optional

    String/String[]

optional public setClearOnPageLoad(clearOnPageLoad?: boolean)

[Method] Sets the value of clearOnPageLoad

Parameters

  • clearOnPageLoad?: boolean optional

    Boolean

optional public setData(data?: any)

[Method] Sets the value of data

Parameters

  • data?: any optional

    Object[]/Ext.data.Model[]

optional public setDestroyRemovedRecords(destroyRemovedRecords?: boolean)

[Method] Sets the value of destroyRemovedRecords

Parameters

  • destroyRemovedRecords?: boolean optional

    Boolean

optional public setFields(fields?: Array<any>)

[Method] Sets the value of fields

Parameters

  • fields?: Array<any> optional

    Object[]

optional public setFilters(filters?: any)

[Method] Sets the value of filters

Parameters

  • filters?: any optional

    Object

optional public setFolderSort(folderSort?: boolean)

[Method] Sets the value of folderSort

Parameters

  • folderSort?: boolean optional

    Boolean

optional public setGetGroupString(getGroupString?: any)

[Method] Sets the value of getGroupString

Parameters

  • getGroupString?: any optional

    Function

optional public setGroupDir(groupDir?: string)

[Method] Sets the value of groupDir

Parameters

  • groupDir?: string optional

    String

optional public setGroupField(groupField?: string)

[Method] Sets the value of groupField

Parameters

  • groupField?: string optional

    String

optional public setGrouper(grouper?: any)

[Method] Sets the value of grouper

Parameters

  • grouper?: any optional

    Object

optional public setListeners(listeners?: any)

[Method] Sets the value of listeners

Parameters

  • listeners?: any optional

    Object

optional public setModel(model?: string)

[Method] Sets the value of model

Parameters

  • model?: string optional

    String

optional public setModelDefaults(modelDefaults?: any)

[Method] Sets the value of modelDefaults

Parameters

  • modelDefaults?: any optional

    Object

optional public setNode(node?: IModel)

[Method] Sets the value of node

Parameters

  • node?: IModel optional

    Ext.data.Model

optional public setPageSize(pageSize?: number)

[Method] Sets the value of pageSize

Parameters

  • pageSize?: number optional

    Number

optional public setProxy(proxy?: any)

[Method] Sets the value of proxy

Parameters

  • proxy?: any optional

    String/Ext.data.proxy.Proxy/Object

optional public setRecursive(recursive?: boolean)

[Method] Sets the value of recursive

Parameters

  • recursive?: boolean optional

    Boolean

optional public setRemoteFilter(remoteFilter?: boolean)

[Method] Sets the value of remoteFilter

Parameters

  • remoteFilter?: boolean optional

    Boolean

optional public setRemoteGroup(remoteGroup?: boolean)

[Method] Sets the value of remoteGroup

Parameters

  • remoteGroup?: boolean optional

    Boolean

optional public setRemoteSort(remoteSort?: boolean)

[Method] Sets the value of remoteSort

Parameters

  • remoteSort?: boolean optional

    Boolean

optional public setRootVisible(rootVisible?: boolean)

[Method] Sets the value of rootVisible

Parameters

  • rootVisible?: boolean optional

    Boolean

optional public setSorters(sorters?: any)

[Method] Sets the value of sorters

Parameters

  • sorters?: any optional

    Object

optional public setStoreId(storeId?: string)

[Method] Sets the value of storeId

Parameters

  • storeId?: string optional

    String

optional public setSyncRemovedRecords(syncRemovedRecords?: boolean)

[Method] Sets the value of syncRemovedRecords

Parameters

  • syncRemovedRecords?: boolean optional

    Boolean

optional public setTotalCount(totalCount?: number)

[Method] Sets the value of totalCount

Parameters

  • totalCount?: number optional

    Number

optional public sort(sorters?: any, defaultDirection?: string, where?: string)

[Method] Sorts the data in the Store by one or more of its properties

Parameters

  • sorters?: any optional

    String/Ext.util.Sorter[] Either a string name of one of the fields in this Store's configured Model, or an array of sorter configurations.

  • defaultDirection?: string optional

    String The default overall direction to sort the data by.

  • where?: string optional

    String This can be either 'prepend' or 'append'. If you leave this undefined it will clear the current sorters.

optional public sum(field?: string): number

[Method] Sums the value of property for each record between start and end and returns the result

Parameters

  • field?: string optional

    String The field in each record.

Returns

number

Number The sum.

optional public suspendEvents()

[Method] Suspends the firing of all events

optional public sync(): any

[Method] Synchronizes the Store with its Proxy

Returns

any

Object

optional public un(eventName?: any, fn?: any, scope?: any, options?: any, order?: string)

[Method] Alias for removeListener

Parameters

  • eventName?: any optional

    String/String[]/Object The type of event the handler was associated with.

  • fn?: any optional

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

  • scope?: any optional

    Object The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

  • options?: any optional

    Object Extra options object. See addListener for details.

  • order?: string optional

    String The order of the listener to remove. Possible values are before, current and after.

optional public unAfter(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for removeAfterListener

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove.

  • scope?: any optional

    Object The scope originally specified for fn.

  • options?: any optional

    Object Extra options object.

optional public unBefore(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for removeBeforeListener

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove.

  • scope?: any optional

    Object The scope originally specified for fn.

  • options?: any optional

    Object Extra options object.