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

# YMaps.ToolBarButton

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

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

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

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


## Поля

Имя | Описание
----- | -----
[Events](toolbarbutton.md#Events) | Список событий кнопки.

## События

Имя | Описание
----- | -----
[Click](toolbarbutton.md#event-Click) | Событие щелчка по кнопке.

## Методы

Имя | Возвращает | Описание
----- | ----- | -----
[deselect](toolbarbutton.md#deselect)() |  | Устанавливает кнопку в состояние "не нажата".
[disable](toolbarbutton.md#disable)() |  | Устанавливает кнопку в состояние "недоступна".
[enable](toolbarbutton.md#enable)() |  | Устанавливает кнопку в состояние "доступна".
[getContent](toolbarbutton.md#getContent)() | Object | Возвращает содержимое кнопки.
[getToolBar](toolbarbutton.md#getToolBar)() | [YMaps.ToolBar](toolbar.md) | Возвращает тулбар, на который добавлена кнопка.
[hide](toolbarbutton.md#hide)() |  | Скрывает кнопку.
[isEnabled](toolbarbutton.md#isEnabled)() | Boolean | Возвращает состояние кнопки "доступна"/"недоступна".
[isSelected](toolbarbutton.md#isSelected)() | Boolean | Возвращает состояние кнопки "нажата"/"не нажата".
[isShown](toolbarbutton.md#isShown)() | Boolean | Возвращает состояние видимости кнопки.
[select](toolbarbutton.md#select)() |  | Переводит кнопку в состояние "нажата".
[setContent](toolbarbutton.md#setContent)(content) |  | Устанавливает содержимое кнопки.
[show](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.ToolBarButton(content, options)
```

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

**Пример:**

```javascript
// Создает и добавляет на тулбар кнопку, которая включает инструмент "Линейка".
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 | ![](../_images/check.png) |  | Содержимое кнопки.
`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 - кнопка недоступна.
`options.shown` | Boolean | ![](../_images/check.png) | true | Состояние кнопки по умолчанию: true - показана, false - скрыта.

## Подробное описание полей {#field_detail}

### Events {#Events}

```javascript
Object Events
```

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

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

### Click {#Click}

```javascript
Click
```

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

### deselect {#deselect}

```javascript
deselect()
```

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

```javascript
disable()
```

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

```javascript
enable()
```

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

```javascript
{Object} getContent()
```

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

**Возвращает:**

Тип | Описание
----- | -----
Object | 

### getToolBar {#getToolBar}

```javascript
{YMaps.ToolBar} getToolBar()
```

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

**Возвращает:**

Тип | Описание
----- | -----
[YMaps.ToolBar](toolbar.md) | Тулбар.

### hide {#hide}

```javascript
hide()
```

Скрывает кнопку.
### isEnabled {#isEnabled}

```javascript
{Boolean} isEnabled()
```

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

**Возвращает:**

Тип | Описание
----- | -----
Boolean | true - кнопка доступна, false - кнопка недоступна.

### isSelected {#isSelected}

```javascript
{Boolean} isSelected()
```

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

**Возвращает:**

Тип | Описание
----- | -----
Boolean | true - кнопка нажата, false - кнопка не нажата.

### isShown {#isShown}

```javascript
{Boolean} isShown()
```

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

**Возвращает:**

Тип | Описание
----- | -----
Boolean | true - кнопка видна, false - не видна.

### select {#select}

```javascript
select()
```

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

```javascript
setContent(content)
```

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

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`content` | Object | Содержимое кнопки.

### show {#show}

```javascript
show()
```

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