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