YMaps.ToolBarToggleButton
Расширяет YMaps.ToolBarButton.
Класс для создания кнопки-переключателя на тулбаре.
Конструктор
Имя | Описание |
---|---|
YMaps.ToolBarToggleButton(content, options) | Создает кнопку-переключатель на тулбаре. |
Наследуемые поля
События
Имя | Описание |
---|---|
Deselect | Событие отмены выбора кнопки. |
Select | Событие выбора кнопки. |
Наследуемые события
Наследуемые методы
- Из YMaps.ToolBarButton:
- deselect, disable, enable, getContent, getToolBar, hide, isEnabled, isSelected, isShown, select, setContent, show
- Из YMaps.IToolBarItem:
- onAddToToolBar, onRemoveFromToolBar
Подробное описание конструктора
YMaps.ToolBarToggleButton(content, options)
Создает кнопку-переключатель на тулбаре.
Пример:
// Создает и добавляет на тулбар кнопку-переключатель, которая включает инструмент "Линейка".
var btn = new YMaps.ToolBarToggleButton({ icon: "http://some.url/path/img.gif", caption: "Линейка", hint: "Линейка для измерения расстояний между точками"});
YMaps.Events.observe(btn, btn.Events.Select, function () {
this.getMap().enableRuler();
}, toolbar);
YMaps.Events.observe(btn, btn.Events.Deselect, function () {
this.getMap().disableRuler();
}, toolbar);
toolbar.add(btn);
Параметры:
Имя | Тип | Необязательный | По умолчанию | Описание |
---|---|---|---|---|
content |
Object | Содержимое кнопки. | ||
content.icon |
String | URL значка кнопки. | ||
content.caption |
String | Заголовок кнопки. | ||
content.hint |
String | Подсказка для кнопки. | ||
content.width |
Integer | Ширина содержимого кнопки (в пикселах). | ||
options |
Object | Опции кнопки. | ||
options.selected |
Boolean | false | Исходное состояние кнопки: true - нажата, false - не нажата. | |
options.enabled |
Boolean | true | true - кнопка доступна, false - кнопка недоступна. |
Подробное описание событий
Deselect
Deselect
Событие отмены выбора кнопки. В callback-функцию передается ссылка на кнопку, для которой был вызван обработчик.
Select
Select
Событие выбора кнопки. В callback-функцию передается ссылка на кнопку, для которой был вызван обработчик.