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

# YMaps.ToolBarRadioButton

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

Элемент группы переключателей (radio button).

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

Имя | Описание
----- | -----
[YMaps.ToolBarRadioButton](toolbarradiobutton.md#constructor)(groupId, content, options) | Создает отдельный элемент группы переключателей (radio button). Группа переключателей позволяет выбрать одну из нескольких взаимоисключающих возможностей.

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


Из [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)

## События

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

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


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

Из [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)

## Методы

Имя | Возвращает | Описание
----- | ----- | -----
[getGroupId](toolbarradiobutton.md#getGroupId)() | String | Возвращает имя группы, которой принадлежит переключатель.
[select](toolbarradiobutton.md#select)() |  | Устанавливает переключатель в состояние "выбран". При этом, для предыдущего выбранного переключателя группы будет вызван метод deselect().

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


Из [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), [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.ToolBarRadioButton(groupId, content, options)
```

Создает отдельный элемент группы переключателей (radio button). Группа переключателей позволяет выбрать одну из нескольких взаимоисключающих возможностей.

При создании переключателя указывается имя группы, в которую он входит. В каждый момент времени выбран может быть только один из переключателей группы. При выборе другого переключателя, предыдущий выбранный переключатель автоматически снимается.


{% note info %}

Для корректной работы механизма группировки переключателей необходимо, чтобы тулбар, на котором расположена группа, уже был добавлен на карту и карта была инициализирована.

{% endnote %}


**Пример:**

```javascript
// Создает и добавляет на тулбар группу из двух переключателей, которые включают/выключают элементы управления
// "Линейка" и "Увеличение", соответственно.
var btn1 = new YMaps.ToolBarRadioButton('my-group', { icon: "http://some.url/path/img.gif", caption: "Линейка"});
var btn2 = new YMaps.ToolBarRadioButton('my-group', { icon: "http://some.url/path/img.gif", caption: "Увеличить"});
YMaps.Events.observe(btn1, btn1.Events.Select, function () {
    this.getMap().enableRuler();
}, toolbar);
YMaps.Events.observe(btn1, btn1.Events.Deselect, function () {
    this.getMap().disableRuler();
}, toolbar);
YMaps.Events.observe(btn2, btn2.Events.Select, function () {
    this.getMap().enableMagnifier();
}, toolbar);
YMaps.Events.observe(btn2, btn2.Events.Deselect, function () {
    this.getMap().disableMagnifier();
}, toolbar);
toolbar.add(btn1);
toolbar.add(btn2);
```

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

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`groupId` | String |  |  | Группа, к которой принадлежит переключатель.
`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}

### Select {#Select}

```javascript
Select
```

Событие выбора переключателя.

В callback-функцию передаются два аргумента:

- ссылка на переключатель;
- ссылка на предыдущий выбранный переключатель в группе.
## Подробное описание методов {#method_detail}

### getGroupId {#getGroupId}

```javascript
{String} getGroupId()
```

Возвращает имя группы, которой принадлежит переключатель.

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

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

### select {#select}

```javascript
select()
```

Устанавливает переключатель в состояние "выбран". При этом, для предыдущего выбранного переключателя группы будет вызван метод deselect().


{% note info %}

Не используйте этот метод, если тулбар, на котором расположена кнопка, еще не добавлен на карту или карта не инициализирована.

{% endnote %}