Расширяет
YMaps.IControl.
Класс для создания элемента управления "Поиск по карте".
Каждый результат поиска представляется в панели элемента управления в виде
двухстрочного блока. Для формирования блока используются (в порядке убывания приоритета)
следующие свойства объекта-результата геокодирования:
- поля name и description;
- поле text;
- текстовое представление координат, возвращаемых методом getCoordPoint.
Если все перечисленные выше поля отсутствуют, то выводится "Без названия".
Поля
| Имя |
Описание |
| Events |
Список обрабатываемых событий элемента управления "Поиск по карте". |
События
| Имя |
Описание |
| Select |
Выбран один из результатов поиска.
|
Методы
| Имя |
Возвращает |
Описание |
| collapse() |
|
Сворачивает панель с результатами поиска. |
| expand() |
|
Раскрывает панель с результатами поиска. |
| isExpanded() |
Boolean |
Возвращает true, если панель с результатами поиска раскрыта,
в противном случае - false. |
Подробное описание конструктора
YMaps.SearchControl(options)
Создает элемент управления "Поиск по карте".
Параметры:
| Имя |
Тип |
Необязательный |
По умолчанию |
Описание |
| options |
Object |
 |
|
Опции. |
| options.width |
Integer |
 |
240 |
Ширина элемента (в пикселах). Минимальное значение: 200. |
| options.resultsPerPage |
Integer |
 |
3 |
Количество результатов поиска на странице. Максимальное значение - 20. |
| options.geocodeOptions |
Object |
 |
|
Опции геокодирования (см. YMaps.Geocoder).
Опции geocodeOptions.skip и geocodeOptions.results игнорируются. |
| options.useMapBounds |
Integer |
 |
true |
true - учитывать при поиске границы видимой области карты
(объекты, найденные внутри видимой области будут показаны в начале списка), false - не учитывать. При значении true,
рассчитанная область видимости имеет больший приоритет, чем заданная через geocodeOptions.boundedBy. |
| options.noCentering |
Boolean |
 |
false |
false - автоматически располагать центр карты так, чтобы объект был виден целиком.
true - не изменять центр карты при показе найденного объекта. |
| options.noPlacemark |
Boolean |
 |
false |
false - автоматически добавлять в центр найденного объекта метку с открытым балуном,
true - не добавлять. Если указать noCentering = true и noPlacemark = true, то при щелчке по результату поиска
никаких видимых изменений на карте не произойдет. |
| options.prefLang |
String |
 |
|
Предпочитаемый язык поисковой выдачи. Опция устарела.
Рекомендуется использовать опцию геокодера geocodeOptions.prefLang. В случае если заданы обе опции, опция элемента управления
будет иметь более высокий приоритет.
Этот параметр влияет только на язык описаний найденных объектов в поисковой выдаче и не затрагивает сам процесс поиска.
При установленной опции описания найденных объектов будут, где возможно, возвращаться на предпочитаемом языке.
Список возможных значений:
- ru - русский;
- uk - украинский;
- be - белорусский.
|
Подробное описание полей
Events
Список обрабатываемых событий элемента управления "Поиск по карте".
Подробное описание событий
Select
Выбран один из результатов поиска.
В callback-функцию передаются два аргумента:
Подробное описание методов
collapse
Сворачивает панель с результатами поиска.
expand
Раскрывает панель с результатами поиска.
isExpanded
Возвращает true, если панель с результатами поиска раскрыта,
в противном случае - false.
Возвращает:
| Тип |
Описание |
| Boolean |
true - панель раскрыта, false - панель свернута. |