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

IGeoObjectSequence

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

Интерфейс неизменяемой коллекции геообъектов.

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

Конструктор

IGeoObjectSequence()

Поля

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

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

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

options IOptionManager

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

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

События

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

Изменение координат географической области, охватывающей коллекцию и ее дочерние геообъекты. Экземпляр класса Event.

mapchange

Сменилась карта. Поля данных:

  • oldMap - старая карта;
  • newMap - новая карта.

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

optionschange

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

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

pixelboundschange

Изменение пиксельных координат области, охватывающей коллекцию и ее дочерние геообъекты. Экземпляр класса Event.

Методы

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

Для каждого дочернего геообъекта, вызывает функцию-обработчик.

get(index)

IGeoObject

Возвращает дочерний геообъект с заданным индексом.

getBounds()

Number[][]|null

Возвращает географические координаты области, охватывающей коллекции и ее дочерние геообъекты.

getIterator()

IIterator

Возвращает итератор по дочерним геообъектам коллекции.

getLength()

Integer

Возвращает длину коллекции.

getMap()

Map

Возвращает ссылку на карту.

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

getPixelBounds()

Number[][]|null

Возвращает глобальные пиксельные координаты области, охватывающей коллекцию и ее дочерние геообъекты.

indexOf(object)

Integer

Возвращает индекс дочернего геообъекта. Если геообъект в коллекции не найден, возвращается -1.

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

boundschange

Изменение координат географической области, охватывающей коллекцию и ее дочерние геообъекты. Экземпляр класса Event.

pixelboundschange

Изменение пиксельных координат области, охватывающей коллекцию и ее дочерние геообъекты. Экземпляр класса Event.

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

each

{} each(callback[, context])

Для каждого дочернего геообъекта, вызывает функцию-обработчик.

Параметры:

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

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

]no-highlight]

Тип: Function

Функция-обработчик.

context

Тип: Object

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

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

get

Возвращает дочерний геообъект с заданным индексом.

Параметры:

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

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

]no-highlight]

Тип: Integer

Индекс.

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

getBounds

{Number[][]|null} getBounds()

Возвращает географические координаты области, охватывающей коллекции и ее дочерние геообъекты.

getIterator

{IIterator} getIterator()

Возвращает итератор по дочерним геообъектам коллекции.

getLength

{Integer} getLength()

Возвращает длину коллекции.

getPixelBounds

{Number[][]|null} getPixelBounds()

Возвращает глобальные пиксельные координаты области, охватывающей коллекцию и её дочерние геообъекты.

indexOf

{Integer} indexOf(object)

Возвращает индекс дочернего геообъекта. Если геообъект в коллекции не найден, возвращается -1.

Параметры:

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

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

]no-highlight]

Тип: IGeoObject

Дочерний геообъект.

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