StyleControl class

パッケージ:

azure-maps-control

マップのスタイルを変更するためのコントロール。

Extends

ControlBase<StyleControlEvents>

コンストラクター

StyleControl(StyleControlOptions)

StyleControl を構築します。

メソッド

disableStyle(string)	スタイルを無効状態に設定する
enableStyle(string)	以前に無効にされた有効なスタイル
onAdd(Map, ControlOptions)	マップに追加されたときに呼び出されるコントロールの初期化メソッド。
onRemove()	コントロールがマップから削除されたときに呼び出されるメソッド。 コントロールに必要なクリーンアップを実行する必要があります。
setSelectedStyle(string)	現在選択されているとおりに表示する必要があるスタイルを設定します。 が の場合 StyleControlOptions.autoSelectionMode 、スタイルが自動的に選択されます true

継承されたメソッド

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

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

コンストラクターの詳細

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]

ControlBase.buildContainerから継承