Class: FilterCriteria¶
Define the filter criteria
Hierarchy¶
- FilterCriteria
Summary¶
Constructors¶
Accessors¶
Methods¶
Constructors¶
constructor¶
+ new FilterCriteria(type
: FilterType, name
: string, caption
: string, filterItems
: Array‹object›, isArrayFilterProperty
: boolean): FilterCriteria
Parameters:
Name | Type | Default |
---|---|---|
type |
FilterType | - |
name |
string | - |
caption |
string | - |
filterItems |
Array‹object› | - |
isArrayFilterProperty |
boolean | false |
Returns: FilterCriteria
Accessors¶
caption¶
• get caption(): string
Returns: string
return the caption of the criteria
filterItems¶
• get filterItems(): Array‹object›
Returns: Array‹object›
return the list of all filter items
isArrayFilterProperty¶
• get isArrayFilterProperty(): boolean
Returns: boolean
return is array type of the criteria
name¶
• get name(): string
Returns: string
return the name of the criteria
Methods¶
isFilter¶
▸ isFilter(): boolean
Returns: boolean
retuen true if it is a filter, Otherwise return false
isSorter¶
▸ isSorter(): boolean
Returns: boolean
return true if it is a sorter, Otherwise return false