Class: KML

ol/format/KML~KML


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

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

read要素 将从 KML 数据源中读取第一个要素。

MultiGeometries 如果是混合几何图形类型,则转换为 GeometryCollections; 如果全部为同一类型,则转换为 MultiPoint/MultiLineString/MultiPolygon。

new KML(options)

Name Type Description
extractStyles boolean (defaults to true)

从 KML 中提取样式。

showPointNames boolean (defaults to true)

将名称显示为包含点的地标的标签。

defaultStyle Array<Style> | undefined

默认样式。 默认的默认样式与 Google Earth 相同。

writeStyles boolean (defaults to true)

将样式写入 KML。

crossOrigin null | string (defaults to 'anonymous')

已加载图像的 crossOrigin 属性。请注意,如果要使用 Canvas 渲染器访问像素数据, 必须提供 crossOrigin 值。

referrerPolicy ReferrerPolicy | undefined

已加载图像的 referrerPolicy 属性。

iconUrl函数 IconUrl函数 | undefined

接受 url 字符串并返回 url 字符串的函数。 可用于更改图标路径或替换从 KMZ 数组缓冲区获取的数据 url。

Extends

Methods

readCamera(source){Array<KMLCamera>}

读取 KML 的相机。

Name Type Description
source Document | Element | string

数据源。

返回值:
相机。

readCameraFromNode(node){Array<KMLCamera>}

Name Type Description
node Element

节点。

返回值:
相机。

read要素(source, options){要素} inherited

读取单个要素。

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

从要素集合中读取所有要素。

Name Type Description
source Document | Element | Object | string

数据源。

options

选项。

Name Type Description
dataProjection ProjectionLike | undefined

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

extent Extent | undefined

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

featureProjection ProjectionLike | undefined

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

返回值:
要素集合。

readName(source){string | undefined}

读取 KML 的名称。

Name Type Description
source Document | Element | string

数据源。

返回值:
名称。

readNetworkLinks(source){Array.<Object>}

读取 KML 的网络链接。

Name Type Description
source Document | Element | string

数据源。

返回值:
网络链接。

从数据源读取投影。

Name Type Description
source Document | Element | Object | string

数据源。

返回值:
投影。

readRegion(source){Array.<Object>}

读取 KML 的区域。

Name Type Description
source Document | Element | string

数据源。

返回值:
区域。

readRegionFromNode(node){Array.<Object>}

Name Type Description
node Element

节点。

返回值:
区域。

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要素sNode(features, options){Node}

将要素数组以 KML 格式编码为 XML 节点。GeometryCollections、 MultiPoints、MultiLineStrings 和 MultiPolygons 将作为 MultiGeometries 输出。

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

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

返回值:
节点。