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 を作成します。 |
Methods | |
---|---|
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) パラメータ:
戻り値: None
指定した地図上に KML レイヤをレンダリングします。地図が null に設定されている場合、レイヤは削除されます。 |
setOptions |
setOptions(options) パラメータ:
戻り値: None
|
setUrl |
setUrl(url) パラメータ:
戻り値: None
表示する KML ファイルの URL を設定します。 |
setZIndex |
setZIndex(zIndex) パラメータ:
戻り値: None
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 対象物のデータ(JSON 形式)。KML 対象物がクリックされたときに返されます。このオブジェクトに含まれるデータは、宣言されている KML または GeoRSS マークアップ内の対象物と関連付けられているデータをミラーリングしています。
プロパティ | |
---|---|
author |
タイプ:
KmlAuthor 対象物の <atom:author> がレイヤ マークアップから抽出されます(指定した場合)。 |
description |
タイプ:
string 対象物の <description> をレイヤ マークアップから抽出したもの。 |
id |
タイプ:
string 対象物の <id> をレイヤ マークアップから抽出したもの。<id> を指定しないと、対象物の一意の ID が生成されます。 |
infoWindowHtml |
タイプ:
string 設定された場合、対象物の吹き出しスタイルのテキスト。 |
name |
タイプ:
string 対象物の <name> をレイヤ マークアップから抽出したもの。 |
snippet |
タイプ:
string 対象物の <Snippet> をレイヤ マークアップから抽出したもの。 |