KmlLayer 類別
class
google.maps.KmlLayer
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()參數：無
傳回值：
取得與這個圖層相關的中繼資料 (如同圖層標記中所指定的一樣)。 |
getStatus |
getStatus()參數：無
傳回值：
取得圖層狀態，在要求的圖層載入後設定。 |
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 圖層載入完成時，就會觸發這個事件。此時，您可以放心讀取狀態屬性，判斷圖層是否已成功載入。 |
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
選填 |
類型：
從圖層標記中擷取的圖層 <atom:author>。 |
KmlLayerStatus 常數
constants
google.maps.KmlLayerStatus
library "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
單一 KML 功能的資料 (使用 JSON 格式，會在點擊 KML 功能時傳回)。這個物件中包含的資料會反映與 KML 或 GeoRSS 標記中的功能關聯的資料，並在該標記中宣告。
屬性 | |
|---|---|
author |
類型：
地圖項目的 <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作者的首頁，如果未指定則為空字串。 |