API Яндекс.Карт. Справочник по программному интерфейсу: YMaps.Regions.RegionCollection

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

Группа регионов на карте.

Конструктор

Имя	Описание
YMaps.Regions.RegionCollection(style)	Создает объект группы регионов на карте.

Поля

Имя	Описание
Events	Список событий группы регионов.

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

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

События

Имя	Описание
BalloonClose	Событие закрытия балуна области региона. В обработчик события передается ссылка на объект группы регионов YMaps.Regions.RegionCollection.
BalloonOpen	Событие открытия балуна области региона. В обработчик события передается ссылка на объект группы регионов YMaps.Regions.RegionCollection.
Click	Щелчок мыши по области региона.
DblClick	Двойной щелчок мыши по области региона.
MouseDown	Над областью региона нажата кнопка мыши.
MouseEnter	Курсор наведен на область региона.
MouseLeave	Курсор убран с области региона.
MouseMove	Движение мышью над областью региона.
MouseUp	Нажатая кнопка мыши отпущена.

Наследуемые события

Из YMaps.Group:: Add, Remove

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

Из YMaps.OverlayGroup:: getMap, getParentContainer
Из YMaps.Group:: add, filter, forEach, get, indexOf, length, remove, removeAll, splice
Из YMaps.IOverlay:: onAddToMap, onMapUpdate, onRemoveFromMap
Из YMaps.IGeoObject:: getBounds, getComputedStyle, getParentGroup, getStyle, onAddToGroup, onRemoveFromGroup, setBounds, setStyle, update

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

YMaps.Regions.RegionCollection(style)

Создает объект группы регионов на карте.

Пример:

// Загружает данные для России и добавляет их на карту.
YMaps.Regions.load("ru", function (state, data) {
    if (state == YMaps.State.SUCCESS) {
        map.addOverlay(data);
        // Задание опций всем активным областям регинов в группе.
        data.forEach(function (region) {
            region.setOptions({
                highlightRegion: false
            });
        });
    }
});

Параметры:

Имя	Тип	Необязательный	По умолчанию	Описание
style	YMaps.Style\|String			Указатель или ключ стиля группы объектов.

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

Events

Object Events

Список событий группы регионов.

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

BalloonClose

BalloonClose

Событие закрытия балуна области региона. В обработчик события передается ссылка на объект группы регионов YMaps.Regions.RegionCollection.

BalloonOpen

BalloonOpen

Событие открытия балуна области региона. В обработчик события передается ссылка на объект группы регионов YMaps.Regions.RegionCollection.