YMaps.Regions.RegionCollection

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

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

Конструктор

Поля

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

Из YMaps.IGeoObject:

description, id, metaDataProperty, name

События

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

Из 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.

Click

Click

Щелчок мыши по области региона.
В обработчик события передаются три аргумента:

• ссылка на объект группы регионов YMaps.Regions.RegionCollection;
• ссылка на объект YMaps.Regions.RegionHotspot, над которым произошло событие;
• ссылка на объект события мыши YMaps.MouseEvent;

DblClick

DblClick

Двойной щелчок мыши по области региона.
В обработчик события передаются три аргумента:

• ссылка на объект группы регионов YMaps.Regions.RegionCollection;
• ссылка на объект YMaps.Regions.RegionHotspot, над которым произошло событие;
• ссылка на объект события мыши YMaps.MouseEvent;

MouseDown

MouseDown

Над областью региона нажата кнопка мыши.
В обработчик события передаются три аргумента:

• ссылка на объект группы регионов YMaps.Regions.RegionCollection;
• ссылка на объект YMaps.Regions.RegionHotspot, над которым произошло событие;
• ссылка на объект события мыши YMaps.MouseEvent;

MouseEnter

MouseEnter

Курсор наведен на область региона.
В обработчик события передаются три аргумента:

• ссылка на объект группы регионов YMaps.Regions.RegionCollection;
• ссылка на объект YMaps.Regions.RegionHotspot, над которым произошло событие;
• ссылка на объект события мыши YMaps.MouseEvent;

MouseLeave

MouseLeave

Курсор убран с области региона.
В обработчик события передаются три аргумента:

• ссылка на объект группы регионов YMaps.Regions.RegionCollection;
• ссылка на объект YMaps.Regions.RegionHotspot, над которым произошло событие;
• ссылка на объект события мыши YMaps.MouseEvent;

MouseMove

MouseMove

Движение мышью над областью региона.
В обработчик события передаются три аргумента:

• ссылка на объект группы регионов YMaps.Regions.RegionCollection;
• ссылка на объект YMaps.Regions.RegionHotspot, над которым произошло событие;
• ссылка на объект события мыши YMaps.MouseEvent;

MouseUp

MouseUp

Нажатая кнопка мыши отпущена.
В обработчик события передаются три аргумента:

• ссылка на объект группы регионов YMaps.Regions.RegionCollection;
• ссылка на объект YMaps.Regions.RegionHotspot, над которым произошло событие;
• ссылка на объект события мыши YMaps.MouseEvent;