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

# YMaps.ToolBar

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

Класс для создания тулбара.

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

Имя | Описание
----- | -----
[YMaps.ToolBar](toolbar.md#constructor)(buttons) | Создает элемент управления "Тулбар".


## Поля

Имя | Статическое | Описание
----- | ----- | -----
[DEFAULT_GROUP](toolbar.md#.DEFAULT_GROUP) | ![](../_images/check.png) | Группа для стандартных кнопок.
[MagnifierButton](toolbar.md#.MagnifierButton) | ![](../_images/check.png) | Конструктор стандартной кнопки "Выделение".
[MoveButton](toolbar.md#.MoveButton) | ![](../_images/check.png) | Конструктор стандартной кнопки "Навигация".
[RulerButton](toolbar.md#.RulerButton) | ![](../_images/check.png) | Конструктор стандартной кнопки "Линейка".

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


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

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

Из [YMaps.Group](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md): 
: [Add](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#event-Add), [Remove](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#event-Remove)

## Методы

Имя | Возвращает | Описание
----- | ----- | -----
[getByGroupId](toolbar.md#getByGroupId)(groupId) | [YMaps.ToolBarRadioButton](toolbarradiobutton.md)[] | Возвращает список кнопок указанной группы.
[getMap](toolbar.md#getMap)() | [YMaps.Map](map.md) | Возвращает карту, на которую добавлен тулбар.

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

Из [YMaps.Group](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md): 
: [add](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#add), [filter](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#filter), [forEach](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#forEach), [get](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#get), [indexOf](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#indexOf), [length](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#length), [remove](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#remove), [removeAll](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#removeAll), [splice](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#splice)

Из [YMaps.IControl](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/icontrol.md): 
: [onAddToMap](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/icontrol.md#onAddToMap), [onRemoveFromMap](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/icontrol.md#onRemoveFromMap)

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

```javascript
YMaps.ToolBar(buttons)
```

Создает элемент управления "Тулбар".

Положение элемента по умолчанию: `YMaps.ControlPosition.TOP_LEFT`, отступ от краев карты - 5 пикселов.

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

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`buttons` | [YMaps.IToolBarItem](itoolbaritem.md)|[YMaps.IToolBarItem](itoolbaritem.md)[] | ![](../_images/check.png) | [new YMaps.ToolBar.MoveButton(), new YMaps.ToolBar.MagnifierButton(), new YMaps.ToolBar.RulerButton()] | Кнопки в тулбаре.

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

### DEFAULT_GROUP {#DEFAULT_GROUP}

```javascript
DEFAULT_GROUP
```

Группа для стандартных кнопок.
### MagnifierButton {#MagnifierButton}

```javascript
MagnifierButton
```

Конструктор стандартной кнопки "Выделение".

Для создания экземпляра кнопки выполните команду `new YMaps.ToolBar.MagnifierButton()`.
### MoveButton {#MoveButton}

```javascript
MoveButton
```

Конструктор стандартной кнопки "Навигация".

Для создания экземпляра кнопки выполните команду `new YMaps.ToolBar.MoveButton()`.
### RulerButton {#RulerButton}

```javascript
RulerButton
```

Конструктор стандартной кнопки "Линейка".

Для создания экземпляра кнопки выполните команду `new YMaps.ToolBar.RulerButton()`.
## Подробное описание методов {#method_detail}

### getByGroupId {#getByGroupId}

```javascript
{YMaps.ToolBarRadioButton[]} getByGroupId(groupId)
```

Возвращает список кнопок указанной группы.

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

Имя | Тип | Описание
----- | ----- | -----
`groupId` | String | Идентификатор группы.


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

Тип | Описание
----- | -----
[YMaps.ToolBarRadioButton](toolbarradiobutton.md)[] | Массив указателей на кнопку.

### getMap {#getMap}

```javascript
{YMaps.Map} getMap()
```

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

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

Тип | Описание
----- | -----
[YMaps.Map](map.md) | Указатель на карту, в которую добавлен тулбар.