map.GeoObjects
Расширяет IGeoObjectCollection.
Коллекция геообъектов карты. У каждой карты уже есть своя коллекция геообъектов, доступная как map.geoObjects. Не инстанцируйте экземпляры этого класса без необходимости.
См.: Map.geoObjects
Конструктор | Поля | События | Методы
Конструктор
map.GeoObjects(map[, options])
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: Map Карта. |
— |
Тип: Object Опции коллекции геообъектов. Через опции map.geoObjects можно задавать настройки геообъектов, добавленных на карту: |
* Обязательный параметр/опция.
Поля
Имя |
Тип |
Описание |
Менеджер событий. Унаследовано от IEventEmitter. |
||
Менеджер опций. Унаследовано от ICustomizable. |
События
Имя |
Описание |
Добавлен (вставлен) дочерний геообъект. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от IGeoObjectCollection. |
|
Изменение координат географической области, охватывающей коллекцию и ее дочерние геообъекты. Экземпляр класса Event. Унаследовано от IGeoObjectCollection. |
|
Сменилась карта. Поля данных:
Унаследовано от IParentOnMap. |
|
Изменение в опциях объекта. Унаследовано от ICustomizable. |
|
Изменение пиксельных координат области, охватывающей коллекцию и ее дочерние геообъекты. Экземпляр класса Event. Унаследовано от IGeoObjectCollection. |
|
Удален дочерний геообъект. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от IGeoObjectCollection. |
|
В коллекцию записан новый дочерний геообъект. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от IGeoObjectCollection. |
Методы
Имя |
Возвращает |
Описание |
Добавляет (вставляет) дочерний геообъект в коллекцию. |
||
Для каждого дочернего геообъекта, вызывает функцию-обработчик. |
||
Возвращает дочерний геообъект с заданным индексом. |
||
Number[][]|null |
Возвращает географические координаты области, охватывающей коллекции и ее дочерние геообъекты. |
|
Возвращает итератор по коллекции. |
||
Integer |
Возвращает длину коллекции. |
|
getMap() |
Возвращает ссылку на карту. Унаследован от IParentOnMap. |
|
Number[][]|null |
Возвращает глобальные пиксельные координаты области, охватывающей коллекцию и ее дочерние геообъекты. |
|
Integer |
Возвращает индекс дочернего геообъекта. Если геообъект в коллекции не найден, возвращается -1. |
|
Удаляет дочерний геообъект из коллекции. |
||
Очищает коллекцию. |
||
Записывает в коллекцию новый дочерний геообъект. |
||
Удаляет геообъекты из коллекции. Если необходимо, вставляет на их место другие. Объекты, которые будут вставлены вместо удаляемых, передаются как дополнительные параметры (после параметра number). |
Описание методов
add
{map.GeoObjects} add(child[, index])
Добавляет (вставляет) дочерний геообъект в коллекцию.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: IGeoObject Дочерний геообъект. |
|
— |
Тип: Integer Индекс, в который добавляется новый объект. По умолчанию объект добавляется в конец коллекции. |
* Обязательный параметр/опция.
each
{} each(callback[, context])
Для каждого дочернего геообъекта, вызывает функцию-обработчик.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Function Функция-обработчик. |
|
— |
Тип: Object Контекст выполнения функции-обработчика. |
* Обязательный параметр/опция.
Пример:
// Отображаем индекс геообъекта в коллекции как содержимое его иконки.
myGeoObjects.events.add(["add", "remove", "set"], function () {
this.each(function (el, i) {
el.properties.set("iconContent", i);
})
}, myGeoObjects);
get
{IGeoObject} get(index)
Возвращает дочерний геообъект с заданным индексом.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Integer Индекс. |
* Обязательный параметр/опция.
getBounds
{Number[][]|null} getBounds()
Возвращает географические координаты области, охватывающей коллекции и ее дочерние геообъекты.
getIterator
{IIterator} getIterator()
Возвращает итератор по коллекции.
getLength
{Integer} getLength()
Возвращает длину коллекции.
getPixelBounds
{Number[][]|null} getPixelBounds()
Возвращает глобальные пиксельные координаты области, охватывающей коллекцию и её дочерние геообъекты.
indexOf
{Integer} indexOf(object)
Возвращает индекс дочернего геообъекта. Если геообъект в коллекции не найден, возвращается -1.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Object Дочерний геообъект. |
* Обязательный параметр/опция.
remove
{map.GeoObjects} remove(child)
Удаляет дочерний геообъект из коллекции.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: IGeoObject Удаляемый геообъект. |
* Обязательный параметр/опция.
Пример:
// При клике по геообъекту удаляем его из коллекции.
myGeoObjects.events.add("click", function (e) {
if (e.get("target").getParent() == this) {
this.remove(e.get("target"));
}
}, myGeoObjects);
removeAll
{map.GeoObjects} removeAll()
Очищает коллекцию.
Возвращает ссылку на себя.
set
{map.GeoObjects} set(index, child)
Записывает в коллекцию новый дочерний геообъект.
Возвращает ссылку на себя.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Integer Индекс. |
|
— |
Тип: IGeoObject Дочерний геообъект. |
* Обязательный параметр/опция.
splice
{GeoObjectCollection} splice(index, number)
Удаляет геообъекты из коллекции. Если необходимо, вставляет на их место другие. Объекты, которые будут вставлены вместо удаляемых, передаются как дополнительные параметры (после параметра number).
Возвращает коллекцию удаленных геообъектов.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Integer Индекс геообъекта, с которого начинается удаление. |
|
— |
Тип: Integer Количество удаляемых геообъектов. |
* Обязательный параметр/опция.
Пример:
// Удаляет второй объект.
myGeoObjects.splice(1, 1);
// Вставляет новый объект obj во вторую позицию.
myGeoObjects.splice(1, 0, obj);
// Заменяет второй объект на новый объект obj.
myGeoObjects.splice(1, 1, obj);
Обязательный параметр.