类:WFS

ol/format/WFS~网络要素服务


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

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

new WFS(options)

Name Type 描述
featureNS Object.<string, string> | string | undefined

用于要素的命名空间 URI。

featureType Array.<string> | string | 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 string | undefined

序列化时可选的 schemaLocation 将覆盖默认值。

version string (defaults to '1.1.0')

需使用的 WFS 版本。可以是两者之一。1.0.0, 1.1.02.0.0.

继承

方法

readFeature(source, options){Feature} inherited

读取单个要素。

Name Type 描述
source Document | Element | Object | string

数据源.

options

Read options.

Name Type 描述
dataProjection ProjectionLike | undefined

所读取数据的投影。若未指定,将尝试从数据中推导(若可行),或dataProjection格式的指定(如果已设置)。如果无法从数据中推导投影,并且如果没有dataProjection指定格式后,要素将不会进行重投影。

extent Extent | undefined

当前读取图块的地图单位范围。仅当读取以平铺像素作为几何单位的数据时才需要此设置。配置后,将显示一个。dataProjection使用TILE_PIXELS作为units以及图块的像素范围为extent需要提供。

featureProjection ProjectionLike | undefined

由格式阅读器创建的要素几何图形的投影。如果未提供,要素将在该投影下返回。dataProjection.

返回:
要素.

readFeatureCollectionMetadata(source){FeatureCollectionMetadata | undefined}

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

Name Type 描述
source Document | Element | Object | string

数据源.

返回:
要素集合元数据。

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

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

Name Type 描述
source Document | Element | Object | string

数据源.

options

Options.

Name Type 描述
dataProjection ProjectionLike | undefined

所读取数据的投影。若未提供,投影将从数据中推导(如可行)或dataProjection格式被指定(如果已设置)。如果无法从数据中推导出投影,并且如果没有dataProjection若格式已设置,则要素将不会被重投影。

extent Extent | undefined

当前读取瓦片的地图单位范围。仅当读取以瓦片像素为几何单位的数据时才需要。配置后,一个dataProjectionTILE_PIXELS作为units以及瓦片的像素范围作为extent需提供。

featureProjection ProjectionLike | undefined

由格式读取器创建的要素几何图形的投影。若未指定,返回的要素将采用此投影。dataProjection.

返回:
要素。

从源读取投影。

Name Type 描述
source Document | Element | Object | string

数据源.

返回:
投影.

readTransactionResponse(source){TransactionResponse | undefined}

读取源的事务响应。

Name Type 描述
source Document | Element | Object | string

数据源.

返回:
事务响应。

writeFeatures(features, options){string} inherited

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

Name Type 描述
features Array<Feature>

要素。

options

Write options.

Name Type 描述
dataProjection ProjectionLike | undefined

所写入数据的投影。如未提供,则dataProjection格式的指定(如果已设置)。如果没有dataProjection格式设置后,要素将以该格式返回。featureProjection.

featureProjection ProjectionLike | undefined

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

rightHanded boolean | undefined

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

decimals number | undefined

坐标的最大小数位数设置。坐标在内部以浮点数形式存储,但浮点运算可能产生大量小数位的坐标,这在输出时通常不必要。在此指定一个数值以对坐标进行舍入。此外,该设置还可确保读入的坐标在输出时能保持相同的小数位数。默认情况下不进行舍入。

返回:
结果。

writeGetFeature(options){Node}

将格式编码为 WFS GetFeature 并返回节点。

Name Type 描述
featureNS string

用于要素的命名空间URI。

featurePrefix string

要素命名空间的前缀。

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

要素类型名称或 FeatureType 对象,用于为每个要素类型名称定义唯一的边界框过滤器(在本例中,选项)bboxgeometryName被忽略。

srsName string | undefined

SRS名称:若未提供,则几何图形的srsName属性不会被设置。

handle string | undefined

处理。

outputFormat string | undefined

输出格式。

maxFeatures 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

分页时检索的要素数量。这是某些Web要素服务将WFS 2.0要素向后移植至WFS 1.1.0的版本。请注意,部分Web要素服务已重新定义该要素的用途。maxfeatures反而。

bbox Extent | undefined

边界框过滤器所使用的范围。geometryName必须设置选项。

filter Filter | undefined

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

resultType string | undefined

指定应返回的响应,例如hits仅包含numberOfFeatures响应中包含属性,但无要素。

返回:
结果。

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

将格式编码为 WFS Transaction,并返回节点。

Name Type 描述
inserts Array<Feature>

待插入的要素。

updates Array<Feature>

待更新的要素。

deletes Array<Feature>

要删除的要素。

options

Write options.

Name Type 描述
featureNS string

用于要素的命名空间 URI。

featurePrefix string

要素命名空间的前缀。

featureType string

要素类型名称。

srsName string | undefined

空间参考系统名称。若未提供,则不会在几何体上设置 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.0, 1.1.02.0.0.

返回:
结果。