Поделиться через


StyleControl class

Элемент управления для изменения стиля карты.

Extends

Конструкторы

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