KML

KmlLayer クラス

google.maps.KmlLayer クラス

KmlLayer は、一般公開されているウェブサーバーでホストされている KML、KMZ、または GeoRSS ファイルから、地図に地理的マークアップを追加します。クリックすると、対象物ごとに KmlFeatureData オブジェクトが提供されます。

このクラスは MVCObject を拡張します。

const {KmlLayer} = await google.maps.importLibrary("maps") を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。
KmlLayer
KmlLayer([opts])
パラメータ: 
指定された KML/KMZ ファイル（https://developers.google.com/kml/documentation/kmlreference）または GeoRSS ファイル（http://www.georss.org）の内容をレンダリングする KmlLayer を作成します。
getDefaultViewport
getDefaultViewport()
パラメータ: なし
戻り値:  LatLngBounds
表示されるレイヤのデフォルトのビューポートを取得します。
getMap
getMap()
パラメータ: なし
戻り値:  Map
KML レイヤがレンダリングされる地図を取得します。
getMetadata
getMetadata()
パラメータ: なし
戻り値:  KmlLayerMetadata
レイヤ マークアップに指定された、このレイヤに関連付けられたメタデータを取得します。
getStatus
getStatus()
パラメータ: なし
戻り値:  KmlLayerStatus
リクエストされたドキュメントが読み込まれたら、レイヤのステータスを取得します。
getUrl
getUrl()
パラメータ: なし
戻り値:  string URL
表示されている KML ファイルの URL を取得します。
getZIndex
getZIndex()
パラメータ: なし
戻り値:  number Z-Index。
KML レイヤの Z-Index を取得します。
setMap
setMap(map)
パラメータ: 
戻り値: なし
KML レイヤを指定された地図にレンダリングします。地図が null に設定されている場合、レイヤは削除されます。
setOptions
setOptions(options)
パラメータ: 
戻り値: なし
setUrl
setUrl(url)
パラメータ: 
  • url:  string
戻り値: なし
表示する KML ファイルの URL を設定します。
setZIndex
setZIndex(zIndex)
パラメータ: 
  • zIndex:  number 設定する Z-Index。
戻り値: なし
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 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 ドキュメントの URL です。
zIndex optional
タイプ:  number optional
レイヤの Z-Index。

KmlLayerMetadata インターフェース

google.maps.KmlLayerMetadata インターフェース

JSON 形式の、1 つの KML レイヤのメタデータ。
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 ドキュメントが見つかりませんでした。無効な URL か、ドキュメントが一般公開されていない可能性があります。
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 ドキュメント上のクリック イベントのプロパティ。
featureData
タイプ:  KmlFeatureData
クリックされた対象物に関する情報を含む KmlFeatureData オブジェクト。
latLng
タイプ:  LatLng
クリックされた対象物に情報ウィンドウを固定する位置。
pixelOffset
タイプ:  Size
クリックされた対象物に固定された情報ウィンドウに適用するオフセット。

KmlFeatureData インターフェース

google.maps.KmlFeatureData インターフェース

KML 対象物がクリックされたときに返される、単一の KML 対象物（JSON 形式）のデータ。このオブジェクトに含まれるデータは、宣言されている 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
作成者のホーム ページ、指定されていない場合は空白の文字列。