ol/format/filter

Функции

and(conditions){И}

format/filter.js, строка 32

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

Создать логический <And> оператор между двумя или более условиями фильтра.

Имя	Тип	Описание
conditions	Фильтр	Условия фильтра.

Возвращает:

<And> оператор.

bbox(geometryName, extent, srsName){Bbox}

format/filter.js, строка 71

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

Создать <BBOX> оператор для проверки, пересекается ли геометрическое свойство с фиксированной ограничивающей рамкой

Имя	Тип	Описание
geometryName	строка	Имя геометрии для использования.
extent	Extent	Ограничивающая рамка.
srsName	строка | undefined	Имя СК. Атрибут srsName не будет задан для геометрий, если он не предоставлен.

Возвращает:

<BBOX> оператор.

between(propertyName, lowerBoundary, upperBoundary){IsBetween}

format/filter.js, строка 248

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

Создает <PropertyIsBetween> оператор сравнения для проверки, лежит ли значение выражения в диапазоне, заданном нижней и верхней границами (включительно).

Имя	Тип	Описание
propertyName	строка	Имя свойства контекста для сравнения.
lowerBoundary	число	Нижняя граница диапазона.
upperBoundary	число	Верхняя граница диапазона.

Возвращает:

<PropertyIsBetween> оператор.

contains(geometryName, geometry, srsName){Contains}

format/filter.js, строка 86

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

Создать <Contains> оператор для проверки, содержит ли геометрическое свойство заданную геометрию.

Имя	Тип	Описание
geometryName	строка	Имя геометрии для использования.
geometry	Geometry	Геометрия.
srsName	строка | undefined	Имя СК. Атрибут srsName не будет задан для геометрий, если он не предоставлен.

Возвращает:

<Contains> оператор.

disjoint(geometryName, geometry, srsName){Disjoint}

format/filter.js, строка 116

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

Создать <Disjoint> оператор для проверки, является ли геометрическое свойство непересекающимся с заданной геометрией.

Имя	Тип	Описание
geometryName	строка	Имя геометрии для использования.
geometry	Geometry	Геометрия.
srsName	строка | undefined	Имя СК. Атрибут srsName не будет задан для геометрий, если он не предоставлен.

Возвращает:

<Disjoint> оператор.

during(propertyName, begin, end){During}

format/filter.js, строка 295

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

Создать <During> временной оператор.

Имя	Тип	Описание
propertyName	строка	Имя свойства контекста для сравнения.
begin	строка	Дата начала в формате ISO-8601.
end	строка	Дата окончания в формате ISO-8601.

Возвращает:

<During> оператор.

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

format/filter.js, строка 148

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

Создать <DWithin> оператор для проверки, находится ли геометрическое свойство в заданном расстоянии от заданной геометрии.

Имя	Тип	Описание
geometryName	строка	Имя геометрии для использования.
geometry	Geometry	Геометрия.
distance	число	Расстояние.
unit	строка	Единица измерения.
srsName	строка | undefined	Имя СК. Атрибут srsName не будет задан для геометрий, если он не предоставлен.

Возвращает:

<DWithin> оператор.

equalTo(propertyName, expression, matchCase){EqualTo}

format/filter.js, строка 161

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

Создаёт оператор сравнения <PropertyIsEqualTo>.

Имя	Тип	Описание
propertyName	строка	Имя свойства контекста для сравнения.
expression	строка | число	Значение для сравнения.
matchCase	логическое | undefined	Учитывать регистр?

Результат:

<PropertyIsEqualTo> оператор.

greaterThan(propertyName, expression){GreaterThan}

format/filter.js, строка 210

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

Создаёт оператор сравнения <PropertyIsGreaterThan>.

Имя	Тип	Описание
propertyName	строка	Имя свойства контекста для сравнения.
expression	число	Значение для сравнения.

Результат:

<PropertyIsGreaterThan> оператор.

greaterThanOrEqualTo(propertyName, expression){GreaterThanOrEqualTo}

format/filter.js, строка 222

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

Создаёт оператор сравнения <PropertyIsGreaterThanOrEqualTo>.

Имя	Тип	Описание
propertyName	строка	Имя свойства контекста для сравнения.
expression	число	Значение для сравнения.

Результат:

<PropertyIsGreaterThanOrEqualTo> оператор.

intersects(geometryName, geometry, srsName){Intersects}

format/filter.js, строка 101

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

Создаёт оператор <Intersects>, чтобы проверить, пересекается ли геометрическое свойство с заданной геометрией.

Имя	Тип	Описание
geometryName	строка	Имя геометрии для использования.
geometry	Geometry	Геометрия.
srsName	строка | undefined	Имя СК. Атрибут srsName не будет задан для геометрий, если он не предоставлен.

Результат:

<Intersects> оператор.

isNull(propertyName){IsNull}

format/filter.js, строка 234

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

Создаёт оператор сравнения <PropertyIsNull>, чтобы проверить, имеет ли значение свойства значение null.

Имя	Тип	Описание
propertyName	строка	Имя свойства контекста для сравнения.

Результат:

<PropertyIsNull> оператор.

lessThan(propertyName, expression){LessThan}

format/filter.js, строка 186

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

Создаёт оператор сравнения <PropertyIsLessThan>.

Имя	Тип	Описание
propertyName	строка	Имя свойства контекста для сравнения.
expression	число	Значение для сравнения.

Результат:

<PropertyIsLessThan> оператор.

lessThanOrEqualTo(propertyName, expression){LessThanOrEqualTo}

format/filter.js, строка 198

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

Создаёт оператор сравнения <PropertyIsLessThanOrEqualTo>.

Имя	Тип	Описание
propertyName	строка	Имя свойства контекста для сравнения.
expression	число	Значение для сравнения.

Результат:

<PropertyIsLessThanOrEqualTo> оператор.

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

format/filter.js, строка 268

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

Представляет оператор сравнения <PropertyIsLike>, который сопоставляет строковое значение свойства с текстовым шаблоном.

Имя	Тип	Описание
propertyName	строка	Имя свойства контекста для сравнения.
pattern	строка	Текстовый шаблон.
wildCard	строка | undefined	Символ шаблона, который соответствует любой последовательности нуля или более символов строки. По умолчанию — «*».
singleChar	строка | undefined	Символ шаблона, который соответствует любому одиночному символу строки. По умолчанию — «.».
escapeChar	строка | undefined	Символ экранирования, который можно использовать для экранирования символов шаблона. По умолчанию — «!».
matchCase	логическое | undefined	Учитывать регистр?

Результат:

<PropertyIsLike> оператор.

not(condition){Not}

format/filter.js, строка 56

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

Представляет логический <Not> оператор для условия фильтрации.

Имя	Тип	Описание
condition	Фильтр	Условие фильтрации.

Возвращает:

<Not> оператор.

notEqualTo(propertyName, expression, matchCase){NotEqualTo}

format/filter.js, строка 174

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

Создаёт оператор <PropertyIsNotEqualTo> сравнения.

Имя	Тип	Описание
propertyName	строка	Имя свойства контекста для сравнения.
expression	строка | число	Значение для сравнения.
matchCase	логическое | undefined	С учётом регистра?

Возвращает:

<PropertyIsNotEqualTo> оператор.

or(conditions){Or}

format/filter.js, строка 44

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

Создаёт логический <Or> оператор между двумя или более условиями фильтрации.

Имя	Тип	Описание
conditions	Фильтр	Условия фильтрации.

Возвращает:

<Or> оператор.

within(geometryName, geometry, srsName){Within}

format/filter.js, строка 131

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

Создаёт оператор <Within> проверки, находится ли геометрия-значимое свойство внутри заданной геометрии.

Имя	Тип	Описание
geometryName	строка	Имя используемой геометрии.
geometry	Геометрия	Геометрия.
srsName	строка | undefined	Имя системы координат. Атрибут srsName не будет задан для геометрий, когда это не предоставлено.

Возвращает:

<Within> оператор.