ScaleControl class

マップ上にスケール バーを表示するコントロール。

Extends

コンストラクター

ScaleControl(ScaleControlOptions)

ScaleControl を構築します。

メソッド

onAdd(Map, ControlOptions)

マップに追加されたときに呼び出されるコントロールの初期化メソッド。

onRemove()

コントロールがマップから削除されたときに呼び出されるメソッド。 コントロールに必要なクリーンアップを実行する必要があります。

setUnit("imperial" | "metric" | "nautical")

距離のスケールの単位を設定する

継承されたメソッド

buildContainer<K>(Map, ControlStyle, string, K)

コントロールの最も外側のコンテナーをビルドし、自動スタイル設定用のリスナーを含むスタイル設定を適用します。

コンストラクターの詳細

ScaleControl(ScaleControlOptions)

ScaleControl を構築します。

new ScaleControl(options?: ScaleControlOptions)

パラメーター

options
ScaleControlOptions

コントロールのオプション。

メソッドの詳細

onAdd(Map, ControlOptions)

マップに追加されたときに呼び出されるコントロールの初期化メソッド。

function onAdd(map: Map, options?: ControlOptions): HTMLElement

パラメーター

map
Map

コントロールが追加されるマップ。

options
ControlOptions

このコントロールの ControlOptions。

戻り値

HTMLElement

コントロールのマップに配置する HTMLElement。

onRemove()

コントロールがマップから削除されたときに呼び出されるメソッド。 コントロールに必要なクリーンアップを実行する必要があります。

function onRemove()

setUnit("imperial" | "metric" | "nautical")

距離のスケールの単位を設定する

function setUnit(unit: "imperial" | "metric" | "nautical")

パラメーター

unit

"imperial" | "metric" | "nautical"

距離の単位 ('imperial''metric' または 'nautical')。

継承済みメソッドの詳細

buildContainer<K>(Map, ControlStyle, string, K)

コントロールの最も外側のコンテナーをビルドし、自動スタイル設定用のリスナーを含むスタイル設定を適用します。

function buildContainer<K>(map: Map, style: ControlStyle, ariaLabel?: string, tagName?: K): HTMLElementTagNameMap[K]

パラメーター

map
Map
style
ControlStyle
ariaLabel

string

tagName

K

戻り値

HTMLElementTagNameMap[K]

ControlBase.buildContainerから継承