StyleControl class
マップのスタイルを変更するためのコントロール。
- Extends
コンストラクター
Style |
StyleControl を構築します。 |
メソッド
disable |
スタイルを無効状態に設定する |
enable |
以前に無効にされた有効なスタイル |
on |
マップに追加されたときに呼び出されるコントロールの初期化メソッド。 |
on |
コントロールがマップから削除されたときに呼び出されるメソッド。 コントロールに必要なクリーンアップを実行する必要があります。 |
set |
現在選択されているとおりに表示する必要があるスタイルを設定します。
が の場合 |
継承されたメソッド
build |
コントロールの最も外側のコンテナーをビルドし、自動スタイル設定用のリスナーを含むスタイル設定を適用します。 |
コンストラクターの詳細
StyleControl(StyleControlOptions)
StyleControl を構築します。
new StyleControl(options?: StyleControlOptions)
パラメーター
- options
- StyleControlOptions
コントロールのオプション。
メソッドの詳細
disableStyle(string)
スタイルを無効状態に設定する
function disableStyle(styleName: string)
パラメーター
- styleName
-
string
無効にするスタイル
enableStyle(string)
以前に無効にされた有効なスタイル
function enableStyle(styleName: string)
パラメーター
- styleName
-
string
無効にするスタイル
onAdd(Map, ControlOptions)
マップに追加されたときに呼び出されるコントロールの初期化メソッド。
function onAdd(map: Map, options?: ControlOptions): HTMLElement
パラメーター
- map
- Map
コントロールが追加されるマップ。
- options
- ControlOptions
このコントロールの ControlOptions。
戻り値
HTMLElement
コントロールのマップに配置する HTMLElement。
onRemove()
コントロールがマップから削除されたときに呼び出されるメソッド。 コントロールに必要なクリーンアップを実行する必要があります。
function onRemove()
setSelectedStyle(string)
現在選択されているとおりに表示する必要があるスタイルを設定します。
が の場合 StyleControlOptions.autoSelectionMode
、スタイルが自動的に選択されます true
function setSelectedStyle(styleName: string)
パラメーター
- styleName
-
string
現在選択されているスタイル名を無効にする必要がある
継承済みメソッドの詳細
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]