Spec-Zone.ru › OpenLayers

ol/format/WFS~WFS


import WFS from 'ol/format/WFS.js';

Формат функций для чтения и записи данных в формате WFS. По умолчанию поддерживает версию WFS 1.1.0. Вы можете передать формат GML в качестве параметра, чтобы переопределить значение по умолчанию. Также см. GMLBase, который используется этим форматом.

новый WFS(options)

format/WFS.js, строка 271
Имя Тип Описание
featureNS Объект.<строка, строка> | строка | undefined

URI пространства имён, используемого для функций.

featureType Массив.<строка> | строка | undefined

Тип функции для парсинга. Используется только для операций чтения.

gmlFormat GMLBase | undefined

Формат GML, используемый для парсинга ответа. Значение по умолчанию — ol/format/GML2 для WFS 1.0.0, ol/format/GML3 для WFS 1.1.0 и ol/format/GML32 для WFS 2.0.0.

schemaLocation строка | undefined

Необязательный schemaLocation для сериализации, который переопределит значение по умолчанию.

version строка (по умолчанию '1.1.0')

Используемая версия WFS. Может быть либо 1.0.0, либо 1.1.0, либо 2.0.0.

Расширяет

  • XMLFeature

Методы

readFeature(source, options){Feature} inherited

format/XMLFeature.js, строка 45

Прочитать один объект.

Имя Тип Описание
source Document | Element | Object | string

Источник.

options

Параметры чтения.

Имя Тип Описание
dataProjection ProjectionLike | undefined

Проекция данных, которые мы читаем. Если не указано, проекция будет взята из данных (если возможно) или задана по умолчанию для формата (если задано). Если проекция не может быть определена из данных и для формата не задана проекция по умолчанию, объекты не будут перепроектированы.

extent Extent | undefined

Область разбиения в единицах карты для загружаемого тайла. Это необходимо только при чтении данных с тайловыми пикселями в качестве единиц геометрии. При настройке необходимо предоставить dataProjection с TILE_PIXELS в качестве units и область пикселей тайла как extent.

featureProjection ProjectionLike | undefined

Проекция геометрий объектов, созданных чтецом формата. Если не указана, объекты будут возвращены в dataProjection.

Возвращает:
Объект.

readFeatureCollectionMetadata(source){FeatureCollectionMetadata | undefined}

format/WFS.js, строка 400

Прочитать метаданные коллекции объектов из источника.

Имя Тип Описание
source Document | Element | Object | string

Источник.

Возвращает:
Метаданные коллекции объектов.

readFeatures(source, options){Array<Feature>} inherited

format/XMLFeature.js, строка 93

Прочитать все объекты из коллекции.

Имя Тип Описание
source Document | Element | Object | string

Источник.

options

Параметры.

Имя Тип Описание
dataProjection ProjectionLike | undefined

Проекция данных, которые мы читаем. Если не указано, проекция будет взята из данных (если возможно) или задана по умолчанию для формата (если задано). Если проекция не может быть определена из данных и для формата не задана проекция по умолчанию, объекты не будут перепроектированы.

extent Extent | undefined

Область разбиения в единицах карты для загружаемого тайла. Это необходимо только при чтении данных с тайловыми пикселями в качестве единиц геометрии. При настройке необходимо предоставить dataProjection с TILE_PIXELS в качестве units и область пикселей тайла как extent.

featureProjection ProjectionLike | undefined

Проекция геометрий объектов, созданных чтецом формата. Если не указана, объекты будут возвращены в dataProjection.

Возвращает:
Объекты.

readProjection(source){Projection} inherited

format/XMLFeature.js, строка 194

Прочитать проекцию из источника.

Имя Тип Описание
source Document | Element | Object | string

Источник.

Возвращает:
Проекцию.

readTransactionResponse(source){TransactionResponse | undefined}

format/WFS.js, строка 374

Прочитать ответ на транзакцию из источника.

Имя Тип Описание
source Document | Element | Object | string

Источник.

Возвращает:
Ответ на транзакцию.

writeFeatures(features, options){string} inherited

format/XMLFeature.js, строка 258

Кодирует массив объектов как строку.

Имя Тип Описание
features Array<Объект>

Объекты.

options

Параметры записи.

Имя Тип Описание
dataProjection Проекция | undefined

Проекция данных, которые мы записываем. Если не указано, используется проекция формата dataProjection (если задана). Если для формата не задана dataProjection, объекты будут возвращены в featureProjection.

featureProjection Проекция | undefined

Проекция геометрий объектов, которые будут сериализованы модулем записи формата. Если не указана, геометрии предполагаются в dataProjection (если она задана), то есть они не преобразуются.

rightHanded boolean | undefined

При записи геометрий следует правилу правой руки для ориентации линейных колец. Это означает, что многоугольники будут иметь внешние кольца против часовой стрелки и внутренние кольца по часовой стрелке. По умолчанию координаты сериализуются как есть. Если true, будет применено правило правой руки. Если false, будет применено правило левой руки (по часовой стрелке для внешних и против часовой стрелки для внутренних колец). Обратите внимание, что не все форматы поддерживают это. Формат GeoJSON использует это свойство при записи геометрий.

decimals число | undefined

Максимальное количество десятичных знаков для координат. Координаты хранятся во внутренней памяти как числа с плавающей запятой, но арифметика с плавающей запятой может создавать координаты с большим количеством десятичных знаков, что обычно нежелательно на выходе. Установите число здесь, чтобы округлить координаты. Его также можно использовать для обеспечения того, чтобы координаты, считанные, можно было записать обратно с тем же количеством десятичных знаков. По умолчанию округление не выполняется.

Возвращает:
Результат.

writeGetFeature(options){Узел}

format/WFS.js, строка 487

Кодирует формат как WFS GetFeature и возвращает узел.

Имя Тип Описание
featureNS строка

URI пространства имён, используемого для объектов.

featurePrefix строка

Префикс для пространства имён объектов.

featureTypes Массив.<(строка|модуль:ol/format/WFS~ТипОбъекта)>

Имена типов объектов или объекты FeatureType для определения уникального фильтра bbox для каждого имени типа объекта (в этом случае параметры bbox и geometryName игнорируются).

srsName строка | undefined

Имя СКСР. Атрибут srsName не будет задан для геометрий, когда это не указано.

handle строка | undefined

Обработчик.

outputFormat строка | undefined

Формат вывода.

maxFeatures число | undefined

Максимальное число объектов для извлечения.

geometryName строка | undefined

Имя геометрии для использования в фильтре BBOX.

propertyNames Массив.<строка> | undefined

Необязательный список имен свойств для сериализации.

viewParams строка | undefined

Параметр поставщика GeoServer viewParams.

startIndex число | undefined

Начальный индекс для использования в постраничной разметке WFS. Это функция WFS 2.0, переносимая в WFS 1.1.0 некоторыми веб-сервисами пространственных данных.

count число | undefined

Количество объектов для получения при постраничной разметке. Это функция WFS 2.0, переносимая в WFS 1.1.0 некоторыми веб-сервисами пространственных данных. Обратите внимание, что некоторые веб-сервисы пространственных данных переназначили maxfeatures вместо этого.

bbox Область | undefined

Область для использования в фильтре BBOX. Необходимо указать параметр geometryName.

filter Фильтр | undefined

Условие фильтра. Для получения дополнительной информации см. ol/format/filter.

resultType строка | undefined

Указывает, какой ответ должен быть возвращен, например, hits включает только атрибут numberOfFeatures в ответе и не включает объекты.

Возвращает:
Результат.

writeTransaction(inserts, updates, deletes, options){Узел}

format/WFS.js, строка 603

Кодирование в формате WFS Transaction и возврат узла.

Имя Тип Описание
inserts Array<Feature>

Вставляемые объекты.

updates Array<Feature>

Обновляемые объекты.

deletes Array<Feature>

Удаляемые объекты.

options

Параметры записи.

Имя Тип Описание
featureNS string

URI пространства имён, используемого для объектов.

featurePrefix string

Префикс для пространства имён объектов.

featureType string

Имя типа объекта.

srsName string | undefined

Имя СК. Атрибут srsName не будет устанавливаться для геометрий, если он не предоставлен.

handle string | undefined

Обработчик.

hasZ boolean | undefined

Должно быть установлено в значение true, если транзакция относится к слою 3D. Это позволит включить координату Z в транзакцию.

nativeElements Array.<Object>

Нативные элементы. В настоящее время не поддерживается.

gmlOptions Options | undefined

Параметры GML для записывателя транзакций WFS.

version string (defaults to '1.1.0')

Версия WFS, используемая для транзакции. Может быть либо 1.0.0, либо 1.1.0, либо 2.0.0.

Результат:
Result.

© 2005-present, OpenLayers Contributors All rights reserved.Licensed under the BSD 2-Clause License.
https://openlayers.org/en/latest/apidoc/module-ol_format_WFS-WFS.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API