InfoWindow クラス
google.maps.InfoWindow
クラス
バブルのように見えるオーバーレイ。多くの場合、マーカーに接続されます。
このクラスは MVCObject
を拡張します。
const {InfoWindow} = await google.maps.importLibrary("maps")
または const {InfoWindow} = await google.maps.importLibrary("streetView")
を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。
コンストラクタ | |
---|---|
InfoWindow |
InfoWindow([opts]) パラメータ:
指定されたオプションで情報ウィンドウを作成します。情報ウィンドウは、オプションで指定した内容に応じて、地図上の特定の位置やマーカーの上に配置できます。自動パンが無効になっていない限り、情報ウィンドウは、開かれたときに自身が表示されるよう、地図をパンします。情報ウィンドウを作成したら、open を呼び出して地図上に表示する必要があります。ユーザーは情報ウィンドウの閉じるボタン [X] をクリックして地図から情報ウィンドウを削除できます。またはデベロッパーが close() を呼び出しても同じことです。 |
方法 | |
---|---|
close |
close() パラメータ: なし
戻り値: なし
DOM 構造から削除して、この情報ウィンドウを閉じます。 |
focus |
focus() パラメータ: なし
戻り値: なし
この InfoWindow にフォーカスを設定します。フォーカスを設定する前に、このメソッドを visible イベントとともに使用して、InfoWindow が表示されていることを確認することをおすすめします。表示されていない InfoWindow はフォーカスできません。 |
getContent |
getContent() パラメータ: なし
|
getPosition |
getPosition() パラメータ: なし
戻り値:
LatLng|null|undefined この情報ウィンドウの LatLng の位置。 |
getZIndex |
getZIndex() パラメータ: なし
戻り値:
number この情報ウィンドウの zIndex。 |
open |
open([options, anchor]) パラメータ:
戻り値: なし
指定された地図でこの情報ウィンドウを開きます。必要に応じて、情報ウィンドウをアンカーに関連付けることができます。コア API では、アンカーは Marker クラスのみです。ただし、アンカーには、LatLng position プロパティと、必要に応じて pixelOffset を計算するための Point anchorPoint プロパティを公開する任意の MVCObject を指定できます(InfoWindowOptions をご覧ください)。anchorPoint は、アンカーの位置から情報ウィンドウの先端までのオフセットです。このメソッドの単一の引数として InfoWindowOpenOptions インターフェースを使用することをおすすめします。開くときにブラウザのフォーカスが変更されないようにするには、InfoWindowOpenOptions.shouldFocus を false に設定します。 |
setContent |
setContent([content]) 戻り値: なし
|
setOptions |
setOptions([options]) パラメータ:
戻り値: なし
|
setPosition |
setPosition([position]) パラメータ:
戻り値: なし
|
setZIndex |
setZIndex(zIndex) パラメータ:
戻り値: なし
|
継承:
addListener 、
bindTo 、
get 、
notify 、
set 、
setValues 、
unbind 、
unbindAll
|
イベント | |
---|---|
close |
function() 引数: なし
このイベントは、 InfoWindow が閉じると発生します。たとえば、InfoWindow.close メソッドを呼び出す、Esc キーを押して情報ウィンドウを閉じる、閉じるボタンのクリック、情報ウィンドウを別の地図に移動することなどが考えられます。 |
closeclick |
function() 引数: なし
このイベントは、閉じるボタン [X] がクリックされると発生します。 |
content_changed |
function() 引数: なし
このイベントは、content プロパティが変更されると発生します。 |
domready |
function() 引数: なし
このイベントは、 InfoWindow のコンテンツを含む <div> が DOM にアタッチされると発生します。情報ウィンドウのコンテンツを動的に作成している場合は、このイベントを監視できます。 |
headercontent_changed |
function() 引数: なし
このイベントは、headerContent プロパティが変更されると発生します。 |
headerdisabled_changed |
function() 引数: なし
このイベントは、headerDisabled プロパティが変更されると発生します。 |
position_changed |
function() 引数: なし
このイベントは、position プロパティが変更されると発生します。 |
visible |
function() 引数: なし
このイベントは、 InfoWindow が完全に表示されると発生します。InfoWindow がパンされて画面に戻されても、このイベントは発生しません。 |
zindex_changed |
function() 引数: なし
このイベントは、 InfoWindow の zIndex が変更されると発生します。 |
InfoWindowOptions インターフェース
google.maps.InfoWindowOptions
インターフェース
InfoWindow で設定できるプロパティを定義するために使用される InfoWindowOptions オブジェクト。
プロパティ | |
---|---|
ariaLabel optional |
タイプ:
string optional 情報ウィンドウに割り当てる AriaLabel。 |
content optional |
情報ウィンドウに表示するコンテンツ。HTML 要素、書式なしテキストの文字列、HTML を含む文字列を指定できます。情報ウィンドウのサイズはコンテンツに応じて調整されます。コンテンツに明確なサイズを設定するには、そのサイズの HTML 要素としてコンテンツを設定します。 |
disableAutoPan optional |
タイプ:
boolean optional デフォルト:
false 情報ウィンドウを開いたときに完全に表示されるように、地図のパンを無効にします。 |
headerContent optional |
情報ウィンドウのヘッダー行に表示されるコンテンツ。HTML 要素または HTML を含む文字列を指定できます。情報ウィンドウのサイズはコンテンツに応じて調整されます。ヘッダー コンテンツのサイズを明示的に設定するには、headerContent をそのサイズの HTML 要素に設定します。 |
headerDisabled optional |
タイプ:
boolean optional 情報ウィンドウのヘッダー行全体を無効にします。true に設定すると、ヘッダーが削除され、ヘッダーの内容と閉じるボタンが非表示になります。 |
maxWidth optional |
タイプ:
number optional コンテンツの幅に関係なく、情報ウィンドウの最大幅。この値は、 open() の呼び出し前に設定されている場合にのみ考慮されます。コンテンツの変更時に最大幅を変更するには、close() 、setOptions() 、open() の順に呼び出します。 |
minWidth optional |
タイプ:
number optional コンテンツの幅に関係しない、情報ウィンドウの最小幅。このプロパティを使用する場合は、 minWidth を地図の幅(ピクセル単位)よりも小さい値に設定することを強くおすすめします。この値は、open() の呼び出し前に設定されている場合にのみ考慮されます。コンテンツを変更するときに最小幅を変更するには、close() 、setOptions() 、open() の順に呼び出します。 |
pixelOffset optional |
タイプ:
Size optional 情報ウィンドウが固定されている地理的座標の地図上のポイントから情報ウィンドウの先端までのオフセット(ピクセル単位)。アンカーで情報ウィンドウを開く場合、 pixelOffset はアンカーの anchorPoint プロパティから計算されます。 |
position optional |
タイプ:
LatLng|LatLngLiteral optional この情報ウィンドウを表示する LatLng。アンカーで情報ウィンドウを開く場合は、代わりにアンカーの位置が使用されます。 |
zIndex optional |
タイプ:
number optional 地図にはすべての情報ウィンドウが zIndex 順に表示され、値が高い情報ウィンドウの前に、低い値が表示されます。デフォルトでは、情報ウィンドウは緯度に従って表示され、低い緯度の情報ウィンドウがより高い緯度の情報ウィンドウの前に表示されます。情報ウィンドウは常にマーカーの前に表示されます。 |
InfoWindowOpenOptions インターフェース
google.maps.InfoWindowOpenOptions
インターフェース
情報ウィンドウを開くオプション
プロパティ | |
---|---|
anchor optional |
タイプ:
MVCObject|AdvancedMarkerElement optional この情報ウィンドウが配置されるアンカーです。アンカーが null でない場合、情報ウィンドウはアンカーの中央上端に配置されます。情報ウィンドウは、アンカーと同じ地図またはパノラマにレンダリングされます(利用可能な場合)。 |
map optional |
タイプ:
Map|StreetViewPanorama optional この情報ウィンドウをレンダリングする地図またはパノラマ。 |
shouldFocus optional |
タイプ:
boolean optional 情報ウィンドウを開いたときに、情報ウィンドウ内でフォーカスを移動するかどうかを指定します。このプロパティを未設定のままにした場合、または null または undefined に設定されている場合は、ヒューリスティックを使用してフォーカスを移動するかどうかを決定します。ヒューリスティックは変更される可能性があり、すべてのユースケースで適切に機能するとは限らないため、ニーズに合わせてこのプロパティを明示的に設定することをおすすめします。 |