模块：ol/format/filter

函数

and(conditions){And}

format/filter.js, line 32

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

在两个或多个过滤条件之间创建逻辑运算符 <And>。

Name	Type	描述
conditions	Filter	过滤条件。

返回：

<And> 运算符。

bbox(geometryName, extent, srsName){Bbox}

format/filter.js, line 71

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

创建一个 <BBOX> 运算符，用于测试几何属性是否与固定边界框相交。

Name	Type	描述
geometryName	string	使用的几何名称。
extent	Extent	范围.
srsName	string | undefined	空间参考系统名称。若未提供，则几何对象上不会设置 srsName 属性。

返回：

<BBOX> 运算符。

between(propertyName, lowerBoundary, upperBoundary){IsBetween}

format/filter.js, line 248

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

创建 <PropertyIsBetween> 比较运算符，用于测试表达式值是否在由下限和上限定义的闭区间内。

Name	Type	描述
propertyName	string	地图（[OL_INLINE_0000_map]）由图层（[OL_INLINE_0001_layers]）和交互（[OL_INLINE_0002_interactions]）和控件（[OL_INLINE_0003_controls]）和源（[OL_INLINE_0004_sources]）和目标（[OL_INLINE_0005_targets]）和覆盖物（[OL_INLINE_0006_overlays]）和视图（[OL_INLINE_0007_views]）组成。
lowerBoundary	number	范围的下界。
upperBoundary	number	范围的上界。

返回：

<PropertyIsBetween> 运算符。

contains(geometryName, geometry, srsName){Contains}

format/filter.js, line 86

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

创建一个 <Contains> 运算符，用于测试几何值属性是否包含给定的几何。

Name	Type	描述
geometryName	string	使用的几何名称。
geometry	Geometry	几何.
srsName	string | undefined	空间参考系统名称：若未提供，则几何上不设置 srsName 属性。

返回：

<Contains> 运算符。

disjoint(geometryName, geometry, srsName){Disjoint}

format/filter.js, line 116

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

创建一个 <Disjoint> 运算符，用于检测几何值属性是否与给定几何不相交。

Name	Type	描述
geometryName	string	待使用的几何名称。
geometry	Geometry	几何.
srsName	string | undefined	SRS名称。若未提供，则几何图形上不会设置srsName属性。

返回：

<Disjoint> 运算符。

during(propertyName, begin, end){During}

format/filter.js, line 295

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

创建 <During> 时间操作符。

Name	Type	描述
propertyName	string	待比较的上下文属性名称。
begin	string	ISO-8601格式的起始日期。
end	string	ISO 8601格式的结束日期。

返回：

<During> 运算符。

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

format/filter.js, line 148

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

创建一个<DWithin>运算符，用于测试几何属性是否在给定几何的指定距离内。

Name	Type	描述
geometryName	string	使用的几何名称。
geometry	Geometry	几何.
distance	number	距离.
unit	string	单位。
srsName	string | undefined	空间参考系统名称：若未提供，则几何对象上不会设置 srsName 属性。

返回：

<DWithin> 运算符。

equalTo(propertyName, expression, matchCase){EqualTo}

format/filter.js, line 161

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

创建一个<PropertyIsEqualTo>比较运算符。

Name	Type	描述
propertyName	string	待比较的上下文属性名称。
expression	string | number	待比较的值。
matchCase	boolean | undefined	区分大小写？

返回：

<PropertyIsEqualTo> 运算符

greaterThan(propertyName, expression){GreaterThan}

format/filter.js, line 210

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

创建<PropertyIsGreaterThan>比较运算符。

Name	Type	描述
propertyName	string	待比较的上下文属性名称。
expression	number	待比较的值。

返回：

<PropertyIsGreaterThan> 运算符。

greaterThanOrEqualTo(propertyName, expression){GreaterThanOrEqualTo}

format/filter.js, line 222

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

创建一个 <PropertyIsGreaterThanOrEqualTo> 比较操作符。

Name	Type	描述
propertyName	string	待比较的上下文属性名称
expression	number	待比较的值。

返回：

<PropertyIsGreaterThanOrEqualTo> 运算符。

intersects(geometryName, geometry, srsName){Intersects}

format/filter.js, line 101

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

定义一个 <Intersects> 运算符，用于测试几何值属性是否与给定几何相交。

Name	Type	描述
geometryName	string	要使用的几何名称。
geometry	Geometry	几何.
srsName	string | undefined	若未提供SRS名称，则几何图形上不会设置srsName属性。

返回：

<Intersects> 运算符。

isNull(propertyName){IsNull}

format/filter.js, line 234

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

创建 <PropertyIsNull> 比较运算符以测试属性值是否为空值。

Name	Type	描述
propertyName	string	待比较的上下文属性名称。

返回：

<PropertyIsNull> 运算符。

lessThan(propertyName, expression){LessThan}

format/filter.js, line 186

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

创建<PropertyIsLessThan>比较运算符。

Name	Type	描述
propertyName	string	待比较的上下文属性名称。
expression	number	待比较的值。

返回：

<PropertyIsLessThan> 运算符。

lessThanOrEqualTo(propertyName, expression){LessThanOrEqualTo}

format/filter.js, line 198

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

创建 <PropertyIsLessThanOrEqualTo> 比较运算符。

Name	Type	描述
propertyName	string	待比较的上下文属性名称
expression	number	待比较值

返回：

<PropertyIsLessThanOrEqualTo> 运算符。

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

format/filter.js, line 268

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

表示一个<PropertyIsLike>比较运算符，用于匹配字符串属性值与文本模式。

Name	Type	描述
propertyName	string	待比较的上下文属性名。
pattern	string	文本图案。
wildCard	string | undefined	匹配零个或多个字符串字符序列的模式字符，默认值为“*”。
singleChar	string | undefined	匹配任意单个字符串字符的模式字符，默认值为“.”。
escapeChar	string | undefined	用于转义模式字符的转义字符。默认为“!”。
matchCase	boolean | undefined	是否区分大小写？

返回：

<PropertyIsLike> 运算符。

not(condition){Not}

format/filter.js, line 56

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

表示用于过滤条件的逻辑 <Not> 运算符。

Name	Type	描述
condition	Filter	过滤条件。

返回：

<Not> 运算符。

notEqualTo(propertyName, expression, matchCase){NotEqualTo}

format/filter.js, line 174

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

创建一个 <PropertyIsNotEqualTo> 比较运算符。

Name	Type	描述
propertyName	string	需比较的上下文属性名称。
expression	string | number	待比较的值
matchCase	boolean | undefined	区分大小写？

返回：

<PropertyIsNotEqualTo> 操作符。

or(conditions){Or}

format/filter.js, line 44

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

在两个或多个过滤条件之间创建逻辑 <Or> 运算符。

Name	Type	描述
conditions	Filter	过滤条件

返回：

<Or> 运算符。

within(geometryName, geometry, srsName){Within}

format/filter.js, line 131

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

创建一个 <Within> 运算符，用于验证几何属性是否在给定几何内部。

Name	Type	描述
geometryName	string	要使用的几何名称
geometry	Geometry	几何.
srsName	string | undefined	SRS名称。若未提供，则不会在几何对象上设置srsName属性。

返回：

<Within> 运算符。