--- metadata: - name: generator content: Diplodoc Platform v5.39.1 alternate: - https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/llms.txt # control.SearchControl Расширяет [IControl](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IControl.md), [ICustomizable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md). Элемент управления "Поиск по карте". Позволяет обрабатывать поисковый запрос пользователя и отображать результат в панели и на карте. Каждый результат поиска представляется в панели элемента управления в виде двухстрочного блока. Для формирования блока используются поля name и description объекта-результата геокодирования. ## Конструктор {#constructor} ```javascript control.SearchControl([options]) ``` **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || `options` | — | Тип: Object Опции. || || `options.boundedBy` | — | Тип: Number[][] Прямоугольная область на карте, где предположительно находится искомый объект. При ранжировании объекты, находящиеся внутри указанной области, будут получать больший приоритет. || || `options.kind` | 'house' | Тип: String Вид топонима (только для обратного геокодирования). Список возможных значений: • house - дом; • street - улица; • metro - станция метро; • district - район города; • locality - населенный пункт (город/поселок/деревня/село/...). || || `options.layout` | — | Тип: Function\|String Макет элемента управления. В конструктор макета передается объект, содержащий поля: • control - ссылка на элемент управления; • options - менеджер опций элемента управления control.SearchControl.options; • data - менеджер данных элемента управления control.SearchControl.data; • state - менеджер состояния элемента управления [control.SearchControl.state](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#state). Макет меняет свой внешний вид на основе данных, состояния и опций элемента управления. Элемент управления, в свою очередь, реагирует на интерфейсные события макета и меняет значения полей [control.SearchControl.state](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#state) в зависимости от полученных команд. (Тип: конструктор объекта с интерфейсом [ISearchControlLayout](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ISearchControlLayout.md) или ключ макета). || || `options.noCentering` | false | Тип: Boolean false - автоматически располагать центр карты так, чтобы объект был виден целиком. true - не изменять центр карты при показе найденного объекта. || || `options.noPlacemark` | false | Тип: Boolean false - автоматически добавлять в центр найденного объекта метку с открытым балуном, true - не добавлять. Если указать noCentering = true и noPlacemark = true, то при щелчке по результату поиска никаких видимых изменений на карте не произойдет. || || `options.noPopup` | false | Тип: Boolean true - не показывать выпадающий список результатов, false - показывать. || || `options.position` | \{ top: 5, left: 104 \} | Тип: Object Положение элемента управления над картой. Задается в виде объекта со следующими полями: • top - отступ от верхнего края контейнера карты в пикселах; • right - отступ от правого края контейнера карты в пикселах; • bottom - отступ от нижнего края контейнера карты в пикселах; • left - отступ от левого края контейнера карты в пикселах. Если при этом заданы одновременно и top, и bottom, то значение bottom игнорируется. Аналогично, если заданы одновременно и left, и right, то значение right игнорируется. Если элемент управления добавляется в группу элементов (например, в тулбар или раскрывающийся список), то значение position не применяется. || || `options.provider` | 'yandex#map' | Тип: [IGeocodeProvider](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeocodeProvider.md)\|String Провайдер геокодирования. Доступный провайдер: • 'yandex#map' - поиск по карте. || || `options.resultsPerPage` | 3 | Тип: Integer Количество результатов поиска на странице. Максимальное значение - 20. || || `options.searchCoordOrder` | 'latlong' | Тип: String Определяет каким образом нужно интрепретировать координаты в запросе. По умолчанию координаты будут обрабатываться как широта-долгота. || || `options.strictBounds` | — | Тип: Boolean Искать только внутри области, заданной опцией boundedBy. Объекты вне указанной области попадать в выдачу не будут. || || `options.useMapBounds` | — | Тип: Boolean Флаг, позволяющий учитывать при поиске границы видимой области карты. При значении true, рассчитанная область видимости имеет больший приоритет, чем заданная через boundedBy. || || `options.visible` | true | Тип: Boolean Признак того, что элемент управления отображается. || || `options.width` | 240 | Тип: Integer Ширина элемента (в пикселах). Минимальное значение: 200. || |# **Пример:** ```javascript // Пример 1. // Создаем карту и панель поиска var map = new ym.Map('map', { center: [51.700684, 39.23291], zoom: 4 }), searchControl = new ym.control.SearchControl({ provider: 'yandex#publicMap' }); // добавляем панель на карту в нужную позицию map.controls.add(searchControl, { left: '40px', top: '10px' }); ``` ## Поля {#fields} #| || **Имя** | **Тип** | **Описание** || || [events](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IEventEmitter.md#events) | [IEventManager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IEventManager.md) | Менеджер событий. Унаследовано от [IEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IEventEmitter.md#events). || || [options](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#options) | [IOptionManager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOptionManager.md) | Менеджер опций. Унаследовано от [ICustomizable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#options). || || [state](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#state) | [data.Manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/data.Manager.md) | Состояние элемента управления. Имена полей, доступных через метод data.Manager.get: • results - массив, содержащий результаты поиска; • currentIndex - индекс текущего выбранного элемента; • pageNumber - текущая страница выдачи результатов; • found - общее количество найденных результатов; • request - текущий активный запрос; • suggest - исправленный запрос; • expanded - признак, свернут или развернут элемент управления; • opened - признак, показана ли панель выдачи результата. || |# ## События {#events} #| || **Имя** | **Описание** || || [close](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#close) | Событие закрытия поисковой панели. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). || || [collapse](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#collapse) | Событие схлопывания поисковой панели. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). || || [expand](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#expand) | Событие развертывания поисковой панели. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). || || [load](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#load) | Событие получения результатов поиска с сервера. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). || || [mapchange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md#mapchange) | Сменилась карта. Поля данных: • oldMap - старая карта; • newMap - новая карта. Унаследовано от [IChildOnMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md#mapchange). || || [open](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#open) | Событие открытия поисковой панели. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). || || [optionschange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#optionschange) | Изменение в опциях объекта. Унаследовано от [ICustomizable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#optionschange). || || [pagechange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#pagechange) | Событие смены страницы с результатами поиска. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). || || [parentchange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChild.md#parentchange) | Сменился родительский объект. Поля данных: • oldParent - старый родитель; • newParent - новый родитель. Унаследовано от [IChild](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChild.md#parentchange). || || [resultselect](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#resultselect) | Событие выбора результата поиска. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). Имена полей, доступных через метод Event.get: • resultIndex - индекс выбранного результата. || || [resultshow](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#resultshow) | Событие показа выбранного результата поиска. Индекс выбранного результата можно получить через свойство события 'resultIndex'. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). || || [submit](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#submit) | Событие отправления поискового запроса на сервер. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). || |# ## Методы {#method} #| || **Имя** | **Возвращает** | **Описание** || || [close](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#close)() | [control.SearchControl](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md) | Закрывает панель с результатами поиска. || || [collapse](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#collapse)() | [control.SearchControl](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md) | Сворачивает панель с результатами поиска. || || [expand](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#expand)() | [control.SearchControl](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md) | Разворачивает панель с результатами поиска. || || [getCurrentPage](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#getCurrentPage)() | Integer | Returns индекс текущий страницы с результатами запроса. Индексы начинаются с 0. || || [getPageCount](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#getPageCount)() | Integer | Возвращает количество страниц результатов текущего поискового запроса. || || [getParent](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IControl.md#getParent)() | [IControlParent](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IControlParent.md) | Returns ссылку на родительский объект. Унаследован от [IControl](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IControl.md#getParent). || || [getRequestString](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#getRequestString)() | String | Возвращает строку, содержащую текущий поисковый запрос. || || [getResult](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#getResult)([index](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#getResult-param-index)) | [util.Promise](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/util.Promise.md) | Предоставляет доступ к результату по заданному индексу. Это асинхронный метод. Если результат с заданным индексом еще не загружен, то он загрузится. || || [getResultCount](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#getResultCount)() | Integer | Возвращает количество результатов текущего поискового запроса. || || [getSelectedIndex](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#getSelectedIndex)() | Integer | Returns индекс текущего выбранного элемента. || || [getSuggestString](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#getSuggestString)() | String | Возвращает строку, содержащую исправленный поисковый запрос, если была допущена опечатка. || || [isExpanded](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#isExpanded)() | Boolean | Возвращает true, если панель с результатами поиска развернута, false - в противном случае. || || [isOpen](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#isOpen)() | Boolean | Возвращает true, если панель с результатами поиска открыта, false - в противном случае. || || [open](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#open)() | [control.SearchControl](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md) | Открывает панель с результатами поиска. || || [search](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#search)([request](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#search-param-request)) | [util.Promise](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/util.Promise.md) | Осуществляет поиск. || || [setParent](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IControl.md#setParent)([parent](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IControl.md#setParent-param-parent)) | [IChildOnMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md) | Устанавливает родительский объект. Унаследован от [IControl](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IControl.md#setParent). || || [showPage](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#showPage)([page](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#showPage-param-page)) | [util.Promise](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/util.Promise.md) | Показывает страницу с результатами запроса по заданному индексу. Индексы страниц начинаются с 0. || || [showResult](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#showResult)([index](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.SearchControl.md#showResult-param-index)) | [util.Promise](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/util.Promise.md) | Отображает результат с заданным индексом. || |# ## Описание полей {#description-fields} ### state ```javascript {data.Manager} state ``` Состояние элемента управления. Имена полей, доступных через метод data.Manager.get: • results - массив, содержащий результаты поиска; • currentIndex - индекс текущего выбранного элемента; • pageNumber - текущая страница выдачи результатов; • found - общее количество найденных результатов; • request - текущий активный запрос; • suggest - исправленный запрос; • expanded - признак, свернут или развернут элемент управления; • opened - признак, показана ли панель выдачи результата. ## Описание событий {#description-events} ### close Событие закрытия поисковой панели. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). ### collapse Событие схлопывания поисковой панели. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). ### expand Событие развертывания поисковой панели. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). ### load Событие получения результатов поиска с сервера. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). ### open Событие открытия поисковой панели. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). ### pagechange Событие смены страницы с результатами поиска. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). ### resultselect Событие выбора результата поиска. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). Имена полей, доступных через метод Event.get: • resultIndex - индекс выбранного результата. ### resultshow Событие показа выбранного результата поиска. Индекс выбранного результата можно получить через свойство события 'resultIndex'. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). ### submit Событие отправления поискового запроса на сервер. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). ## Описание методов {#description-methods} ### close ```javascript {control.SearchControl} close() ``` Закрывает панель с результатами поиска. **Returns** ссылку на себя. ### collapse ```javascript {control.SearchControl} collapse() ``` Сворачивает панель с результатами поиска. **Returns** ссылку на себя. ### expand ```javascript {control.SearchControl} expand() ``` Разворачивает панель с результатами поиска. **Returns** ссылку на себя. ### getCurrentPage ```javascript {Integer} getCurrentPage() ``` **Returns** индекс текущий страницы с результатами запроса. Индексы начинаются с 0. ### getPageCount ```javascript {Integer} getPageCount() ``` Возвращает количество страниц результатов текущего поискового запроса. **Returns** количество страниц. ### getRequestString ```javascript {String} getRequestString() ``` Возвращает строку, содержащую текущий поисковый запрос. **Returns** строка, содержащая текущий поисковый запрос. ### getResult ```javascript {util.Promise} getResult(index) ``` Предоставляет доступ к результату по заданному индексу. Это асинхронный метод. Если результат с заданным индексом еще не загружен, то он загрузится. **Returns** возвращает объект типа [util.Promise](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/util.Promise.md). **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || `index`[*](*parametr) | — | Тип: Integer Индекс результата, начинается с 0. || |# \* Обязательный параметр/опция. **Пример:** ```javascript searchControl.getResult(5).then(function (result) { alert(result.properties.get('name')); }); ``` ### getResultCount ```javascript {Integer} getResultCount() ``` Возвращает количество результатов текущего поискового запроса. **Returns** количество результатов. ### getSelectedIndex ```javascript {Integer} getSelectedIndex() ``` **Returns** индекс текущего выбранного элемента. ### getSuggestString ```javascript {String} getSuggestString() ``` Возвращает строку, содержащую исправленный поисковый запрос, если была допущена опечатка. **Returns** строка, содержащая исправленный поисковый запрос. ### isExpanded ```javascript {Boolean} isExpanded() ``` Возвращает true, если панель с результатами поиска развернута, false - в противном случае. **Returns** true если панель развернута. ### isOpen ```javascript {Boolean} isOpen() ``` Возвращает true, если панель с результатами поиска открыта, false - в противном случае. **Returns** true если панель развернута. ### open ```javascript {control.SearchControl} open() ``` Открывает панель с результатами поиска. **Returns** ссылку на себя. ### search ```javascript {util.Promise} search(request) ``` Осуществляет поиск. **Returns** возвращает объект типа [util.Promise](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/util.Promise.md). **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || `request`[*](*parametr) | — | Тип: String Запрос. || |# \* Обязательный параметр/опция. **Пример:** ```javascript searchControl.search('Москва').then(function (geoObjectsArr) { // geoObjectsArr - это массив геообъектов, содержащий результаты запроса. // выводит свойство name первого геообъекта из результатов запроса alert(geoObjectsArr[0].properties.get('name')); }); ``` ### showPage ```javascript {util.Promise} showPage(page) ``` Показывает страницу с результатами запроса по заданному индексу. Индексы страниц начинаются с 0. **Returns** возвращает объект типа [util.Promise](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/util.Promise.md). **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || `page`[*](*parametr) | — | Тип: Integer Индекс страницы, которую нужно показать. || |# \* Обязательный параметр/опция. **Пример:** ```javascript searchControl.showPage(1).then( function (pageIndex) { alert('Показана страница ' + pageIndex); } ); ``` ### showResult ```javascript {util.Promise} showResult(index) ``` Отображает результат с заданным индексом. **Returns** возвращает объект типа [util.Promise](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/util.Promise.md). **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || `index`[*](*parametr) | — | Тип: Integer Индекс результата, начинается с 0. || |# \* Обязательный параметр/опция. [*parametr]:Обязательный параметр/опция.