ドキュメントを検索

Type Alias: GeoloniaMapOptions

GeoloniaMapOptions = MapOptions & object

GeoloniaMap のコンストラクタに渡すオプション。

MapLibre GL JS の MapOptions を拡張し、Geolonia 固有の設定 (API キー、スタイル、マーカー、各種コントロール、GeoJSON 表示など)を 追加したものである。container や center、zoom などの基本オプションは MapLibre の MapOptions から継承する。

Type Declaration

3d?

optional 3d?: boolean

3D モード(対応スタイルの建物などの 3D 表示)を有効にするかどうか。

Default Value

false

apiKey?

optional apiKey?: string

Geolonia の API キー。Geolonia がホストするスタイルやタイルを使う場合に必要。 指定するとキーリングにも設定される。

choropleth?

optional choropleth?: string | ChoroplethOptions

geojson のポリゴンを、プロパティの値で塗り分ける(コロプレス)。 プロパティ名の文字列、または ChoroplethOptions を指定する。 地物の simplestyle の fill より優先する。地物に fill-opacity がないときの不透明度は、 背景の地図が透けるよう 1 ではなく 0.7 にする。

circle?

optional circle?: CircleOptions

geojson のポイントの円の大きさと色を、プロパティの値で変える。 指定するとクラスタリングは行わず、marker-symbol を持つポイントも円で描く(アイコンとタイトルは表示しない)。 地物の simplestyle の marker-color より優先する。

cluster?

optional cluster?: boolean

geojson のポイント地物をクラスタリングするかどうか。

Default Value

true

clusterColor?

optional clusterColor?: string

クラスタマーカーの色。

Default Value

'#ff0000'

customMarker?

optional customMarker?: string

マーカーとして使うカスタム要素の CSS セレクタ。

customMarkerOffset?

optional customMarkerOffset?: [number, number]

カスタムマーカーのオフセット。[x, y] のピクセル値。

errorMessage?

optional errorMessage?: string | false

地図の初期化に失敗したときに表示する文言。 文字列を指定するとその文言に差し替える(HTML としては解釈しない)。 false または 'off' を指定するとエラー表示自体を行わない。 未指定のときは、原因と利用者が試せる復旧手順を示す既定の案内を表示する。

fullscreenControl?

optional fullscreenControl?: boolean | ControlPosition

全画面コントロール。true / false、または表示位置を指定する。

Default Value

false

geojson?

optional geojson?: string | GeoJSON.FeatureCollection

SimpleStyle で表示する GeoJSON。URL、または GeoJSON オブジェクトを指定する。 center が未指定のときは、この GeoJSON の範囲に自動的にフィットする。

geolocateControl?

optional geolocateControl?: boolean | ControlPosition

現在地コントロール。true / false、または表示位置を指定する。

Default Value

false

geoloniaControl?

optional geoloniaControl?: boolean | ControlPosition

Geolonia のロゴコントロール。true / false、または表示位置を指定する。

Default Value

true

gestureHandling?

optional gestureHandling?: boolean

スクロール可能なページでジェスチャ操作(2本指での地図操作の要求など)を 有効にするかどうか。

Default Value

true

heatmap?

optional heatmap?: boolean | string | HeatmapOptions

geojson のポイントをヒートマップで描く。true で重みなし、 プロパティ名の文字列でその値を重みにする。HeatmapOptions も指定できる。 指定するとクラスタリングとポイントのマーカーは表示しない。

lang?

optional lang?: "ja" | "en" | "auto"

ラベルの言語。'ja' / 'en' / 'auto'(ブラウザ言語に従う)。 'auto' または未指定のときは getLang() の結果('ja' または 'en')になる。

Default Value

'auto'

loader?

optional loader?: boolean

地図の読み込み中にローディングアニメーションを表示するかどうか。

Default Value

true

marker?

optional marker?: boolean

中心にデフォルトマーカーを表示するかどうか。center が指定されている場合にのみ 実際に表示される。

markerColor?

optional markerColor?: string

マーカーの色(CSS カラー文字列)。

optional navigationControl?: boolean | ControlPosition

ズームと回転のコントロール。true / false、または表示位置 ('top-right'、'bottom-left' など)を指定する。 コンパスは地図の傾きも表し、クリックすると向きと傾きの両方を戻す。

Default Value

true

openPopup?

optional openPopup?: boolean

読み込み時にマーカーのポップアップを自動的に開くかどうか。

scaleControl?

optional scaleControl?: boolean | ControlPosition

スケールコントロール。true / false、または表示位置を指定する。

Default Value

false

simpleVector?

optional simpleVector?: string

SimpleStyle Vector で表示するベクトルタイルの URL または論理名。

stage?

optional stage?: string

API のステージ('dev' / 'v1' など)。API エンドポイントの選択に使う。 省略時は共有キーリングの現在のステージを使う。別の地図が stage を指定してキーリングを変更済みの場合は、その値になる。

Default Value

'v1'(キーリングの初期値)

style?

optional style?: string

地図スタイル。Geolonia のスタイル論理名('geolonia/basic-v2')、 style.json の完全な URL、または相対パスのいずれか。

Default Value

'geolonia/basic-v2'

transformRequest?

optional transformRequest?: RequestTransformFunction | null

リクエストを送る直前に URL やヘッダーを書き換える関数。MapLibre の transformRequest と同じ形。

Geolonia のソース(api.geolonia.com と Geolonia のタイルホスト)とスプライトのリクエストでは、 maps-core が key や sessionId を付けた後の URL が渡される。 undefined を返すと maps-core の変換結果がそのまま使われる。 Promise を返してもよい。解決値が undefined のときも maps-core の変換結果が使われる。

map.setTransformRequest() で差し替えると maps-core の変換も外れる。後から変えるときは、 maps-core が付ける key や sessionId を自分で付ける必要がある。

Example

const map = new GeoloniaMap({
  container: "#map",
  apiKey: "YOUR-API-KEY",
  style: "geolonia/basic-v2",
  center: [139.7671, 35.6812],
  zoom: 14,
  lang: "ja",
});