Class: FilterCriteria¶
Define the filter criteria
Hierarchy¶
- FilterCriteria
Summary¶
Constructors¶
Accessors¶
Class Accessors¶
Inherited Accessors¶
Currently none inherited from the parent class(es).
Methods¶
Class Methods¶
Inherited Methods¶
Currently none inherited from the parent class(es).
Constructors¶
constructor¶
+ new FilterCriteria(type: FilterType, name: string, caption: string, filterItems: Array‹object›, isArrayFilterProperty: boolean, label: string, filterItemsDisplayValue: Array‹string›): FilterCriteria
Parameters:
| Name | Type | Default |
|---|---|---|
type |
FilterType | - |
name |
string | - |
caption |
string | - |
filterItems |
Array‹object› | - |
isArrayFilterProperty |
boolean | false |
label |
string | "" |
filterItemsDisplayValue |
Array‹string› | null |
Returns: FilterCriteria
Accessors¶
caption¶
• getter
Returns: string
return the caption of the criteria
filterItems¶
• getter
Returns: Array‹object›
return the list of all filter items
• setter
Parameters:
| Name | Type |
|---|---|
items |
Array‹object› |
Returns: void
return the list of all filter items
filterItemsDisplayValue¶
• getter
Returns: Array‹string›
return the list of all filter items display value
isArrayFilterProperty¶
• getter
Returns: boolean
return is array type of the criteria
label¶
• getter
Returns: string
return the label of the criteria
name¶
• getter
Returns: string
return the name of the criteria
type¶
• getter
Returns: FilterType
return the type of the criteria
Methods¶
isFilter¶
▸ isFilter(): boolean
Returns: boolean
return true if it is a filter, Otherwise return false
isSorter¶
▸ isSorter(): boolean
Returns: boolean
return true if it is a sorter, Otherwise return false