map.Hint
Расширяет IEventEmitter.
Менеджер хинта карты. У каждой карты уже есть собственный менеджер хинта, доступный как map.hint. В один момент на карте может быть открыт только один хинт, управляемый менеджером. Не создавайте экземпляры этого класса без необходимости.
См.: Map.hint
Конструктор
map.Hint(map)
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: Map Ссылка на объект карты. |
* Обязательный параметр/опция.
Поля
Имя |
Тип |
Описание |
Менеджер событий. Унаследовано от IEventEmitter. |
События
Имя |
Описание |
Событие, возникающее после скрытия hint-а. Экземпляр класса Event. |
|
Событие, возникающее после отображения hint-а на карте. Экземпляр класса Event. Имена полей, доступных через метод Event.get: • hint - ссылка на экземпляр класса Hint. |
Методы
Имя |
Возвращает |
Описание |
Скрывает хинт. |
||
Имя: isShown() |
Boolean |
Проверяет состояние хинта. |
Показывает хинт на карте в заданной точке. Возвращает экземпляр класса Hint |
Описание событий
hide
Событие, возникающее после скрытия hint-а. Экземпляр класса Event.
show
Событие, возникающее после отображения hint-а на карте. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
• hint - ссылка на экземпляр класса Hint.
Описание методов
hide
{} hide(callback, urgently)
Скрывает хинт.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: |
|
— |
Тип: |
* Обязательный параметр/опция.
isShown
{Boolean} isShown()
Проверяет состояние хинта.
Returns true - если хинт в данный момент открыт, false - в обратном случае.
Пример:
// Открываем хинт (по таймауту в 1 сек.)
var hint = myMap.hint.show(myMap.getCenter(), { content: 'loading' }, { showTimeout: 1000 });
// Выполняем AJAX-запрос:
$.getJSON('hint-data.json')
.success(function (data) {
// Обновляем данные если хинт открыт, иначе вешаемся на событие открытия.
if (myMap.hint.isShown()) {
hint.setData(data);
} else {
myMap.hint.events.add('show', function () {
hint.setData(data);
});
}
});
show
{Hint} show(position[, data[, options]])
Показывает хинт на карте в заданной точке. Возвращает экземпляр класса Hint
Returns экземпляр хинта.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: Number[] Позиция привязки хинта. |
|
— |
Тип: Object|String Данные для отображения. |
|
— |
Тип: Object Опции хинта. |
* Обязательный параметр/опция.
Пример:
// Показываем в хинте координаты клика на карте.
geoMap.events.add('click', function (e) {
geoMap.hint.show(e.get('coordPosition'), e.get('coordPosition').join(', '), {
showTimeout: false,
hideTimeout: 500
});
});
Обязательный параметр/опция.