Google マプレット リファレンス
class GMap2
地図を作成するには、クラス GMap2 のインスタンスを作成します。これは API の中心となるクラスです。他はすべて補助的なクラスです。
コンストラクタ
| コンストラクタ |
説明 |
| GMap2() |
メイン地図へのハンドルを返します。 |
非同期メソッド
設定
| 非同期メソッド |
コールバック値 |
説明 |
| draggingEnabledAsync(callback) |
Boolean |
地図のドラッグ操作が有効な場合は、true を返します。 |
| infoWindowEnabledAsync(callback) |
Boolean |
情報ウィンドウが有効になっている場合は、true を返します。 |
| doubleClickZoomEnabledAsync(callback) |
Boolean |
ダブルクリックによるズームインとズームアウトが有効な場合にのみ、true を返します。(2.58 以降) |
| continuousZoomEnabledAsync(callback) |
Boolean |
滑らかなズームが有効な場合に、true を返します。(2.58 以降) |
マップ タイプ
| 非同期メソッド |
コールバック値 |
説明 |
| getMapTypesAsync(callback) |
GMapType の配列 |
対象の地図に登録されているマップ タイプを配列で返します。 |
| getCurrentMapTypeAsync(callback) |
GMapType |
現在選択されているマップ タイプを返します。 |
| setMapType(type) |
該当なし |
指定された新しいマップ タイプを選択します。タイプは地図に認識されている必要があります。コンストラクタとメソッド addMapType() を参照してください。 |
地図の状態
| 非同期メソッド |
コールバック値 |
説明 |
| isLoadedAsync(callback) |
Boolean |
マップが作成されて、setCenter() で初期化された場合は、true を返します。 |
| getCenterAsync(callback) |
GLatLng |
マップ ビューの中心地点の地理座標を返します。 |
| getBoundsAsync(callback) |
GLatLngBounds |
マップ ビューの矩形の表示領域を地理座標で返します。 |
| getBoundsZoomLevelAsync(bounds, callback) |
Number |
指定された矩形領域がマップ ビューに収まるズーム レベルを返します。ズーム レベルは、現在選択されているマップ タイプに合わせて計算されます。マップ タイプが選択されていない場合は、マップ タイプ リストの最初のタイプが使用されます。 |
| getSizeAsync(callback) |
GSize |
マップ ビューのサイズをピクセル単位で返します。 |
| getZoomAsync(callback) |
Number |
現在のズーム レベルを返します。 |
地図の状態の変更
| 非同期メソッド |
コールバック値 |
説明 |
| setCenter(center, zoom?, type?) |
該当なし |
指定された中心地点に対してマップ ビューを設定します。オプションで、ズーム レベルとマップ タイプも設定できます。マップ タイプは地図に認識されている必要があります。コンストラクタとメソッドaddMapType() を参照してください。このメソッドは、地図の初期状態を設定したら最初に呼び出す必要があります。設定後に地図に対する他の操作を呼び出すと、エラーになります。 |
| panTo(center) |
該当なし |
地図の中心を指定された地点に変更します。その地点が現在のマップ ビューに既に表示されている場合は、滑らかに移動して中心を変更します。 |
| panBy(distance) |
該当なし |
ピクセル単位で指定した距離だけ、現在の位置から移動します。 |
| panDirection(dx, dy) |
該当なし |
指定された方向に地図の幅の半分だけ現在の位置から移動します。+1 を指定すると右か下に、-1 を指定すると左か上にそれぞれ移動します。 |
| setZoom(level) |
該当なし |
ズーム レベルを、指定された新しい値に設定します。 |
| zoomIn() |
該当なし |
ズーム レベルを 1 つ上げます。 |
| zoomOut() |
該当なし |
ズーム レベルを 1 つ下げます。 |
オーバーレイ
| 非同期メソッド |
コールバック値 |
説明 |
| addOverlay(overlay) |
該当なし |
地図にオーバーレイを追加し、addoverlay イベントを発行します。 |
| removeOverlay(overlay) |
該当なし |
地図からオーバーレイを削除します。オーバーレイが地図上にあった場合は、removeoverlay イベントを発行します。 |
| clearOverlays() |
該当なし |
地図からすべてのオーバーレイを削除し、clearoverlays イベントを発行します。 |
情報ウィンドウ
| 非同期メソッド |
コールバック値 |
説明 |
| openInfoWindow(point, node, opts?) |
該当なし |
指定された地点に情報ウィンドウを表示します。情報ウィンドウが完全に表示されるように地図を移動します。情報ウィンドウのコンテンツは DOM ノードとして指定されます。 |
| openInfoWindowHtml(point, html, opts?) |
該当なし |
指定された地点に情報ウィンドウを表示します。情報ウィンドウが完全に表示されるように地図を移動します。情報ウィンドウのコンテンツは HTML テキストとして指定されます。 |
| openInfoWindowTabs(point, tabs, opts?) |
該当なし |
指定された地点にタブ付き情報ウィンドウを表示します。情報ウィンドウが完全に表示されるように地図を移動します。情報ウィンドウのコンテンツは DOM ノードとして指定されます。 |
| openInfoWindowTabsHtml(point, tabs, opts?) |
該当なし |
指定された地点にタブ付き情報ウィンドウを表示します。情報ウィンドウが完全に表示されるように地図を移動します。情報ウィンドウのコンテンツは HTML テキストとして指定されます。 |
| showMapBlowup(point, opts?) |
該当なし |
指定された地点に、指定された地点周辺の詳細地図を表示した情報ウィンドウを開きます。 |
| closeInfoWindow() |
該当なし |
現在表示されている情報ウィンドウを閉じます。 |
| getInfoWindowAsync(callback) |
GInfoWindow |
地図の情報ウィンドウ オブジェクトを返します。情報ウィンドウが存在しない場合は、ウィンドウは作成されますが表示されません。enableInfoWindow() の影響は受けません。 |
座標の変換
| 非同期メソッド |
コールバック値 |
説明 |
| fromLatLngToDivPixelAsync(latlng, callback) |
GPoint |
ドラッグ可能な地図を含む、DOM 要素内で指定された地理的地点を、ピクセル座標で計算します。このメソッドは、カスタム オーバーレイに GOverlay.redraw() メソッドを実装する際に、そのオーバーレイを配置するために必要です。 |
| fromDivPixelToLatLngAsync(pixel, callback) |
GLatLng |
ドラッグ可能な地図を含む DIV のピクセル座標から、地理的座標を計算します。このメソッドは、カスタム オーバーレイとの対話的な操作を実装する際に必要です。 |
| fromContainerPixelToLatLngAsync(pixel, callback) |
GLatLng |
ページ上に地図を含む DOM 要素内で、ピクセル座標で指定された地点を、地理的座標で計算します。カスタム コントロールと地図との対話的な操作を実装する際に、このメソッドが必要です。 |
イベント
| イベント |
引数 |
説明 |
| addmaptype |
type |
このイベントは、地図にマップ タイプが追加されると発生します。 |
| removemaptype |
type |
このイベントは、地図からマップ タイプが削除されると発生します。 |
| click |
overlay, point
|
このイベントは、地図をマウスでクリックすると発生します。マーカーをクリックすると、マーカーが overlay 引数でイベント ハンドラに渡され、マーカーに対する click イベントも発生します。それ以外の地点をクリックすると、クリックした地点の地理的座標が point 引数で渡されます。 |
| dblclick |
overlay, point
|
このイベントは、地図上でダブルクリックすると発生します。マーカーをダブルクリックした場合は、このイベントは発生しません。ダブルクリックした地点の地理的座標が point 引数で渡されます。overlay 引数は常に null に設定されます。(2.83 以降) |
| movestart |
該当なし |
このイベントは、マップ ビューの変更が開始されると発生します。これはドラッグによって発生する可能性があり、その場合は dragstart イベントも発生します。または、マップ ビューを変更するメソッドの起動によって発生する可能性があります。 |
| moveend |
該当なし |
このイベントは、マップ ビューの変更が終わると発生します。 |
| zoomend |
oldLevel, newLevel
|
このイベントは、地図が新しいズーム レベルになると発生します。イベント ハンドラは、以前のズーム レベルと新しいズーム レベルを引数として受け取ります。 |
| maptypechanged |
該当なし |
このイベントは、別のマップ タイプが選択されると発生します。 |
| infowindowopen |
該当なし |
このイベントは情報ウィンドウが表示されると発生します。 |
| infowindowclose |
該当なし |
このイベントは情報ウィンドウが閉じると発生します。このイベントの前に、イベント infowindowbeforeclose が発生します。openInfoWindow*() に対する別の呼び出しを使用して、現在表示されている情報ウィンドウが別の地点で再度表示された場合は、イベント infowindowbeforeclose、infowindowclose、infowindowopen が順に発生します。 |
| addoverlay |
overlay |
このイベントは、メソッド addOverlay() によって地図にオーバーレイが 1 つ追加されると発生します。新しいオーバーレイが引数 overlay としてイベント ハンドラに渡されます。 |
| removeoverlay |
overlay |
このイベントは、メソッド removeOverlay() によってオーバーレイが 1 つ削除されると発生します。削除されたオーバーレイが引数 overlay としてイベント ハンドラに渡されます。 |
| clearoverlays |
該当なし |
このイベントは、メソッド clearOverlays() によってすべてのオーバーレイが一度に削除されると発生します。 |
| dragstart |
該当なし |
このイベントは、ユーザーが地図のドラッグを開始すると発生します。 |
| dragend |
該当なし |
このイベントは、ユーザーが地図のドラッグを終了すると発生します。 |
class GInfoWindow
GInfoWindow にはコンストラクタがありません。地図によって生成され、そのメソッド GMap2.getInfoWindowAsync(callback: Function) によってアクセスされます。
非同期メソッド
| 非同期メソッド |
コールバック値 |
説明 |
| selectTab(index) |
該当なし |
指定されたインデックスを持つタブを選択します。相当するタブをクリックするのと同様の効果があります。 |
| hide() |
該当なし |
情報ウィンドウを非表示にします。注: 情報ウィンドウは閉じません。show() を使用して再度表示できます。 |
| show() |
該当なし |
情報ウィンドウが現在非表示になっている場合は表示します。 |
| isHiddenAsync() |
Boolean |
情報ウィンドウが非表示の場合に、true を返します。閉じている情報ウィンドウは非表示になっていると見なされます。 |
| reset(point, tabs, size, offset?, selectedTab?) |
該当なし |
情報ウィンドウの状態をリセットします。各引数を null に指定すると、現在の値は変更されません。 |
| getPointAsync() |
GLatLng |
情報ウィンドウが固定されている地理的位置を返します。ピクセル オフセットに基づいて、ウィンドウの先端が地図上のこの地点を指します。 |
| getPixelOffsetAsync() |
GSize |
情報ウィンドウが固定されている地理座標の地図上の地点を基準とした、情報ウィンドウの先端までのオフセットをピクセル単位で返します。 |
| getSelectedTabAsync() |
Number |
現在選択されているタブの 0 から始まるインデックスを返します。 |
イベント
| イベント |
引数 |
説明 |
| closeclick |
該当なし |
このイベントは情報ウィンドウの [閉じる] ボタンがクリックされると発生します。このイベントのイベントハンドラは、GMap2.closeInfoWindow() メソッドを呼び出すことにより、情報ウィンドウを閉じることを実装できます。 |
class GInfoWindowTab
このクラスのインスタンスの配列は、tabs 引数としてメソッド GMap2.openInfoWindowTabs()、GMap2.openInfoWindowTabsHtml()、GMarker.openInfoWindowTabs()、GMarker.openInfoWindowTabsHtml() と、bindInfoWindow*() のバリアントに渡すことができます。配列に複数の要素が含まれる場合は、タブ付き情報ウィンドウが表示されます。すべての InfoWindowTab オブジェクトには、2 つのアイテムが含まれます。content は、タブが選択されたときに表示される情報ウィンドウのコンテンツを定義します。label はタブのラベルを定義します。プロパティは引数としてコンストラクタに渡されます。openInfoWindowTabs() メソッドでは、content は DOM ノードです。メソッド openInfoWindowTabsHtml() では、content は HTML テキストを含む文字列です。
コンストラクタ
| コンストラクタ |
説明 |
| GInfoWindowTab(label, content) |
情報ウィンドウのタブのデータ構造を作成します。このデータ構造は tabs 引数で openInfoWindowTabs*() メソッドに渡すことができます。 |
class GInfoWindowOptions
このクラスのインスタンスは、クラス opts? と openInfoWindow() のメソッド openInfoWindowHtml()、openInfoWindowTabs()、openInfoWindowTabsHtml()、bindInfoWindow*()、showMapBlowup()、GMap2 に対する GMarker 引数で使用されます。このクラスにコンストラクタはありません。代わりに、このクラスは javascript オブジェクト リテラルとしてインスタンス化されます。
プロパティ
このクラス名が示すとおり、すべてのプロパティは省略可能です。
| プロパティ |
タイプ |
説明 |
| disableGoogleLinks |
Boolean |
情報ウィンドウの下部に自動的に表示される、道路ルートとローカル検索の Google リンクを非表示にします。
|
| selectedTab |
Number |
最初のタブ (インデックス 0) の代わりに、指定されたインデックス (0 から始まる) を持つタブを選択します。 |
| maxWidth |
Number |
情報ウィンドウのコンテンツの最大幅 (ピクセル単位)。 |
| zoomLevel |
Number |
showMapBlowup() にのみ関連。情報ウィンドウ内の詳細地図のズーム レベル。 |
| mapType |
GMapType |
showMapBlowup() にのみ関連。情報ウィンドウ内の詳細地図のマップ タイプ。 |
class GMarker
GMarker は地図上に位置をマークします。これは、GOverlay インターフェースを実装するので、GMap2.addOverlay() メソッドを使用して地図に追加されます。
マーカー オブジェクトには、point マーカーが地図上に固定される地理的位置と icon があります。icon がコンストラクタで設定されていない場合は、デフォルトのアイコン G_DEFAULT_ICON が使用されます。
地図に追加されると、マーカーから地図の情報ウィンドウを開くことができるようになります。マーカー オブジェクトはマウス イベントと情報ウィンドウイベントを発行します。
コンストラクタ
| コンストラクタ |
説明 |
| GMarker(point, icon?, inert?) |
GPoint または GLatLng の渡された point に、icon または G_DEFAULT_ICON を使用してマーカーを作成します。inert フラグが true である場合は、マーカーはクリック不可能でイベントは発生しません。(2.50 以降非推奨) |
| GMarker(latlng, opts?) |
latlng に GMarkerOptions で指定されているオプションを使用してマーカーを作成します。(2.50 以降) |
非同期メソッド
これらのメソッドを起動する前に、マーカーが地図に追加されている必要があります。
| 非同期メソッド |
コールバック値 |
説明 |
| openInfoWindow(content, opts?) |
該当なし |
地図の情報ウィンドウをマーカーのアイコン上に表示します。情報ウィンドウのコンテンツは DOM ノードとして指定されます。使用可能なオプションは GInfoWindowOptions.maxWidth だけです。 |
| openInfoWindowHtml(content, opts?) |
該当なし |
地図の情報ウィンドウをマーカーのアイコン上に表示します。情報ウィンドウのコンテンツは HTML テキストを含む文字列として指定されます。使用可能なオプションは GInfoWindowOptions.maxWidth だけです。 |
| openInfoWindowTabs(tabs, opts?) |
該当なし |
タブ付き情報ウィンドウをマーカーのアイコン上に表示します。情報ウィンドウのコンテンツは、DOM ノードをタブのコンテンツとして含むタブの配列で指定されます。使用可能なオプションは、GInfoWindowOptions.maxWidth と InfoWindowOptions.selectedTab だけです。 |
| openInfoWindowTabsHtml(tabs, opts?) |
該当なし |
タブ付き情報ウィンドウをマーカーのアイコン上に表示します。情報ウィンドウのコンテンツは、HTML テキストを含む文字列をコンテンツとして含むタブの配列として指定されます。使用可能なオプションは、InfoWindowOptions.maxWidth と InfoWindowOptions.selectedTab だけです。 |
| bindInfoWindow(content, opts?) |
該当なし |
指定された DOM ノードをこのマーカーにバインドします。このコンテンツは、マーカーがクリックされたときに自動的に情報ウィンドウに表示されます。content を null として渡すと、バインドが解除されます。 |
| bindInfoWindowHtml(content, opts?) |
該当なし |
指定された HTML をこのマーカーにバインドします。このコンテンツは、マーカーがクリックされたときに自動的に情報ウィンドウに表示されます。content を null として渡すと、バインドが解除されます。 |
| bindInfoWindowTabs(tabs, opts?) |
該当なし |
指定されたタブをこのマーカーにバインドします。このコンテンツは、マーカーがクリックされたときに自動的に情報ウィンドウに表示されます。content を null として渡すと、バインドが解除されます。 |
| bindInfoWindowTabsHtml(tabs, opts?) |
該当なし |
指定されたタブをこのマーカーにバインドします。このコンテンツは、マーカーがクリックされたときに自動的に情報ウィンドウに表示されます。content を null として渡すと、バインドが解除されます。 |
| closeInfoWindow() |
該当なし |
このマーカーに属している場合に、情報ウィンドウを閉じます。 |
| showMapBlowup(opts?) |
該当なし |
地図の情報ウィンドウをマーカーのアイコン上に表示します。情報ウィンドウのコンテンツはマーカー地点周辺の詳細地図です。使用可能なオプションは、InfoWindowOptions.zoomLevel と InfoWindowOptions.mapType だけです。 |
| getIconAsync(callback) |
GIcon |
コンストラクタの設定どおりに、このマーカーの icon を返します。 |
| getPointAsync(callback) |
GLatLng |
コンストラクタまたは setPoint() の設定に従って、このマーカーが固定されている地点の地理的座標を返します。 |
| setPoint(point) |
該当なし |
マーカーが固定される地点の地理座標を設定します。 |
| enableDragging() |
該当なし |
地図上でのマーカーのドラッグ アンド ドロップを有効にします。機能させるには、マーカーが GMarkerOptions.draggable = true で初期化されている必要があります。 |
| disableDragging() |
該当なし |
地図上でのマーカーのドラッグ アンド ドロップを無効にします。 |
| draggableAsync(callback) |
Boolean |
マーカーがドラッグ可能な場合に true を返します。 |
| draggingEnabledAsync(callback) |
Boolean |
マーカーに対してドラッグ操作が有効になっている場合に true を返します。 |
| setImage(url) |
該当なし |
url で指定された画像を、このマーカーの前面の画像として設定するようにリクエストします。印刷画像も影の画像も調整されないことに注意してください。したがって、このメソッドは、マーカーの見た目を大幅に変更するというよりは、ハイライト表示または淡色表示効果を実装することを目的としています。(2.75 以降) |
| hide() |
該当なし |
マーカーが現在表示されている場合に、非表示にします。マーカーが現在表示されている場合は、この関数はイベント GMarker.visibilitychanged をトリガするのでご注意ください。(2.77 以降) |
| show() |
該当なし |
マーカーが現在非表示の場合に、表示します。マーカーが現在非表示になっている場合は、この関数はイベント GMarker.visibilitychanged をトリガするのでご注意ください。(2.77 以降) |
| isHiddenAsync(callback) |
Boolean |
マーカーが現在非表示になっている場合に true を返します。それ以外の場合は false を返します。(2.77 以降) |
イベント
これらのイベントはすべて、マーカーが inert でない場合にのみ発生します (コンストラクタを参照)。
| イベント |
引数 |
説明 |
| click |
該当なし |
このイベントは、マーカー アイコンがクリックされると発生します。マーカーが最初の引数としてイベントハンドラに渡されると、このイベントは地図に対しても発生します。 |
| dblclick |
該当なし |
このイベントは、マーカー アイコンがダブルクリックされると発生します。地図では、ダブルクリックを組み込みの動作として主に使用するため、このイベントは地図に対しては発生しないことに注目してください。 |
| infowindowopen |
該当なし |
このイベントは地図の情報ウィンドウがこのマーカーから開かれると発生します。 |
| infowindowclose |
該当なし |
このイベントは、マーカーから開かれた地図の情報ウィンドウが閉じられると発生します。情報ウィンドウが閉じられたか、別のマーカーや地図上で開かれた場合に発生します。このイベントの前に、イベント infowindowbeforeclose が発生します。 |
| 削除 |
該当なし |
このイベントは、GMap2.removeOverlay() または GMap2.clearOverlays() を使用して地図からマーカーが削除されると発生します。 |
| dragstart |
該当なし |
マーカーのドラッグ操作が有効な場合は、マーカーのドラッグが開始されるとこのイベントが発生します。 |
| dragend |
該当なし |
マーカーのドラッグ操作が有効な場合は、マーカーのドラッグが終了するとこのイベントが発生します。 |
| visibilitychanged |
isVisible |
このイベントは、マーカーの表示が変わる、つまり表示から非表示、またはその反対に切り替わると発生します。isVisible は、表示変更後のマーカーの状態を指定します。(2.77 以降) |
class GMarkerOptions
このクラスのインスタンスは opts? クラスのコンストラクタに対する GMarker 引数で使用されます。このクラスにコンストラクタはありません。代わりに、このクラスは javascript オブジェクト リテラルとしてインスタンス化されます。
プロパティ
このクラス名が示すとおり、すべてのプロパティは省略可能です。
| プロパティ |
タイプ |
説明 |
| icon |
GIcon |
このクラスにアイコンを選択します。指定されない場合は、G_DEFAULT_ICON が使用されます。(2.50 以降) |
| dragCrossMove |
Boolean |
マーカーをドラッグすると、マーカーが浮き上がってカーソルから離れます。この値を true に設定すると、マーカーをカーソルの下に維持し、代わりにクロスを下に移動します。このオプションのデフォルト値は、false です。(2.63 以降) |
| title |
文字列 |
この文字列はマーカー上にツールチップとして表示されます。つまり、HTML 要素の title 属性のように機能します。(2.50 以降) |
| clickable |
Boolean |
マーカーがクリック可能かどうかを切り替えます。クリック不可能またはドラッグ不可能なマーカーは inert で、消費するリソースが少なく、イベントに応答しません。このオプションのデフォルト値は true です。つまり、このオプションが指定されていない場合は、マーカーはクリック可能です。(2.50 以降) |
| draggable |
Boolean |
マーカーがドラッグ可能かどうかを切り替えます。ドラッグできるように設定されたマーカーは、クリック可能なマーカーよりもその設定に多くのリソースを必要とします。ドラッグ可能なマーカーは、すべてクリックも可能であり、デフォルトでバウンドします。このオプションのデフォルト値は、false です。(2.61 以降) |
| bouncy |
Boolean |
ドラッグ終了後にマーカーがバウンドするかどうかを切り替えます。このオプションのデフォルト値は、false です。(2.61 以降) |
| bounceGravity |
Number |
この数値は、ドラッグ終了時に、バウンドして地面に着地する間のマーカーの加速率を定義するのに使用されます。このオプションのデフォルト値は、1 です。(2.61 以降) |
class GPolyline
これは、ブラウザのベクター描画機能が使用可能な場合に、この機能を使用して地図上にポリラインを描く地図のオーバーレイ、または、Google サーバーからの画像のオーバーレイです。
コンストラクタ
| コンストラクタ |
説明 |
| GPolyline(points, color?, weight?, opacity?, opts?) |
頂点の配列からポリラインを作成します。color は、HTML 方式の 16 進数で表した色 (#RRGGBB) を含む文字列として指定されます。weight はピクセル単位の線の幅です。opacity は、0～1 の数値で指定されます。線はアンチエイリアスされて半透明になります。 |
非同期メソッド
| 非同期メソッド |
コールバック値 |
説明 |
| getVertexCountAsync(callback) |
Number |
ポリラインの頂点の数を返します。(2.46 以降) |
| getVertexAsync(index, callback) |
GLatLng |
ポリラインに指定されているインデックスに対応する頂点を返します。(2.46 以降) |
| getLengthAsync(callback) |
Number |
球面大地表面に沿ったポリラインの長さ (単位 m) を返します。(2.85 以降) |
| getBoundsAsync(callback) |
GLatLngBounds |
このポリラインの境界を返します。(2.85 以降) |
イベント
| イベント |
引数 |
説明 |
| 削除 |
該当なし |
このイベントは、GMap2.removeOverlay() または GMap2.clearOverlays() を使用して地図からポリラインが削除されると発生します。 |
class GPolylineOptions
このクラスのインスタンスは GPolyline のコンストラクタで使用されます。このクラスにコンストラクタはありません。代わりに、このクラスは javascript オブジェクト リテラルとしてインスタンス化されます。
プロパティ
このクラス名が示すとおり、すべてのプロパティは省略可能です。
| プロパティ |
タイプ |
説明 |
| geodesic |
Boolean |
ポリラインの各辺を測地線として表示します。これは、球面大地に沿った 2 地点間の最短経路です。
|
class GPolygon
これは GPolyline によく似ていますが、それに加えて塗りつぶす色と透明度を指定することができます。
コンストラクタ
| コンストラクタ |
説明 |
| GPolygon(points, strokeColor?, strokeWeight?, strokeOpacity?, fillColor?, fillOpacity?) |
頂点の配列からポリゴンを作成します。colors は HTML 方式の 16 進数で表した色 (#RRGGBB) を含む文字列として指定されます。weight はピクセル単位の線の幅です。opacities は、0～1 の数値で指定されます。線はアンチエイリアスされて半透明になります。(2.69 以降) |
非同期メソッド
| 非同期メソッド |
コールバック値 |
説明 |
| getVertexCountAsync(callback) |
Number |
ポリゴンの頂点の数を返します。(2.69 以降) |
| getVertexAsync(index, callback) |
GLatLng |
ポリゴンに指定されているインデックスに対応する頂点を返します。(2.69 以降) |
| getAreaAsync(callback) |
Number |
球面大地を前提としたポリゴンの面積 (単位平方メートル) を返します。(2.46 以降) |
| getBoundsAsync(callback) |
GLatLngBounds |
このポリゴンの境界を返します。(2.85 以降) |
イベント
| イベント |
引数 |
説明 |
| 削除 |
該当なし |
このイベントは、GMap2.removeOverlay() または GMap2.clearOverlays() を使用して地図からポリゴンが削除されると発生します。 |
class GGroundOverlay
このオブジェクトは地図上に矩形の画像オーバーレイを作成します。境界は GLatLngBounds で定義されます。
コンストラクタ
| コンストラクタ |
説明 |
| GGroundOverlay(imageUrl, bounds) |
|
class GIcon
アイコンは、GMarker を地図上に表示するのに使用する画像を指定します。ブラウザの互換性の理由から、アイコンの指定はかなり複雑です。独自のアイコンを指定しない場合は、デフォルトの Maps アイコン G_DEFAULT_ICON を使用できます。
コンストラクタ
| コンストラクタ |
説明 |
| GIcon(copy?, image?) |
新しいアイコンオブジェクトを作成します。別のアイコンがオプションの copy 引数に指定されると、そのプロパティがコピーされます。指定されない場合は空のままです。省略可能な引数 image は image プロパティの値を設定します。 |
定数
| 定数 |
説明 |
| G_DEFAULT_ICON |
マーカーが使用するデフォルトのアイコン。 |
プロパティ
| プロパティ |
タイプ |
説明 |
| image |
文字列 |
アイコンの前面の画像の URL。 |
| shadow |
文字列 |
アイコンの影の画像の URL。 |
| iconSize |
GSize |
アイコンの前面の画像のピクセル単位のサイズ。 |
| shadowSize |
GSize |
影の画像のピクセル単位のサイズ。 |
| iconAnchor |
GPoint |
アイコン画像左上隅を基準とした、アイコンが地図に固定される場所のピクセル座標。 |
| infoWindowAnchor |
GPoint |
アイコン画像左上隅を基準とした、情報ウィンドウがこのアイコンに固定される場所のピクセル座標。 |
| printImage |
文字列 |
印刷地図に使用されるアイコンの前面の画像の URL。image で指定されているメイン アイコン画像と同じサイズである必要があります。 |
| mozPrintImage |
文字列 |
Firefox/Mozilla の印刷地図に使用されるアイコンの前面の画像の URL。image で指定されているメイン アイコン画像と同じサイズである必要があります。 |
| printShadow |
文字列 |
印刷地図に使用される影の画像の URL。ほとんどのブラウザでは PNG 画像を印刷できないので、GIF 画像にする必要があります。 |
| transparent |
文字列 |
Internet Explorer のクリック イベントの捕捉に使用されるアイコン前面の画像の仮想的な透明バージョンの URL。この画像は、メイン アイコン画像の不透明度 1% の 24 ビット PNG バージョンである必要があります。ただし、形状とサイズはメイン アイコンと同じです。 |
| imageMap |
数値配列 |
Internet Explorer 以外のブラウザで、アイコン画像のクリック可能な部分を指定するのに使用する、画像マップの x/y 座標を示す整数の配列。 |
| maxHeight |
整数値 |
ドラッグされたときにマーカーが目に見えて「上がる」距離をピクセル単位で指定します。(2.79 以降) |
| dragCrossImage |
文字列 |
アイコンがドラッグされると表示される、クロス画像の URL を指定します。(2.79 以降) |
| dragCrossSize |
GSize |
アイコンがドラッグされると表示される、クロス画像のサイズをピクセル単位で指定します。(2.79 以降) |
| dragCrossAnchor |
GPoint |
アイコンがドラッグされると表示される、クロス画像のピクセル座標オフセット (iconAnchor に関連する) を指定します。(2.79 以降) |
class GPoint
GPoint はピクセル座標で地図上の地点を表します。v2 では、このクラスで地球上の地点の地理座標を表すことがなくなりました。地理座標は現在 GLatLng で表されます。
地図座標系では、x 座標は左方向に、y 座標は下方向に増加します。
GPoint の 2 つのパラメータがプロパティ x や y としてアクセス可能な場合は、このパラメータを変更せずに、別のパラメータを使用して新しいオブジェクトを作成することをお勧めします。
コンストラクタ
| コンストラクタ |
説明 |
| GPoint(x, y) |
GPoint オブジェクトを作成します。 |
プロパティ
| プロパティ |
タイプ |
説明 |
| x |
Number |
x 座標、左方向に増加します。 |
| y |
Number |
y 座標、下方向に増加します。 |
メソッド
| メソッド |
戻り値 |
説明 |
| equals(other) |
Boolean |
他の地点と座標が同じ場合に、true を返します。 |
| toString() |
文字列 |
x 座標と y 座標を、この順にカンマで区切られた文字列として返します。 |
class GSize
GSize は地図の矩形領域のピクセル単位のサイズです。サイズ オブジェクトには、2 つのパラメータ width と height があります。width は 2 つの地点の x 座標の差分、height は y 座標の差分です。
GSize の 2 つのパラメータがプロパティ width や height としてアクセス可能な場合は、このパラメータを変更せずに、別のパラメータを使用して新しいオブジェクトを作成することをお勧めします。
コンストラクタ
| コンストラクタ |
説明 |
| GSize(width, height) |
GSize オブジェクトを作成します。 |
プロパティ
| プロパティ |
タイプ |
説明 |
| width |
Number |
width パラメータ。 |
| height |
Number |
height パラメータ。 |
メソッド
| メソッド |
戻り値 |
説明 |
| equals(other) |
Boolean |
他のサイズ オブジェクトの持つコンポーネントとまったく等しい場合に、true を返します。 |
| toString() |
文字列 |
width と height パラメータを、この順にカンマで区切られた文字列として返します。 |
class GBounds
GBounds はピクセル座標で表した地図の矩形領域です。地理座標での矩形領域は、GLatLngBounds オブジェクトによって表されます。
コンストラクタ
| コンストラクタ |
説明 |
| GBounds(points) |
指定されたすべての points を網羅する矩形領域を構築します。 |
プロパティ
| プロパティ |
タイプ |
説明 |
| minX |
Number |
矩形の左辺の x 座標。 |
| minY |
Number |
矩形の上辺の y 座標。 |
| maxX |
Number |
矩形の右辺の x 座標。 |
| maxY |
Number |
矩形の下辺の y 座標。 |
メソッド
| メソッド |
戻り値 |
説明 |
| toString() |
文字列 |
矩形領域の左上の頂点と右下の頂点の座標を、この順にカンマで区切られ、かっこで囲まれた文字列として返します。 |
| min() |
GPoint |
ボックスの左上角の地点。 |
| max() |
GPoint |
ボックスの右下角の地点。 |
| containsBounds(other) |
Boolean |
他のボックスがこのボックス内に完全に含まれている場合は、true を返します。 |
| extend(point) |
該当なし |
指定された地点がこの矩形領域にも含まれるように、矩形領域を拡大します。 |
| intersection(other) |
GBounds |
このボックスが他のボックスと重なっている部分のボックスを返します。重なっている部分がない場合は、空のボックスを返します。 |
class GLatLng
GLatLng は地点の地理座標 (経緯度) です。
通常のマップ投影は、経度を地図の x 座標に、緯度を y 座標に関連付けますが、地図製作での慣習に従って常に緯度座標、経度座標の順に記載します。
また、GLatLng の座標を変更できないことにも注意してください。別の地点を算出する場合は、新たに作成する必要があります。
コンストラクタ
| コンストラクタ |
説明 |
| GLatLng(lat, lng, unbounded?) |
緯度と経度の順序に注意します。unbounded フラグが true の場合は、数値は渡されたままの値として使用されますが、そうでない場合は、緯度は -90 度～ +90 度の間に収まるように制限され、経度は -180 度～ +180 度の間に収まるように必要に応じて逆回りで測定されます。 |
メソッド
| メソッド |
戻り値 |
説明 |
| lat() |
Number |
緯度座標を -90 ～ +90 の間の数値として度単位で返します。unbounded フラグがコンストラクタで設定された場合は、座標の値がこの範囲外になる可能性があります。 |
| lng() |
Number |
経度座標を -180 ～ +180 の間の数値として度単位で返します。unbounded フラグがコンストラクタで設定された場合は、座標の値がこの範囲外になる可能性があります。 |
| latRadians() |
Number |
緯度座標を -PI/2 ～ +PI/2 の間の数値としてラジアン単位で返します。unbounded フラグがコンストラクタで設定された場合は、座標の値がこの範囲外になる可能性があります。 |
| lngRadians() |
Number |
経度座標を -PI ～ +PI の間の数値としてラジアン単位で返します。unbounded フラグがコンストラクタで設定された場合は、座標の値がこの範囲外になる可能性があります。 |
| equals(other) |
Boolean |
他のサイズのオブジェクトが持つコンポーネントと、丸め誤差の範囲で等しい場合に、true を返します。 |
| distanceFrom(other) |
Number |
この地点から指定の地点までの距離をメートル単位で返します。地球を球形として概算するので、距離には最大 0.3% の誤差が生じます。 |
| toUrlValue() |
文字列 |
このメソッドは、改定バージョン (下記参照) が出たために非推奨になりました。新しいバージョンではオプションの precision パラメータが渡されます。(2.78 以降非推奨) |
| toUrlValue(precision?) |
文字列 |
URL パラメータ値として使用するのに適した形式 (カンマ区切り、空白なし) で、この地点を表す文字列を返します。デフォルトでは、精度は 6 桁で返されます。これは 11 cm (4 インチ) の解像度に相当します。オプションの precision パラメータを使用すると、さらに低い精度を指定してサーバーの負荷を減らすことができます。注: 2.78 より前のバージョンでは、この
precision パラメータは使用できませんでした。(2.78 以降) |
プロパティ
これらのプロパティは、v1 のイベント ハンドラの関数との下位互換性のためだけに存在します。使用しないでください。
これらのプロパティは lng() と lat() のアクセサ メソッドの戻り値を反映し、v1 クライアントで GLatLng が予想される場所に GPoint を表示できるようにします。これは、GLatLng がイベントの詳細 (イベント ハンドラの関数の引数) に表示される場合に必要です。メソッドのラッパーとは対照的に、現在の基盤ではイベントのラッパーを作成することはできません。
| プロパティ |
タイプ |
説明 |
| x |
Number |
非推奨。 |
| y |
Number |
非推奨。 |
class GLatLngBounds
GLatLngBounds インスタンスは、地理座標で矩形領域を表します。180 度の子午線を超えるものも含まれます。
コンストラクタ
| コンストラクタ |
説明 |
| GLatLngBounds(sw?, ne?) |
南西と北東の 2 つの頂点から矩形を構築します。 |
メソッド
| メソッド |
戻り値 |
説明 |
| equals(other) |
Boolean |
この矩形のすべてのパラメータが他の矩形のパラメータと、丸め誤差の範囲で等しい場合に、true を返します。 |
| contains(latlng) |
Boolean |
地理座標で表した地点がこの矩形内にある場合に、true を返します。 |
| intersects(other) |
Boolean |
名前の示すとおりです。 |
| containsBounds(other) |
Boolean |
名前の示すとおりです。 |
| extend(latlng) |
該当なし |
指定された地点を含むようにこの矩形を拡大します。経度方向に拡大する 2 つの方法のうち、領域が小さくなる方法で拡大されます。どちらを使用しても等しくなる場合は、東側に拡大されます。 |
| getSouthWest() |
GLatLng |
矩形の南西の頂点の位置を返します。 |
| getNorthEast() |
GLatLng |
矩形の北東の頂点の位置を返します。 |
| toSpan() |
GLatLng |
矩形のサイズを表す座標を含む GLatLng を返します。 |
| isFullLat() |
Boolean |
矩形領域が南極から北極まで覆う場合に、true を返します。 |
| isFullLng() |
Boolean |
矩形領域が、経度方向に地球を完全に一周している場合に、true を返します。 |
| isEmpty() |
Boolean |
この矩形領域が空の場合は true を返します。 |
| getCenter() |
GLatLng |
矩形領域の中心地点を返します。(2.52 以降) |
class GTileLayer
このクラスは、タイル リクエストごとに拡張されたタイル URL テンプレートを受け取ります。たとえば 'http://host/tile?x={X}&y={Y}&z={Z}.png', を受け取り、'http://host/tile?x=3&y=27&z=5.png'. などに変換します。「ズーム」を意味する {Z} の代わりに、「Maps API バージョン 1 の命名規則を使用してズーム」を意味する {V1_Z} を使用できます。17 を指定すると最大限に縮小表示され（世界中が 1 個のタイルに収まります）、0 を指定すると街路レベルまで拡大されます。実質的に {V1_Z} = 17 - {Z} という関係になります。
コンストラクタ
| コンストラクタ |
説明 |
| GTileLayer(null, minResolution, maxResolution, opts) |
opts.tileUrlTemplate は、上記のとおり、有効な URL テンプレートである必要があります。 |
class GTileLayerOverlay
GTileLayerOverlay は GTileLayer で地図を補強します。これは、GOverlay インターフェースを実装するので、GMap2.addOverlay() メソッドを使用して地図に追加されます。
コンストラクタ
| コンストラクタ |
説明 |
| GTileLayerOverlay(tileLayer) |
GTileLayerOverlay をラップする tileLayer を作成します。(2.61 以降) |
非同期メソッド
| 非同期メソッド |
コールバック値 |
説明 |
| hide() |
該当なし |
このオーバーレイを見えないように非表示にしますが、オーバーレイのスタック内の位置は維持します。(2.71 以降) |
| show() |
該当なし |
以前に非表示にされた TileLayerOverlay を表示します。(2.71 以降) |
| getTileLayerAsync() |
該当なし |
このオーバーレイに使われたタイル レイヤーを返します。(2.83 以降) |
namespace GEvent
この名前空間には、カスタム イベントと DOM イベントの両方でイベント ハンドラの登録とカスタム イベントの生成に使用する関数が含まれています。この API で定義されたイベントはすべて GEvent.trigger() によって内部で生成されたカスタム イベントです。
静的メソッド
| 静的メソッド |
戻り値 |
説明 |
| addListener(source, event, handler) |
GEventListener |
ソース オブジェクト上のカスタム イベントのイベント ハンドラを登録します。最終的にハンドラを登録解除するために使用できるハンドルを返します。イベント ハンドラは、this セットとともにソース オブジェクトに呼び出されます。 |
| addDomListener(source, event, handler) |
GEventListener |
ソース オブジェクト上の DOM イベントのイベント ハンドラを登録します。ソース オブジェクトは DOM ノードである必要があります。最終的にハンドラを登録解除するために使用できるハンドルを返します。イベント ハンドラは、this セットとともにソース オブジェクトに呼び出されます。この関数は、現在のブラウザの DOM メソッドを使用してイベント ハンドラを登録します。 |
| removeListener(handle) |
該当なし |
addListener() または addDomListener() を使用して、インストールされたハンドラを削除します。 |
| clearListeners(source, event) |
該当なし |
addListener() または addDomListener() を使用してインストールされた、指定されたイベントの指定されたオブジェクト上のハンドラをすべて削除します。 |
| clearInstanceListeners(source) |
該当なし |
addListener() または addDomListener() を使用してインストールされた、すべてのイベントの指定されたオブジェクト上のハンドラをすべて削除します。 |
| trigger(source, event, ...) |
該当なし |
ソース オブジェクト上のカスタム イベントを生成します。event の後に残るオプションの引数はすべて、イベント ハンドラ関数への引数として順に渡されます。 |
| bind(source, event, object, method) |
GEventListener |
ソース オブジェクト上のカスタム イベントのイベント ハンドラとして、指定されたオブジェクト上のメソッドの起動を登録します。最終的にハンドラを登録解除するために、使用できるハンドルを返します。 |
| bindDom(source, event, object, method) |
GEventListener |
ソース オブジェクト上のカスタム イベントのイベント ハンドラとして、指定されたオブジェクト上のメソッドの起動を登録します。最終的にハンドラを登録解除するために、使用できるハンドルを返します。 |
| callback(object, method) |
関数 |
method 上で object を呼び出すクロージャを返します。 |
| callbackArgs(object, method, ...) |
関数 |
method 上で object を呼び出すクロージャを返します。method の後のオプションの引数はすべて、返された関数が起動すると、引数 method として順に渡されます。 |
イベント
| イベント |
引数 |
説明 |
| clearlisteners |
event? |
オブジェクト上で clearListeners() または clearInstanceListeners() が呼び出されると、そのオブジェクト上でこのイベントが発生します。もちろん、イベントは関数が実行される前に発生します。 |
class GEventListener
このクラスは不透明です。メソッドもコンストラクタもありません。インスタンスは、GEvent.addListener() または GEvent.addDomListener() から返され、最終的に GEvent.removeListener() に戻されます。
enum GGeoStatusCode
各記号定数の対応する数値は、かっこに入れて指定します。
定数
| 定数 |
説明 |
| G_GEO_SUCCESS (200) |
エラーは発生しませんでした。住所は正常に解析され、ジオコードが返されました。(2.55 以降) |
| G_GEO_BAD_REQUEST (400) |
ルート リクエストを正常に解析できませんでした。(2.81 以降) |
| G_GEO_SERVER_ERROR (500) |
ジオコーディングまたはルート リクエストを正常に処理できませんでした。失敗の正確な理由は不明です。(2.55 以降) |
| G_GEO_MISSING_QUERY (601) |
HTTP q パラメータは、見つからないか値がありませんでした。ジオコーディング リクエストの場合、空の住所が入力指定されたことを意味します。ルート リクエストの場合、クエリが入力指定されていなかったことを意味します。(2.81 以降) |
| G_GEO_MISSING_ADDRESS (601) |
G_GEO_MISSING_QUERY の同義語。(2.55 以降) |
| G_GEO_UNKNOWN_ADDRESS (602) |
指定された住所の対応する地理的位置が見つかりませんでした。これは、住所が比較的新しいか、正しくないことが原因である可能性があります。(2.55 以降) |
| G_GEO_UNAVAILABLE_ADDRESS (603) |
法的または契約的理由により、指定された住所のジオコードまたは指定されたルートクエリの経路を返せません。(2.55 以降) |
| G_GEO_UNKNOWN_DIRECTIONS (604) |
GDirections オブジェクトが、クエリで指定された地点間のルートを計算できませんでした。これは、通常、2 つの地点間の経路が入手できなかったり、その地域の経路選択データがないことが理由です。(2.81 以降) |
| G_GEO_BAD_KEY (610) |
指定されたキーが無効であるか、指定されたドメインと一致しません。(2.55 以降) |
enum GGeoAddressAccuracy
この列挙に対して定義された記号定数はありません。
定数
| 定数 |
説明 |
| 0 |
不明な場所。(2.59 以降) |
| 1 |
国レベルの精度。(2.59 以降) |
| 2 |
地域 (州、省、県など) レベルの精度。(2.59 以降) |
| 3 |
準地域 (郡、市区町村など) レベルの精度。(2.59 以降) |
| 4 |
町 (番地) レベルの精度。(2.59 以降) |
| 5 |
郵便番号レベルの精度。(2.59 以降) |
| 6 |
通りレベルの精度。(2.59 以降) |
| 7 |
交差点レベルの精度。(2.59 以降) |
| 8 |
住所レベルの精度。(2.59 以降) |
class GClientGeocoder
このクラスは、Google サーバーと直接通信して、ユーザーが指定した住所のジオコードを取得するために使用します。さらに、ジオコーダは住所の独自のキャッシュを維持するため、サーバーへの問い合わせなしに繰り返し行われるクエリに回答できます。
コンストラクタ
| コンストラクタ |
説明 |
| GClientGeocoder() |
Google サーバーと直接通信する、ジオコーダの新しいインスタンスを作成します。(2.55 以降) |
非同期メソッド
| 非同期メソッド |
コールバック値 |
説明 |
| getLatLngAsync(address, callback) |
GLatLng |
指定された住所をジオコード化するために、Google サーバーにリクエストを送信します。住所が正常に特定できると、GLatLng 地点でユーザーが指定したコールバック関数が起動します。特定できない場合、コールバック関数は null 地点を取得します。あいまいな住所の場合、最も一致する地点のみがコールバック関数に渡されます。(2.55 以降) |
| getLocationsAsync(address, callback) |
JSON |
指定された住所をジオコード化するために、Google サーバーにリクエストを送信します。応答が正常なステータスコードを含む場合、1 つ以上の Placemark オブジェクトを含む応答が、ユーザーの指定したコールバック関数に渡されます。GClientGeocoder.getLatLng メソッドとは異なり、コールバック関数は Status フィールドのコード値を調べて、失敗の理由を特定する場合があります。(2.55 以降) |
class GGeoXml
GGeoXml オブジェクトは、地理的コンテンツを公開でアクセス可能な Web サーバー上でホストされている XML ファイル（KML ファイルなど）の地図に追加します。これは、GOverlay インターフェースを実装するので、GMap2.addOverlay() メソッドを使用して地図に追加されます。
コンストラクタ
| コンストラクタ |
説明 |
| GGeoXml(urlOfXml, opt_callback) |
その XML ファイルを示す GOverlay を作成します。GGeoXml オブジェクトが XML ファイルのロードを終了すると、オプションのコールバック関数が呼び出されます。(2.76 以降) |
function GAsync
複数の非同期要求を同時に実行するユーティリティ関数です。この関数は結果を収集して、ユーザーが指定した単一のコールバックに渡します。たとえば、map の現在のズーム レベルを取得するには、point の座標変換を行い、marker の位置を取得します。
GAsync(
map, 'getZoom', 'fromContainerPixelToLatLng', [ point ],
marker, 'getPoint',
function(zoom, pointA, pointB) { ... });
非同期メソッド
| 非同期メソッド |
コールバック値 |
説明 |
| GAsync(...) |
... |
1 つ以上の非同期要求を同時に実行します。マーカー宣言のサンプル形式は、object1, methodName1 [, オプションの引数配列], methodName2 [, オプションの引数配列], object2, methodName3 [, オプションの引き引数配列], コールバックです。コールバック関数の引数でメソッド名が指定された順序で、各非同期要求の戻り値がこの関数に渡されます。
|
class GDirections
このクラスは、ルート案内結果を取得し、それを地図やテキストパネル上に表示するために使用します。
コンストラクタ
| コンストラクタ |
説明 |
| GDirections(map?) |
ルート結果をリクエストおよび保存するために、ルート オブジェクトの新しいインスタンスを作成します。このルート オブジェクトはその後、GDirections.load() メソッドを使用してクエリに答えるルートを作成できます。コンストラクタは、オプションのマップ オブジェクト（計算されたルートのポリラインを表示する）やパネル DIV 要素（テキストのルート結果を表示する）を使用します。map 引数を渡すと、新しいルート結果が計算されている場合は、結果に関連付けられたポリラインとマーカーが自動的にオーバーレイとして地図上に追加されます。Maps API の panel 引数は Mapplets API ではサポートされていません。オブジェクトは、インターセプト可能な次の 3 つのイベントを発行します。「load」: このイベントは、GDirections.load() 経由で発行されるルートクエリの結果が入手できる場合にトリガされます。注: load() メソッドは新しいクエリを開始することに注意してください。クエリがロードを終了すると順に「load」イベントをトリガします。「load」イベントは、オーバーレイ要素が地図やパネルに追加される前にトリガされます。「addoverlay」: このイベントは、ポリラインまたはテキストのルート コンポーネント、あるいはその両方が、地図または DIV 要素、あるいはその両方に追加された後にトリガされます。これらの要素のどちらも addoverlay オブジェクトに添付されていない場合、「GDirections」イベントはトリガされないことに注意してください。「error」: このイベントは、ルート リクエストでエラーが発生した場合にトリガされます。呼び出し元は、GDirections.getStatusAsync() を使用してエラーに関する詳細情報を取得できます。「error」イベントが発生したときは、「load」イベントや「addoverlay」イベントはトリガされません。(2.87 以降) |
非同期メソッド
| 非同期メソッド |
コールバック値 |
説明 |
| load(query, queryOpts?) |
該当なし |
このメソッドは新しいルート クエリを生成します。query パラメータは、「from: Seattle to: San Francisco」や「from: Toronto to: Ottawa to: New York」などの有効なルート クエリを含む文字列です。デフォルトでは、地図が GDirections オブジェクトの構築中に指定されると、クエリはポリライン結果をリクエストします。指定されない場合、結果には検出された経路の要約情報しか含まれません。この動作を変更して、このオブジェクトに地図が添付されていなかった場合でも、ポリライン情報をリクエストするために、呼び出し元はオプションの queryOpts パラメータを使用できます。詳細は、GDirectionsOptions のドキュメントを参照してください。ルート結果を受け取ると、このオブジェクトは古い結果を新しい結果で上書きして、地図を新しい結果で更新します。ルート結果は、複数の経路で構成されています（GRoute タイプのオブジェクト）。クエリで指定され経由地点/住所の連続ペアごとに 1 つです。同様に、経路も複数のステップで構成されています (GStep タイプのオブジェクト)。load() が新しく呼び出されたときに、以前の load() リクエストが完了していない場合、以前のリクエストはキャンセルされます。このため、1 つの GDirections オブジェクトを使用して複数のルート リクエストを連続的に発行できますが、複数のリクエストを同時に発行するには、複数の GDirections オブジェクトを使用する必要があります。(2.87 以降) |
| loadFromWaypoints(waypoints, queryOpts?) |
該当なし |
1 つのクエリ文字列の代わりに経由地点の配列を入力して、新しいルート クエリを発行します。配列内の各エントリは、入力住所または緯度/経度の地点を示す文字列です。このメソッドの動作の詳細については、GDirections.load() を参照してください。(2.87 以降) |
| clear() |
該当なし |
既存のルート結果をクリアし、地図とパネルからオーバーレイを削除して、保留中の load() リクエストをキャンセルします。(2.87 以降) |
| getStatusAsync() |
オブジェクト |
ルート リクエストのステータスを返します。返されたオブジェクトは次のような形式です: { code: 200 request: "directions" } 。ステータス コードは、GGeoStatusCode で定義された値を取ります。(2.87 以降) |
| getBoundsAsync() |
GLatLngBounds |
このメソッドは、ルート クエリの結果の境界ボックスを取得するために使用されます。正常な結果が取得できない場合、GLatLngBounds オブジェクトまたは null を返します。(2.87 以降) |
| getNumRoutesAsync() |
Number |
結果で入手できる経路の数を返します。正常なクエリの場合、これは入力経由地点の合計数から 1 を引いたものです。クエリが発行されなかったか、以前のクエリに失敗したため結果を入手できない場合、このメソッドは 0 を返します。(2.87 以降) |
| getRouteAsync(i) |
GRoute |
応答の i 番目の経路の GRoute オブジェクトを返します。(2.87 以降) |
| getNumGeocodesAsync() |
Number |
結果として入手できるジオコード エントリの数を返します。正常なクエリの場合、これは入力経由地点の合計数と同じになります。クエリが発行されなかったか、以前のクエリに失敗したため結果を入手できない場合、このメソッドは 0 を返します。(2.87 以降) |
| getGeocodeAsync(i) |
オブジェクト |
i 番目の経由地点のジオコード結果を返します。このオブジェクトの構造は、GClientGeocoder オブジェクトの応答にある単一の目印のものと同じです。(2.87 以降) |
| getCopyrightsHtmlAsync() |
文字列 |
この結果の著作権情報を含む HTML 文字列を返します。(2.87 以降) |
| getSummaryHtmlAsync() |
文字列 |
このルート リクエスト全体の時間と距離の要約を含む HTML スニペットを返します。この要約は、関連する地図や DIV 要素なしに構築された GDirections オブジェクトに返される唯一の情報であることに注意してください。(2.87 以降) |
| getDistanceAsync() |
オブジェクト |
(すべての経路を通じて) ルート リクエストの合計距離を示すオブジェクト リテラルを返します。オブジェクトには次の 2 つのフィールドが含まれます。「meters」と呼ばれる数字は、距離の数値を示します（メートル単位）。「html」と呼ばれる文字列には、このルート セットの出発国で一般的に使用される単位に変更された距離の文字列表現が含まれています。(2.87 以降) |
| getDurationAsync() |
オブジェクト |
すべての経路を通じて、ルート リクエストの合計時間を示すオブジェクト リテラルを返します。オブジェクトには次の 2 つのフィールドが含まれます。「seconds」と呼ばれる数字は、時間の数値を示します（秒単位）。「html」と呼ばれる文字列には、地域に合わせて変更された時間の文字列表現が含まれています。(2.87 以降) |
| getPolylineAsync() |
GPolyline |
ルート応答全体に関連付けられた GPolyline オブジェクトを返します。応答内のすべての経路を示すポリラインが 1 つあることに注意してください。このオブジェクトは、ルート結果がロードされた (つまり、「load」イベントがトリガされた) 後にのみ定義されます。(2.87 以降) |
| getMarkerAsync(i) |
GMarker |
i 番目のジオコードに関連付けられたマーカーを返します。このメソッドは、ルート結果がロードされた (つまり、「load」イベントがトリガされた) 後にのみ null 以外の値を返します。(2.87 以降) |
class GDirectionsOptions
このクラスは、GDirections.load() メソッドと GDirections.loadFromWaypoints() メソッドのオプションの引数を示します。これには、コンストラクタはありませんが、オブジェクト リテラルとしてインスタンス化されます。
プロパティ
| プロパティ |
タイプ |
説明 |
| locale |
文字列 |
ルート結果に使用するロケール。たとえば、「ja」、「en_US」、「fr」、「fr_CA」などです。 |
| getPolyline |
Boolean |
デフォルトで、地図が GDirections.load*() オブジェクトに添付されている場合にのみ、GDirections メソッドはポリライン データをフェッチします。このフィールドは、地図がルート オブジェクトに添付されていなくても、この動作を上書きしてポリライン データを取得するために使用できます。 |
| getSteps |
Boolean |
デフォルトで、パネルが GDirections.load*() オブジェクトに添付されている場合にのみ、GDirections メソッドはステップ データをフェッチします。このフィールドは、パネルがルート オブジェクトに添付されていなくても、この動作を上書きしてステップ データを取得するために使用できます。 |
| preserveViewport |
Boolean |
デフォルトで、ルート オブジェクトに地図がある場合、地図は中心に置かれ、ルート結果の境界ボックスがズームされます。このオプションが true に設定されている場合、ビューポートはこの要求についてはそのままになります (ビューポートが最初から設定されていなかった場合を除く)。 |
class GRoute
このクラスのオブジェクトは、ルート結果の 1 つの経路についての情報を保存するため、GDirections オブジェクトによって作成されます。クライアントは、このクラスのオブジェクトを直接作成すべきではありません。
メソッド
| メソッド |
戻り値 |
説明 |
| getNumSteps() |
Number |
この経路のステップの数を返します。(2.87 以降) |
| getStep(i) |
GStep |
この経路の i 番目のステップの、GStep オブジェクトを返します。(2.87 以降) |
| getStartGeocode() |
オブジェクト |
この経路の出発地点のジオコード結果を返します。このオブジェクトの構造は、GClientGeocoder オブジェクトの応答にある単一の目印のものと同じです。(2.87 以降) |
| getEndGeocode() |
オブジェクト |
この経路の到着地点のジオコード結果を返します。このオブジェクトの構造は、GClientGeocoder オブジェクトの応答にある単一の目印のものと同じです。(2.87 以降) |
| getEndLatLng() |
GLatLng |
この経路のポリラインに沿った最終地点の GLatLng オブジェクトを返します。getEndLatLng() は必ず道路網にはまる地点を返すことから、この地点は GRoute.getEndGeocode() の緯度経度とは異なる場合があります。getStartLatLng() 呼び出しと同じであるため、対応する GRoute.getStep(0).getLatLng() メソッドはありません。(2.87 以降) |
| getSummaryHtml() |
文字列 |
この経路の時間と距離の要約を含む HTML スニペットを返します。(2.87 以降) |
| getDistance() |
オブジェクト |
この経路の合計距離を示すオブジェクト リテラルを返します。このオブジェクトの構造については、GDirections.getDistance() を参照してください。(2.87 以降) |
| getDuration() |
オブジェクト |
この経路の合計時間を示すオブジェクト リテラルを返します。このオブジェクトの構造については、GDirections.getDuration() を参照してください。(2.87 以降) |
class GStep
このクラスのオブジェクトは、ルート結果の経路内の 1 つのステップについての情報を保存するため、GDirections オブジェクトによって作成されます。このクラスにはパブリック コンストラクタはありません。クライアントは、このクラスのオブジェクトを直接作成すべきではありません。
メソッド
| メソッド |
戻り値 |
説明 |
| getLatLng() |
GLatLng |
このステップのポリラインに沿った最初の地点の GLatLng オブジェクトを返します。(2.87 以降) |
| getPolylineIndex() |
Number |
このステップのポリラインに沿った最初の地点のインデックスを返します。(2.87 以降) |
| getDescriptionHtml() |
文字列 |
このステップの説明を含む HTML 文字列を返します。(2.87 以降) |
| getDistance() |
オブジェクト |
このステップの合計距離を示すオブジェクト リテラルを返します。このオブジェクトの構造については、GDirections.getDistance() を参照してください。(2.87 以降) |
| getDuration() |
オブジェクト |
このステップの合計時間を示すオブジェクト リテラルを返します。このオブジェクトの構造については、GDirections.getDuration() を参照してください。(2.87 以降) |
トップへ戻る
| 
日本語