KmlLayer 类
google.maps.KmlLayer
class
extends MVCObject
library "maps"
const {KmlLayer} = await google.maps.importLibrary("maps");
构造函数 | |
|---|---|
KmlLayer |
KmlLayer([opts])参数:
创建 KmlLayer,用于呈现指定 KML/KMZ 文件 (https://developers.google.com/kml/documentation/kmlreference) 或 GeoRSS 文件 (http://www.georss.org) 的内容。 |
方法 | |
|---|---|
getDefaultViewport |
getDefaultViewport()参数:无
返回值:
LatLngBounds|null获取适用于所显示图层的默认视口。 |
getMap |
getMap()参数:无
返回值:
Map|null获取在其上渲染 KML 图层的地图。 |
getMetadata |
getMetadata()参数:无
返回值:
KmlLayerMetadata|null获取与此图层相关联的元数据,如图层标记中所指定。 |
getStatus |
getStatus()参数:无
返回值:
KmlLayerStatus|null获取图层的状态,在请求的文档加载后设置。 |
getUrl |
getUrl()参数:无
返回值:
string 网址获取所显示 KML 文件的网址。 |
getZIndex |
getZIndex()参数:无
返回值:
number Z-index。获取 KML 图层的 Z 轴索引。 |
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()参数:无
当 KML 图层默认可视区域改变时会触发此事件。 |
status_changed |
function()参数:无
此事件会在 KML 图层加载完毕时触发。此时,您可以安全地读取 status 属性,以确定图层是否已成功加载。 |
KmlLayerOptions 接口
google.maps.KmlLayerOptions
接口
此对象定义了可在 KmlLayer 对象上设置的属性。
属性 | |
|---|---|
clickable
可选 |
类型:
boolean optional默认值:
true如果为 true,则图层会接收鼠标事件。 |
map
可选 |
类型:
Map optional要在其上显示图层的地图。 |
preserveViewport
可选 |
类型:
boolean optional默认值:
false如果此选项设为 true,或者从未设置地图的中心位置和缩放级别,则输入地图会根据图层内容的边界框设置中心位置和进行缩放。 |
screenOverlays
可选 |
类型:
boolean optional默认值:
true是否呈现屏幕叠加层。 |
suppressInfoWindows
可选 |
类型:
boolean optional取消在点击图层地图项时呈现信息窗口。 |
url
可选 |
类型:
string optional要显示的 KML 文档的网址。 |
zIndex
可选 |
类型:
number optional图层的 Z-index。 |
KmlLayerMetadata 接口
google.maps.KmlLayerMetadata
接口
一个 KML 图层的元数据(采用 JSON 格式)。
属性 | |
|---|---|
description |
类型:
string从图层标记中提取的图层 <description>。 |
hasScreenOverlays |
类型:
boolean图层是否具有任何屏幕叠加层。 |
name |
类型:
string从图层标记中提取的图层 <name>。 |
snippet |
类型:
string从图层标记中提取的图层 <Snippet> |
author
可选 |
类型:
KmlAuthor optional从图层标记中提取的图层 <atom:author>。 |
KmlLayerStatus 常量
google.maps.KmlLayerStatus
常量
库 "maps"
KmlLayer 在文档加载完成后返回的状态。按值或使用常量名称指定这些值。例如 'OK' 或 google.maps.KmlLayerStatus.OK。
这些常量也可以用作字符串。在 TypeScript 中,字符串字面量由 KmlLayerStatusString 类型定义。
const {KmlLayerStatus} = await google.maps.importLibrary("maps");
常量 | |
|---|---|
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作者的主页,或空字符串(如果未指定)。 |