Class: WFS

ol/format/WFS~WFS


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

用于读写 WFS 格式数据的要素格式。 默认支持 WFS 1.1.0 版本。可以通过选项传递 GML 格式来覆盖默认值。 另请参见此格式使用的 GMLBase

new WFS(options)

Name Type Description
featureNS 对象。<string, string> | string | undefined

用于要素的命名空间 URI。

featureType Array.<string> | string | undefined

要解析的要素类型。仅在读取操作中使用。

gmlFormat GMLBase | undefined

用于解析响应的 GML 格式。 默认情况下,WFS 1.0.0 使用 ol/format/GML2,WFS 1.1.0 使用 ol/format/GML3,WFS 2.0.0 使用 ol/format/GML32

schemaLocation string | undefined

用于序列化的可选 schemaLocation,这将覆盖默认值。

version string (defaults to '1.1.0')

要使用的 WFS 版本。可以是 1.0.01.1.02.0.0

Extends

Methods

read要素(source, options){要素} inherited

读取单个要素。

Name Type Description
source Document | Element | Object | string

数据源。

options

读取选项。

Name Type Description
dataProjection ProjectionLike | undefined

正在读取的数据的投影。 如果未提供,投影将从数据中派生(如可能),或 分配格式的 dataProjection(如已设置)。如果无法从数据中派生投影且格式未设置 dataProjection, 要素将不会进行重投影。

extent Extent | undefined

正在读取的瓦片的地图单位范围的瓦片范围。 仅在读取以瓦片像素为几何单位的数据时需要。配置后, 需要提供以 TILE_PIXELSunitsdataProjection 以及瓦片的像素范围作为 extent

featureProjection ProjectionLike | undefined

格式读取器创建的要素几何图形的投影。 如果未提供,要素将在 dataProjection 中返回。

返回值:
要素。

read要素CollectionMetadata(source){要素CollectionMetadata | undefined}

读取数据源的要素集合元数据。

Name Type Description
source Document | Element | Object | string

数据源。

返回值:
要素集合元数据。

read要素s(source, options){Array<要素>} inherited

从要素集合中读取所有要素。

Name Type Description
source Document | Element | Object | string

数据源。

options

选项。

Name Type Description
dataProjection ProjectionLike | undefined

正在读取的数据的投影。 如果未提供,投影将从数据中派生(如可能),或 分配格式的 dataProjection(如已设置)。如果无法从数据中派生投影且格式未设置 dataProjection, 要素将不会进行重投影。

extent Extent | undefined

正在读取的瓦片的地图单位范围的瓦片范围。 仅在读取以瓦片像素为几何单位的数据时需要。配置后, 需要提供以 TILE_PIXELSunitsdataProjection 以及瓦片的像素范围作为 extent

featureProjection ProjectionLike | undefined

格式读取器创建的要素几何图形的投影。 如果未提供,要素将在 dataProjection 中返回。

返回值:
要素集合。

从数据源中读取投影。

Name Type Description
source Document | Element | Object | string

数据源。

返回值:
投影。

readTransactionResponse(source){TransactionResponse | undefined}

读取数据源的事务响应。

Name Type Description
source Document | Element | Object | string

数据源。

返回值:
Transaction response.

write要素s(features, options){string} inherited

将要素数组编码为字符串。

Name Type Description
features Array<要素>

要素集合。

options

写入选项。

Name Type Description
dataProjection ProjectionLike | undefined

正在写入的数据的投影。 如果未提供,将分配格式的 dataProjection(如已设置)。 如果格式未设置 dataProjection,要素将在 featureProjection 中返回。

featureProjection ProjectionLike | undefined

格式写入器将序列化的要素几何图形的投影。 如果未提供,如果已设置 dataProjection,则假定几何图形在该投影中;换句话说,它们不会进行变换。

rightHanded boolean | undefined

写入几何图形时,遵循线性环方向的右手 规则。这意味着多边形将具有逆时针 外环和顺时针内环。默认情况下,坐标按构造时 提供的方式序列化。如果为 true,将应用右手规则。 如果为 false,将应用左手规则(外环顺时针, 内环逆时针)。请注意,并非所有格式都支持此属性。 GeoJSON 格式在写入几何图形时确实使用此属性。

decimals number | undefined

坐标的最大小数位数。 坐标在内部存储为浮点数,但浮点运算可能会产生 大量小数位的坐标,通常在输出中不需要。 在此设置数字以舍入坐标。也可用于确保读入的坐标 可以以相同的小数位数写回。 默认不进行舍入。

返回值:
结果。

writeGet要素(options){Node}

将格式编码为 WFS Get要素 并返回 Node。

Name Type Description
featureNS string

要素使用的命名空间 URI。

featurePrefix string

要素命名空间的前缀。

featureTypes Array.<(string|module:ol/format/WFS~要素Type)>

要素类型名称或 要素Type 对象,用于为每个要素类型名称定义唯一的 bbox 过滤器(在这种情况下,bboxgeometryName 选项将被忽略)。

srsName string | undefined

SRS 名称。未提供时,几何图形上将不会设置 srsName 属性。

handle string | undefined

句柄。

outputFormat string | undefined

输出格式。

max要素s number | undefined

要获取的最大要素数。

geometryName string | undefined

在 BBOX 过滤器中使用的几何图形名称。

propertyNames Array.<string> | undefined

要序列化的属性名称的可选列表。

viewParams string | undefined

viewParams GeoServer 供应商参数。

startIndex number | undefined

用于 WFS 分页的起始索引。这是 WFS 2.0 的功能,被某些 Web 要素服务回移植到 WFS 1.1.0。

count number | undefined

分页时要检索的要素数。这是 WFS 2.0 的功能,被某些 Web 要素服务回移植到 WFS 1.1.0。请注意,某些 Web 要素服务已改为使用 maxfeatures

bbox Extent | undefined

用于 BBOX 过滤器的范围。必须设置 geometryName 选项。

filter Filter | undefined

过滤条件。请参阅 ol/format/filter 了解更多信息。

resultType string | undefined

指示应返回什么响应, 例如 hits 仅在响应中包含 numberOf要素s 属性而不包含要素。

返回值:
结果。

writeTransaction(inserts, updates, deletes, options){Node}

将格式编码为 WFS Transaction 并返回 Node。

Name Type Description
inserts Array<要素>

要插入的要素。

updates Array<要素>

要更新的要素。

deletes Array<要素>

要删除的要素。

options

写入选项。

Name Type Description
featureNS string

用于要素的命名空间 URI。

featurePrefix string

要素命名空间的前缀。

featureType string

要素类型名称。

srsName string | undefined

SRS 名称。未提供时,几何图形上将不会设置 srsName 属性。

handle string | undefined

句柄。

hasZ boolean | undefined

如果事务用于 3D 图层,则必须设置为 true。这将允许在事务中包含 Z 坐标。

nativeElements Array.<Object>

原生元素。目前不支持。

gmlOptions Options | undefined

WFS 事务写入器的 GML 选项。

version string (defaults to '1.1.0')

事务使用的 WFS 版本。可以是 1.0.01.1.02.0.0

返回值:
结果。