YMaps.IGeoObject

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

Конструктор

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

Поля

Имя Описание
description Описание объекта.
id ID объекта.
metaDataProperty Объект-контейнер для указания дополнительных свойств объекта.
name Имя объекта.

Методы

Имя Возвращает Описание
getBounds() YMaps.ICoordBounds

Возвращает область, занимаемую объектом.

getComputedStyle() YMaps.Style

Возвращает вычисленный стиль объекта.

getParentGroup() YMaps.IGeoObject Возвращает указатель на родительскую группу.
getStyle() YMaps.Style|String Возвращает текущий стиль объекта.
onAddToGroup(parentGroup) Вызывается при добавлении объекта в родительскую группу.
onRemoveFromGroup() Вызывается при удалении объекта из родительской группы.
setBounds(bounds) Устанавливает область, занимаемую объектом.
setStyle(style) Устанавливает стиль объекта.
update()

Полностью обновляет объект.

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

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

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

YMaps.IGeoObject()

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

Подробное описание полей

description

String description

Описание объекта.

id

String id

ID объекта.

metaDataProperty

Object metaDataProperty

Объект-контейнер для указания дополнительных свойств объекта. Внутренняя структура metaDataProperty определяется пользователем.

name

String name

Имя объекта.

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

getBounds

{YMaps.ICoordBounds} getBounds()

Возвращает область, занимаемую объектом.

Если значение не было установлено методом setBounds, возвращает null.

Возвращает:

Тип Описание
YMaps.ICoordBounds Область, занимаемую объектом.

getComputedStyle

{YMaps.Style} getComputedStyle()

Возвращает вычисленный стиль объекта.

Если собственный стиль объекта не задан, то применяется стиль родителя, если стиль родителя не задан, то применяется стиль родителя родителя, и т. д.

Возвращает:

Тип Описание
YMaps.Style Указатель на вычисленный стиль.

getParentGroup

{YMaps.IGeoObject} getParentGroup()

Возвращает указатель на родительскую группу.

Возвращает:

Тип Описание
YMaps.IGeoObject Указатель на родительскую группу.

getStyle

{YMaps.Style|String} getStyle()

Возвращает текущий стиль объекта.

Возвращает:

Тип Описание
YMaps.Style|String Указатель или ключ стиля.

onAddToGroup

onAddToGroup(parentGroup)

Вызывается при добавлении объекта в родительскую группу.

Параметры:

Имя Тип Описание
parentGroup YMaps.IGeoObject Указатель на родительскую группу.

onRemoveFromGroup

onRemoveFromGroup()

Вызывается при удалении объекта из родительской группы.

setBounds

setBounds(bounds)

Устанавливает область, занимаемую объектом.

Параметры:

Имя Тип Описание
bounds YMaps.ICoordBounds Область, занимаемая объектом.

setStyle

setStyle(style)

Устанавливает стиль объекта.

Параметры:

Имя Тип Описание
style YMaps.Style|String Указатель или ключ стиля.

update

update()

Полностью обновляет объект.

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

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