YMaps.IInteractiveGeoObject

Расширяет YMaps.IGeoObject.

Интерфейс интерактивного геообъекта.

Конструктор

Имя Описание
YMaps.IInteractiveGeoObject(options) Интерфейс интерактивного геообъекта.

Наследуемые поля

Из YMaps.IGeoObject:
description, id, metaDataProperty, name

Методы

Имя Возвращает Описание
closeBalloon() Закрывает балун, если он был открыт.
getBalloon() YMaps.Balloon Возвращает балун объекта или null, если он не открыт.
getBalloonContent() YMaps.ILayout Возвращает содержимое балуна, установленное через setBalloonContent.
getBalloonOptions() YMaps.BalloonOptions Возвращает опции балуна.
getHintContent() YMaps.ILayout Возвращает содержимое всплывающей подсказки, установленное с помощью метода YMaps.IInteractiveGeoObject.setHintContent.
getHintOptions() YMaps.HintOptions Возвращает опции всплывающей подсказки.
getOptions() YMaps.InteractiveGeoObjectOptions Возвращает опции геообъекта.
openBalloon(content, options) Открывает балун для заданного объекта карты.
setBalloonContent(content) Устанавливает содержимое балуна.
setBalloonOptions(options, restoreDefault) Устанавливает опции балуна.
setHintContent(content) Устанавливает содержимое всплывающей подсказки.
setHintOptions(options, restoreDefault) Устанавливает опции всплывающей подсказки.
setOptions(options, restoreDefault) Устанавливает опции геообъекта.
update()

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

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

Из YMaps.IGeoObject:
getBounds, getComputedStyle, getParentGroup, getStyle, onAddToGroup, onRemoveFromGroup, setBounds, setStyle

Подробное описание конструктора

YMaps.IInteractiveGeoObject(options)

Интерфейс интерактивного геообъекта.

Параметры:

Имя Тип Необязательный По умолчанию Описание
options YMaps.InteractiveGeoObjectOptions Опции геообъекта.

Подробное описание методов

closeBalloon

closeBalloon()

Закрывает балун, если он был открыт.

getBalloon

{YMaps.Balloon} getBalloon()

Возвращает балун объекта или null, если он не открыт.

Возвращает:

Тип Описание
YMaps.Balloon Балун для данного объекта.

getBalloonContent

{YMaps.ILayout} getBalloonContent()

Возвращает содержимое балуна, установленное через setBalloonContent.

Возвращает:

Тип Описание
YMaps.ILayout Содержимое балуна.

getBalloonOptions

{YMaps.BalloonOptions} getBalloonOptions()

Возвращает опции балуна.

Возвращает:

Тип Описание
YMaps.BalloonOptions Опции балуна.

getHintContent

{YMaps.ILayout} getHintContent()

Возвращает содержимое всплывающей подсказки, установленное с помощью метода YMaps.IInteractiveGeoObject.setHintContent.

Возвращает:

Тип Описание
YMaps.ILayout Содержимое всплывающей подсказки.

getHintOptions

{YMaps.HintOptions} getHintOptions()

Возвращает опции всплывающей подсказки.

Возвращает:

Тип Описание
YMaps.HintOptions Опции всплывающей подсказки.

getOptions

Возвращает опции геообъекта.

Возвращает:

Тип Описание
YMaps.InteractiveGeoObjectOptions Опции геообъекта.

openBalloon

openBalloon(content, options)

Открывает балун для заданного объекта карты.

Примеры:

1.

// Открывает балун и отображает его содержимое с помощью заданного стиля.
interactiveObject.openBalloon();

2.

// Перекрывает содержимое балуна, заданное с помощью стиля, и ограничивает максимальную ширину балуна 100 пикселами.
interactiveObject.setBalloonContent("test");
interactiveObject.setBalloonOptions({maxWidth: 100});
interactiveObject.openBalloon();
// Эквивалентно
interactiveObject.openBalloon("test", {maxWidth: 100});

Параметры:

Имя Тип Необязательный По умолчанию Описание
content String|HTMLElement|YMaps.ILayout Содержимое балуна.
options YMaps.MapBalloonOptions Опции балуна.

setBalloonContent

setBalloonContent(content)

Устанавливает содержимое балуна. Содержимое, установленное таким образом, приоритетнее содержимого, созданного с применением текущего стиля содержимого балуна.

Параметры:

Имя Тип Описание
content String|HTMLElement|YMaps.ILayout Содержимое балуна.

setBalloonOptions

setBalloonOptions(options, restoreDefault)

Устанавливает опции балуна.

Параметры:

Имя Тип Необязательный По умолчанию Описание
options YMaps.BalloonOptions Опции балуна.
restoreDefault Boolean false Незаданные опции установить в значения по умолчанию.

setHintContent

setHintContent(content)

Устанавливает содержимое всплывающей подсказки. Содержимое, установленное таким образом, приоритетнее содержимого, созданного при помощи текущего стиля содержимого подсказки.

Параметры:

Имя Тип Описание
content String|HTMLElement|YMaps.ILayout Содержимое всплывающей подсказки.

setHintOptions

setHintOptions(options, restoreDefault)

Устанавливает опции всплывающей подсказки.

Параметры:

Имя Тип Необязательный По умолчанию Описание
options YMaps.HintOptions Опции.
restoreDefault Boolean false Незаданные опции установить в значения по умолчанию.

setOptions

setOptions(options, restoreDefault)

Устанавливает опции геообъекта.

Параметры:

Имя Тип Необязательный По умолчанию Описание
options YMaps.InteractiveGeoObjectOptions Опции геообъекта.
restoreDefault Boolean false Незаданные опции установить в значения по умолчанию.

update

update()

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

Метод вызывается при изменении стиля объекта и при добавлении объекта в родительскую группу. При изменении стиля родительской группы метод update вызывается у всех членов группы автоматически.

Также метод может вызываться для перерисовки объекта при изменении его данных.