类:GML3

ol/format/GML3~地理标记语言3.0


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

用于读写GML 3.1.1格式数据的要素格式。目前仅支持GML 3.1.1简单要素配置文件。

new GML3(options)

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

要素命名空间。若未定义,将从 GML 派生。如果配置了多个来自不同要素命名空间的要素类型,则它表示一个对象,其键为 featureType 数组中各条目使用的前缀,而对象的值即为对应的要素命名空间本身。例如,可能存在一个 featureType 条目。topp:statesfeatureType随后将存在一个键topp在带有值的 featureNS 对象中http://www.openplans.org/topp.

featureType Array.<string> | string | undefined

要素类型(用于解析)。若需配置多个源自不同要素命名空间的要素类型,featureNS将是一个对象,其键为 featureType 数组条目中使用的前缀,值即为要素命名空间本身。例如,可能存在一个 featureType 项。topp:states随后将有一个键被命名为topp在包含值的 featureNS 对象中http://www.openplans.org/topp.

srsName string | undefined

用于写入几何图形的空间参考系统名称。

surface boolean (defaults to false)

应使用 gml:表面 元素而非 gml:多边形 元素,这同样适用于多部分几何中的元素。

curve boolean (defaults to false)

应使用 gml:Curve 而非 gml:LineString 元素。这也影响多部分几何中的元素。

multiCurve boolean (defaults to true)

建议使用 gml:MultiCurve 而非 gml:MultiLineString,因为后者在 GML 3 中已弃用。

multiSurface boolean (defaults to true)

应使用 gml:multiSurface 替代 gml:多重多边形,因为后者在 GML 3 中已弃用。

schemaLocation string | undefined

在生成 GML 时,可指定可选的 schemaLocation 以覆盖默认提供的值。

hasZ boolean (defaults to false)

如果坐标包含Z值。

子类

继承

方法

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.

返回:
要素.

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

当前读取图块的地图单位范围。仅当读取以瓦片像素作为几何单位的数据时才需要此设置。配置后,会出现一个dataProjection具有TILE_PIXELS作为units和瓦片的像素范围为extent需提供。

featureProjection ProjectionLike | undefined

由格式解析器创建的要素几何图形的投影。若未提供,要素将返回在dataProjection.

返回:
要素。

从源读取投影。

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

数据源.

返回:
投影.

writeFeatures(features, options){string}

将要素数组编码为GML 3.1.1简单要素。

Name Type 描述
features Array<Feature>

要素。

options

Options.

Name Type 描述
dataProjection ProjectionLike | undefined

待写入数据的投影。如未提供,则dataProjection若已指定格式,则使用该格式;否则dataProjection若格式已设定,要素将按该格式返回。featureProjection.

featureProjection ProjectionLike | undefined

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

rightHanded boolean | undefined

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

decimals number | undefined

坐标的最大小数位数。坐标在内部以浮点数形式存储,但浮点运算可能产生多位小数的坐标,这在输出中通常不必要。设置该值以对坐标进行舍入。同时可确保读取的坐标能以相同的小数位数回写。默认情况下不进行舍入。

返回:
结果。

writeFeaturesNode(features, options){Element}

将要素数组按 GML 3.1.1 格式编码为 XML 节点。

Name Type 描述
features Array<Feature>

要素。

options

Options.

Name Type 描述
dataProjection ProjectionLike | undefined

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

featureProjection ProjectionLike | undefined

将被格式写入器序列化的要素几何的投影。如果未提供,则假定几何图形位于dataProjection若已启用;换言之,它们将保持不变。

rightHanded boolean | undefined

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

decimals number | undefined

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

返回:
节点。

writeGeometryNode(geometry, options){Node}

在 GML 3.1.1 简单要素中对几何体进行编码。

Name Type 描述
geometry Geometry

几何.

options

Options.

Name Type 描述
dataProjection ProjectionLike | undefined

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

featureProjection ProjectionLike | undefined

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

rightHanded boolean | undefined

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

decimals number | undefined

设置坐标的最大小数位数。坐标在内部以浮点数形式存储,但浮点运算可能生成大量小数位的坐标,输出时通常不需要。在此输入数值以舍入坐标,同时可确保读入的坐标能以相同的小数位数写回。默认情况下不进行舍入。

返回:
节点。