Class: FilterCriteria¶
Define the filter criteria
Summary¶
Constructors¶
Properties¶
Class Properties¶
Currently none in this class.
Inherited Properties¶
Currently none inherited from the parent class(es).
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: object[], isArrayFilterProperty?: boolean = false, label?: string = '', filterItemsDisplayValue?: string[] = null): FilterCriteria
Parameters:
| Name | Type |
|---|---|
| type | FilterType |
| name | string |
| caption | string |
| filterItems | object[] |
| isArrayFilterProperty? | boolean = false |
| label? | string = '' |
| filterItemsDisplayValue? | string[] = null |
Returns: FilterCriteria
Accessors¶
caption¶
Get Signature¶
▸ getter
Returns¶
string
return the caption of the criteria
filterItems¶
Get Signature¶
▸ getter
Returns¶
object[]
return the list of all filter items
Set Signature¶
▸ setter
Parameters¶
items¶
object[]
Returns¶
void
return the list of all filter items
filterItemsDisplayValue¶
Get Signature¶
▸ getter
Returns¶
string[]
return the list of all filter items display value
isArrayFilterProperty¶
Get Signature¶
▸ getter
Returns¶
boolean
return is array type of the criteria
label¶
Get Signature¶
▸ getter
Returns¶
string
return the label of the criteria
name¶
Get Signature¶
▸ getter
Returns¶
string
return the name of the criteria
type¶
Get Signature¶
▸ getter
Returns¶
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