@geolonia/maps-core 0.4.2 → 0.4.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/npm/index.js CHANGED
@@ -227,6 +227,11 @@ var ATTRIBUTION_CSS = `
227
227
  }
228
228
  `;
229
229
  var CustomAttributionControl = class {
230
+ /**
231
+ * コントロールを生成します。
232
+ *
233
+ * @param options 帰属表示の挙動を指定するオプションです。省略した場合は空のオブジェクトが使われます。
234
+ */
230
235
  constructor(options = {}) {
231
236
  this.options = options;
232
237
  bindAll(
@@ -239,9 +244,24 @@ var CustomAttributionControl = class {
239
244
  this
240
245
  );
241
246
  }
247
+ /**
248
+ * このコントロールの既定の表示位置を返します。
249
+ *
250
+ * @returns 既定の表示位置である `"bottom-right"` を返します。
251
+ */
242
252
  getDefaultPosition() {
243
253
  return "bottom-right";
244
254
  }
255
+ /**
256
+ * コントロールが地図に追加されるときに呼び出されます。
257
+ *
258
+ * Shadow DOM を持つコンテナ要素を生成し、その内部に帰属表示用の要素と CSS を組み立てます。
259
+ * あわせて帰属表示の内容を初期化し、地図の各種イベント(`styledata`、`sourcedata`、`terrain`、
260
+ * `resize`、`drag`)や印刷メディアクエリの変化を監視するリスナーを登録します。
261
+ *
262
+ * @param map このコントロールを追加する対象の地図です。
263
+ * @returns 地図に挿入するコントロールのルート要素を返します。
264
+ */
245
265
  onAdd(map) {
246
266
  this._map = map;
247
267
  this._compact = this.options.compact;
@@ -284,6 +304,12 @@ var CustomAttributionControl = class {
284
304
  this.printQuery.addEventListener("change", this.onMediaPrintChange);
285
305
  return this._container;
286
306
  }
307
+ /**
308
+ * コントロールが地図から取り除かれるときに呼び出されます。
309
+ *
310
+ * 生成したコンテナ要素を DOM から削除し、`onAdd` で登録した地図のイベントリスナーと
311
+ * 印刷メディアクエリのリスナーを解除したうえで、内部で保持している状態を破棄します。
312
+ */
287
313
  onRemove() {
288
314
  if (this._container) {
289
315
  DOM.remove(this._container);
@@ -405,6 +431,14 @@ var attribution_default = CustomAttributionControl;
405
431
 
406
432
  // src/lib/controls/geolonia-logo.ts
407
433
  var GeoloniaControl = class {
434
+ /**
435
+ * コントロールの DOM 要素を生成して返します。
436
+ *
437
+ * `IControl` の実装として、`Map.addControl` で地図に追加された際に MapLibre から呼び出されます。
438
+ * Geolonia のロゴ画像を含み、`https://geolonia.com/` へのリンクが設定された要素を組み立てて返します。
439
+ *
440
+ * @returns このコントロールのコンテナとなる `HTMLDivElement`。
441
+ */
408
442
  onAdd() {
409
443
  this.container = document.createElement("div");
410
444
  this.container.className = "maplibregl-ctrl";
@@ -425,9 +459,22 @@ var GeoloniaControl = class {
425
459
  this.container.appendChild(link);
426
460
  return this.container;
427
461
  }
462
+ /**
463
+ * コントロールの DOM 要素を地図から除去します。
464
+ *
465
+ * `IControl` の実装として、`Map.removeControl` で地図から取り除かれた際に MapLibre から呼び出されます。
466
+ * `onAdd` で生成したコンテナを親ノードから削除します。
467
+ */
428
468
  onRemove() {
429
469
  this.container.parentNode?.removeChild(this.container);
430
470
  }
471
+ /**
472
+ * このコントロールの既定の表示位置を返します。
473
+ *
474
+ * `Map.addControl` で位置を明示しなかった場合に使用されます。
475
+ *
476
+ * @returns 既定の表示位置 `"bottom-left"`。
477
+ */
431
478
  getDefaultPosition() {
432
479
  return "bottom-left";
433
480
  }
@@ -447,6 +494,19 @@ var MARKER_SVG = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 52 67">
447
494
  </svg>`;
448
495
  var DEFAULT_COLOR = "#E4402F";
449
496
  var GeoloniaMarker = class extends maplibregl2.Marker {
497
+ /**
498
+ * Geolonia マーカーを作成します。
499
+ *
500
+ * `options.element` が指定されていない場合は、Geolonia デフォルトの SVG マーカー
501
+ * 要素を生成して `options.element` に設定し、`options.color`(未指定時は `#E4402F`)で
502
+ * マーカーの色を適用したうえで、`options.offset` を `[0, -15]` に設定します。
503
+ * `options.element` が指定されている場合は、これらの処理を行わず指定された要素を
504
+ * そのまま使用します。
505
+ *
506
+ * @param options `maplibregl.Marker` の `MarkerOptions` です。`element` を省略すると
507
+ * Geolonia デフォルトのマーカーが生成され、`color` でその色を指定できます。
508
+ * 省略した場合は空のオブジェクトが使われます。
509
+ */
450
510
  constructor(options = {}) {
451
511
  if (!options.element) {
452
512
  const markerElement = document.createElement("div");
@@ -486,31 +546,83 @@ var Keyring = class {
486
546
  __privateAdd(this, _stage, "dev");
487
547
  __privateAdd(this, _isGeoloniaStyle, true);
488
548
  }
549
+ /**
550
+ * 現在設定されている API キーを返します。
551
+ *
552
+ * 未設定の場合は空文字列を返します。
553
+ *
554
+ * @returns API キーの文字列を返します。
555
+ */
489
556
  get apiKey() {
490
557
  return __privateGet(this, _apiKey);
491
558
  }
559
+ /**
560
+ * 現在設定されているステージを返します。
561
+ *
562
+ * 初期値は `"dev"` です。
563
+ *
564
+ * @returns ステージを表す文字列を返します。
565
+ */
492
566
  get stage() {
493
567
  return __privateGet(this, _stage);
494
568
  }
569
+ /**
570
+ * 現在のスタイルが Geolonia スタイル(API キーが必要なスタイル)かどうかを返します。
571
+ *
572
+ * @returns Geolonia スタイルの場合は `true`、それ以外の場合は `false` を返します。
573
+ */
495
574
  get isGeoloniaStyle() {
496
575
  return __privateGet(this, _isGeoloniaStyle);
497
576
  }
577
+ /**
578
+ * 現在のスタイルが Geolonia スタイルかどうかを設定します。
579
+ *
580
+ * @param value Geolonia スタイルとして扱う場合は `true`、それ以外の場合は `false` を指定します。
581
+ */
498
582
  set isGeoloniaStyle(value) {
499
583
  __privateSet(this, _isGeoloniaStyle, value);
500
584
  }
585
+ /**
586
+ * API キーを設定します。
587
+ *
588
+ * @param key 設定する API キーの文字列を指定します。
589
+ */
501
590
  setApiKey(key) {
502
591
  __privateSet(this, _apiKey, key);
503
592
  }
593
+ /**
594
+ * ステージを設定します。
595
+ *
596
+ * @param stage 設定するステージの文字列を指定します。
597
+ */
504
598
  setStage(stage) {
505
599
  __privateSet(this, _stage, stage);
506
600
  }
601
+ /**
602
+ * API キー、ステージ、Geolonia スタイル判定をすべて初期状態に戻します。
603
+ *
604
+ * API キーは空文字列、ステージは `"dev"`、Geolonia スタイル判定は `true` にリセットされます。
605
+ */
507
606
  reset() {
508
607
  __privateSet(this, _apiKey, "");
509
608
  __privateSet(this, _stage, "dev");
510
609
  __privateSet(this, _isGeoloniaStyle, true);
511
610
  }
512
611
  /**
513
- * Check if the given style is a Geolonia style (requires API key)
612
+ * 与えられたスタイルが Geolonia スタイル(API キーが必要なスタイル)かどうかを判定します。
613
+ *
614
+ * 判定は次のロジックで行われます。
615
+ *
616
+ * - 空文字列(未指定)の場合は `true` を返します。
617
+ * - `https://cdn.geolonia.com/style/` または `https://api.geolonia.com/` で始まる URL の場合は `true` を返します。
618
+ * - 上記以外で `http://` または `https://` で始まる外部 URL の場合は `false` を返します。
619
+ * - `geolonia://` で始まる場合は Geolonia 独自プロトコルのため `true` を返します。
620
+ * - それ以外のプロトコル(`xxx://` 形式)で始まる場合は `false` を返します。
621
+ * - `.json` で終わる場合は `false` を返します。
622
+ * - 上記のいずれにも該当しない場合は、`geolonia/basic` のような Geolonia の論理名とみなして `true` を返します。
623
+ *
624
+ * @param style 判定対象のスタイル(URL、プロトコル付き文字列、または論理名)を指定します。
625
+ * @returns Geolonia スタイルの場合は `true`、それ以外の場合は `false` を返します。
514
626
  */
515
627
  isGeoloniaStyleCheck(style) {
516
628
  if (!style || style === "") {
@@ -673,6 +785,16 @@ var template = {
673
785
  features: []
674
786
  };
675
787
  var SimpleStyle = class {
788
+ /**
789
+ * SimpleStyle を作成します。
790
+ *
791
+ * `geojson` に URL 文字列を渡した場合は、その URL から GeoJSON を非同期に取得します。
792
+ * 取得の完了は `_loadingPromise` で待つことができます。
793
+ *
794
+ * @param geojson 表示する GeoJSON です。{@link FeatureCollection} または GeoJSON を返す URL 文字列を指定します。
795
+ * @param options 表示オプションです。指定した項目のみが既定値を上書きします。既定値は
796
+ * `id: "geolonia-simple-style"`、`cluster: true`、`heatmap: false`、`clusterColor: "#ff0000"` です。
797
+ */
676
798
  constructor(geojson, options) {
677
799
  this.callFitBounds = false;
678
800
  this._eventHandlers = [];
@@ -686,6 +808,16 @@ var SimpleStyle = class {
686
808
  ...options
687
809
  };
688
810
  }
811
+ /**
812
+ * 表示中のデータを新しい GeoJSON で差し替えます。
813
+ *
814
+ * フィーチャーをポイントとそれ以外(ポリゴン、ライン)に振り分け、
815
+ * それぞれ対応するソースの内容を更新します。レイヤー自体の追加は行わないため、
816
+ * あらかじめ {@link SimpleStyle.addTo | addTo} で地図に追加されている必要があります。
817
+ *
818
+ * @param geojson 差し替える {@link FeatureCollection} です。
819
+ * @returns メソッドチェーンのための `this` を返します。
820
+ */
689
821
  updateData(geojson) {
690
822
  this.setGeoJSON(geojson);
691
823
  const features = this.geojson.features;
@@ -707,6 +839,24 @@ var SimpleStyle = class {
707
839
  );
708
840
  return this;
709
841
  }
842
+ /**
843
+ * 地図にソースとレイヤーを追加して GeoJSON を表示します。
844
+ *
845
+ * ポリゴンとラインのソース、ポイント用のソース(クラスタリング設定付き)を追加し、
846
+ * ポリゴンとラインのラベル用シンボルレイヤーを配置したうえで、
847
+ * {@link SimpleStyle.setPolygonGeometries | setPolygonGeometries}、
848
+ * {@link SimpleStyle.setLineGeometries | setLineGeometries}、
849
+ * {@link SimpleStyle.setPointGeometries | setPointGeometries}、
850
+ * {@link SimpleStyle.setCluster | setCluster} を呼び出して各ジオメトリのレイヤーを設定します。
851
+ *
852
+ * @param map 表示先の地図です。
853
+ * @returns メソッドチェーンのための `this` を返します。
854
+ *
855
+ * @example
856
+ * ```typescript
857
+ * new SimpleStyle(geojson).addTo(map);
858
+ * ```
859
+ */
710
860
  addTo(map) {
711
861
  this.map = map;
712
862
  const features = this.geojson.features;
@@ -784,6 +934,17 @@ var SimpleStyle = class {
784
934
  this.setCluster();
785
935
  return this;
786
936
  }
937
+ /**
938
+ * データ全体の範囲に地図をフィットさせます。
939
+ *
940
+ * 現在の GeoJSON のフィーチャーからバウンディングボックスを算出し、そこへ地図を移動します。
941
+ * フィーチャーが存在しない場合は何もしません。データを URL から取得中に呼び出した場合は、
942
+ * フィット要求を保持しておき、取得完了後に自動でフィットします。
943
+ *
944
+ * @param options `map.fitBounds` に渡すオプションです。既定値は `duration: 3000`、`padding: 30` で、
945
+ * 指定した項目のみがこれらを上書きします。
946
+ * @returns メソッドチェーンのための `this` を返します。
947
+ */
787
948
  fitBounds(options = {}) {
788
949
  this.callFitBounds = true;
789
950
  const _options = {
@@ -800,7 +961,12 @@ var SimpleStyle = class {
800
961
  return this;
801
962
  }
802
963
  /**
803
- * Set polygon geometries.
964
+ * ポリゴンの塗りレイヤーを設定します。
965
+ *
966
+ * `$type` が `Polygon` のフィーチャーを対象に塗りレイヤーを追加し、
967
+ * `fill`、`fill-opacity`、`stroke`(輪郭色)の各 simplestyle プロパティを反映します。
968
+ * あわせて {@link SimpleStyle.setPopup | setPopup} でこのレイヤーにポップアップを設定します。
969
+ * 通常は {@link SimpleStyle.addTo | addTo} から呼び出されます。
804
970
  */
805
971
  setPolygonGeometries() {
806
972
  this.map.addLayer({
@@ -817,7 +983,12 @@ var SimpleStyle = class {
817
983
  this.setPopup(this.map, `${this.options.id}-polygon`);
818
984
  }
819
985
  /**
820
- * Set line geometries.
986
+ * ラインのレイヤーを設定します。
987
+ *
988
+ * `$type` が `LineString` のフィーチャーを対象にラインレイヤーを追加し、
989
+ * `stroke-width`(線幅)、`stroke`(線色)、`stroke-opacity`(不透明度)の各 simplestyle プロパティを反映します。
990
+ * 線端と結合は丸めて描画します。あわせて {@link SimpleStyle.setPopup | setPopup} でこのレイヤーにポップアップを設定します。
991
+ * 通常は {@link SimpleStyle.addTo | addTo} から呼び出されます。
821
992
  */
822
993
  setLineGeometries() {
823
994
  this.map.addLayer({
@@ -838,7 +1009,15 @@ var SimpleStyle = class {
838
1009
  this.setPopup(this.map, `${this.options.id}-linestring`);
839
1010
  }
840
1011
  /**
841
- * Setup point geometries.
1012
+ * ポイントのレイヤーを設定します。
1013
+ *
1014
+ * クラスターに属さないポイントを対象に、2 種類のレイヤーを追加します。
1015
+ * `marker-symbol` を持たないポイントには円レイヤーを、
1016
+ * `marker-symbol` を持つポイントにはアイコンとラベルのシンボルレイヤーを使います。
1017
+ * `marker-size`(`small`、`large`、その他)に応じて円の半径やラベルのオフセットを変え、
1018
+ * `marker-color`、`stroke`、`title`、`text-color` などの simplestyle プロパティを反映します。
1019
+ * あわせて円レイヤーとシンボルレイヤーの双方に {@link SimpleStyle.setPopup | setPopup} でポップアップを設定します。
1020
+ * 通常は {@link SimpleStyle.addTo | addTo} から呼び出されます。
842
1021
  */
843
1022
  setPointGeometries() {
844
1023
  this.map.addLayer({
@@ -898,6 +1077,17 @@ var SimpleStyle = class {
898
1077
  this.setPopup(this.map, `${this.options.id}-circle-points`);
899
1078
  this.setPopup(this.map, `${this.options.id}-symbol-points`);
900
1079
  }
1080
+ /**
1081
+ * 指定したレイヤーにクリックでポップアップを表示するイベントハンドラーを設定します。
1082
+ *
1083
+ * クリックされたフィーチャーが `description` プロパティを持つ場合、その中心座標に
1084
+ * サニタイズ済みの HTML を表示するポップアップを追加します。あわせてホバー時に
1085
+ * カーソルを変えるハンドラーも設定します。登録したハンドラーは `_eventHandlers` に記録され、
1086
+ * {@link SimpleStyle.remove | remove} でまとめて解除されます。
1087
+ *
1088
+ * @param map ポップアップを表示する地図です。
1089
+ * @param source ハンドラーを設定する対象のレイヤー ID です。
1090
+ */
901
1091
  async setPopup(map, source) {
902
1092
  const clickHandler = async (e) => {
903
1093
  if (!e.features?.[0]) return;
@@ -926,7 +1116,15 @@ var SimpleStyle = class {
926
1116
  );
927
1117
  }
928
1118
  /**
929
- * Setup cluster markers
1119
+ * クラスタリング用のレイヤーを設定します。
1120
+ *
1121
+ * `point_count` を持つクラスターを対象に、クラスターを表す円レイヤーと、
1122
+ * 件数(`point_count_abbreviated`)を表示するラベルのシンボルレイヤーを追加します。
1123
+ * 円の色は `clusterColor` オプションを使います。クラスターをクリックすると、
1124
+ * そのクラスターが展開するズームレベルまで地図を移動します。あわせてホバー時に
1125
+ * カーソルを変えるハンドラーも設定します。登録したハンドラーは `_eventHandlers` に記録され、
1126
+ * {@link SimpleStyle.remove | remove} でまとめて解除されます。通常は
1127
+ * {@link SimpleStyle.addTo | addTo} から呼び出されます。
930
1128
  */
931
1129
  setCluster() {
932
1130
  this.map.addLayer({
@@ -991,6 +1189,15 @@ var SimpleStyle = class {
991
1189
  }
992
1190
  );
993
1191
  }
1192
+ /**
1193
+ * 追加したソース、レイヤー、イベントハンドラーを地図から除去します。
1194
+ *
1195
+ * {@link SimpleStyle.setPopup | setPopup} や {@link SimpleStyle.setCluster | setCluster}
1196
+ * で登録したイベントハンドラーをすべて解除し、ポリゴン、ライン、ポイント、クラスターの各レイヤーと、
1197
+ * それらのソースを削除します。カーソルのスタイルも元に戻します。まだ地図に追加されていない場合は何もしません。
1198
+ *
1199
+ * @returns メソッドチェーンのための `this` を返します。
1200
+ */
994
1201
  remove() {
995
1202
  if (!this.map) return this;
996
1203
  const id = this.options.id;
@@ -1021,6 +1228,18 @@ var SimpleStyle = class {
1021
1228
  this.map.getCanvas().style.cursor = "";
1022
1229
  return this;
1023
1230
  }
1231
+ /**
1232
+ * 内部で保持する GeoJSON を設定します。
1233
+ *
1234
+ * `geojson` が URL 文字列の場合は、いったん空のデータを設定したうえで、その URL から GeoJSON を
1235
+ * 非同期に取得します。取得中の Promise は `_loadingPromise` に保持され、取得完了後に
1236
+ * {@link SimpleStyle.updateData | updateData} で表示を更新します。フィット要求が保留されていれば
1237
+ * あわせてフィットします。応答が 2xx 以外の場合は空のデータとして扱い、通信や JSON の解析で
1238
+ * 例外が発生した場合はエラーをコンソールに出力します。
1239
+ * `geojson` が {@link FeatureCollection} の場合は、そのまま内部データとして設定します。
1240
+ *
1241
+ * @param geojson 設定する {@link FeatureCollection} または GeoJSON を返す URL 文字列です。
1242
+ */
1024
1243
  setGeoJSON(geojson) {
1025
1244
  if (typeof geojson === "string" && isURL(geojson)) {
1026
1245
  this.geojson = template;
@@ -1053,10 +1272,32 @@ var textHaloColor2 = "#FFFFFF";
1053
1272
  var backgroundColor2 = "rgba(255, 0, 0, 0.4)";
1054
1273
  var strokeColor2 = "#FFFFFF";
1055
1274
  var SimpleStyleVector = class {
1275
+ /**
1276
+ * @param url 表示するベクトルタイルソースの TileJSON(tiles.json)URL です。
1277
+ */
1056
1278
  constructor(url) {
1057
1279
  this.url = url;
1058
1280
  this.sourceName = "vt-geolonia-simple-style";
1059
1281
  }
1282
+ /**
1283
+ * 地図にベクトルタイルソースと各レイヤーを追加し、simplestyle の規約に沿って表示します。
1284
+ *
1285
+ * ソースを追加したうえで、ポリゴン(塗り潰しとラベル)、ライン(線とラベル)、
1286
+ * ポイント(円、アイコン、ラベル)の各レイヤーを設定します。あわせて、ポリゴンの塗り潰し、
1287
+ * ラインの線、ポイントの円とアイコンの各レイヤーにクリック時のポップアップを登録します
1288
+ * (ポリゴンやラインのラベル用シンボルレイヤーには登録しません)。
1289
+ *
1290
+ * 地図コンテナの `data-lng` および `data-lat` 属性がいずれも指定されていない場合は、
1291
+ * ソースの読み込み完了を待って、そのソースの `bounds` に一度だけ地図の表示範囲を合わせます
1292
+ * (`padding` は 30、アニメーションなし)。
1293
+ *
1294
+ * @param map レイヤーを追加する対象の地図インスタンスです。
1295
+ *
1296
+ * @example
1297
+ * ```typescript
1298
+ * new SimpleStyleVector(url).addTo(map);
1299
+ * ```
1300
+ */
1060
1301
  addTo(map) {
1061
1302
  const container = map.getContainer();
1062
1303
  if (!container.dataset || !container.dataset.lng && !container.dataset.lat) {
@@ -1139,9 +1380,14 @@ var SimpleStyleVector = class {
1139
1380
  this.setPointGeometries(map);
1140
1381
  }
1141
1382
  /**
1142
- * Set polygon geometries.
1383
+ * ポリゴンジオメトリ用のレイヤーを設定します。
1384
+ *
1385
+ * `$type` が `Polygon` のフィーチャーに対して塗り潰しレイヤー(`fill` タイプ)を追加します。
1386
+ * 塗り色はフィーチャーの `fill` プロパティ、不透明度は `fill-opacity`、
1387
+ * 外周線の色は `stroke` プロパティを用い、いずれも未指定の場合は既定値を適用します。
1388
+ * あわせて、このポリゴンレイヤーにクリック時のポップアップを登録します。
1143
1389
  *
1144
- * @param map
1390
+ * @param map レイヤーを追加する対象の地図インスタンスです。
1145
1391
  */
1146
1392
  setPolygonGeometries(map) {
1147
1393
  map.addLayer({
@@ -1159,9 +1405,15 @@ var SimpleStyleVector = class {
1159
1405
  this.setPopup(map, "vt-geolonia-simple-style-polygon");
1160
1406
  }
1161
1407
  /**
1162
- * Set line geometries.
1408
+ * ラインジオメトリ用のレイヤーを設定します。
1163
1409
  *
1164
- * @param map
1410
+ * `$type` が `LineString` のフィーチャーに対して線レイヤー(`line` タイプ)を追加します。
1411
+ * 線幅はフィーチャーの `stroke-width` プロパティ、線色は `stroke`、
1412
+ * 不透明度は `stroke-opacity` を用い、いずれも未指定の場合は既定値を適用します。
1413
+ * 線の端点と結合部はいずれも丸め(`round`)で描画します。
1414
+ * あわせて、このラインレイヤーにクリック時のポップアップを登録します。
1415
+ *
1416
+ * @param map レイヤーを追加する対象の地図インスタンスです。
1165
1417
  */
1166
1418
  setLineGeometries(map) {
1167
1419
  map.addLayer({
@@ -1183,9 +1435,16 @@ var SimpleStyleVector = class {
1183
1435
  this.setPopup(map, "vt-geolonia-simple-style-linestring");
1184
1436
  }
1185
1437
  /**
1186
- * Setup point geometries.
1438
+ * ポイントジオメトリ用のレイヤーを設定します。
1439
+ *
1440
+ * 2 つのレイヤーを追加します。1 つは `marker-symbol` を持たないポイント向けの円レイヤー
1441
+ * (`circle` タイプ)で、半径はフィーチャーの `marker-size`(`small` は 7、`large` は 13、
1442
+ * それ以外は 9)に応じて変化し、色は `marker-color`、外周線は `stroke` 系プロパティを用います。
1443
+ * もう 1 つはすべてのポイント向けのシンボルレイヤー(`symbol` タイプ)で、`marker-symbol` を
1444
+ * アイコン画像として、`title` をラベルとして表示します。ラベルの位置は `marker-size` に応じて調整します。
1445
+ * あわせて、円レイヤーとシンボルレイヤーの両方にクリック時のポップアップを登録します。
1187
1446
  *
1188
- * @param map
1447
+ * @param map レイヤーを追加する対象の地図インスタンスです。
1189
1448
  */
1190
1449
  setPointGeometries(map) {
1191
1450
  map.addLayer({
@@ -1246,6 +1505,19 @@ var SimpleStyleVector = class {
1246
1505
  this.setPopup(map, "vt-circle-simple-style-points");
1247
1506
  this.setPopup(map, "vt-geolonia-simple-style-points");
1248
1507
  }
1508
+ /**
1509
+ * 指定したレイヤーにクリック時のポップアップ表示を設定します。
1510
+ *
1511
+ * 対象レイヤーのフィーチャーがクリックされると、そのフィーチャーの中心座標
1512
+ * (`@turf/center` で算出)にポップアップを表示します。ポップアップの内容は、
1513
+ * フィーチャーの `description` プロパティをサニタイズした HTML です。`description` を
1514
+ * 持たないフィーチャーではポップアップを表示しません。あわせて、`description` を持つ
1515
+ * フィーチャーにマウスが乗ったときはカーソルをポインターに変更し、離れたときに元へ戻します。
1516
+ *
1517
+ * @param map イベントを登録する対象の地図インスタンスです。
1518
+ * @param source ポップアップを設定する対象のレイヤー ID です。
1519
+ * @returns イベントリスナーの登録が完了すると解決する Promise です。
1520
+ */
1249
1521
  async setPopup(map, source) {
1250
1522
  map.on("click", source, async (e) => {
1251
1523
  if (!e.features?.[0]) return;
@@ -1378,6 +1650,36 @@ function ensurePMTiles() {
1378
1650
  maplibregl5.addProtocol("pmtiles", protocol.tile);
1379
1651
  }
1380
1652
  var GeoloniaMap = class extends maplibregl5.Map {
1653
+ /**
1654
+ * 地図を生成します。
1655
+ *
1656
+ * `apiKey` や `stage` が指定されていればキーリングに設定し、スタイル
1657
+ * (既定は `"geolonia/basic-v2"`)を実際の style.json の URL に解決してから
1658
+ * MapLibre GL JS の `Map` を初期化します。あわせて Geolonia のロゴ、出典表示、
1659
+ * ナビゲーションなどのコントロールを追加し、読み込み完了後にはローディング表示の
1660
+ * 除去、デフォルトマーカーの配置、ジェスチャ操作やスタイル拡張の適用を行います。
1661
+ *
1662
+ * `arg` にコンテナを直接指定する後方互換の形式では、そのコンテナの `data-*`
1663
+ * 属性から設定を読み込みます。指定したコンテナに既に地図が生成済みの場合は、
1664
+ * 新規生成せず既存のインスタンスを返します。
1665
+ *
1666
+ * @param arg 地図の設定です。{@link GeoloniaMapOptions} オブジェクトのほか、
1667
+ * 後方互換としてコンテナを指す CSS セレクタ文字列や `HTMLElement` も指定できます。
1668
+ * @throws コンテナ要素が見つからない場合に `Error` を投げます。
1669
+ * @throws Geolonia のスタイルを API キーなしで使おうとした場合に `Error` を投げます。
1670
+ * @throws MapLibre GL JS の `Map` の初期化に失敗した場合、コンテナにエラー表示を
1671
+ * 行ったうえで、その例外を再スローします。
1672
+ *
1673
+ * @example
1674
+ * ```typescript
1675
+ * const map = new GeoloniaMap({
1676
+ * container: "#map",
1677
+ * apiKey: "YOUR-API-KEY",
1678
+ * center: [139.7671, 35.6812],
1679
+ * zoom: 14,
1680
+ * });
1681
+ * ```
1682
+ */
1381
1683
  // biome-ignore lint/correctness/noUnreachableSuper: intentional singleton pattern - returns existing map instance before super()
1382
1684
  constructor(arg) {
1383
1685
  const options = normalizeConstructorArg(arg);
@@ -1628,6 +1930,28 @@ var GeoloniaMap = class extends maplibregl5.Map {
1628
1930
  container.geoloniaMap = this;
1629
1931
  return this;
1630
1932
  }
1933
+ /**
1934
+ * 地図のスタイルを差し替えます。
1935
+ *
1936
+ * `style` が文字列の場合は、Geolonia のスタイル論理名(`"geolonia/basic-v2"`
1937
+ * など)、style.json の URL、相対パスのいずれかとして解釈し、実際の URL に
1938
+ * 解決してから適用します。解決の際の言語はブラウザ言語に従い、API キーは
1939
+ * キーリングに設定済みの値を使います。`StyleSpecification` オブジェクトを
1940
+ * 直接渡した場合はそのまま適用します。
1941
+ *
1942
+ * @param style 新しいスタイルです。スタイル論理名や URL などの文字列、または
1943
+ * `StyleSpecification` オブジェクトを指定します。
1944
+ * @param options MapLibre GL JS に渡すスタイル差し替えオプションです。
1945
+ * 既定は空のオブジェクトです。
1946
+ * @returns メソッドチェーンのために自身を返します。
1947
+ * @throws Geolonia のスタイルを API キーなしで使おうとした場合に `Error` を投げます。
1948
+ *
1949
+ * @example
1950
+ * ```typescript
1951
+ * const map = new GeoloniaMap({ container: "#map", apiKey: "YOUR-API-KEY" });
1952
+ * map.setStyle("geolonia/gsi");
1953
+ * ```
1954
+ */
1631
1955
  setStyle(style, options = {}) {
1632
1956
  if (style !== null && typeof style === "string") {
1633
1957
  style = getStyle(style, { lang: getLang(), apiKey: keyring.apiKey });
@@ -1636,11 +1960,45 @@ var GeoloniaMap = class extends maplibregl5.Map {
1636
1960
  super.setStyle.call(this, style, options);
1637
1961
  return this;
1638
1962
  }
1963
+ /**
1964
+ * 地図を破棄し、関連するリソースやイベントリスナーを解放します。
1965
+ *
1966
+ * MapLibre GL JS の破棄処理に加えて、コンテナ要素に保持している地図インスタンスへの
1967
+ * 参照(`geoloniaMap`)も削除します。これにより、同じコンテナで再度
1968
+ * {@link GeoloniaMap} を生成した際に、破棄済みのインスタンスが返されることを防ぎます。
1969
+ *
1970
+ * @example
1971
+ * ```typescript
1972
+ * const map = new GeoloniaMap({ container: "#map", apiKey: "YOUR-API-KEY" });
1973
+ * // 不要になったら破棄します
1974
+ * map.remove();
1975
+ * ```
1976
+ */
1639
1977
  remove() {
1640
1978
  const container = this.getContainer();
1641
1979
  super.remove.call(this);
1642
1980
  delete container.geoloniaMap;
1643
1981
  }
1982
+ /**
1983
+ * 画像を読み込みます。
1984
+ *
1985
+ * `callback` を渡した場合は後方互換のコールバック形式で結果を受け取り、戻り値は
1986
+ * `undefined` になります。`callback` を省略した場合は `Promise` を返します。
1987
+ *
1988
+ * @param url 読み込む画像の URL です。
1989
+ * @param callback 省略可能です。指定した場合はコールバック形式で結果を受け取ります。
1990
+ * @returns `callback` を省略した場合は、読み込んだ画像を含むレスポンスに解決される
1991
+ * `Promise` を返します。`callback` を指定した場合は `undefined` を返します。
1992
+ *
1993
+ * @example
1994
+ * ```typescript
1995
+ * const map = new GeoloniaMap({ container: "#map", apiKey: "YOUR-API-KEY" });
1996
+ * map.on("load", async () => {
1997
+ * const image = await map.loadImage("https://example.com/marker.png");
1998
+ * map.addImage("custom-marker", image.data);
1999
+ * });
2000
+ * ```
2001
+ */
1644
2002
  loadImage(url, callback) {
1645
2003
  const promise = super.loadImage(url);
1646
2004
  if (callback) {
@@ -1652,7 +2010,7 @@ var GeoloniaMap = class extends maplibregl5.Map {
1652
2010
  };
1653
2011
 
1654
2012
  // src/version.ts
1655
- var VERSION = "0.1.0";
2013
+ var VERSION = "0.4.3";
1656
2014
  export {
1657
2015
  attribution_default as CustomAttributionControl,
1658
2016
  GeoloniaControl,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@geolonia/maps-core",
3
- "version": "0.4.2",
3
+ "version": "0.4.3",
4
4
  "type": "module",
5
5
  "main": "dist/npm/index.cjs",
6
6
  "module": "dist/npm/index.js",
@@ -37,6 +37,8 @@
37
37
  "jsdom": "^29.0.1",
38
38
  "maplibre-gl": "5.7.0",
39
39
  "tsup": "^8",
40
+ "typedoc": "^0.28.20",
41
+ "typedoc-plugin-markdown": "^4.12.0",
40
42
  "typescript": "^5.8",
41
43
  "vite": "^8.0.16",
42
44
  "vitest": "^4.1.2"
@@ -44,13 +46,17 @@
44
46
  "scripts": {
45
47
  "build": "tsup",
46
48
  "build:umd": "vite build --config vite.umd.config.ts",
49
+ "check:externals": "node scripts/check-externals.mjs",
50
+ "smoke": "node scripts/smoke.mjs",
51
+ "verify": "npm run build && npm run check:externals && npm run smoke",
47
52
  "test": "vitest run",
48
53
  "test:watch": "vitest",
49
54
  "test:coverage": "vitest run --coverage",
50
55
  "dev": "vite --config vite.config.ts",
51
56
  "e2e": "playwright test",
52
57
  "lint": "biome check src/ test/ e2e/ example/",
53
- "lint:fix": "biome check --write src/ test/ e2e/ example/"
58
+ "lint:fix": "biome check --write src/ test/ e2e/ example/",
59
+ "docs:api": "typedoc"
54
60
  },
55
61
  "license": "MIT",
56
62
  "repository": {