类:折线

ol/format/Polyline~折线


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

用于读写编码折线算法格式数据的要素格式。

读取要素时,假定坐标为二维,并遵循[纬度, 经度]顺序。

由于折线源仅包含一个要素,readFeatures 将返回一个包含该要素的数组。

new Polyline(options)

Name Type 描述
factor number (defaults to 1e5)

坐标值缩放因子。

geometryLayout GeometryLayout (defaults to 'XY')

格式读取器创建的要素几何布局。

继承

方法

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

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

featureProjection ProjectionLike | undefined

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

返回:
要素.

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

从数据源读取要素。

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

数据源.

options

Read options.

Name Type 描述
dataProjection ProjectionLike | undefined

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

extent Extent | undefined

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

featureProjection ProjectionLike | undefined

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

返回:
要素。

readGeometry(source, options){Geometry} inherited

从源读取几何。

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

数据源.

options

Read options.

Name Type 描述
dataProjection ProjectionLike | undefined

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

extent Extent | undefined

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

featureProjection ProjectionLike | undefined

格式阅读器创建的要素几何图形投影。若未提供,返回的要素将采用此投影。dataProjection.

返回:
几何.

readProjection(source){Projection | undefined} inherited

从源读取投影。

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

数据源.

返回:
投影.

writeFeature(feature, options){string} inherited

将要素编码为字符串。

Name Type 描述
feature 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

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

返回:
编码要素。

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

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

返回:
编码要素。

writeGeometry(geometry, options){string} inherited

编写单个几何图形。

Name Type 描述
geometry Geometry

几何.

options

Write options.

Name Type 描述
dataProjection ProjectionLike | undefined

待写入数据的投影。若未提供,则dataProjection格式被指定(如果已设置)。如果未指定格式dataProjection如果设置了格式,要素将按该格式返回。featureProjection.

featureProjection ProjectionLike | undefined

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

rightHanded boolean | undefined

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

decimals number | undefined

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

返回:
几何.