Class: EsriJSON

ol/format/EsriJSON~EsriJSON


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

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

new EsriJSON(options)

Name Type Description
geometryName string | undefined

创建要素时使用的几何图形名称。

Extends

Methods

read要素(source, options){要素Type | Array.<要素Type>} inherited

读取要素。仅适用于单个要素。使用 read要素s 来读取要素集合。

Name Type Description
source ArrayBuffer | 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.<要素Type>} inherited

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

Name Type Description
source ArrayBuffer | 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 ArrayBuffer | Document | Element | Object | string

数据源。

options

读取选项。

Name Type Description
dataProjection ProjectionLike | undefined

正在读取的数据的投影。 如果未提供,将从数据中推导投影(如可能)或使用格式的 dataProjection(如已设置)。 如果无法从数据中推导投影且格式未设置 dataProjection,要素将不会被重新投影。

extent Extent | undefined

正在读取的瓦片的范围(以地图单位表示)。 仅在使用瓦片像素作为几何图形单位读取数据时需要。配置时, 需要提供以 TILE_PIXELSunitsdataProjection 以及瓦片的像素范围作为 extent

featureProjection ProjectionLike | undefined

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

返回值:
几何对象。

读取投影。

Name Type Description
source ArrayBuffer | 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,则假定几何图形在该投影中;换句话说,它们不会被转换。

rightHanded boolean | undefined

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

decimals number | undefined

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

返回值:
Encoded feature.

write要素Object(feature, options){Object}

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

Name Type Description
feature 要素

要素。

options

写入选项。

Name Type Description
dataProjection ProjectionLike | undefined

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

featureProjection ProjectionLike | undefined

格式写入器将序列化的要素几何图形的投影。 如果未提供,如果设置了 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,则假定几何图形在该投影中;换句话说,它们不会被转换。

rightHanded boolean | undefined

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

decimals number | undefined

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

返回值:
Encoded features.

write要素sObject(features, options){EsriJSON要素Set}

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

Name Type Description
features Array<要素>

要素数组。

options

写入选项。

Name Type Description
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 Description
geometry Geometry

几何图形。

options

写入选项。

Name Type Description
dataProjection ProjectionLike | undefined

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

featureProjection ProjectionLike | undefined

格式写入器将序列化的要素几何图形的投影。 如果未提供,如果设置了 dataProjection,则假定几何图形在该投影中;换句话说,它们不会被转换。

rightHanded boolean | undefined

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

decimals number | undefined

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

返回值:
Encoded geometry.

writeGeometryObject(geometry, options){EsriJSONGeometry}

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

Name Type Description
geometry Geometry

几何图形。

options

写入选项。

Name Type Description
dataProjection ProjectionLike | undefined

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

featureProjection ProjectionLike | undefined

格式写入器将序列化的要素几何图形的投影。 如果未提供,如果设置了 dataProjection,则假定几何图形在该投影中;换句话说,它们不会被转换。

rightHanded boolean | undefined

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

decimals number | undefined

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

返回值:
对象。