Interface: IFilterable¶
This interface defines the filter/sorter. It has to be implemented by the controls using the filter action to display a filter modal page
Summary¶
Properties¶
Class Properties¶
Currently none in this class.
Inherited Properties¶
Currently none inherited from the parent class(es).
Methods¶
Class Methods¶
- getFilterCriteria
- getFilterCriteriaAsync
- getFilterFeedbackSorters
- getFilterItemString
- getSelectedValues
- getSorterCriteria
- redrawFilterFeedback
- redrawUIFilterFeedback
- setFilterResult
- standardFilterUpdated
Inherited Methods¶
Currently none inherited from the parent class(es).
Methods¶
getFilterCriteria()¶
▸ getFilterCriteria(name: string, values: object[], isArrayFilterProperty?: boolean): FilterCriteria
Get defined filter criteria based on the name
Parameters:
| Name | Type | Description |
|---|---|---|
| name | string | the name of the criteria to find |
| values | object[] | the values of the criteria to find |
| isArrayFilterProperty? | boolean | is the array type of criteria |
Returns: FilterCriteria
return the filter criteria
Deprecated¶
- use getFilterCriteriaAsync
getFilterCriteriaAsync¶
▸ getFilterCriteriaAsync(name: string, values: object[], isArrayFilterProperty?: boolean): Promise<[FilterCriteria, object[]]>
Get defined filter criteria based on the name
Parameters:
| Name | Type | Description |
|---|---|---|
| name | string | the name of the criteria to find |
| values | object[] | the values of the criteria to find |
| isArrayFilterProperty? | boolean | is the array type of criteria |
Returns: Promise<[FilterCriteria, object[]]>
return array [ the filter criteria, values of the criteria ]
getFilterFeedbackSorters¶
▸ getFilterFeedbackSorters(): string[]
Returns: string[]
return sorters managed on filter feedback bar of filterable object
getFilterItemString¶
▸ getFilterItemString(name: string, value: any): string
Get filter value string based on the name and odata version 2 / 4
Parameters:
| Name | Type | Description |
|---|---|---|
| name | string | the name of the criteria |
| value | any | the value of the criteria |
Returns: string
return string can be used in filter string
getSelectedValues¶
▸ getSelectedValues(): FilterCriteria[]
Returns: FilterCriteria[]
return selected list of filter criteria
getSorterCriteria¶
▸ getSorterCriteria(name: string): FilterCriteria
Get defined sorter criteria based on the name
Parameters:
| Name | Type | Description |
|---|---|---|
| name | string | the name of the criteria to find |
Returns: FilterCriteria
redrawFilterFeedback¶
▸ redrawFilterFeedback(): any
Redraw Filter Feedback bar
Returns: any
redrawUIFilterFeedback¶
▸ redrawUIFilterFeedback(): any
Redraw only UI of Filter Feedback bar
Returns: any
setFilterResult¶
▸ setFilterResult(result: FilterCriteria[], redraw: boolean): any
Set filter result with list of defined criteria
Parameters:
| Name | Type | Description |
|---|---|---|
| result | FilterCriteria[] | the list of criteria for filter/sorter |
| redraw | boolean | if redrawing the section with the filter. Default value is true |
Returns: any
standardFilterUpdated¶
▸ standardFilterUpdated(result: FilterCriteria[]): any
Set filter result with list of defined criteria
Parameters:
| Name | Type | Description |
|---|---|---|
| result | FilterCriteria[] | the list of criteria for filter/sorter |
Returns: any