KML

KmlLayer

google.maps.KmlLayer

KmlLayer 用于向托管在可公开访问的 Web 服务器上的 KML、KMZ 或 GeoRSS 文件中的地图添加地理标记。用户点击每个地图项时,都会提供一个 KmlFeatureData 对象。

此类扩展了 MVCObject

通过调用 const {KmlLayer} = await google.maps.importLibrary("maps") 进行访问。请参阅 Maps JavaScript API 中的库

KmlLayer
KmlLayer([opts])
参数
创建一个 KmlLayer,用于呈现指定 KML/KMZ 文件 (https://developers.google.com/kml/documentation/kmlreference) 或 GeoRSS 文件 (http://www.georss.org) 的内容。
getDefaultViewport
getDefaultViewport()
参数:无
返回值LatLngBounds
获取适用于所显示图层的默认视口。
getMap
getMap()
参数:无
返回值Map
获取在其上渲染 KML 图层的地图。
getMetadata
getMetadata()
参数:无
返回值KmlLayerMetadata
获取与此图层相关联的元数据,如图层标记中所指定。
getStatus
getStatus()
参数:无
返回值KmlLayerStatus
获取层的状态,在请求的文档加载完成后设置。
getUrl
getUrl()
参数:无
返回值string 网址
获取显示的 KML 文件的网址。
getZIndex
getZIndex()
参数:无
返回值number Z-index。
获取 KML 图层的 Z-index。
setMap
setMap(map)
参数
返回值:None
在指定地图上渲染该 KML 图层。如果地图设置为 null,系统会移除该图层。
setOptions
setOptions(options)
参数
返回值:None
setUrl
setUrl(url)
参数
  • urlstring
返回值:None
设置要显示的 KML 文件的网址。
setZIndex
setZIndex(zIndex)
参数
  • zIndexnumber要设置的 Z-index。
返回值:None
设置 KML 图层的 Z-index。
继承的样式addListenerbindTogetnotifysetsetValuesunbindunbindAll
click
function(kmlClickEvent)
参数
点击图层中的特征时将会触发此事件。
defaultviewport_changed
function()
参数:None
当 KML 图层默认可视区域改变时会触发此事件。
status_changed
function()
参数:None
当 KML 图层完成加载时会触发此事件。此时,可以放心地读取 status 属性来确定图层是否加载成功。

KmlLayerOptions 接口

google.maps.KmlLayerOptions 接口

此对象定义了可在 KmlLayer 对象上设置的属性。

clickable optional
类型boolean optional
默认值true
如果为 true,则图层会收到鼠标事件。
map optional
类型Map optional
要在其上显示图层的地图。
preserveViewport optional
类型boolean optional
默认值false
如果此选项设置为 true,或者从未设置地图的中心和缩放级别,则输入地图会居中并缩放至图层内容的边界框。
screenOverlays optional
类型boolean optional
默认值true
是否渲染屏幕叠加层。
suppressInfoWindows optional
类型boolean optional
取消在点击图层地图项时呈现信息窗口。
url optional
类型string optional
要显示的 KML 文档的网址。
zIndex optional
类型number optional
层的 Z-index。

KmlLayerMetadata 接口

google.maps.KmlLayerMetadata 接口

一个 KML 图层的元数据(采用 JSON 格式)。

author
类型KmlAuthor
图层的 <atom:author>,从图层标记中提取。
description
类型string
图层的 <description>,从图层标记中提取。
hasScreenOverlays
类型boolean
图层是否有任何屏幕叠加层。
name
类型string
图层的 <name>,从图层标记中提取。
snippet
类型string
图层的 <Snippet>,从图层标记中提取

KmlLayerStatus 常量

google.maps.KmlLayerStatus 常量

KmlLayer 在文档加载完成时返回的状态。通过值或使用常量名称来指定这些变量。例如 'OK'google.maps.KmlLayerStatus.OK

通过调用 const {KmlLayerStatus} = await google.maps.importLibrary("maps") 进行访问。请参阅 Maps JavaScript API 中的库

DOCUMENT_NOT_FOUND 找不到文件。这很可能是无效网址,或者文档未公开提供。
DOCUMENT_TOO_LARGE 此文档超出了 KmlLayer 的文件大小上限。
FETCH_ERROR 无法提取文档。
INVALID_DOCUMENT 该文档不是有效的 KML、KMZ 或 GeoRSS 文档。
INVALID_REQUEST KmlLayer 无效。
LIMITS_EXCEEDED 此文档超出了 KmlLayer 的地图项限制。
OK 图层已成功加载。
TIMED_OUT 文档无法在合理的时间内加载。
UNKNOWN 文档加载失败,原因未知。

KmlMouseEvent 接口

google.maps.KmlMouseEvent 接口

KML/KMZ 或 GeoRSS 文档的 click 事件的属性。

featureData
KmlFeatureData 对象,包含有关所点击地图项的信息。
latLng
类型LatLng
信息窗口在所点击特征上的锚定位置。
pixelOffset
类型Size
要应用于锚定在所点击地图项上的信息窗口的偏移量。

KmlFeatureData 接口

google.maps.KmlFeatureData 接口

一个 JSON 格式的 KML 特征数据,当点击 KML 特征时传回。此对象中包含的数据将镜像声明它时所在的 KML 或 GeoRSS 标记中特征的关联数据。

author
类型KmlAuthor
地图项的 <atom:author>,从图层标记(如果已指定)中提取。
description
类型string
地图项的 <description>,从图层标记中提取。
id
类型string
地图项的 <id>,从图层标记中提取。如果未指定 <id>,系统会为此地图项生成唯一 ID。
infoWindowHtml
类型string
特征的气球样式文本(如果已设置)。
name
类型string
地图项的 <name>,从图层标记中提取。
snippet
类型string
地图项的 <Snippet>,从图层标记中提取。

KmlAuthor 接口

google.maps.KmlAuthor 接口

包含有关 KML 文档或特征的作者的详细信息。

email
类型string
作者的电子邮件地址,或空字符串(如果未指定)。
name
类型string
作者的姓名,或空字符串(如果未指定)。
uri
类型string
作者的主页,或空字符串(如果未指定)。