YMaps.ToolBarButton

Расширяет YMaps.IToolBarItem.

Класс кнопки тулбара.

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

ПоляПоля

СобытияСобытия

МетодыМетоды

Наследуемые методыНаследуемые методы

Из YMaps.IToolBarItem:

onAddToToolBar, onRemoveFromToolBar

Подробное описание конструктораПодробное описание конструктора

YMaps.ToolBarButton(content, options)

Создает кнопку тулбара. Обычная кнопка тулбара имеет три состояния: кнопка нажата, кнопка не нажата, кнопка недоступна.

Пример:

// Создает и добавляет на тулбар кнопку, которая включает инструмент "Линейка".
var btn = new YMaps.ToolBarButton({ icon: "http://some.url/path/img.gif", caption: "Линейка", hint: "Линейка для измерения расстояний между точками"});
YMaps.Events.observe(btn, btn.Events.Click, function () {
    this.getMap().enableRuler();
}, 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 - кнопка недоступна.
options.shown	Boolean		true	Состояние кнопки по умолчанию: true - показана, false - скрыта.

Подробное описание полейПодробное описание полей

EventsEvents

Object Events

Список событий кнопки.

Подробное описание событийПодробное описание событий

ClickClick

Click

Событие щелчка по кнопке. В callback-функцию передается ссылка на кнопку, для которой был вызван обработчик.

Подробное описание методовПодробное описание методов

deselectdeselect

deselect()

Устанавливает кнопку в состояние "не нажата".

disabledisable

disable()

Устанавливает кнопку в состояние "недоступна". Не применяется к нажатым кнопкам.

enableenable

enable()

Устанавливает кнопку в состояние "доступна".

getContentgetContent

{Object} getContent()

Возвращает содержимое кнопки.

Возвращает:

getToolBargetToolBar

{YMaps.ToolBar} getToolBar()

Возвращает тулбар, на который добавлена кнопка.

Возвращает:

hidehide

hide()

Скрывает кнопку.

isEnabledisEnabled

{Boolean} isEnabled()

Возвращает состояние кнопки "доступна"/"недоступна".

Возвращает:

isSelectedisSelected

{Boolean} isSelected()

Возвращает состояние кнопки "нажата"/"не нажата".

Возвращает:

isShownisShown

{Boolean} isShown()

Возвращает состояние видимости кнопки.

Возвращает:

selectselect

select()

Переводит кнопку в состояние "нажата". Операция не применяется к недоступным кнопкам.

setContentsetContent

setContent(content)

Устанавливает содержимое кнопки.

Параметры:

showshow

show()

Показывает кнопку.