FilterValueCollection

FilterValueCollection class

Represents the multiple filter collection.

class FilterValueCollection;

Properties

PropertyTypeDescription
matchBlankbooleanIndicates whether to filter by blank.

Methods

MethodDescription
get(number)Gets FilterValue by index.
add(string)Adds a label filter criteria.
add(DateTimeGroupingType, number, number, number)Adds a date filter criteria value.
add(DateTimeGroupingType, number, number, number, number, number, number)Adds a date time filter criteria value.

matchBlank

Indicates whether to filter by blank.

matchBlank : boolean;

get(number)

Gets FilterValue by index.

get(index: number) : FilterValue;

Parameters:

ParameterTypeDescription
indexnumber

Returns

FilterValue

add(string)

Adds a label filter criteria.

add(filter: string) : void;

Parameters:

ParameterTypeDescription
filterstringThe filter data.

add(DateTimeGroupingType, number, number, number)

Adds a date filter criteria value.

add(type: DateTimeGroupingType, year: number, month: number, day: number) : void;

Parameters:

ParameterTypeDescription
typeDateTimeGroupingTypeThe type of date filter.
yearnumberThe year.
monthnumberThe month.
daynumberThe day.

add(DateTimeGroupingType, number, number, number, number, number, number)

Adds a date time filter criteria value.

add(type: DateTimeGroupingType, year: number, month: number, day: number, hour: number, minute: number, second: number) : void;

Parameters:

ParameterTypeDescription
typeDateTimeGroupingTypeThe type of date filter.
yearnumberThe year.
monthnumberThe month.
daynumberThe day.
hournumberThe hour.
minutenumberThe minute.
secondnumberThe second.