@geolonia/maps-core 0.4.2 → 0.5.0

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.
@@ -38,6 +38,7 @@ var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "
38
38
  var index_exports = {};
39
39
  __export(index_exports, {
40
40
  CustomAttributionControl: () => attribution_default,
41
+ DEFAULT_STAGE: () => DEFAULT_STAGE,
41
42
  GeoloniaControl: () => GeoloniaControl,
42
43
  GeoloniaMap: () => GeoloniaMap,
43
44
  GeoloniaMarker: () => GeoloniaMarker,
@@ -272,6 +273,11 @@ var ATTRIBUTION_CSS = `
272
273
  }
273
274
  `;
274
275
  var CustomAttributionControl = class {
276
+ /**
277
+ * コントロールを生成します。
278
+ *
279
+ * @param options 帰属表示の挙動を指定するオプションです。省略した場合は空のオブジェクトが使われます。
280
+ */
275
281
  constructor(options = {}) {
276
282
  this.options = options;
277
283
  bindAll(
@@ -284,9 +290,24 @@ var CustomAttributionControl = class {
284
290
  this
285
291
  );
286
292
  }
293
+ /**
294
+ * このコントロールの既定の表示位置を返します。
295
+ *
296
+ * @returns 既定の表示位置である `"bottom-right"` を返します。
297
+ */
287
298
  getDefaultPosition() {
288
299
  return "bottom-right";
289
300
  }
301
+ /**
302
+ * コントロールが地図に追加されるときに呼び出されます。
303
+ *
304
+ * Shadow DOM を持つコンテナ要素を生成し、その内部に帰属表示用の要素と CSS を組み立てます。
305
+ * あわせて帰属表示の内容を初期化し、地図の各種イベント(`styledata`、`sourcedata`、`terrain`、
306
+ * `resize`、`drag`)や印刷メディアクエリの変化を監視するリスナーを登録します。
307
+ *
308
+ * @param map このコントロールを追加する対象の地図です。
309
+ * @returns 地図に挿入するコントロールのルート要素を返します。
310
+ */
290
311
  onAdd(map) {
291
312
  this._map = map;
292
313
  this._compact = this.options.compact;
@@ -329,6 +350,12 @@ var CustomAttributionControl = class {
329
350
  this.printQuery.addEventListener("change", this.onMediaPrintChange);
330
351
  return this._container;
331
352
  }
353
+ /**
354
+ * コントロールが地図から取り除かれるときに呼び出されます。
355
+ *
356
+ * 生成したコンテナ要素を DOM から削除し、`onAdd` で登録した地図のイベントリスナーと
357
+ * 印刷メディアクエリのリスナーを解除したうえで、内部で保持している状態を破棄します。
358
+ */
332
359
  onRemove() {
333
360
  if (this._container) {
334
361
  DOM.remove(this._container);
@@ -450,6 +477,14 @@ var attribution_default = CustomAttributionControl;
450
477
 
451
478
  // src/lib/controls/geolonia-logo.ts
452
479
  var GeoloniaControl = class {
480
+ /**
481
+ * コントロールの DOM 要素を生成して返します。
482
+ *
483
+ * `IControl` の実装として、`Map.addControl` で地図に追加された際に MapLibre から呼び出されます。
484
+ * Geolonia のロゴ画像を含み、`https://geolonia.com/` へのリンクが設定された要素を組み立てて返します。
485
+ *
486
+ * @returns このコントロールのコンテナとなる `HTMLDivElement`。
487
+ */
453
488
  onAdd() {
454
489
  this.container = document.createElement("div");
455
490
  this.container.className = "maplibregl-ctrl";
@@ -470,9 +505,22 @@ var GeoloniaControl = class {
470
505
  this.container.appendChild(link);
471
506
  return this.container;
472
507
  }
508
+ /**
509
+ * コントロールの DOM 要素を地図から除去します。
510
+ *
511
+ * `IControl` の実装として、`Map.removeControl` で地図から取り除かれた際に MapLibre から呼び出されます。
512
+ * `onAdd` で生成したコンテナを親ノードから削除します。
513
+ */
473
514
  onRemove() {
474
515
  this.container.parentNode?.removeChild(this.container);
475
516
  }
517
+ /**
518
+ * このコントロールの既定の表示位置を返します。
519
+ *
520
+ * `Map.addControl` で位置を明示しなかった場合に使用されます。
521
+ *
522
+ * @returns 既定の表示位置 `"bottom-left"`。
523
+ */
476
524
  getDefaultPosition() {
477
525
  return "bottom-left";
478
526
  }
@@ -492,6 +540,19 @@ var MARKER_SVG = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 52 67">
492
540
  </svg>`;
493
541
  var DEFAULT_COLOR = "#E4402F";
494
542
  var GeoloniaMarker = class extends import_maplibre_gl2.default.Marker {
543
+ /**
544
+ * Geolonia マーカーを作成します。
545
+ *
546
+ * `options.element` が指定されていない場合は、Geolonia デフォルトの SVG マーカー
547
+ * 要素を生成して `options.element` に設定し、`options.color`(未指定時は `#E4402F`)で
548
+ * マーカーの色を適用したうえで、`options.offset` を `[0, -15]` に設定します。
549
+ * `options.element` が指定されている場合は、これらの処理を行わず指定された要素を
550
+ * そのまま使用します。
551
+ *
552
+ * @param options `maplibregl.Marker` の `MarkerOptions` です。`element` を省略すると
553
+ * Geolonia デフォルトのマーカーが生成され、`color` でその色を指定できます。
554
+ * 省略した場合は空のオブジェクトが使われます。
555
+ */
495
556
  constructor(options = {}) {
496
557
  if (!options.element) {
497
558
  const markerElement = document.createElement("div");
@@ -524,38 +585,91 @@ var import_center = __toESM(require("@turf/center"), 1);
524
585
  var import_maplibre_gl3 = __toESM(require("maplibre-gl"), 1);
525
586
 
526
587
  // src/lib/keyring.ts
588
+ var DEFAULT_STAGE = "v1";
527
589
  var _apiKey, _stage, _isGeoloniaStyle;
528
590
  var Keyring = class {
529
591
  constructor() {
530
592
  __privateAdd(this, _apiKey, "");
531
- __privateAdd(this, _stage, "dev");
593
+ __privateAdd(this, _stage, DEFAULT_STAGE);
532
594
  __privateAdd(this, _isGeoloniaStyle, true);
533
595
  }
596
+ /**
597
+ * 現在設定されている API キーを返します。
598
+ *
599
+ * 未設定の場合は空文字列を返します。
600
+ *
601
+ * @returns API キーの文字列を返します。
602
+ */
534
603
  get apiKey() {
535
604
  return __privateGet(this, _apiKey);
536
605
  }
606
+ /**
607
+ * 現在設定されているステージを返します。
608
+ *
609
+ * 初期値は {@link DEFAULT_STAGE}(`"v1"`)です。
610
+ *
611
+ * @returns ステージを表す文字列を返します。
612
+ */
537
613
  get stage() {
538
614
  return __privateGet(this, _stage);
539
615
  }
616
+ /**
617
+ * 現在のスタイルが Geolonia スタイル(API キーが必要なスタイル)かどうかを返します。
618
+ *
619
+ * @returns Geolonia スタイルの場合は `true`、それ以外の場合は `false` を返します。
620
+ */
540
621
  get isGeoloniaStyle() {
541
622
  return __privateGet(this, _isGeoloniaStyle);
542
623
  }
624
+ /**
625
+ * 現在のスタイルが Geolonia スタイルかどうかを設定します。
626
+ *
627
+ * @param value Geolonia スタイルとして扱う場合は `true`、それ以外の場合は `false` を指定します。
628
+ */
543
629
  set isGeoloniaStyle(value) {
544
630
  __privateSet(this, _isGeoloniaStyle, value);
545
631
  }
632
+ /**
633
+ * API キーを設定します。
634
+ *
635
+ * @param key 設定する API キーの文字列を指定します。
636
+ */
546
637
  setApiKey(key) {
547
638
  __privateSet(this, _apiKey, key);
548
639
  }
640
+ /**
641
+ * ステージを設定します。
642
+ *
643
+ * @param stage 設定するステージの文字列を指定します。
644
+ */
549
645
  setStage(stage) {
550
646
  __privateSet(this, _stage, stage);
551
647
  }
648
+ /**
649
+ * API キー、ステージ、Geolonia スタイル判定をすべて初期状態に戻します。
650
+ *
651
+ * API キーは空文字列、ステージは {@link DEFAULT_STAGE}、Geolonia スタイル判定は `true` にリセットされます。
652
+ */
552
653
  reset() {
553
654
  __privateSet(this, _apiKey, "");
554
- __privateSet(this, _stage, "dev");
655
+ __privateSet(this, _stage, DEFAULT_STAGE);
555
656
  __privateSet(this, _isGeoloniaStyle, true);
556
657
  }
557
658
  /**
558
- * Check if the given style is a Geolonia style (requires API key)
659
+ * 与えられたスタイルが Geolonia スタイル(API キーが必要なスタイル)かどうかを判定します。
660
+ *
661
+ * 判定は次のロジックで行われます。
662
+ *
663
+ * - 空文字列(未指定)の場合は `true` を返します。
664
+ * - `https://cdn.geolonia.com/style/` または `https://api.geolonia.com/` で始まる URL の場合は `true` を返します。
665
+ * - 上記以外で `http://` または `https://` で始まる外部 URL の場合は `false` を返します。
666
+ * - `geolonia://` で始まる場合は Geolonia 独自プロトコルのため `true` を返します。
667
+ * - それ以外のプロトコル(`xxx://` 形式)で始まる場合は `false` を返します。
668
+ * - `.json` で終わる場合は `false` を返します。
669
+ * - 上記のいずれにも該当しない場合は、`geolonia/basic` のような Geolonia の論理名とみなして `true` を返します。
670
+ *
671
+ * @param style 判定対象のスタイル(URL、プロトコル付き文字列、または論理名)を指定します。
672
+ * @returns Geolonia スタイルの場合は `true`、それ以外の場合は `false` を返します。
559
673
  */
560
674
  isGeoloniaStyleCheck(style) {
561
675
  if (!style || style === "") {
@@ -718,6 +832,16 @@ var template = {
718
832
  features: []
719
833
  };
720
834
  var SimpleStyle = class {
835
+ /**
836
+ * SimpleStyle を作成します。
837
+ *
838
+ * `geojson` に URL 文字列を渡した場合は、その URL から GeoJSON を非同期に取得します。
839
+ * 取得の完了は `_loadingPromise` で待つことができます。
840
+ *
841
+ * @param geojson 表示する GeoJSON です。{@link FeatureCollection} または GeoJSON を返す URL 文字列を指定します。
842
+ * @param options 表示オプションです。指定した項目のみが既定値を上書きします。既定値は
843
+ * `id: "geolonia-simple-style"`、`cluster: true`、`heatmap: false`、`clusterColor: "#ff0000"` です。
844
+ */
721
845
  constructor(geojson, options) {
722
846
  this.callFitBounds = false;
723
847
  this._eventHandlers = [];
@@ -731,6 +855,16 @@ var SimpleStyle = class {
731
855
  ...options
732
856
  };
733
857
  }
858
+ /**
859
+ * 表示中のデータを新しい GeoJSON で差し替えます。
860
+ *
861
+ * フィーチャーをポイントとそれ以外(ポリゴン、ライン)に振り分け、
862
+ * それぞれ対応するソースの内容を更新します。レイヤー自体の追加は行わないため、
863
+ * あらかじめ {@link SimpleStyle.addTo | addTo} で地図に追加されている必要があります。
864
+ *
865
+ * @param geojson 差し替える {@link FeatureCollection} です。
866
+ * @returns メソッドチェーンのための `this` を返します。
867
+ */
734
868
  updateData(geojson) {
735
869
  this.setGeoJSON(geojson);
736
870
  const features = this.geojson.features;
@@ -752,6 +886,24 @@ var SimpleStyle = class {
752
886
  );
753
887
  return this;
754
888
  }
889
+ /**
890
+ * 地図にソースとレイヤーを追加して GeoJSON を表示します。
891
+ *
892
+ * ポリゴンとラインのソース、ポイント用のソース(クラスタリング設定付き)を追加し、
893
+ * ポリゴンとラインのラベル用シンボルレイヤーを配置したうえで、
894
+ * {@link SimpleStyle.setPolygonGeometries | setPolygonGeometries}、
895
+ * {@link SimpleStyle.setLineGeometries | setLineGeometries}、
896
+ * {@link SimpleStyle.setPointGeometries | setPointGeometries}、
897
+ * {@link SimpleStyle.setCluster | setCluster} を呼び出して各ジオメトリのレイヤーを設定します。
898
+ *
899
+ * @param map 表示先の地図です。
900
+ * @returns メソッドチェーンのための `this` を返します。
901
+ *
902
+ * @example
903
+ * ```typescript
904
+ * new SimpleStyle(geojson).addTo(map);
905
+ * ```
906
+ */
755
907
  addTo(map) {
756
908
  this.map = map;
757
909
  const features = this.geojson.features;
@@ -829,6 +981,17 @@ var SimpleStyle = class {
829
981
  this.setCluster();
830
982
  return this;
831
983
  }
984
+ /**
985
+ * データ全体の範囲に地図をフィットさせます。
986
+ *
987
+ * 現在の GeoJSON のフィーチャーからバウンディングボックスを算出し、そこへ地図を移動します。
988
+ * フィーチャーが存在しない場合は何もしません。データを URL から取得中に呼び出した場合は、
989
+ * フィット要求を保持しておき、取得完了後に自動でフィットします。
990
+ *
991
+ * @param options `map.fitBounds` に渡すオプションです。既定値は `duration: 3000`、`padding: 30` で、
992
+ * 指定した項目のみがこれらを上書きします。
993
+ * @returns メソッドチェーンのための `this` を返します。
994
+ */
832
995
  fitBounds(options = {}) {
833
996
  this.callFitBounds = true;
834
997
  const _options = {
@@ -845,7 +1008,12 @@ var SimpleStyle = class {
845
1008
  return this;
846
1009
  }
847
1010
  /**
848
- * Set polygon geometries.
1011
+ * ポリゴンの塗りレイヤーを設定します。
1012
+ *
1013
+ * `$type` が `Polygon` のフィーチャーを対象に塗りレイヤーを追加し、
1014
+ * `fill`、`fill-opacity`、`stroke`(輪郭色)の各 simplestyle プロパティを反映します。
1015
+ * あわせて {@link SimpleStyle.setPopup | setPopup} でこのレイヤーにポップアップを設定します。
1016
+ * 通常は {@link SimpleStyle.addTo | addTo} から呼び出されます。
849
1017
  */
850
1018
  setPolygonGeometries() {
851
1019
  this.map.addLayer({
@@ -862,7 +1030,12 @@ var SimpleStyle = class {
862
1030
  this.setPopup(this.map, `${this.options.id}-polygon`);
863
1031
  }
864
1032
  /**
865
- * Set line geometries.
1033
+ * ラインのレイヤーを設定します。
1034
+ *
1035
+ * `$type` が `LineString` のフィーチャーを対象にラインレイヤーを追加し、
1036
+ * `stroke-width`(線幅)、`stroke`(線色)、`stroke-opacity`(不透明度)の各 simplestyle プロパティを反映します。
1037
+ * 線端と結合は丸めて描画します。あわせて {@link SimpleStyle.setPopup | setPopup} でこのレイヤーにポップアップを設定します。
1038
+ * 通常は {@link SimpleStyle.addTo | addTo} から呼び出されます。
866
1039
  */
867
1040
  setLineGeometries() {
868
1041
  this.map.addLayer({
@@ -883,7 +1056,15 @@ var SimpleStyle = class {
883
1056
  this.setPopup(this.map, `${this.options.id}-linestring`);
884
1057
  }
885
1058
  /**
886
- * Setup point geometries.
1059
+ * ポイントのレイヤーを設定します。
1060
+ *
1061
+ * クラスターに属さないポイントを対象に、2 種類のレイヤーを追加します。
1062
+ * `marker-symbol` を持たないポイントには円レイヤーを、
1063
+ * `marker-symbol` を持つポイントにはアイコンとラベルのシンボルレイヤーを使います。
1064
+ * `marker-size`(`small`、`large`、その他)に応じて円の半径やラベルのオフセットを変え、
1065
+ * `marker-color`、`stroke`、`title`、`text-color` などの simplestyle プロパティを反映します。
1066
+ * あわせて円レイヤーとシンボルレイヤーの双方に {@link SimpleStyle.setPopup | setPopup} でポップアップを設定します。
1067
+ * 通常は {@link SimpleStyle.addTo | addTo} から呼び出されます。
887
1068
  */
888
1069
  setPointGeometries() {
889
1070
  this.map.addLayer({
@@ -943,6 +1124,17 @@ var SimpleStyle = class {
943
1124
  this.setPopup(this.map, `${this.options.id}-circle-points`);
944
1125
  this.setPopup(this.map, `${this.options.id}-symbol-points`);
945
1126
  }
1127
+ /**
1128
+ * 指定したレイヤーにクリックでポップアップを表示するイベントハンドラーを設定します。
1129
+ *
1130
+ * クリックされたフィーチャーが `description` プロパティを持つ場合、その中心座標に
1131
+ * サニタイズ済みの HTML を表示するポップアップを追加します。あわせてホバー時に
1132
+ * カーソルを変えるハンドラーも設定します。登録したハンドラーは `_eventHandlers` に記録され、
1133
+ * {@link SimpleStyle.remove | remove} でまとめて解除されます。
1134
+ *
1135
+ * @param map ポップアップを表示する地図です。
1136
+ * @param source ハンドラーを設定する対象のレイヤー ID です。
1137
+ */
946
1138
  async setPopup(map, source) {
947
1139
  const clickHandler = async (e) => {
948
1140
  if (!e.features?.[0]) return;
@@ -971,7 +1163,15 @@ var SimpleStyle = class {
971
1163
  );
972
1164
  }
973
1165
  /**
974
- * Setup cluster markers
1166
+ * クラスタリング用のレイヤーを設定します。
1167
+ *
1168
+ * `point_count` を持つクラスターを対象に、クラスターを表す円レイヤーと、
1169
+ * 件数(`point_count_abbreviated`)を表示するラベルのシンボルレイヤーを追加します。
1170
+ * 円の色は `clusterColor` オプションを使います。クラスターをクリックすると、
1171
+ * そのクラスターが展開するズームレベルまで地図を移動します。あわせてホバー時に
1172
+ * カーソルを変えるハンドラーも設定します。登録したハンドラーは `_eventHandlers` に記録され、
1173
+ * {@link SimpleStyle.remove | remove} でまとめて解除されます。通常は
1174
+ * {@link SimpleStyle.addTo | addTo} から呼び出されます。
975
1175
  */
976
1176
  setCluster() {
977
1177
  this.map.addLayer({
@@ -1036,6 +1236,15 @@ var SimpleStyle = class {
1036
1236
  }
1037
1237
  );
1038
1238
  }
1239
+ /**
1240
+ * 追加したソース、レイヤー、イベントハンドラーを地図から除去します。
1241
+ *
1242
+ * {@link SimpleStyle.setPopup | setPopup} や {@link SimpleStyle.setCluster | setCluster}
1243
+ * で登録したイベントハンドラーをすべて解除し、ポリゴン、ライン、ポイント、クラスターの各レイヤーと、
1244
+ * それらのソースを削除します。カーソルのスタイルも元に戻します。まだ地図に追加されていない場合は何もしません。
1245
+ *
1246
+ * @returns メソッドチェーンのための `this` を返します。
1247
+ */
1039
1248
  remove() {
1040
1249
  if (!this.map) return this;
1041
1250
  const id = this.options.id;
@@ -1066,6 +1275,18 @@ var SimpleStyle = class {
1066
1275
  this.map.getCanvas().style.cursor = "";
1067
1276
  return this;
1068
1277
  }
1278
+ /**
1279
+ * 内部で保持する GeoJSON を設定します。
1280
+ *
1281
+ * `geojson` が URL 文字列の場合は、いったん空のデータを設定したうえで、その URL から GeoJSON を
1282
+ * 非同期に取得します。取得中の Promise は `_loadingPromise` に保持され、取得完了後に
1283
+ * {@link SimpleStyle.updateData | updateData} で表示を更新します。フィット要求が保留されていれば
1284
+ * あわせてフィットします。応答が 2xx 以外の場合は空のデータとして扱い、通信や JSON の解析で
1285
+ * 例外が発生した場合はエラーをコンソールに出力します。
1286
+ * `geojson` が {@link FeatureCollection} の場合は、そのまま内部データとして設定します。
1287
+ *
1288
+ * @param geojson 設定する {@link FeatureCollection} または GeoJSON を返す URL 文字列です。
1289
+ */
1069
1290
  setGeoJSON(geojson) {
1070
1291
  if (typeof geojson === "string" && isURL(geojson)) {
1071
1292
  this.geojson = template;
@@ -1098,10 +1319,32 @@ var textHaloColor2 = "#FFFFFF";
1098
1319
  var backgroundColor2 = "rgba(255, 0, 0, 0.4)";
1099
1320
  var strokeColor2 = "#FFFFFF";
1100
1321
  var SimpleStyleVector = class {
1322
+ /**
1323
+ * @param url 表示するベクトルタイルソースの TileJSON(tiles.json)URL です。
1324
+ */
1101
1325
  constructor(url) {
1102
1326
  this.url = url;
1103
1327
  this.sourceName = "vt-geolonia-simple-style";
1104
1328
  }
1329
+ /**
1330
+ * 地図にベクトルタイルソースと各レイヤーを追加し、simplestyle の規約に沿って表示します。
1331
+ *
1332
+ * ソースを追加したうえで、ポリゴン(塗り潰しとラベル)、ライン(線とラベル)、
1333
+ * ポイント(円、アイコン、ラベル)の各レイヤーを設定します。あわせて、ポリゴンの塗り潰し、
1334
+ * ラインの線、ポイントの円とアイコンの各レイヤーにクリック時のポップアップを登録します
1335
+ * (ポリゴンやラインのラベル用シンボルレイヤーには登録しません)。
1336
+ *
1337
+ * 地図コンテナの `data-lng` および `data-lat` 属性がいずれも指定されていない場合は、
1338
+ * ソースの読み込み完了を待って、そのソースの `bounds` に一度だけ地図の表示範囲を合わせます
1339
+ * (`padding` は 30、アニメーションなし)。
1340
+ *
1341
+ * @param map レイヤーを追加する対象の地図インスタンスです。
1342
+ *
1343
+ * @example
1344
+ * ```typescript
1345
+ * new SimpleStyleVector(url).addTo(map);
1346
+ * ```
1347
+ */
1105
1348
  addTo(map) {
1106
1349
  const container = map.getContainer();
1107
1350
  if (!container.dataset || !container.dataset.lng && !container.dataset.lat) {
@@ -1184,9 +1427,14 @@ var SimpleStyleVector = class {
1184
1427
  this.setPointGeometries(map);
1185
1428
  }
1186
1429
  /**
1187
- * Set polygon geometries.
1430
+ * ポリゴンジオメトリ用のレイヤーを設定します。
1431
+ *
1432
+ * `$type` が `Polygon` のフィーチャーに対して塗り潰しレイヤー(`fill` タイプ)を追加します。
1433
+ * 塗り色はフィーチャーの `fill` プロパティ、不透明度は `fill-opacity`、
1434
+ * 外周線の色は `stroke` プロパティを用い、いずれも未指定の場合は既定値を適用します。
1435
+ * あわせて、このポリゴンレイヤーにクリック時のポップアップを登録します。
1188
1436
  *
1189
- * @param map
1437
+ * @param map レイヤーを追加する対象の地図インスタンスです。
1190
1438
  */
1191
1439
  setPolygonGeometries(map) {
1192
1440
  map.addLayer({
@@ -1204,9 +1452,15 @@ var SimpleStyleVector = class {
1204
1452
  this.setPopup(map, "vt-geolonia-simple-style-polygon");
1205
1453
  }
1206
1454
  /**
1207
- * Set line geometries.
1455
+ * ラインジオメトリ用のレイヤーを設定します。
1208
1456
  *
1209
- * @param map
1457
+ * `$type` が `LineString` のフィーチャーに対して線レイヤー(`line` タイプ)を追加します。
1458
+ * 線幅はフィーチャーの `stroke-width` プロパティ、線色は `stroke`、
1459
+ * 不透明度は `stroke-opacity` を用い、いずれも未指定の場合は既定値を適用します。
1460
+ * 線の端点と結合部はいずれも丸め(`round`)で描画します。
1461
+ * あわせて、このラインレイヤーにクリック時のポップアップを登録します。
1462
+ *
1463
+ * @param map レイヤーを追加する対象の地図インスタンスです。
1210
1464
  */
1211
1465
  setLineGeometries(map) {
1212
1466
  map.addLayer({
@@ -1228,9 +1482,16 @@ var SimpleStyleVector = class {
1228
1482
  this.setPopup(map, "vt-geolonia-simple-style-linestring");
1229
1483
  }
1230
1484
  /**
1231
- * Setup point geometries.
1485
+ * ポイントジオメトリ用のレイヤーを設定します。
1486
+ *
1487
+ * 2 つのレイヤーを追加します。1 つは `marker-symbol` を持たないポイント向けの円レイヤー
1488
+ * (`circle` タイプ)で、半径はフィーチャーの `marker-size`(`small` は 7、`large` は 13、
1489
+ * それ以外は 9)に応じて変化し、色は `marker-color`、外周線は `stroke` 系プロパティを用います。
1490
+ * もう 1 つはすべてのポイント向けのシンボルレイヤー(`symbol` タイプ)で、`marker-symbol` を
1491
+ * アイコン画像として、`title` をラベルとして表示します。ラベルの位置は `marker-size` に応じて調整します。
1492
+ * あわせて、円レイヤーとシンボルレイヤーの両方にクリック時のポップアップを登録します。
1232
1493
  *
1233
- * @param map
1494
+ * @param map レイヤーを追加する対象の地図インスタンスです。
1234
1495
  */
1235
1496
  setPointGeometries(map) {
1236
1497
  map.addLayer({
@@ -1291,6 +1552,19 @@ var SimpleStyleVector = class {
1291
1552
  this.setPopup(map, "vt-circle-simple-style-points");
1292
1553
  this.setPopup(map, "vt-geolonia-simple-style-points");
1293
1554
  }
1555
+ /**
1556
+ * 指定したレイヤーにクリック時のポップアップ表示を設定します。
1557
+ *
1558
+ * 対象レイヤーのフィーチャーがクリックされると、そのフィーチャーの中心座標
1559
+ * (`@turf/center` で算出)にポップアップを表示します。ポップアップの内容は、
1560
+ * フィーチャーの `description` プロパティをサニタイズした HTML です。`description` を
1561
+ * 持たないフィーチャーではポップアップを表示しません。あわせて、`description` を持つ
1562
+ * フィーチャーにマウスが乗ったときはカーソルをポインターに変更し、離れたときに元へ戻します。
1563
+ *
1564
+ * @param map イベントを登録する対象の地図インスタンスです。
1565
+ * @param source ポップアップを設定する対象のレイヤー ID です。
1566
+ * @returns イベントリスナーの登録が完了すると解決する Promise です。
1567
+ */
1294
1568
  async setPopup(map, source) {
1295
1569
  map.on("click", source, async (e) => {
1296
1570
  if (!e.features?.[0]) return;
@@ -1423,6 +1697,36 @@ function ensurePMTiles() {
1423
1697
  import_maplibre_gl5.default.addProtocol("pmtiles", protocol.tile);
1424
1698
  }
1425
1699
  var GeoloniaMap = class extends import_maplibre_gl5.default.Map {
1700
+ /**
1701
+ * 地図を生成します。
1702
+ *
1703
+ * `apiKey` や `stage` が指定されていればキーリングに設定し、スタイル
1704
+ * (既定は `"geolonia/basic-v2"`)を実際の style.json の URL に解決してから
1705
+ * MapLibre GL JS の `Map` を初期化します。あわせて Geolonia のロゴ、出典表示、
1706
+ * ナビゲーションなどのコントロールを追加し、読み込み完了後にはローディング表示の
1707
+ * 除去、デフォルトマーカーの配置、ジェスチャ操作やスタイル拡張の適用を行います。
1708
+ *
1709
+ * `arg` にコンテナを直接指定する後方互換の形式では、そのコンテナの `data-*`
1710
+ * 属性から設定を読み込みます。指定したコンテナに既に地図が生成済みの場合は、
1711
+ * 新規生成せず既存のインスタンスを返します。
1712
+ *
1713
+ * @param arg 地図の設定です。{@link GeoloniaMapOptions} オブジェクトのほか、
1714
+ * 後方互換としてコンテナを指す CSS セレクタ文字列や `HTMLElement` も指定できます。
1715
+ * @throws コンテナ要素が見つからない場合に `Error` を投げます。
1716
+ * @throws Geolonia のスタイルを API キーなしで使おうとした場合に `Error` を投げます。
1717
+ * @throws MapLibre GL JS の `Map` の初期化に失敗した場合、コンテナにエラー表示を
1718
+ * 行ったうえで、その例外を再スローします。
1719
+ *
1720
+ * @example
1721
+ * ```typescript
1722
+ * const map = new GeoloniaMap({
1723
+ * container: "#map",
1724
+ * apiKey: "YOUR-API-KEY",
1725
+ * center: [139.7671, 35.6812],
1726
+ * zoom: 14,
1727
+ * });
1728
+ * ```
1729
+ */
1426
1730
  // biome-ignore lint/correctness/noUnreachableSuper: intentional singleton pattern - returns existing map instance before super()
1427
1731
  constructor(arg) {
1428
1732
  const options = normalizeConstructorArg(arg);
@@ -1673,6 +1977,28 @@ var GeoloniaMap = class extends import_maplibre_gl5.default.Map {
1673
1977
  container.geoloniaMap = this;
1674
1978
  return this;
1675
1979
  }
1980
+ /**
1981
+ * 地図のスタイルを差し替えます。
1982
+ *
1983
+ * `style` が文字列の場合は、Geolonia のスタイル論理名(`"geolonia/basic-v2"`
1984
+ * など)、style.json の URL、相対パスのいずれかとして解釈し、実際の URL に
1985
+ * 解決してから適用します。解決の際の言語はブラウザ言語に従い、API キーは
1986
+ * キーリングに設定済みの値を使います。`StyleSpecification` オブジェクトを
1987
+ * 直接渡した場合はそのまま適用します。
1988
+ *
1989
+ * @param style 新しいスタイルです。スタイル論理名や URL などの文字列、または
1990
+ * `StyleSpecification` オブジェクトを指定します。
1991
+ * @param options MapLibre GL JS に渡すスタイル差し替えオプションです。
1992
+ * 既定は空のオブジェクトです。
1993
+ * @returns メソッドチェーンのために自身を返します。
1994
+ * @throws Geolonia のスタイルを API キーなしで使おうとした場合に `Error` を投げます。
1995
+ *
1996
+ * @example
1997
+ * ```typescript
1998
+ * const map = new GeoloniaMap({ container: "#map", apiKey: "YOUR-API-KEY" });
1999
+ * map.setStyle("geolonia/gsi");
2000
+ * ```
2001
+ */
1676
2002
  setStyle(style, options = {}) {
1677
2003
  if (style !== null && typeof style === "string") {
1678
2004
  style = getStyle(style, { lang: getLang(), apiKey: keyring.apiKey });
@@ -1681,11 +2007,45 @@ var GeoloniaMap = class extends import_maplibre_gl5.default.Map {
1681
2007
  super.setStyle.call(this, style, options);
1682
2008
  return this;
1683
2009
  }
2010
+ /**
2011
+ * 地図を破棄し、関連するリソースやイベントリスナーを解放します。
2012
+ *
2013
+ * MapLibre GL JS の破棄処理に加えて、コンテナ要素に保持している地図インスタンスへの
2014
+ * 参照(`geoloniaMap`)も削除します。これにより、同じコンテナで再度
2015
+ * {@link GeoloniaMap} を生成した際に、破棄済みのインスタンスが返されることを防ぎます。
2016
+ *
2017
+ * @example
2018
+ * ```typescript
2019
+ * const map = new GeoloniaMap({ container: "#map", apiKey: "YOUR-API-KEY" });
2020
+ * // 不要になったら破棄します
2021
+ * map.remove();
2022
+ * ```
2023
+ */
1684
2024
  remove() {
1685
2025
  const container = this.getContainer();
1686
2026
  super.remove.call(this);
1687
2027
  delete container.geoloniaMap;
1688
2028
  }
2029
+ /**
2030
+ * 画像を読み込みます。
2031
+ *
2032
+ * `callback` を渡した場合は後方互換のコールバック形式で結果を受け取り、戻り値は
2033
+ * `undefined` になります。`callback` を省略した場合は `Promise` を返します。
2034
+ *
2035
+ * @param url 読み込む画像の URL です。
2036
+ * @param callback 省略可能です。指定した場合はコールバック形式で結果を受け取ります。
2037
+ * @returns `callback` を省略した場合は、読み込んだ画像を含むレスポンスに解決される
2038
+ * `Promise` を返します。`callback` を指定した場合は `undefined` を返します。
2039
+ *
2040
+ * @example
2041
+ * ```typescript
2042
+ * const map = new GeoloniaMap({ container: "#map", apiKey: "YOUR-API-KEY" });
2043
+ * map.on("load", async () => {
2044
+ * const image = await map.loadImage("https://example.com/marker.png");
2045
+ * map.addImage("custom-marker", image.data);
2046
+ * });
2047
+ * ```
2048
+ */
1689
2049
  loadImage(url, callback) {
1690
2050
  const promise = super.loadImage(url);
1691
2051
  if (callback) {
@@ -1697,10 +2057,11 @@ var GeoloniaMap = class extends import_maplibre_gl5.default.Map {
1697
2057
  };
1698
2058
 
1699
2059
  // src/version.ts
1700
- var VERSION = "0.1.0";
2060
+ var VERSION = "0.5.0";
1701
2061
  // Annotate the CommonJS export names for ESM import in node:
1702
2062
  0 && (module.exports = {
1703
2063
  CustomAttributionControl,
2064
+ DEFAULT_STAGE,
1704
2065
  GeoloniaControl,
1705
2066
  GeoloniaMap,
1706
2067
  GeoloniaMarker,