类:WKB

ol/format/WKB~已知二进制


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

该几何数据格式支持以 Well-Known Binary (WKB) 格式进行读写操作,同时也支持在 PostGIS 等系统中使用的 Extended Well-Known Binary (EWKB) 格式。

new WKB(options)

Name Type 描述
splitCollection boolean (defaults to false)

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

hex boolean (defaults to true)

输出时返回十六进制字符串而非 ArrayBuffer。这也作为内部提示,用于指示在读取内容时应加载为文本还是 ArrayBuffer。

littleEndian boolean (defaults to true)

输出时使用小端字节序。

ewkb boolean (defaults to true)

使用 EWKB 格式输出。

geometryLayout GeometryLayout (defaults to null)

为输出要素设置特定坐标排列(默认:自动检测)

nodataZ number (defaults to 0)

如果geometryLayout若输出几何不匹配,则此值用于填充缺失的Z坐标值。

nodataM number (defaults to 0)

如果geometryLayout与输出几何不匹配时,该值用于填充M坐标的缺失值。

srid number | boolean (defaults to true)

输出SRID:指定整数值以强制设置SRID。指定true从中提取dataProjection. false用于禁用输出。该选项仅当...时生效ewkbtrue.

继承

方法

readFeature(source, options){Feature}

从源读取单个要素。

Name Type 描述
source string | ArrayBuffer | ArrayBufferView

数据源.

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>}

从源读取所有要素。

Name Type 描述
source string | ArrayBuffer | ArrayBufferView

数据源.

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}

从数据源中读取单个几何图形。

Name Type 描述
source string | ArrayBuffer | ArrayBufferView

数据源.

options

Read options.

Name Type 描述
dataProjection ProjectionLike | undefined

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

extent Extent | undefined

读取中图块的地图单位范围。仅当读取以瓦片像素作为几何单位的数据时才需设置。配置后,将显示一个输入框。dataProjection使用TILE_PIXELS作为units以及瓦片的像素范围为extent需提供。

featureProjection ProjectionLike | undefined

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

返回:
几何.

readProjection(source){Projection | undefined}

从源读取投影。

Name Type 描述
source string | ArrayBuffer | ArrayBufferView

数据源.

返回:
投影.

writeFeature(feature, options){string | ArrayBuffer}

按此格式编码要素。

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 | ArrayBuffer}

以这种格式编码一个要素数组。

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 | ArrayBuffer}

按此格式编写一个几何对象。

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

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

返回:
结果。