Module: ol/format/filter

ol/format/filter


Methods

module:ol/format/filter.and(conditions){module:ol/format/filter/And~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 module:ol/format/filter/Filter~Filter

Filter conditions.
Returns:
<And> operator.

module:ol/format/filter.bbox(geometryName, extent, opt_srsName){module:ol/format/filter/Bbox~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 module:ol/extent~Extent

Extent.
srsName string | undefined

SRS name. No srsName attribute will be set on geometries when this is not provided.
Returns:
<BBOX> operator.

module:ol/format/filter.between(propertyName, lowerBoundary, upperBoundary){module:ol/format/filter/IsBetween~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.

module:ol/format/filter.contains(geometryName, geometry, opt_srsName){module:ol/format/filter/Contains~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 module:ol/geom/Geometry~Geometry

Geometry.
srsName string | undefined

SRS name. No srsName attribute will be set on geometries when this is not provided.
Returns:
<Contains> operator.

module:ol/format/filter.disjoint(geometryName, geometry, opt_srsName){module:ol/format/filter/Disjoint~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 module:ol/geom/Geometry~Geometry

Geometry.
srsName string | undefined

SRS name. No srsName attribute will be set on geometries when this is not provided.
Returns:
<Disjoint> operator.

module:ol/format/filter.during(propertyName, begin, end){module:ol/format/filter/During~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.

module:ol/format/filter.dwithin(geometryName, geometry, distance, unit, opt_srsName){module:ol/format/filter/DWithin~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 module:ol/geom/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.

module:ol/format/filter.equalTo(propertyName, expression, opt_matchCase){module:ol/format/filter/EqualTo~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.

module:ol/format/filter.greaterThan(propertyName, expression){module:ol/format/filter/GreaterThan~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.

module:ol/format/filter.greaterThanOrEqualTo(propertyName, expression){module:ol/format/filter/GreaterThanOrEqualTo~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.

module:ol/format/filter.intersects(geometryName, geometry, opt_srsName){module:ol/format/filter/Intersects~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 module:ol/geom/Geometry~Geometry

Geometry.
srsName string | undefined

SRS name. No srsName attribute will be set on geometries when this is not provided.
Returns:
<Intersects> operator.

module:ol/format/filter.isNull(propertyName){module:ol/format/filter/IsNull~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.

module:ol/format/filter.lessThan(propertyName, expression){module:ol/format/filter/LessThan~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.

module:ol/format/filter.lessThanOrEqualTo(propertyName, expression){module:ol/format/filter/LessThanOrEqualTo~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.

module:ol/format/filter.like(propertyName, pattern, opt_wildCard, opt_singleChar, opt_escapeChar, opt_matchCase){module:ol/format/filter/IsLike~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.

module:ol/format/filter.not(condition){module:ol/format/filter/Not~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 module:ol/format/filter/Filter~Filter

Filter condition.
Returns:
<Not> operator.

module:ol/format/filter.notEqualTo(propertyName, expression, opt_matchCase){module:ol/format/filter/NotEqualTo~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.

module:ol/format/filter.or(conditions){module:ol/format/filter/Or~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 module:ol/format/filter/Filter~Filter

Filter conditions.
Returns:
<Or> operator.

module:ol/format/filter.within(geometryName, geometry, opt_srsName){module:ol/format/filter/Within~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 module:ol/geom/Geometry~Geometry

Geometry.
srsName string | undefined

SRS name. No srsName attribute will be set on geometries when this is not provided.
Returns:
<Within> operator.