objectManager.Hint
Расширяет IHintManager.
Менеджер хинта объектного слоя. Позволяет управлять хинтом объектного слоя, открывать и скрывать его. Использует внутри себя менеджер хинтов карты map.Hint. Объектные слои содержат экземпляры этого класса, доступные как myObjectManager.objects.hint и myObjectManager.clusters.hint. Не создавайте экземпляры этого класса без необходимости.
См.: Hint
Конструктор | Поля | События | Методы
Конструктор
objectManager.Hint(collection)
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: IReadOnlyCollection Объектный слой. |
* Обязательный параметр/опция.
Поля
Имя |
Тип |
Описание |
Менеджер событий. Унаследовано от IEventEmitter. |
События
Имя |
Описание |
Закрытие инфо-объекта. Названия полей доступны через метод Event.get:
Унаследовано от IPopupManager. |
|
Открытие инфо-объекта. Названия полей доступны через метод Event.get:
Унаследовано от IPopupManager. |
Методы
Имя |
Возвращает |
Описание |
Скрывает всплывающую подсказку. |
||
destroy() |
Отключает менеджер инфо-объекта. Унаследован от IPopupManager. |
|
getData() |
Object|null |
Возвращает хэш с описанием объекта, на котором показан хинт или null, если хинт не был показан. |
IOptionManager|null |
Возвращает менеджер опций или null. Унаследован от IPopupManager. |
|
Возвращает объект-обещание вернуть оверлей. Унаследован от IPopupManager. |
||
IOverlay|null |
Возвращает оверлей, если тот существует. Унаследован от IPopupManager. |
|
Number[]|null |
Возвращает координаты инфо-объекта или Унаследован от IPopupManager. |
|
Boolean |
Метод, определяющий, показана ли всплывающая подсказка на объекте с переданным идентификатором. |
|
Показывает всплывающую подсказку на объекте с переданным идентификатором. |
||
Задаёт новые данные для отображения всплывающей подсказки. |
||
Задаёт инфо-объекту новые опции. Унаследован от IPopupManager. |
||
Задаёт инфо-объекту новую позицию. Унаследован от IPopupManager. |
Описание методов
close
{vow.Promise} close([force])
Скрывает всплывающую подсказку.
Возвращает объект-promise.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
false |
Тип: Boolean Мгновенное закрытие. |
Пример:
// Закроем все всплывающие подсказки на слое.
objectManager.objects.hint.close();
objectManager.clusters.hint.close();
getData
{Object|null} getData()
Возвращает хэш с описанием объекта, на котором показан хинт или null, если хинт не был показан.
Пример:
var cluster = objectManager.clusters.hint.getData();
if (cluster) {
alert('Кластер отображает подсказку.');}
isOpen
{Boolean} isOpen(id)
Метод, определяющий, показана ли всплывающая подсказка на объекте с переданным идентификатором.
Возвращает состояние подсказки: показана/скрыта.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: Object Идентификатор объекта. |
* Обязательный параметр/опция.
Пример:
// Скроем подсказку при клике на объекте.
objectManager.objects.add('click', function (e) {
var objectId = e.get('objectId');
if (objectManager.objects.hint.isOpen(objectId)) {
objectManager.objects.hint.close();
}
});
open
{vow.Promise} open(objectId[, position])
Показывает всплывающую подсказку на объекте с переданным идентификатором.
Возвращает объект-promise.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Object Идентификатор объекта, на котором надо открыть подсказку. |
|
— |
Тип: Number[] Позиция, на которой надо показать всплывающую подсказку в глобальных пиксельных координатах. Если значение не задано, хинт покажется на геометрическом центре объекта. |
* Обязательный параметр/опция.
Пример:
objectManager.clusters.hint.open(objectId);
setData
{vow.Promise} setData(objectData)
Задаёт новые данные для отображения всплывающей подсказки.
Возвращает объект-promise.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Object Хэш с описанием объекта, на котором открыт хинт. Соответствует описанию объекта, который подается на вход ObjectManager.add. |
* Обязательный параметр/опция.
Пример:
objectManager.objects.hint.setData(objectManager.objects.getById(objectId));
Обязательный параметр.