FilterValueCollection

FilterValueCollection class

Represents the multiple filter collection.

class FilterValueCollection implements Iterable<FilterValue>;

Properties

Property	Type	Description
matchBlank	boolean	Indicates whether to filter by blank.

Methods

Method	Description
get(number)	Gets FilterValue by index.
getMatchBlank()	@deprecated. Please use the ‘matchBlank’ property instead. Indicates whether to filter by blank.
setMatchBlank(boolean)	@deprecated. Please use the ‘matchBlank’ property instead. Indicates whether to filter by blank.
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.
getCount()	@deprecated. Please use the ‘count’ property instead. Gets the number of elements contained in.
isNull()	Checks whether the implementation object is null.

[Symbol.iterator](): Iterator<FilterValue>

Returns an iterator over the items in the collection. Enables use of for...of, spread syntax, and Array.from().

matchBlank

Indicates whether to filter by blank.

matchBlank : boolean;

get(number)

Gets FilterValue by index.

get(index: number) : FilterValue;

Parameters:

Parameter	Type	Description
index	number

Returns

FilterValue

getMatchBlank()

@deprecated. Please use the ‘matchBlank’ property instead. Indicates whether to filter by blank.

getMatchBlank() : boolean;

setMatchBlank(boolean)

@deprecated. Please use the ‘matchBlank’ property instead. Indicates whether to filter by blank.

setMatchBlank(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

add(string)

Adds a label filter criteria.

add(filter: string) : void;

Parameters:

Parameter	Type	Description
filter	string	The filter data.

add(DateTimeGroupingType, number, number, number)

Adds a date filter criteria value.

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

Parameters:

Parameter	Type	Description
type	DateTimeGroupingType	The type of date filter.
year	number	The year.
month	number	The month.
day	number	The 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:

Parameter	Type	Description
type	DateTimeGroupingType	The type of date filter.
year	number	The year.
month	number	The month.
day	number	The day.
hour	number	The hour.
minute	number	The minute.
second	number	The second.

getCount()

@deprecated. Please use the ‘count’ property instead. Gets the number of elements contained in.

getCount() : number;

isNull()

Checks whether the implementation object is null.

isNull() : boolean;