Class: GML32

ol/format/GML32~GML32


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

用于读写 GML 格式 3.2.1 版本数据的要素格式。

new GML32(options)

Name Type Description
featureNS 对象。<string, string> | string | undefined 要素命名空间。如果未定义,将从 GML 派生。如果配置了来自不同要素命名空间的多个要素类型,这将是一个对象,其键为 featureType 数组条目中使用的前缀。对象的值将是要素命名空间本身。例如,featureType 数组中可能有一个 topp:states 条目,然后 featureNS 对象中将有一个键 topp,其值为 http://www.openplans.org/topp。
featureType Array.<string> | string | undefined 要解析的要素类型。如果需要配置来自不同要素命名空间的多个要素类型,featureNS 将是一个对象,其键为 featureType 数组条目中使用的前缀。对象的值将是要素命名空间本身。例如,featureType 中可能有一个 topp:states 条目,然后 featureNS 对象中将有一个名为 topp 的键,其值为 http://www.openplans.org/topp。
srsName string | undefined

写入几何图形时使用的 srsName。

surface boolean (defaults to false)

写入 gml:Surface 而非 gml:Polygon 元素。这也会影响多部分几何图形中的元素。

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:MultiPolygon。因为后者在 GML 3 中已被弃用。

schemaLocation string | undefined

写出 GML 时使用的可选 schemaLocation,这将覆盖提供的默认值。

hasZ boolean (defaults to false)

坐标是否包含 Z 值。

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要素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

源。

返回值:
投影。

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

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

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

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

返回值:
结果。

write要素sNode(features, options){Element} inherited

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

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

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

返回值:
节点。

writeGeometryNode(geometry, options){Node} inherited

将几何图形编码为 GML 3.1.1 简单要素格式。

Name Type Description
geometry Geometry

几何对象。

options

选项。

Name Type Description
dataProjection ProjectionLike | undefined

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

featureProjection ProjectionLike | undefined

将由格式写入器序列化的要素几何对象的投影。 如果未提供,假设几何对象在 dataProjection 中(如果已设置); 换句话说,它们不会被转换。

rightHanded boolean | undefined

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

decimals number | undefined

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

返回值:
节点。