类:WKT

ol/format/WKT~已知文本


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

用于读写 WellKnownText (WKT) 格式数据的几何格式。

new WKT(options)

Name Type 描述
splitCollection boolean (defaults to false)

读取时是否将几何集合拆分为多个要素?

继承

方法

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

Read options.

Name Type 描述
dataProjection ProjectionLike | undefined

输入数据的投影。若未指定,将尝试从数据中推导投影(如可能),或dataProjection格式的分配(如果已设置)。如果无法从数据中推导出投影,并且如果没有dataProjection格式设置后,要素不会重新投影。

extent Extent | undefined

正在读取瓦片的地图单位范围。仅当数据以瓦片像素为几何单位读取时才需要。配置后,一个dataProjection使用TILE_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

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

返回:
几何.