Class: JSON要素

ol/format/JSON要素~JSON要素


抽象基类;通常仅用于创建子类,不应在应用中直接实例化。 JSON 要素格式的基类。

Subclasses

Extends

Methods

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

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

Name Type Description
source ArrayBuffer | Document | Element | Object | string

数据源。

options

读取选项。

Name Type Description
dataProjection ProjectionLike | undefined

所读取数据的投影。 如果未提供,投影将从数据中派生(在可能的情况下),或者 分配格式的 dataProjection(如果已设置)。如果无法从数据中派生投影, 且格式未设置 dataProjection,则要素将不会被重新投影。

extent Extent | undefined

正在读取的瓦片的地图单位范围。 仅在以瓦图像素作为几何图形单位读取数据时需要。配置时, 需要提供以 TILE_PIXELS 作为 unitsdataProjection,以及瓦片的像素范围作为 extent

featureProjection ProjectionLike | undefined

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

返回值:
要素。

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

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

Name Type Description
source ArrayBuffer | Document | Element | Object | string

数据源。

options

读取选项。

Name Type Description
dataProjection ProjectionLike | undefined

所读取数据的投影。 如果未提供,投影将从数据中派生(在可能的情况下),或者 分配格式的 dataProjection(如果已设置)。如果无法从数据中派生投影, 且格式未设置 dataProjection,则要素将不会被重新投影。

extent Extent | undefined

正在读取的瓦片的地图单位范围。 仅在以瓦图像素作为几何图形单位读取数据时需要。配置时, 需要提供以 TILE_PIXELS 作为 unitsdataProjection,以及瓦片的像素范围作为 extent

featureProjection ProjectionLike | undefined

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

返回值:
要素集合。

readGeometry(source, options){Geometry}

读取几何图形。

Name Type Description
source ArrayBuffer | Document | Element | Object | string

数据源。

options

读取选项。

Name Type Description
dataProjection ProjectionLike | undefined

所读取数据的投影。 如果未提供,投影将从数据中派生(在可能的情况下),或者 分配格式的 dataProjection(如果已设置)。如果无法从数据中派生投影, 且格式未设置 dataProjection,则要素将不会被重新投影。

extent Extent | undefined

正在读取的瓦片的地图单位范围。 仅在以瓦图像素作为几何图形单位读取数据时需要。配置时, 需要提供以 TILE_PIXELS 作为 unitsdataProjection,以及瓦片的像素范围作为 extent

featureProjection ProjectionLike | undefined

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

返回值:
几何图形。

readProjection(source){Projection}

读取投影。

Name Type Description
source ArrayBuffer | Document | Element | Object | string

数据源。

返回值:
投影。

write要素(feature, options){string}

将要素编码为字符串。

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}

将要素数组编码为字符串。

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

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

返回值:
编码后的要素集合。

writeGeometry(geometry, options){string}

将几何图形编码为字符串。

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

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

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