类:GPX

ol/format/GPX~GPX格式


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

用于读写GPX格式数据的要素格式。

请注意,readFeature 仅读取源的第一个要素。

读取时,路线(<rte>)转换为 LineString 几何,轨迹(<trk>)转换为 MultiLineString。路线与轨迹航点的所有属性均被忽略。

在写入时,LineString 几何体输出为路线(<rte>),而 MultiLineString 输出为轨迹(<trk>)。

new GPX(options)

Name Type 描述
readExtensions function | undefined

用于处理的回调函数extensions节点。为了防止内存泄漏,该回调函数不应存储对该节点的任何引用。请注意,extensions在GPX 1.0规范中,节点是不被允许的。此外,仅extensions节点来源于wpt, rtetrk这些可以被处理,因为它们直接映射到要素。

继承

方法

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

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

featureProjection ProjectionLike | undefined

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

返回:
要素。

readMetadata(source){GPXMetadata | null}

读取 GPX 文件的元数据标签,包括但不限于:

  • 该GPX文件的名称及描述
  • 其作者
  • 此GPX文件的版权

如果不存在元数据标签(或未给出有效源),则返回 null。

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

数据源.

返回:
元数据

从源读取投影。

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

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

返回:
结果。

writeFeaturesNode(features, options){Node}

将 GPX 格式的要素数组编码为 XML 节点。LineString 几何输出为路线 (<rte>),MultiLineString 输出为轨迹 (<trk>)。

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

坐标小数位数的最大值。坐标在内部以浮点数形式存储,但浮点运算可能生成具有大量小数位的坐标,这在输出中通常不希望出现。在此处设置一个数值以对坐标进行舍入。还可用于确保读入的坐标在写回时保持相同的小数位数。默认情况下不进行舍入。

返回:
节点。