---
metadata:
  - name: generator
    content: Diplodoc Platform v5.37.1
alternate:
  - https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/toolbartogglebutton.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/jsapi-v1-1/doc/ru/llms.txt

# YMaps.ToolBarToggleButton

Расширяет [YMaps.ToolBarButton](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/toolbarbutton.md).

Класс для создания кнопки-переключателя на тулбаре.

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

Имя | Описание
----- | -----
[YMaps.ToolBarToggleButton](toolbartogglebutton.md#constructor)(content, options) | Создает кнопку-переключатель на тулбаре.

## Наследуемые поля


Из [YMaps.ToolBarButton](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/toolbarbutton.md): 
: [Events](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/toolbarbutton.md#Events)

## События

Имя | Описание
----- | -----
[Deselect](toolbartogglebutton.md#event-Deselect) | Событие отмены выбора кнопки.
[Select](toolbartogglebutton.md#event-Select) | Событие выбора кнопки.

## Наследуемые события


Из [YMaps.ToolBarButton](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/toolbarbutton.md): 
: [Click](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/toolbarbutton.md#event-Click)

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


Из [YMaps.ToolBarButton](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/toolbarbutton.md): 
: [deselect](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/toolbarbutton.md#deselect), [disable](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/toolbarbutton.md#disable), [enable](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/toolbarbutton.md#enable), [getContent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/toolbarbutton.md#getContent), [getToolBar](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/toolbarbutton.md#getToolBar), [hide](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/toolbarbutton.md#hide), [isEnabled](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/toolbarbutton.md#isEnabled), [isSelected](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/toolbarbutton.md#isSelected), [isShown](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/toolbarbutton.md#isShown), [select](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/toolbarbutton.md#select), [setContent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/toolbarbutton.md#setContent), [show](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/toolbarbutton.md#show)

Из [YMaps.IToolBarItem](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/itoolbaritem.md): 
: [onAddToToolBar](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/itoolbaritem.md#onAddToToolBar), [onRemoveFromToolBar](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/itoolbaritem.md#onRemoveFromToolBar)

## Подробное описание конструктора {#constructor}

```javascript
YMaps.ToolBarToggleButton(content, options)
```

Создает кнопку-переключатель на тулбаре.

**Пример:**

```javascript
// Создает и добавляет на тулбар кнопку-переключатель, которая включает инструмент "Линейка".
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 | ![](../_images/check.png) |  | URL значка кнопки.
`content.caption` | String | ![](../_images/check.png) |  | Заголовок кнопки.
`content.hint` | String | ![](../_images/check.png) |  | Подсказка для кнопки.
`content.width` | Integer | ![](../_images/check.png) |  | Ширина содержимого кнопки (в пикселах).
`options` | Object | ![](../_images/check.png) |  | Опции кнопки.
`options.selected` | Boolean | ![](../_images/check.png) | false | Исходное состояние кнопки: true - нажата, false - не нажата.
`options.enabled` | Boolean | ![](../_images/check.png) | true | true - кнопка доступна, false - кнопка недоступна.


## Подробное описание событий {#event_detail}

### Deselect {#Deselect}

```javascript
Deselect
```

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

```javascript
Select
```

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