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

# YMaps.SearchControl

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

Класс для создания элемента управления "Поиск по карте".

Каждый результат поиска представляется в панели элемента управления в виде двухстрочного блока. Для формирования блока используются (в порядке убывания приоритета) следующие свойства объекта-результата геокодирования:

1. поля name и description;
1. поле text;
1. текстовое представление координат, возвращаемых методом getCoordPoint.

Если все перечисленные выше поля отсутствуют, то выводится "Без названия".
## Конструктор

Имя | Описание
----- | -----
[YMaps.SearchControl](searchcontrol.md#constructor)(options) | Создает элемент управления "Поиск по карте".


## Поля

Имя | Описание
----- | -----
[Events](searchcontrol.md#Events) | Список обрабатываемых событий элемента управления "Поиск по карте".

## События

Имя | Описание
----- | -----
[Select](searchcontrol.md#event-Select) | Выбран один из результатов поиска.

## Методы

Имя | Возвращает | Описание
----- | ----- | -----
[collapse](searchcontrol.md#collapse)() |  | Сворачивает панель с результатами поиска.
[expand](searchcontrol.md#expand)() |  | Раскрывает панель с результатами поиска.
[isExpanded](searchcontrol.md#isExpanded)() | Boolean | Возвращает true, если панель с результатами поиска раскрыта, в противном случае - false.

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

Из [YMaps.IControl](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/icontrol.md): 
: [onAddToMap](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/icontrol.md#onAddToMap), [onRemoveFromMap](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/icontrol.md#onRemoveFromMap)

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

```javascript
YMaps.SearchControl(options)
```

Создает элемент управления "Поиск по карте".

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

#|
|| **Имя** | **Тип** | **Необязательный** | **По умолчанию** | **Описание** ||
||`options` | Object | ![](../_images/check.png) |  | Опции.||
||`options.width` | Integer | ![](../_images/check.png) | 240 | Ширина элемента (в пикселах). Минимальное значение: 200.||
||`options.resultsPerPage` | Integer | ![](../_images/check.png) | 3 | Количество результатов поиска на странице. Максимальное значение - 20.||
||`options.geocodeOptions` | Object | ![](../_images/check.png) |  | Опции геокодирования (см. [YMaps.Geocoder](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/geocoder.md)). Опции geocodeOptions.skip и geocodeOptions.results игнорируются.||
||`options.useMapBounds` | Integer | ![](../_images/check.png) | true | true - учитывать при поиске границы видимой области карты (объекты, найденные внутри видимой области будут показаны в начале списка), false - не учитывать. При значении true, рассчитанная область видимости имеет больший приоритет, чем заданная через geocodeOptions.boundedBy.||
||`options.noCentering` | Boolean | ![](../_images/check.png) | false | false - автоматически располагать центр карты так, чтобы объект был виден целиком. true - не изменять центр карты при показе найденного объекта.||
||`options.noPlacemark` | Boolean | ![](../_images/check.png) | false | false - автоматически добавлять в центр найденного объекта метку с открытым балуном, true - не добавлять. Если указать noCentering = true и noPlacemark = true, то при щелчке по результату поиска никаких видимых изменений на карте не произойдет.||
||`options.prefLang` | String | ![](../_images/check.png) |  | Предпочитаемый язык поисковой выдачи.


{% note info %}

Опция устарела. Рекомендуется использовать опцию геокодера geocodeOptions.prefLang. В случае если заданы обе опции, опция элемента управления будет иметь более высокий приоритет.

{% endnote %}


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

Список возможных значений:

- ru - русский;
- uk - украинский;
- be - белорусский.||
|#

## Подробное описание полей {#field_detail}

### Events {#Events}

```javascript
Object Events
```

Список обрабатываемых событий элемента управления "Поиск по карте".

## Подробное описание событий {#event_detail}

### Select {#Select}

```javascript
Select
```
 Выбран один из результатов поиска. 
В callback-функцию передаются два аргумента:

- указатель на объект YMaps.SearchControl;
- указатель на выбранный объект [YMaps.GeocoderResult](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/geocoderresult.md).
## Подробное описание методов {#method_detail}

### collapse {#collapse}

```javascript
collapse()
```

Сворачивает панель с результатами поиска.
### expand {#expand}

```javascript
expand()
```

Раскрывает панель с результатами поиска.
### isExpanded {#isExpanded}

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

Возвращает true, если панель с результатами поиска раскрыта, в противном случае - false.

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

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