KML

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)
參數: 
  • urlstring
傳回值:
設定要顯示的 KML 檔案網址。
setZIndex
setZIndex(zIndex)
參數: 
  • zIndexnumber要設定的 Z-index。
傳回值:
設定 KML 圖層的 Z-index。
繼承: addListenerbindTogetnotifysetsetValuesunbindunbindAll
click
function(kmlClickEvent)
引數: 
按一下圖層中的功能時,會引發此事件。
defaultviewport_changed
function()
引數:
當 KML 圖層預設的檢視區變更後,會引發此事件。
status_changed
function()
引數:
當 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 格式)。

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
KmlFeatureData 物件,包含點擊功能的相關資訊。
latLng
類型:  LatLng
在可點擊功能上固定資訊視窗的位置。
pixelOffset
類型:  Size
套用至資訊視窗 (固定在可點擊功能上) 的位移。

KmlFeatureData 介面

google.maps.KmlFeatureData 介面

單一 KML 功能的資料 (使用 JSON 格式,會在點擊 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
作者的首頁,如果未指定則為空字串。