ISuggestProvider
Интерфейс провайдера поисковых подсказок.
Конструктор
ISuggestProvider()Методы
| Имя | Возвращает | Описание |
|---|---|---|
| suggest(request[, options]) | Отправляет запрос за поисковыми подсказками. Возвращает объект Promise, который будет либо отклонён с ошибкой, либо подтверждён массивом объектов вида { displayName: "Мытищи, Московская область", value: "Россия, Московская область, Мытищи ", hl: [[0,5]] }. Поле displayName отвечает за представление топонима в удобном для чтения пользователем виде. Поле value – значение, которое необходимо подставить в поле ввода после выбора пользователем данной подсказки. Поле hl – массив диапазонов подсветки, необходимых, чтобы показать, какая именно часть результата совпала с запросом. Диапазон подсветки - массив из двух чисел: индексы начального и конечного символов диапазона. |
| Имя | Возвращает | Описание |
|---|---|---|
| suggest(request[, options]) | Отправляет запрос за поисковыми подсказками. Возвращает объект Promise, который будет либо отклонён с ошибкой, либо подтверждён массивом объектов вида { displayName: "Мытищи, Московская область", value: "Россия, Московская область, Мытищи ", hl: [[0,5]] }. Поле displayName отвечает за представление топонима в удобном для чтения пользователем виде. Поле value – значение, которое необходимо подставить в поле ввода после выбора пользователем данной подсказки. Поле hl – массив диапазонов подсветки, необходимых, чтобы показать, какая именно часть результата совпала с запросом. Диапазон подсветки - массив из двух чисел: индексы начального и конечного символов диапазона. |
Описание методов
suggest
{vow.Promise} suggest(request[, options])Отправляет запрос за поисковыми подсказками. Возвращает объект Promise, который будет либо отклонён с ошибкой, либо подтверждён массивом объектов вида { displayName: "Мытищи, Московская область", value: "Россия, Московская область, Мытищи ", hl: [[0,5]] }. Поле displayName отвечает за представление топонима в удобном для чтения пользователем виде. Поле value – значение, которое необходимо подставить в поле ввода после выбора пользователем данной подсказки. Поле hl – массив диапазонов подсветки, необходимых, чтобы показать, какая именно часть результата совпала с запросом. Диапазон подсветки - массив из двух чисел: индексы начального и конечного символов диапазона.
Возвращает объект Promise.
Параметры:
| Параметр | Значение по умолчанию | Описание |
|---|---|---|
| request * | — | Тип: String Строка запроса. |
| options | — | Тип: Object Опции. |
| options.boundedBy | — | Тип: Number[][] Прямоугольная область на карте, где предположительно находится искомый объект. Должна быть задана как массив, например [[30, 40], [50, 50]]. |
| options.results | — | Тип: Number Максимальное количество возвращаемых результатов. |
| Параметр | Значение по умолчанию | Описание |
|---|---|---|
| request * | — | Тип: String Строка запроса. |
| options | — | Тип: Object Опции. |
| options.boundedBy | — | Тип: Number[][] Прямоугольная область на карте, где предположительно находится искомый объект. Должна быть задана как массив, например [[30, 40], [50, 50]]. |
| options.results | — | Тип: Number Максимальное количество возвращаемых результатов. |
* Обязательный параметр/опция.