Skip to content

Class: FilterCriteria

Define the filter criteria

Hierarchy

  • FilterCriteria

Summary

Constructors

Accessors

Class Accessors

Inherited Accessors

Methods

Class Methods

Inherited Methods

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

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

set filterItems(items: Array‹object›): void

Parameters:

Name Type
items Array‹object›

Returns: void

return the list of all filter items


filterItemsDisplayValue

get filterItemsDisplayValue(): Array‹string›

Returns: Array‹string›

return the list of all filter items display value


isArrayFilterProperty

get isArrayFilterProperty(): boolean

Returns: boolean

return is array type of the criteria


label

get label(): string

Returns: string

return the label of the criteria


name

get name(): string

Returns: string

return the name of the criteria


type

get type(): FilterType

Returns: FilterType

return the type 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