Interface IFilterable

Hierarchy

Index

Properties

Methods

Properties

optional public alias?: Array<string>

[Config Option] (String[])

optional public alternateClassName?: any

[Config Option] (String/String[])

optional public config?: any

[Config Option] (Object)

optional public currentSortFn?: any

[Property] (Object)

optional public dirtyFilterFn?: 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] (Array)

optional public inheritableStatics?: any

[Config Option] (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 statics?: any

[Config Option] (Object)

optional public uses?: Array<string>

[Config Option] (String[])

Methods

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?: Array<any>): any

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

Parameters

  • filters?: Array<any> optional

    Array An array with filters. A filter 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 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 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 destroy()

[Method]

optional public filter(data?: Array<any>): Array<any>

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

Parameters

  • data?: Array<any> optional

    Array The array you want to have sorted.

Returns

Array<any>

Array The array you passed after it is sorted.

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 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 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 removeFilters(filters?: Array<any>)

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

Parameters

  • filters?: Array<any> optional

    Array Each value in the array can be a string (property name), function (sorterFn), an object containing a property and value keys or Sorter instance.

optional public setFilterRoot(filterRoot?: string)

[Method] Sets the value of filterRoot

Parameters

  • filterRoot?: string optional

    String The new value.

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

[Method] Sets the value of filters

Parameters

  • filters?: Array<any> optional

    Array The new value.