KmlLayer クラス
class
google.maps.KmlLayer
extends MVCObject
library "maps"
const {KmlLayer} = await google.maps.importLibrary("maps");
コンストラクタ | |
|---|---|
KmlLayer |
KmlLayer([opts])パラメータ:
指定された KML / KMZ ファイル(https://developers.google.com/kml/documentation/kmlreference)または GeoRSS ファイル(http://www.georss.org)のコンテンツをレンダリングする KmlLayer を作成します。 |
メソッド | |
|---|---|
getDefaultViewport |
getDefaultViewport()パラメータ: なし
戻り値:
LatLngBounds|null表示されるレイヤのデフォルトのビューポートを取得します。 |
getMap |
getMap()パラメータ: なし
戻り値:
Map|nullKML レイヤがレンダリングされる地図を取得します。 |
getMetadata |
getMetadata()パラメータ: なし
戻り値:
レイヤ マークアップに指定された、このレイヤに関連付けられたメタデータを取得します。 |
getStatus |
getStatus()パラメータ: なし
戻り値:
リクエストされたドキュメントが読み込まれたときに設定される、レイヤのステータスを取得します。 |
getUrl |
getUrl()パラメータ: なし
戻り値:
string URL表示されている KML ファイルの URL を取得します。 |
getZIndex |
getZIndex()パラメータ: なし
戻り値:
number z-index。KML レイヤの Z-Index を取得します。 |
setMap |
setMap(map)パラメータ:
戻り値: なし
指定された地図に KML レイヤをレンダリングします。map が null に設定されている場合、レイヤは削除されます。 |
setOptions |
setOptions(options)パラメータ:
戻り値: なし
|
setUrl |
setUrl(url)パラメータ:
戻り値: なし
表示する KML ファイルの URL を設定します。 |
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デフォルト:
truetrue の場合、レイヤはマウスイベントを受け取ります。 |
map
省略可 |
タイプ:
Map optionalレイヤを表示する地図。 |
preserveViewport
省略可 |
タイプ:
boolean optionalデフォルト:
falseこのオプションが true に設定されている場合、または地図の中心とズームが設定されていない場合、入力地図はレイヤのコンテンツの境界ボックスに中心が設定され、ズームされます。 |
screenOverlays
省略可 |
タイプ:
boolean optionalデフォルト:
true画面オーバーレイをレンダリングするかどうか。 |
suppressInfoWindows
省略可 |
タイプ:
boolean optionalレイヤの対象物をクリックしたときに、情報ウィンドウのレンダリングを抑制します。 |
url
省略可 |
タイプ:
string optional表示する KML ドキュメントの URL。 |
zIndex
省略可 |
タイプ:
number optionalレイヤの z-index。 |
KmlLayerMetadata インターフェース
インターフェース
google.maps.KmlLayerMetadata
JSON 形式の、1 つの KML レイヤのメタデータ。
プロパティ | |
|---|---|
description |
タイプ:
stringレイヤの <description>。レイヤ マークアップから抽出されます。 |
hasScreenOverlays |
タイプ:
booleanレイヤにスクリーン オーバーレイがあるかどうか。 |
name |
タイプ:
stringレイヤの <name>。レイヤ マークアップから抽出されます。 |
snippet |
タイプ:
stringレイヤの <Snippet>(レイヤ マークアップから抽出) |
author
省略可 |
タイプ:
レイヤの <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 |
ドキュメントが見つかりませんでした。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 オブジェクト。 |
latLng |
タイプ:
LatLngクリックされた対象物に情報ウィンドウを固定する位置。 |
pixelOffset |
タイプ:
Sizeクリックされた対象物に固定された情報ウィンドウに適用するオフセット。 |
KmlFeatureData インターフェース
インターフェース
google.maps.KmlFeatureData
JSON 形式の単一の KML 地物のデータ。KML 地物がクリックされたときに返されます。このオブジェクトに含まれるデータは、宣言されている KML または GeoRSS マークアップ内の対象物と関連付けられているデータをミラーリングしています。
プロパティ | |
|---|---|
author |
タイプ:
対象物の <atom:author>。レイヤ マークアップから抽出されます(指定されている場合)。 |
description |
タイプ:
stringレイヤ マークアップから抽出された対象物の <description>。 |
id |
タイプ:
stringレイヤ マークアップから抽出された対象物の <id>。<id> が指定されていない場合、この特徴に一意の ID が生成されます。 |
infoWindowHtml |
タイプ:
string設定された場合、対象物の吹き出しスタイルのテキスト。 |
name |
タイプ:
stringレイヤ マークアップから抽出された対象物の <name>。 |
snippet |
タイプ:
stringレイヤ マークアップから抽出された対象物の <Snippet>。 |