Documentation { elastic.js }

ejs ⟩ AndFilter

A container Filter that allows Boolean AND composition of Filters.

Module

 AndFilter

 AndFilter ( f )
A container Filter that allows Boolean AND composition of Filters.

Parameters
f <Filter | Filter[]> A single Filter object or an array of valid Filter objects.

Method Summary

Returns Name Description
String_type()The type of ejs object. For internal use only.
Objectcache(trueFalse)Enable or disable caching of the filter
ObjectcacheKey(key)Sets the cache key.
Objectfilters(fltr)Sets the filters for the filter. If fltr is a single Filter, it is added to the current filters. If fltr is an array of Filters, then they replace all existing filters.
Objectname(name)Sets the filter name.
ObjecttoJSON()Returns the filter object.

Method Detail

 _type

 String _type ( )
The type of ejs object. For internal use only.

Returns
the type of object

 cache

 Object cache ( trueFalse )
Enable or disable caching of the filter

Parameters
trueFalse <Boolean> True to cache the filter, false otherwise.
Returns
returns this so that calls can be chained.

 cacheKey

 Object cacheKey ( key )
Sets the cache key.

Parameters
key <String> the cache key as a string.
Returns
returns this so that calls can be chained.

 filters

 Object filters ( fltr )
Sets the filters for the filter. If fltr is a single Filter, it is added to the current filters. If fltr is an array of Filters, then they replace all existing filters.

Parameters
fltr <Filter | Filter[]> A valid filter object or an array of filters.
Returns
returns this so that calls can be chained.

 name

 Object name ( name )
Sets the filter name.

Parameters
name <String> A name for the filter.
Returns
returns this so that calls can be chained.

 toJSON

 Object toJSON ( )
Returns the filter object.

Returns
filter object

Request

Queries

Filters

Aggregations

Facets

Suggesters

Geo