Info Window

InfoWindow クラス

google.maps.InfoWindow class
extends MVCObject
library "maps", "streetView"

吹き出しのようなオーバーレイで、多くの場合、マーカーに接続されています。

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

InfoWindowOpenOptions インターフェース

google.maps.InfoWindowOpenOptions インターフェース

InfoWindow を開くためのオプション

anchor
省略可
タイプ: MVCObject|AdvancedMarkerElement optional
この InfoWindow を配置するアンカー。アンカーが null 以外の場合、InfoWindow はアンカーの上部中央に配置されます。InfoWindow は、アンカーと同じ地図またはパノラマにレンダリングされます(利用可能な場合)。
map
省略可
タイプ: Map|StreetViewPanorama optional
この InfoWindow をレンダリングする地図またはパノラマ。
shouldFocus
省略可
タイプ: boolean optional
情報ウィンドウが開かれたときに、そのウィンドウ内でフォーカスを移動するかどうか。このプロパティが未設定の場合、または null か undefined に設定されている場合は、ヒューリスティックを使用してフォーカスを移動するかどうかを決定します。ヒューリスティックは変更される可能性があり、すべてのユースケースで適切に機能するとは限らないため、ニーズに合わせてこのプロパティを明示的に設定することをおすすめします。