类:EsriJSON

ol/format/EsriJSON~Esri JSON格式


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

用于读写EsriJSON格式数据的要素格式。

new EsriJSON(options)

Name Type 描述
geometryName string | undefined

用于创建要素的几何名称。

继承

方法

readFeature(source, options){FeatureType | Array.<FeatureType>} inherited

读取一个要素。仅适用于单个要素。使用 readFeatures 读取要素集合。

Name Type 描述
source ArrayBuffer | 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.<FeatureType>} inherited

读取所有要素。适用于单个要素和要素集合。

Name Type 描述
source ArrayBuffer | 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 ArrayBuffer | 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.

返回:
几何.

读取投影。

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

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

返回:
编码要素。

writeFeatureObject(feature, options){Object}

将要素编码为 esriJSON 要素对象。

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

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

返回:
编码要素。

writeFeaturesObject(features, options){EsriJSONFeatureSet}

将要素数组编码为EsriJSON对象。

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

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

返回:
EsriJSON 对象。

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

坐标的最大小数位数。坐标在内部以浮点数形式存储,但浮点运算可能产生小数位数过多的坐标,这在输出中通常不需要。指定一个数值来舍入坐标。还可用于确保读入的坐标在输出时能保持相同的小数位数。默认不进行舍入。

返回:
编码几何。

writeGeometryObject(geometry, options){EsriJSONGeometry}

将几何对象编码为 EsriJSON 对象。

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

坐标小数位数上限。坐标在内部以浮点数形式存储,但浮点运算可能产生小数位过多的坐标,通常不希望出现在输出结果中。在此处指定数值以对坐标进行舍入处理。此设置还可确保读取的坐标在重新输出时保持相同的小数位数。默认情况下不进行舍入。

返回:
对象。