Module: ol/format/filter

Functions

and(conditions){And}

format/filter.js, line 32

import {and} from 'ol/format/filter';

Create a logical <And> operator between two or more filter conditions.

Name	Type	Description
conditions	Filter	Filter conditions.

Returns:

<And> operator.

bbox(geometryName, extent, srsName){Bbox}

format/filter.js, line 71

import {bbox} from 'ol/format/filter';

Create a <BBOX> operator to test whether a geometry-valued property intersects a fixed bounding box

Name	Type	Description
geometryName	string	Geometry name to use.
extent	Extent	Extent.
srsName	string | undefined	SRS name. No srsName attribute will be set on geometries when this is not provided.

Returns:

<BBOX> operator.

between(propertyName, lowerBoundary, upperBoundary){IsBetween}

format/filter.js, line 248

import {between} from 'ol/format/filter';

Creates a <PropertyIsBetween> comparison operator to test whether an expression value lies within a range given by a lower and upper bound (inclusive).

Name	Type	Description
propertyName	string	Name of the context property to compare.
lowerBoundary	number	The lower bound of the range.
upperBoundary	number	The upper bound of the range.

Returns:

<PropertyIsBetween> operator.

contains(geometryName, geometry, srsName){Contains}

format/filter.js, line 86

import {contains} from 'ol/format/filter';

Create a <Contains> operator to test whether a geometry-valued property contains a given geometry.

Name	Type	Description
geometryName	string	Geometry name to use.
geometry	Geometry	Geometry.
srsName	string | undefined	SRS name. No srsName attribute will be set on geometries when this is not provided.

Returns:

<Contains> operator.

disjoint(geometryName, geometry, srsName){Disjoint}

format/filter.js, line 116

import {disjoint} from 'ol/format/filter';

Create a <Disjoint> operator to test whether a geometry-valued property is disjoint to a given geometry.

Name	Type	Description
geometryName	string	Geometry name to use.
geometry	Geometry	Geometry.
srsName	string | undefined	SRS name. No srsName attribute will be set on geometries when this is not provided.

Returns:

<Disjoint> operator.

during(propertyName, begin, end){During}

format/filter.js, line 295

import {during} from 'ol/format/filter';

Create a <During> temporal operator.

Name	Type	Description
propertyName	string	Name of the context property to compare.
begin	string	The begin date in ISO-8601 format.
end	string	The end date in ISO-8601 format.

Returns:

<During> operator.

dwithin(geometryName, geometry, distance, unit, srsName){DWithin}

format/filter.js, line 148

import {dwithin} from 'ol/format/filter';

Create a <DWithin> operator to test whether a geometry-valued property is within a distance to a given geometry.

Name	Type	Description
geometryName	string	Geometry name to use.
geometry	Geometry	Geometry.
distance	number	Distance.
unit	string	Unit.
srsName	string | undefined	SRS name. No srsName attribute will be set on geometries when this is not provided.

Returns:

<DWithin> operator.

equalTo(propertyName, expression, matchCase){EqualTo}

format/filter.js, line 161

import {equalTo} from 'ol/format/filter';

Creates a <PropertyIsEqualTo> comparison operator.

Name	Type	Description
propertyName	string	Name of the context property to compare.
expression	string | number	The value to compare.
matchCase	boolean | undefined	Case-sensitive?

Returns:

<PropertyIsEqualTo> operator.

greaterThan(propertyName, expression){GreaterThan}

format/filter.js, line 210

import {greaterThan} from 'ol/format/filter';

Creates a <PropertyIsGreaterThan> comparison operator.

Name	Type	Description
propertyName	string	Name of the context property to compare.
expression	number	The value to compare.

Returns:

<PropertyIsGreaterThan> operator.

greaterThanOrEqualTo(propertyName, expression){GreaterThanOrEqualTo}

format/filter.js, line 222

import {greaterThanOrEqualTo} from 'ol/format/filter';

Creates a <PropertyIsGreaterThanOrEqualTo> comparison operator.

Name	Type	Description
propertyName	string	Name of the context property to compare.
expression	number	The value to compare.

Returns:

<PropertyIsGreaterThanOrEqualTo> operator.

intersects(geometryName, geometry, srsName){Intersects}

format/filter.js, line 101

import {intersects} from 'ol/format/filter';

Create a <Intersects> operator to test whether a geometry-valued property intersects a given geometry.

Name	Type	Description
geometryName	string	Geometry name to use.
geometry	Geometry	Geometry.
srsName	string | undefined	SRS name. No srsName attribute will be set on geometries when this is not provided.

Returns:

<Intersects> operator.

isNull(propertyName){IsNull}

format/filter.js, line 234

import {isNull} from 'ol/format/filter';

Creates a <PropertyIsNull> comparison operator to test whether a property value is null.

Name	Type	Description
propertyName	string	Name of the context property to compare.

Returns:

<PropertyIsNull> operator.

lessThan(propertyName, expression){LessThan}

format/filter.js, line 186

import {lessThan} from 'ol/format/filter';

Creates a <PropertyIsLessThan> comparison operator.

Name	Type	Description
propertyName	string	Name of the context property to compare.
expression	number	The value to compare.

Returns:

<PropertyIsLessThan> operator.

lessThanOrEqualTo(propertyName, expression){LessThanOrEqualTo}

format/filter.js, line 198

import {lessThanOrEqualTo} from 'ol/format/filter';

Creates a <PropertyIsLessThanOrEqualTo> comparison operator.

Name	Type	Description
propertyName	string	Name of the context property to compare.
expression	number	The value to compare.

Returns:

<PropertyIsLessThanOrEqualTo> operator.

like(propertyName, pattern, wildCard, singleChar, escapeChar, matchCase){IsLike}

format/filter.js, line 268

import {like} from 'ol/format/filter';

Represents a <PropertyIsLike> comparison operator that matches a string property value against a text pattern.

Name	Type	Description
propertyName	string	Name of the context property to compare.
pattern	string	Text pattern.
wildCard	string | undefined	Pattern character which matches any sequence of zero or more string characters. Default is '*'.
singleChar	string | undefined	pattern character which matches any single string character. Default is '.'.
escapeChar	string | undefined	Escape character which can be used to escape the pattern characters. Default is '!'.
matchCase	boolean | undefined	Case-sensitive?

Returns:

<PropertyIsLike> operator.

not(condition){Not}

format/filter.js, line 56

import {not} from 'ol/format/filter';

Represents a logical <Not> operator for a filter condition.

Name	Type	Description
condition	Filter	Filter condition.

Returns:

<Not> operator.

notEqualTo(propertyName, expression, matchCase){NotEqualTo}

format/filter.js, line 174

import {notEqualTo} from 'ol/format/filter';

Creates a <PropertyIsNotEqualTo> comparison operator.

Name	Type	Description
propertyName	string	Name of the context property to compare.
expression	string | number	The value to compare.
matchCase	boolean | undefined	Case-sensitive?

Returns:

<PropertyIsNotEqualTo> operator.

or(conditions){Or}

format/filter.js, line 44

import {or} from 'ol/format/filter';

Create a logical <Or> operator between two or more filter conditions.

Name	Type	Description
conditions	Filter	Filter conditions.

Returns:

<Or> operator.

within(geometryName, geometry, srsName){Within}

format/filter.js, line 131

import {within} from 'ol/format/filter';

Create a <Within> operator to test whether a geometry-valued property is within a given geometry.

Name	Type	Description
geometryName	string	Geometry name to use.
geometry	Geometry	Geometry.
srsName	string | undefined	SRS name. No srsName attribute will be set on geometries when this is not provided.

Returns:

<Within> operator.