ol/format/WFS~WFS
import WFS from 'ol/format/WFS.js';
Формат функций для чтения и записи данных в формате WFS. По умолчанию поддерживает версию WFS 1.1.0. Вы можете передать формат GML в качестве параметра, чтобы переопределить значение по умолчанию. Также см. GMLBase, который используется этим форматом.
-
новый WFS(options)
-
Имя Тип Описание featureNSОбъект.<строка, строка> | строка | undefined URI пространства имён, используемого для функций.
featureTypeМассив.<строка> | строка | undefined Тип функции для парсинга. Используется только для операций чтения.
gmlFormatGMLBase | 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.
Расширяет
Методы
-
Прочитать один объект.
Имя Тип Описание sourceDocument | Element | Object | string Источник.
optionsПараметры чтения.
Имя Тип Описание dataProjectionProjectionLike | undefined Проекция данных, которые мы читаем. Если не указано, проекция будет взята из данных (если возможно) или задана по умолчанию для формата (если задано). Если проекция не может быть определена из данных и для формата не задана проекция по умолчанию, объекты не будут перепроектированы.
extentExtent | undefined Область разбиения в единицах карты для загружаемого тайла. Это необходимо только при чтении данных с тайловыми пикселями в качестве единиц геометрии. При настройке необходимо предоставить
dataProjectionсTILE_PIXELSв качествеunitsи область пикселей тайла какextent.featureProjectionProjectionLike | undefined Проекция геометрий объектов, созданных чтецом формата. Если не указана, объекты будут возвращены в
dataProjection.Возвращает:
Объект.
-
readFeatureCollectionMetadata(source){FeatureCollectionMetadata | undefined}
-
Прочитать метаданные коллекции объектов из источника.
Имя Тип Описание sourceDocument | Element | Object | string Источник.
Возвращает:
Метаданные коллекции объектов.
-
Прочитать все объекты из коллекции.
Имя Тип Описание sourceDocument | Element | Object | string Источник.
optionsПараметры.
Имя Тип Описание dataProjectionProjectionLike | undefined Проекция данных, которые мы читаем. Если не указано, проекция будет взята из данных (если возможно) или задана по умолчанию для формата (если задано). Если проекция не может быть определена из данных и для формата не задана проекция по умолчанию, объекты не будут перепроектированы.
extentExtent | undefined Область разбиения в единицах карты для загружаемого тайла. Это необходимо только при чтении данных с тайловыми пикселями в качестве единиц геометрии. При настройке необходимо предоставить
dataProjectionсTILE_PIXELSв качествеunitsи область пикселей тайла какextent.featureProjectionProjectionLike | undefined Проекция геометрий объектов, созданных чтецом формата. Если не указана, объекты будут возвращены в
dataProjection.Возвращает:
Объекты.
-
readProjection(source){Projection} inherited
-
Прочитать проекцию из источника.
Имя Тип Описание sourceDocument | Element | Object | string Источник.
Возвращает:
Проекцию.
-
readTransactionResponse(source){TransactionResponse | undefined}
-
Прочитать ответ на транзакцию из источника.
Имя Тип Описание sourceDocument | Element | Object | string Источник.
Возвращает:
Ответ на транзакцию.
-
writeFeatures(features, options){string} inherited
-
Кодирует массив объектов как строку.
Имя Тип Описание featuresArray<Объект> Объекты.
optionsПараметры записи.
Имя Тип Описание dataProjectionПроекция | undefined Проекция данных, которые мы записываем. Если не указано, используется проекция формата
dataProjection(если задана). Если для формата не заданаdataProjection, объекты будут возвращены вfeatureProjection.featureProjectionПроекция | undefined Проекция геометрий объектов, которые будут сериализованы модулем записи формата. Если не указана, геометрии предполагаются в
dataProjection(если она задана), то есть они не преобразуются.rightHandedboolean | undefined При записи геометрий следует правилу правой руки для ориентации линейных колец. Это означает, что многоугольники будут иметь внешние кольца против часовой стрелки и внутренние кольца по часовой стрелке. По умолчанию координаты сериализуются как есть. Если
true, будет применено правило правой руки. Еслиfalse, будет применено правило левой руки (по часовой стрелке для внешних и против часовой стрелки для внутренних колец). Обратите внимание, что не все форматы поддерживают это. Формат GeoJSON использует это свойство при записи геометрий.decimalsчисло | undefined Максимальное количество десятичных знаков для координат. Координаты хранятся во внутренней памяти как числа с плавающей запятой, но арифметика с плавающей запятой может создавать координаты с большим количеством десятичных знаков, что обычно нежелательно на выходе. Установите число здесь, чтобы округлить координаты. Его также можно использовать для обеспечения того, чтобы координаты, считанные, можно было записать обратно с тем же количеством десятичных знаков. По умолчанию округление не выполняется.
Возвращает:
Результат.
-
writeGetFeature(options){Узел}
-
Кодирует формат как 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){Узел}
-
Кодирование в формате WFS
Transactionи возврат узла.Имя Тип Описание insertsArray<Feature> Вставляемые объекты.
updatesArray<Feature> Обновляемые объекты.
deletesArray<Feature> Удаляемые объекты.
optionsПараметры записи.
Имя Тип Описание featureNSstring URI пространства имён, используемого для объектов.
featurePrefixstring Префикс для пространства имён объектов.
featureTypestring Имя типа объекта.
srsNamestring | undefined Имя СК. Атрибут srsName не будет устанавливаться для геометрий, если он не предоставлен.
handlestring | undefined Обработчик.
hasZboolean | undefined Должно быть установлено в значение true, если транзакция относится к слою 3D. Это позволит включить координату Z в транзакцию.
nativeElementsArray.<Object> Нативные элементы. В настоящее время не поддерживается.
gmlOptionsOptions | undefined Параметры GML для записывателя транзакций WFS.
versionstring (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