Документация
Справочник JavaScript API
2.1.64 (текущая версия)
collection
interactivityModel
Интерфейсы

objectManager.OverlayCollection

Расширяет ICustomizable, IEventEmitter.

Коллекция овелеев.

Конструктор | Поля | События | Методы

Конструктор

objectManager.OverlayCollection()

Поля

ИмяТипОписание
events IEventManager

Менеджер событий.

Унаследовано от IEventEmitter.

options IOptionManager

Менеджер опций.

Унаследовано от ICustomizable.

События

ИмяОписание
add

Добавление оверлея в коллекцию. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - добавленный оверлей.

click

Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

contextmenu

Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

dblclick

Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

mousedown

Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

mouseenter

Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

mouseleave

Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

mousemove

Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

mouseup

Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

multitouchend

Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Имена полей, доступных через метод IMultiTouchEvent.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

multitouchmove

Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Имена полей, доступных через метод IMultiTouchEvent.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

multitouchstart

Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Имена полей, доступных через метод IMultiTouchEvent.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

optionschange

Изменение в опциях объекта.

Унаследовано от ICustomizable.

remove

Удаление оверлея из коллекции. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - удаленный оверлей.

wheel

Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

Методы

ИмяВозвращаетОписание
each(callback, context)
getAll()

Object[]

Возвращает массив объектов, содержащихся в коллекции.

getById(id)

Object|null

Возвращает оверлей или null, если оверлея с переданным id не существует.

getId(overlay)

Number|null

Возвращает идентификатор объекта или null, если оверлей не содержится в коллекции.

getIterator()

IIterator

Возвращает итератор по коллекции.

getLength()

Number

Возвращает количество объектов в коллекции.

Описание событий

add

Добавление оверлея в коллекцию. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - добавленный оверлей.

click

Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

contextmenu

Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

dblclick

Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

mousedown

Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

mouseenter

Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

mouseleave

Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

mousemove

Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

mouseup

Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

multitouchend

Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Имена полей, доступных через метод IMultiTouchEvent.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

multitouchmove

Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Имена полей, доступных через метод IMultiTouchEvent.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

multitouchstart

Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Имена полей, доступных через метод IMultiTouchEvent.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

remove

Удаление оверлея из коллекции. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - удаленный оверлей.

wheel

Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • objectId - идентификатор объекта, которому принадлежит оверлей;
  • overlay - IOverlay - оверлей, на котором произошло событие;
  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в пикселях от левого верхнего угла страницы;
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

Описание методов

each

{} each(callback, context)

Параметры:

ПараметрЗначение по умолчаниюОписание
callback *
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: Function

Функция-обработчик, в которую передаются объекты коллекции.

context *
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: Object

Контекст исполнения функции-обработчика.

* Обязательный параметр/опция.

Пример:

objectManager.clusters.overlays.each(function (overlay) {
     overlay.options.set('cursor', 'help');
});

getAll

{Object[]} getAll()

Возвращает массив объектов, содержащихся в коллекции.

Пример:

var clusterOverlayArray = objectManager.clusters.overlays.getAll();

getById

{Object|null} getById(id)

Возвращает оверлей или null, если оверлея с переданным id не существует.

Параметры:

ПараметрЗначение по умолчаниюОписание
id *
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: Number

Идентификатор объекта, которому принадлежит оверлей.

* Обязательный параметр/опция.

Пример:

objectManager.objects.add('mouseenter', function (e) {
    var objectId = e.get('objectId'),
        overlay = objectManager.objects.overlays.getById(objectId);
    overlay.options.set('zIndex', 100);
});

getId

{Number|null} getId(overlay)

Возвращает идентификатор объекта или null, если оверлей не содержится в коллекции.

Параметры:

ПараметрЗначение по умолчаниюОписание
overlay *
[no-highlight[

* Обязательный параметр/опция.

]no-highlight]

Тип: IOverlay

Оверлей.

* Обязательный параметр/опция.

Пример:

objectManager.objects.overlays.each(function (overlay) {
    var objectId = objectManager.objects.overlays.getId(overlay);
    objectManager.objects.setObjectOptions(objectId, {
        preset: 'islands#redIcon'
    });
});

getIterator

{IIterator} getIterator()

Возвращает итератор по коллекции.

Пример:

var it = objectManager.objects.overlays.getIterator(),
    overlay;
while ((overlay = it.getNext()) != it.STOP_ITERATION) {
    overlay.options.set('zIndex', 10);
}

getLength

{Number} getLength()

Возвращает количество объектов в коллекции.

Пример:

var objectsNumber = objectManager.objects.getLength(),
    overlaysNumber = objectManager.objects.overlays.getNumber();
alert('На данный момент на карте показано ' + overlaysNumber + ' из ' + objectsNumber.);