Class: GeoJSON

ol/format/GeoJSON~GeoJSON


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

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

new GeoJSON(options)

Name Type Description
dataProjection ProjectionLike (defaults to 'EPSG:4326')

默认数据投影。

featureProjection ProjectionLike | undefined

格式读取或写入要素时使用的投影。传递给读取或写入方法的选项将优先。

geometryName string | undefined

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

extractGeometryName boolean (defaults to false)

某些 GeoJSON 提供者在要素 GeoJSON 中包含 geometry_name 字段。如果设置为 true,GeoJSON 读取器将查找该字段来设置几何图形名称。如果此字段设置为 true 且提供了 geometryName,则 geometryName 优先。

featureClass 要素To要素Class<要素Type> | 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

正在读取的瓦片的地图单位范围。这仅在读取以瓦片像素为几何单位的数据时才需要。配置时,需要提供一个 unitsTILE_PIXELSdataProjection 和瓦片的像素范围作为 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

正在读取的瓦片的地图单位范围。这仅在读取以瓦片像素为几何单位的数据时才需要。配置时,需要提供一个 unitsTILE_PIXELSdataProjection 和瓦片的像素范围作为 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

正在读取的瓦片的地图单位范围。这仅在读取以瓦片像素为几何单位的数据时才需要。配置时,需要提供一个 unitsTILE_PIXELSdataProjection 和瓦片的像素范围作为 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

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

返回值:
编码后的要素。

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

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

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

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

返回值:
编码后的要素。

write要素sObject(features, options){GeoJSON要素Collection}

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

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

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

返回值:
GeoJSON 对象。

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

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

返回值:
编码后的几何图形。

writeGeometryObject(geometry, options){GeoJSONGeometry | GeoJSONGeometryCollection}

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

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

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

返回值:
对象。