---
metadata:
  - name: generator
    content: Diplodoc Platform v5.39.1
alternate:
  - https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/control.ListBoxItem.md
  - https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.ListBoxItem.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/llms.txt

# control.ListBoxItem

Расширяет [ICustomizable](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md), [ISelectableControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md).

Элемент раскрывающегося списка.

[Конструктор](#constructor-summary) | [Поля ](#properties-summary) | [События ](#events-summary) | [Методы ](#methods-summary)

## Конструктор {#constructor-summary}

```javascript
control.ListBoxItem([parameters])
```

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`parameters`](#param-parameters) | — | Тип: Object\|String

Параметры элемента либо строка - HTML-содержимое элемента. ||
|| [`parameters.data`](#param-parameters.data) | — | Тип: Object

Данные элемента. ||
|| [`parameters.data.content`](#param-parameters.data.content) | — | Тип: String

Содержимое элемента. ||
|| [`parameters.options`](#param-parameters.options) | — | Тип: Object

Опции элемента управления. ||
|| [`parameters.options.layout`](#param-parameters.options.layout) | 'islands#listBoxItemLayout' | Тип: Function\|String

Конструктор макета элемента управления, реализующий интерфейс [ISelectableControlLayout](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControlLayout.md) или ключ макета в хранилище [layout.storage](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/layout.storage.md). Это базовый макет, который в зависимости от значения опции type выбирает, какой из подмакетов отобразить - options.selectableLayout или options.separatorLayout. В конструктор макета передается объект, содержащий поля:
- control - ссылка на элемент управления;
- options - менеджер опций элемента управления control.ListBoxItem.options;
- data - менеджер данных элемента управления [control.ListBoxItem.data](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.ListBoxItem.md#data);
- state - менеджер состояния элемента управления [control.ListBoxItem.state](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.ListBoxItem.md#state).
Макет меняет свой внешний вид на основе данных, состояния и опций элемента управления. Элемент управления, в свою очередь, реагирует на интерфейсные события макета и меняет значения полей [control.ListBoxItem.state](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.ListBoxItem.md#state) в зависимости от полученных команд. ||
|| [`parameters.options.selectableLayout`](#param-parameters.options.selectableLayout) | 'islands#listBoxItemSelectableLayout' | Тип: Function|String

Конструктор макета элемента списка, реализующий интерфейс [ISelectableControlLayout](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControlLayout.md) или ключ макета в хранилище [layout.storage](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/layout.storage.md). Применяется к элементам с опцией type='item'. Опция стандартной реализации макета элемента списка. ||
|| [`parameters.options.selectOnClick`](#param-parameters.options.selectOnClick) | true | Тип: Boolean

Флаг, разрешающий автоматическое выделение элемента списка по клику.
- true — элемент списка выделяется после клика и меняет значение поля [control.ListBoxItem.state](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.ListBoxItem.md#state) на 'selected';
- false — элемент списка не меняет свой внешний вид и состояние после клика. ||
|| [`parameters.options.separatorLayout`](#param-parameters.options.separatorLayout) | 'islands#listBoxItemSeparatorLayout' | Тип: Function\|String

Конструктор макета разделителя элементов списка, реализующий интерфейс IControlLayout или ключ макета в хранилище [layout.storage](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/layout.storage.md). Применяется к элементам с опцией type='separator'. Опция стандартной реализации макета элемента списка. ||
|| [`parameters.options.type`](#param-parameters.options.type) | 'selectable' | Тип: String

Тип пункта меню. В зависимости от значения этой опции макет элемента списка инстанцирует один из подмакетов - options.selectableLayout или options.separatorLayout. Возможные значения:
- 'selectable' - элемент списка, выделяется галочкой справа от содержимого;
- 'separator' - разделитель. ||
|| [`parameters.options.visible`](#param-parameters.options.visible) | true | Тип: Boolean

Признак того, что элемент управления отображается. ||
|| [`parameters.state`](#param-parameters.state) | — | Тип: Object

Объект, описывающий состояние пункта меню. ||
|| [`parameters.state.selected`](#param-parameters.state.selected) | false | Тип: Boolean

Признак, выбран ли пункт. ||
|#


## Поля {#properties-summary}

#|
|| **Имя** | **Тип** | **Описание** ||
|| [data](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.ListBoxItem.md#data) | [data.Manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/data.Manager.md) | Данные элемента списка. Имена полей, доступных через метод data.Manager.get:
- content - cодержимое элемента списка в виде HTML;
- title - текст всплывающей подсказки. ||
|| [events](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md#events) | [IEventManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventManager.md) | Менеджер событий.

Унаследовано от [IEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md#events). ||
|| [options](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#options) | [IOptionManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOptionManager.md) | Менеджер опций.

Унаследовано от [ICustomizable](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#options). ||
|| [state](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.ListBoxItem.md#state) | [data.Manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/data.Manager.md) | Состояние элемента списка. Имена полей, доступных через метод data.Manager.get:
- selected - признак, выбран ли элемент списка;
- enabled - признак, активен ли элемент списка. ||
- |#

## События {#events-summary}

#|
|| **Имя** | **Описание** ||
|| [click](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.ListBoxItem.md#event-click) | Выбор элемента списка. ||
|| [deselect](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#event-deselect) | Элемент управления не выбран.

Унаследовано от [ISelectableControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#event-deselect). ||
|| [disable](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#event-disable) | Элемент управления стал недоступным.

Унаследовано от [ISelectableControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#event-disable). ||
|| [enable](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#event-enable) | Элемент управления стал доступным.

Унаследовано от [ISelectableControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#event-enable). ||
|| [optionschange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange) | Изменение в опциях объекта.

Унаследовано от [ICustomizable](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange). ||
|| [parentchange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChild.md#event-parentchange) | Сменился родительский объект.

Поля данных:

- oldParent - старый родитель;
- newParent - новый родитель.

Унаследовано от [IChild](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChild.md#event-parentchange). ||
|| [select](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#event-select) | Элемент управления выбран.

Унаследовано от [ISelectableControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#event-select). ||
|#

## Методы {#methods-summary}

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [deselect](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#deselect)() | | Отменяет выбор элемента управления (выключает).

Унаследован от [ISelectableControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#deselect). ||
|| [disable](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#disable)() | | Делает элемент управления недоступным (запрещены пользовательские действия).

Унаследован от [ISelectableControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#disable). ||
|| [enable](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#enable)() | | Делает элемент управления доступным (разрешены пользовательские действия).

Унаследован от [ISelectableControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#enable). ||
|| [getMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.ListBoxItem.md#getMap)() | [Map](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Map.md) | Возвращает ссылку на карту. ||
|| [getParent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#getParent)() | [IControlParent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControlParent.md)\|null | Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен.

Унаследован от [IControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#getParent). ||
|| [isEnabled](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#isEnabled)() | Boolean | Возвращает true - элемент управления доступен, false - недоступен.

Унаследован от [ISelectableControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#isEnabled). ||
|| [isSelected](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#isSelected)() | Boolean | Возвращает true - элемент управления выбран, false - не выбран.

Унаследован от [ISelectableControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#isSelected). ||
|| [select](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#select)() | | Выбирает (включает) элемент управления.

Унаследован от [ISelectableControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISelectableControl.md#select). ||
|| [setParent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#setParent)([parent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#setParent-param-parent)) | [IChildOnMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md) | Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта.

Унаследован от [IControl](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#setParent). ||
|#

## Описание полей {#field_detail}

### data {#data}

```javascript
{data.Manager} data
```

Данные элемента списка. Имена полей, доступных через метод data.Manager.get:
- content - cодержимое элемента списка в виде HTML;
- title - текст всплывающей подсказки.

### state {#state}

```javascript
{data.Manager} state
```

Состояние элемента списка. Имена полей, доступных через метод data.Manager.get:
- selected - признак, выбран ли элемент списка;
- enabled - признак, активен ли элемент списка.

## Описание событий {#event_detail}

### click {#click}

Выбор элемента списка.

## Описание методов {#method_detail}

### getMap {#getMap}

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

**Возвращает** ссылку на карту.

<!-- XLIFF_FARM_M2YyYTU0_CACHING -->