Module: ol/format/filter

函数s

and(conditions){And}

format/filter.js, line 32

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

创建两个或多个筛选条件之间的逻辑 <And> 运算符。

Name	Type	Description
conditions	Filter	筛选条件。

返回值：

<And> operator.

bbox(geometryName, extent, srsName){Bbox}

format/filter.js, line 71

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

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

Name	Type	Description
geometryName	string	要使用的几何图形名称。
extent	Extent	范围。
srsName	string | undefined	SRS 名称。未提供时不会在几何图形上设置 srsName 属性。

返回值：

<BBOX> operator.

between(propertyName, lowerBoundary, upperBoundary){IsBetween}

format/filter.js, line 248

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

创建 <PropertyIsBetween> 比较运算符，用于测试表达式值是否在由下界和上界（含）给定的范围内。

Name	Type	Description
propertyName	string	要比较的上下文属性名称。
lowerBoundary	number	范围的下界。
upperBoundary	number	范围的上界。

返回值：

<PropertyIsBetween> operator.

contains(geometryName, geometry, srsName){Contains}

format/filter.js, line 86

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

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

Name	Type	Description
geometryName	string	要使用的几何图形名称。
geometry	Geometry	几何图形。
srsName	string | undefined	SRS 名称。未提供时不会在几何图形上设置 srsName 属性。

返回值：

<Contains> operator.

disjoint(geometryName, geometry, srsName){Disjoint}

format/filter.js, line 116

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

创建 <Disjoint> 运算符，用于测试几何图形值属性是否与给定几何图形相离。

Name	Type	Description
geometryName	string	要使用的几何图形名称。
geometry	Geometry	几何图形。
srsName	string | undefined	SRS 名称。未提供时不会在几何图形上设置 srsName 属性。

返回值：

<Disjoint> operator.

during(propertyName, begin, end){During}

format/filter.js, line 295

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

创建 <During> 时间运算符。

Name	Type	Description
propertyName	string	要比较的上下文属性名称。
begin	string	ISO-8601 格式的开始日期。
end	string	ISO-8601 格式的结束日期。

返回值：

<During> operator.

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

format/filter.js, line 148

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

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

Name	Type	Description
geometryName	string	要使用的几何图形名称。
geometry	Geometry	几何图形。
distance	number	距离。
unit	string	单位。
srsName	string | undefined	SRS 名称。未提供时不会在几何图形上设置 srsName 属性。

返回值：

<DWithin> operator.

equalTo(propertyName, expression, matchCase){EqualTo}

format/filter.js, line 161

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

创建 <PropertyIsEqualTo> 比较运算符。

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

返回值：

<PropertyIsEqualTo> operator.

greaterThan(propertyName, expression){GreaterThan}

format/filter.js, line 210

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

创建 <PropertyIsGreaterThan> 比较运算符。

Name	Type	Description
propertyName	string	要比较的上下文属性名称。
expression	number	要比较的值。

返回值：

<PropertyIsGreaterThan> operator.

greaterThanOrEqualTo(propertyName, expression){GreaterThanOrEqualTo}

format/filter.js, line 222

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

创建 <PropertyIsGreaterThanOrEqualTo> 比较运算符。

Name	Type	Description
propertyName	string	要比较的上下文属性名称。
expression	number	要比较的值。

返回值：

<PropertyIsGreaterThanOrEqualTo> operator.

intersects(geometryName, geometry, srsName){Intersects}

format/filter.js, line 101

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

创建 <Intersects> 运算符，用于测试几何图形值属性是否与给定几何图形相交。

Name	Type	Description
geometryName	string	要使用的几何图形名称。
geometry	Geometry	几何图形。
srsName	string | undefined	SRS 名称。未提供时不会在几何图形上设置 srsName 属性。

返回值：

<Intersects> operator.

isNull(propertyName){IsNull}

format/filter.js, line 234

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

创建 <PropertyIsNull> 比较运算符，用于测试属性值是否为 null。

Name	Type	Description
propertyName	string	要比较的上下文属性名称。

返回值：

<PropertyIsNull> operator.

lessThan(propertyName, expression){LessThan}

format/filter.js, line 186

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

创建 <PropertyIsLessThan> 比较运算符。

Name	Type	Description
propertyName	string	要比较的上下文属性名称。
expression	number	要比较的值。

返回值：

<PropertyIsLessThan> operator.

lessThanOrEqualTo(propertyName, expression){LessThanOrEqualTo}

format/filter.js, line 198

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

创建 <PropertyIsLessThanOrEqualTo> 比较运算符。

Name	Type	Description
propertyName	string	要比较的上下文属性名称。
expression	number	要比较的值。

返回值：

<PropertyIsLessThanOrEqualTo> operator.

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

format/filter.js, line 268

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

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

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

返回值：

<PropertyIsLike> operator.

not(condition){Not}

format/filter.js, line 56

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

表示筛选条件的逻辑 <Not> 运算符。

Name	Type	Description
condition	Filter	筛选条件。

返回值：

<Not> operator.

notEqualTo(propertyName, expression, matchCase){NotEqualTo}

format/filter.js, line 174

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

创建 <PropertyIsNotEqualTo> 比较运算符。

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

返回值：

<PropertyIsNotEqualTo> operator.

or(conditions){Or}

format/filter.js, line 44

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

创建两个或多个筛选条件之间的逻辑 <Or> 运算符。

Name	Type	Description
conditions	Filter	筛选条件。

返回值：

<Or> operator.

within(geometryName, geometry, srsName){Within}

format/filter.js, line 131

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

创建 <Within> 运算符，用于测试几何图形值属性是否在给定几何图形之内。

Name	Type	Description
geometryName	string	要使用的几何图形名称。
geometry	Geometry	几何图形。
srsName	string | undefined	SRS 名称。未提供时不会在几何图形上设置 srsName 属性。

返回值：

<Within> operator.