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

# YMaps.ListBox

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

Класс для создания элемента тулбара в виде раскрывающегося списка.

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

Список может иметь заголовок, который показывается на тулбаре. В список можно добавлять и удалять элементы. Элементы списка могут быть как экземплярами стандартных классов YMaps.ToolBarItem и YMaps.ToolBarToggleItem, так и пользовательскими объектами, реализующими интерфейс [YMaps.IToolBarItem](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/itoolbaritem.md).
## Конструктор

Имя | Описание
----- | -----
[YMaps.ListBox](listbox.md#constructor)(options) | Создает элемент тулбара в виде раскрывающегося списка.

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

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

## Методы

Имя | Возвращает | Описание
----- | ----- | -----
[collapse](listbox.md#collapse)() |  | Скрывает список.
[expand](listbox.md#expand)() |  | Раскрывает список.
[getCaption](listbox.md#getCaption)() | String | Возвращает текущий заголовок раскрывающегося списка.
[getToolBar](listbox.md#getToolBar)() | [YMaps.ToolBar](toolbar.md) | Возвращает тулбар, на который добавлен раскрывающийся список.
[isExpanded](listbox.md#isExpanded)() | Boolean | Возвращает состояние раскрывающегося списка (раскрыт/скрыт).
[setCaption](listbox.md#setCaption)(caption) |  | Задает новый заголовок раскрывающегося списка.

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

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

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

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

```javascript
YMaps.ListBox(options)
```

Создает элемент тулбара в виде раскрывающегося списка.

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

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`options` | Object |  |  | Опции раскрывающегося списка.
`options.width` | Integer | ![](../_images/check.png) | 140 | Ширина списка (в пикселах).
`options.caption` | String | ![](../_images/check.png) | '' | Заголовок списка.

## Подробное описание методов {#method_detail}

### collapse {#collapse}

```javascript
collapse()
```

Скрывает список.
### expand {#expand}

```javascript
expand()
```

Раскрывает список.
### getCaption {#getCaption}

```javascript
{String} getCaption()
```

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

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

Тип | Описание
----- | -----
String | Заголовок списка.

### getToolBar {#getToolBar}

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

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

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

Тип | Описание
----- | -----
[YMaps.ToolBar](toolbar.md) | Тулбар, на который добавлен раскрывающийся список.

### isExpanded {#isExpanded}

```javascript
{Boolean} isExpanded()
```

Возвращает состояние раскрывающегося списка (раскрыт/скрыт).

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

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

### setCaption {#setCaption}

```javascript
setCaption(caption)
```

Задает новый заголовок раскрывающегося списка.

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

Имя | Тип | Описание
----- | ----- | -----
`caption` | String | Новый заголовок списка.