Class: WKT

ol/format/WKT~WKT


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

用于读写 WellKnown文本 (WKT) 格式数据的几何图形格式。

new WKT(options)

Name Type Description
splitCollection boolean (defaults to false)

读取时是否将 GeometryCollections 拆分为多个要素。

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

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

返回值:
几何对象。