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

IGeoObjectCollection

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

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

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

Конструктор

IGeoObjectCollection()

Поля

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

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

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

options IOptionManager

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

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

События

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

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

  • index: Integer - индекс добавленного геообъекта;
  • child: IGeoObject - ссылка на добавленный геообъект.

boundschange

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

mapchange

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

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

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

optionschange

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

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

pixelboundschange

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

remove

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

  • index: Integer — индекс удаленного геообъекта;
  • child: IGeoObject — ссылка на удаленный геообъект.

set

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

  • index: Integer - индекс геообъекта;
  • child: IGeoObject - ссылка на новый геообъект;
  • prevChild: IGeoObject — ссылка на предыдущее значение для данного индекса.

Методы

ИмяВозвращаетОписание
add(child[, index])

IGeoObjectCollection

Добавляет (вставляет) дочерний геообъект в коллекцию.

each(callback[, context])

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

get(index)

IGeoObject

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

getBounds()

Number[][]|null

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

getIterator()

IIterator

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

getLength()

Integer

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

getMap()

Map

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

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

getPixelBounds()

Number[][]|null

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

indexOf(object)

Integer

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

remove(child)

IGeoObjectCollection

Удаляет дочерний геообъект из коллекции.

removeAll()

IGeoObjectCollection

Очищает коллекцию.

set(index, child)

IGeoObjectCollection

Записывает в коллекцию новый дочерний геообъект.

splice(index, number)

IGeoObjectCollection

Удаляет геообъекты из коллекции. Если необходимо, вставляет на их место другие. Объекты, которые будут вставлены вместо удаляемых, передаются как дополнительные параметры (после параметра number).

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

add

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

  • index: Integer - индекс добавленного геообъекта;
  • child: IGeoObject - ссылка на добавленный геообъект.

boundschange

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

pixelboundschange

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

remove

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

  • index: Integer — индекс удаленного геообъекта;
  • child: IGeoObject — ссылка на удаленный геообъект.

set

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

  • index: Integer - индекс геообъекта;
  • child: IGeoObject - ссылка на новый геообъект;
  • prevChild: IGeoObject — ссылка на предыдущее значение для данного индекса.

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

add

Добавляет (вставляет) дочерний геообъект в коллекцию.

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

Параметры:

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

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

]no-highlight]

Тип: IGeoObject

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

index

Тип: Integer

Индекс, в который добавляется новый объект. По умолчанию объект добавляется в конец коллекции.

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

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]

Тип: Object

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

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

remove

Удаляет дочерний геообъект из коллекции.

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

Параметры:

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

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

]no-highlight]

Тип: IGeoObject

Удаляемый геообъект.

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

removeAll

{IGeoObjectCollection} removeAll()

Очищает коллекцию.

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

set

Записывает в коллекцию новый дочерний геообъект.

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

Параметры:

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

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

]no-highlight]

Тип: Integer

Индекс.

child *
[no-highlight[

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

]no-highlight]

Тип: IGeoObject

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

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

splice

Удаляет геообъекты из коллекции. Если необходимо, вставляет на их место другие. Объекты, которые будут вставлены вместо удаляемых, передаются как дополнительные параметры (после параметра number).

Возвращает коллекцию удаленных геообъектов.

Параметры:

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

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

]no-highlight]

Тип: Integer

Индекс геообъекта, с которого начинается удаление.

number *
[no-highlight[

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

]no-highlight]

Тип: Integer

Количество удаляемых геообъектов.

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