Class: FilterMap

(package) FilterMap(entriesopt, nullable)

A FilterMap object contains a set of filters, each mapped to a boolean value indicating whether the filter should be applied. It is used by FiltersByDomain.

Constructor

(package) new FilterMap(entriesopt, nullable)

Creates a FilterMap object.
Parameters:
Name Type Attributes Description
entries Array.<Array> <optional>
<nullable>
The initial entries in the object.
Source:

Members

size

Returns the number of filters in the object.
Source:

Methods

delete(key)

Removes the filter referenced by the given key.
Parameters:
Name Type Description
key ActiveFilter The filter.
Source:

entries() → {object}

Yields all the filters in the object along with a boolean value for each filter indicating whether the filter should be applied.
Source:
Returns:
An iterator that yields a two-tuple containing an ActiveFilter object and a boolean value.
Type
object

get(key) → {boolean|undefined}

Returns a boolean value indicating whether the filter referenced by the given key should be applied.
Parameters:
Name Type Description
key ActiveFilter The filter.
Source:
Returns:
Whether the filter should be applied. If the object does not contain the filter referenced by key, returns undefined.
Type
boolean | undefined

set(key, value)

Sets the boolean value for the filter referenced by the given key indicating whether the filter should be applied.
Parameters:
Name Type Description
key ActiveFilter The filter.
value boolean The boolean value.
Source: