KmlLayer 类
google.maps.KmlLayer 类
KmlLayer 可从托管在可公开访问的网络服务器上的 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)参数：
返回值：无
在指定地图上渲染该 KML 图层。如果将地图设置为 null，则会移除相应图层。 |
setOptions |
setOptions(options)参数：
返回值：无
|
setUrl |
setUrl(url)参数：
返回值：无
设置要显示的 KML 文件的网址。 |
setZIndex |
setZIndex(zIndex)参数：
返回值：无
设置 KML 图层的 z-index。 |
继承自：
addListener、bindTo、get、notify、set、setValues、unbind、unbindAll
| |
事件 | |
|---|---|
click |
function(kmlClickEvent)实参：
点击图层中的特征时将会触发此事件。 |
defaultviewport_changed |
function()参数：None
当 KML 图层默认可视区域改变时会触发此事件。 |
status_changed |
function()参数：None
此事件会在 KML 图层加载完毕时触发。此时，可以安全地读取状态属性，以确定图层是否已成功加载。 |
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 格式）。
属性 | |
|---|---|
description |
类型：
string从图层标记中提取的图层 <description>。 |
hasScreenOverlays |
类型：
boolean相应层是否具有任何屏幕叠加层。 |
name |
类型：
string从图层标记中提取的图层 <name>。 |
snippet |
类型：
string从图层标记中提取的图层 <Snippet> |
author optional |
类型：
KmlAuthor optional从图层标记中提取的图层 <atom:author>。 |
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一个 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作者的主页，或空字符串（如果未指定）。 |