---
metadata:
- name: generator
content: Diplodoc Platform v5.39.1
alternate:
- https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/SuggestView.md
- https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/SuggestView.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/llms.txt
# SuggestView
{% include [include](../../../_includes/2.1/terms/index-47b676c75e05.md) %}
Расширяет [ICustomizable](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md), [IEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md).
Создаёт выпадающую панель с поисковыми подсказками и прикрепляет к HTML-элементу ``.
[Конструктор](#constructor-summary) | [Поля ](#properties-summary) | [События ](#events-summary) | [Методы ](#methods-summary)
## Конструктор {#constructor-summary}
```javascript
SuggestView(element[, options])
```
**Параметры:**
#|
|| **Параметр** | **Значение по умолчанию** | **Описание** ||
|| [`element`](#param-element)[*](*star) | — | Тип: HTMLElement\|String
HTML-элемент или его id. ||
|| [`options`](#param-options) | — | Тип: Object
Опции. ||
|| [`options.boundedBy`](#param-options.boundedBy) | — | Тип: Number[][]
Прямоугольная область на карте, где предположительно находится искомый объект. Должна быть задана как массив, например [[30, 40], [50, 50]]. ||
|| [`options.container`](#param-options.container) | — | Тип: HTMLElement
HTML-элемент для размещения верстки панели подсказок. Если не задан, панель подсказок добавляется в родителя HTML-элемента input, для которого создаётся. ||
|| [`options.layout`](#param-options.layout) | 'islands#suggestView' | Тип: String\|[ISuggestViewLayout](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISuggestViewLayout.md)
Макет панели.
В конструктор макета передается объект, содержащий поля:
- suggestView — ссылка панель с поисковыми подсказками;
- options — менеджер опций элемента управления (см. suggestView.options);
- state — менеджер состояния элемента управления (см. suggestView.state).
Макет меняет свой внешний вид на основе состояния и опций элемента панели подсказок. Элемент управления, в свою очередь, реагирует на интерфейсные события макета и меняет значения полей suggestView.state в зависимости от полученных команд. ||
|| [`options.offset`](#param-options.offset) | — | Тип: Number[]
Отступы панели подсказок от её положения по умолчанию (по умолчанию панель подсказок прикрепляется к нижней границе элемента input и имеет одинаковую с ним ширину). Задаётся в виде смещений по горизонтали и вертикали относительно левого нижнего угла элемента input. ||
|| [`options.provider`](#param-options.provider) | "yandex#map" | Тип: String\|[ISuggestProvider](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISuggestProvider.md)
Провайдер поисковых подсказок. Может быть задан объектом, реализующим интерфейс [ISuggestProvider](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISuggestProvider.md), либо стандартным значением "yandex#map". ||
|| [`options.results`](#param-options.results) | 5 | Тип: Number
Максимальное количество показываемых подсказок. ||
|| [`options.width`](#param-options.width) | — | Тип: Number
Ширина панели подсказок. По умолчанию совпадает с шириной HTML-элемента input, к которому панель привязана. ||
|| [`options.zIndex`](#param-options.zIndex) | 40000 | Тип: Number
z-index для dom-элемента панели подсказок. ||
|#
\* Обязательный параметр/опция.
**Примеры:**
**1.**
```javascript
```
**2.**
```javascript
```
## Поля {#properties-summary}
#|
|| **Имя** | **Тип** | **Описание** ||
|| [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/SuggestView.md#state) | [data.Manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/data.Manager.md) | Состояние панели поисковых подсказок. Имена полей, доступных через метод data.Manager.get:
- request: String — текущий активный запрос;
- items: Object[] — массив поисковых подсказок (объектов с полями value и displayName);
- activeIndex: Number\|null — индекс текущей активной подсказки, выделенная пользователем путём наведения мыши или с клавиатуры, или null, если ни одна подсказка не активна;
- panelClosed: Boolean — признак, была ли панель закрыта пользователем путём нажатия клавиши ESC или выбора одной из подсказок. ||
|#
## События {#events-summary}
#|
|| **Имя** | **Описание** ||
|| [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). ||
|| [select](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/SuggestView.md#event-select) | Пользователь выбрал одну из поисковых подсказок. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- `item` — поисковая подсказка, объект с полями displayName и value. ||
|#
## Методы {#methods-summary}
#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [destroy](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/SuggestView.md#destroy)() | Уничтожает панель подсказок. ||
|#
## Описание полей {#field_detail}
### state {#state}
```javascript
{data.Manager} state
```
Состояние панели поисковых подсказок. Имена полей, доступных через метод data.Manager.get:
- request: String — текущий активный запрос;
- items: Object[] — массив поисковых подсказок (объектов с полями value и displayName);
- activeIndex: Number\|null — индекс текущей активной подсказки, выделенная пользователем путём наведения мыши или с клавиатуры, или null, если ни одна подсказка не активна;
- panelClosed: Boolean — признак, была ли панель закрыта пользователем путём нажатия клавиши ESC или выбора одной из подсказок.
## Описание событий {#event_detail}
### select {#select}
Пользователь выбрал одну из поисковых подсказок. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- `item` — поисковая подсказка, объект с полями displayName и value.
## Описание методов {#method_detail}
### destroy {#destroy}
```javascript
{} destroy()
```
Уничтожает панель подсказок.
[*star]: Обязательный параметр.