Class: Polyline

ol/format/Polyline~Polyline


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

用于读取和写入编码折线算法格式(Encoded Polyline Algorithm Format)数据的要素格式。

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

由于 Polyline 数据源包含单个要素, read要素s 将在数组中返回 该要素。

new Polyline(options)

Name Type Description
factor number (defaults to 1e5)

坐标值将被缩放的因子。

geometryLayout GeometryLayout (defaults to 'XY')

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

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 返回。

返回值:
要素集合。

readGeometry(source, options){Geometry} 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 返回。

返回值:
几何图形。

readProjection(source){Projection | undefined} inherited

从数据源读取投影。

Name Type Description
source Document | Element | Object | string

数据源。

返回值:
投影。

write要素(feature, options){string} inherited

将要素编码为字符串。

Name Type Description
feature 要素

要素。

options

写入选项。

Name Type Description
dataProjection ProjectionLike | undefined

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

featureProjection ProjectionLike | undefined

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

rightHanded boolean | undefined

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

decimals number | undefined

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

返回值:
编码后的要素。

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

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

Name Type Description
features Array<要素>

要素集合。

options

写入选项。

Name Type Description
dataProjection ProjectionLike | undefined

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

featureProjection ProjectionLike | undefined

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

rightHanded boolean | undefined

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

decimals number | undefined

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

返回值:
编码后的要素集合。

writeGeometry(geometry, options){string} inherited

写入单个几何图形。

Name Type Description
geometry Geometry

几何图形。

options

写入选项。

Name Type Description
dataProjection ProjectionLike | undefined

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

featureProjection ProjectionLike | undefined

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

rightHanded boolean | undefined

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

decimals number | undefined

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

返回值:
几何图形。