GoogleMapsJavaScriptAPIでInfoWindowを1つだけ開く方法

自作の「氷点下コーラの全国マップ」では、店舗のアイコン(マーカー)を押すと、InfoWindow(情報ウィンドウ)に店舗の情報を表示していました。

ただ、アイコン1を押してからアイコン2を押しても、アイコン1のInfoWindowが閉じずに残っていました。

そこで、すでにInfoWindowが開いていたら閉じてから新しいものを開く処理を入れました。

この記事では、閉じなかった理由と直し方、修正前後で開いているInfoWindowの数を数えて確かめた結果をまとめます。

忙しい人向け

InfoWindowは、close()を呼ぶか利用者が閉じるボタンを押すまで開いたままです。

別のマーカーのInfoWindowを開いても、前のものは自動では閉じません。

currentInfoWindowという変数に今開いているInfoWindowを持っておき、新しいマーカーを押したときにclose()してから次をopen()すれば、常に1つだけ開いた状態にできます。

前提条件

  • 地図に複数のマーカーを表示している。
  • マーカーごとにInfoWindowを作り、マーカーのクリックで開いている。

発生環境

  • macOS/GoogleChrome
  • Vue: 3.4.30(VueCLI5で作成)
  • @googlemaps/js-api-loader: 1.16.6
  • MapsJavaScriptAPI: weeklyチャネル
  • マーカー: google.maps.marker.AdvancedMarkerElement
  • 気づいた時期: 2024年11月

※ バージョンはマップのソースのpackage-lock.jsonで確かめた値です。

問題発生時のファイル構成(例)

src/
└─ components/
   └─ MainContent.vue   # 地図の初期化・マーカーとInfoWindowの作成をここで行っていた

症状

アイコン1を押したあとにアイコン2を押すと、アイコン1のInfoWindowが残ったままになります。

複数のInfoWindowが同時に見える状態でした。

修正前のクリック処理は、次のようにInfoWindowを開くだけでした。

const infoWindow = new google.maps.InfoWindow({ ... }); // 店舗ごとの情報ウィンドウ

marker.addListener("click", () => {
  // マーカーがクリックされたときに情報ウィンドウを表示する
  infoWindow.open(vm.map, marker);
});

原因

店舗ごとにInfoWindowを作っていたので、マーカーの数だけ別々のInfoWindowがありました。

公式ドキュメントでは、InfoWindowは利用者が閉じるボタンを押すかEscキーを押すまで開いたままで、明示的に閉じるにはclose()を呼ぶ、と説明されています(情報ウィンドウ|MapsJavaScriptAPI)。

同じページには、複数のInfoWindowを同時に表示することもできると書かれています。

つまり、別のInfoWindowをopen()しても、前のものが閉じないのはAPIの仕様どおりの動きでした。

一方で、同じページでは「使いやすさのために、地図上で開くInfoWindowは一度に1つにするのがよい」とも勧めています。

1つだけにしたいなら、閉じる処理を自分で書く必要がある、ということです。

対処手順

手順1: 今開いているInfoWindowを持つ変数を用意する

let currentInfoWindow = null; // 現在開いている情報ウィンドウを追跡する変数

マーカーを作るループの外に置きます。

ループの中に置くと、マーカーごとに別の変数になってしまい、前のInfoWindowを覚えておけません。

手順2: マーカーのクリックで、古いInfoWindowを閉じてから開く

const infoWindow = new google.maps.InfoWindow({ ... }); // 店舗ごとの情報ウィンドウ

marker.addListener("click", () => {
  // 古い情報ウィンドウを閉じる
  if (currentInfoWindow) {
    currentInfoWindow.close();
  }

  // 新しい情報ウィンドウを表示
  infoWindow.open(vm.map, marker);

  // 現在の情報ウィンドウを更新
  currentInfoWindow = infoWindow;
});

最初のクリックではcurrentInfoWindowがnullなので、閉じる処理は飛ばされます。

2回目からは、前に開いたInfoWindowをclose()してから新しいものを開きます。

ほかの方法: InfoWindowを1つだけ作って使い回す

公式ドキュメントでは、InfoWindowを1つだけ作り、クリックされたマーカーに合わせて中身と位置を変えて開き直す方法も紹介されています。

InfoWindowが1つしか無いので、2つ同時に開くことがそもそも起きません。

今回は店舗ごとにInfoWindowの中身を作り込んでいたので、作りを大きく変えずに済むcurrentInfoWindowの方法にしました。

実際に試した結果

氷点下コーラの全国マップは、今は閉鎖しています。

そこで記事を書き直すにあたって、マーカー2つとInfoWindow2つだけの最小のページを作り、修正前と修正後の処理を手元で比べました。

確かめた環境は次のとおりです。

  • GoogleChrome156(macOS)
  • MapsJavaScriptAPI: weeklyチャネル(読み込まれたのは3.66.12d)
  • マーカー: AdvancedMarkerElement(当時のマップと同じ)

ページを開いてから、アイコン1、アイコン2の順にクリックし、そのたびに開いているInfoWindowの中身を数えました。

数えるのには、ブラウザの開発者ツールで次のスクリプトを使いました(.gm-style-iw-cは、InfoWindowの吹き出し部分に付いているクラス名です)。

[...document.querySelectorAll(".gm-style-iw-c")].map((e) => e.innerText.trim());

結果は次のとおりです。

修正前(open()のみ)
  アイコン1を押した後: ["アイコン1"]
  アイコン2を押した後: ["アイコン1", "アイコン2"]

修正後(close()あり)
  アイコン1を押した後: ["アイコン1"]
  アイコン2を押した後: ["アイコン2"]

修正前は、アイコン2を押した時点でInfoWindowが2つ開いていて、当時の症状と同じでした。

修正後は、アイコン2を押すとアイコン1のInfoWindowが閉じ、常に1つだけになりました。

なお、この確認ではAPIキーを付けずに読み込んだため、地図の上に開発用の透かしと注意のダイアログが出ていました。

InfoWindowの開け閉めは、キーの有無に関係なく同じように動いていました。

まとめ

InfoWindowは、別のものを開いても自動では閉じません。

1つだけ開いた状態にしたいときは、今開いているInfoWindowを変数に持っておき、新しく開く前にclose()します。

参考リンク