LoadingObjectManager

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

Менеджер объектов, осуществляющий их оптимальную подгрузку с сервера. Позволяет оптимально загружать, отображать, кластеризовать и управлять видимостью объектов. Менеджер отправляет запрос за данными по указанному url в JSONP-формате. Описание формата соответствует формату добавляемых в ObjectManager объектов (см. ObjectManager.add). Обратите внимание, что у объектов, отрисованных на карте через данный менеджер, нельзя включать режимы редактирования и перетаскивания.

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

Конструктор

LoadingObjectManager(urlTemplate[, options])

Параметры:

Параметр	Значение по умолчанию	Описание
`urlTemplate`*	—	Тип: String шаблон URL данных. Поддерживаются специальные конструкции по аналогии с Layer. Также поддерживаются подстановки: %b заменяется на массив географических координат, описывающих прямоугольную область, для которой требуется загрузить данные. %t заменяется на массив номеров тайлов, описывающих прямоугольную область, для которой требуется загрузить данные.
`options`	—	Тип: Object Опции. Можно задавать все опции, указанные в описании Clusterer, за исключением опций hasBalloon и hasHint. Опции для кластеров задаются с префиксом cluster. Список опций указан в описании класса ClusterPlacemark; Опции для одиночных объектов задаются с префиксом geoObject. Список опций определен в классе GeoObject. Обратите внимание, менеджер не учитывает опцию 'visible'.
`options.clusterize`	false	Тип: Boolean Флаг, показывающий, нужно ли кластеризовать объекты. Обратите внимание, что на данный момент кластеризация работает только для точечных объектов. При включенном режиме кластеризации все неточечные объекты будут игнорироваться.
`options.loadTileSize`	256	Тип: Number Размер тайла для загрузки данных.
`options.paddingParamName`	'callback'	Тип: Boolean Имя GET-параметра, который содержит значение jsonp-колбека.
`options.paddingTemplate`	null	Тип: String Шаблон для jsonp-колбека. Поддерживает те же подстановки, что и urlTemplate. Все символы, не являющиеся буквой или цифрой, будут заменены на '_'. Если параметр не задан, то имя jsonp-колбека будет сгенерировано автоматически. Примеры преобразований при tileNumber=[3, 1], zoom=9: 'myCallback=%x' => 'myCallback_3' '%c' => 'x_3_y_1_z_9' 'callback2_%c' => 'callback2_x_3_y_1_z_9' 'callback%test' => 'callback_test' 'callback_%b' => 'callback_85_0841__180_0000_85_0841_180_0000' Обратите внимание, что если не использовать в значении опции подстановки, то это может привести к ошибке. Все запросы будут обращаться к одной callback-функции.
`options.splitRequests`	false	Тип: Boolean Разделять запросы за данными на запросы за одиночными тайлами. По умолчанию запросы делаются за данными для прямоугольной области, содержащей несколько тайлов.
`options.syncOverlayInit`	false	Тип: Boolean Флаг, разрешающий создавать оверлеи для объектов синхронно. Обратите внимание, что при синхронном создании оверлея нужно самостоятельно обеспечить загрузку нужного класса, реализующего интерфейс IOverlay. По умолчанию оверлеи создаются асинхронно, при этом класс оверлея загружается по требованию.
`options.viewportMargin`	128	Тип: Number\|Number[] Отступ для области, в которой показываются объекты. С помощью данной опции область показа объектов расширяется по отношению к видимой области карты.

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

Примеры:

var objectManager = new ymaps.LoadingObjectManager('http://myServer.com/tile?bbox=%b', {
    // Включаем кластеризацию.
    clusterize: true,
    // Опции кластеров задаются с префиксом 'cluster'.
    clusterHasBalloon: false,
    // Опции геообъектов задаются с префиксом 'geoObject'.
    geoObjectOpenBalloonOnClick: false
});

// Опции можно задавать напрямую в дочерние коллекции.
objectManager.clusters.options.set({
    preset: 'islands#grayClusterIcons',
    hintContentLayout: ymaps.templateLayoutFactory.createClass('Группа объектов')
});
objectManager.objects.options.set('preset', 'islands#grayIcon');

Пример ответа для LoadingObjectManager
jsonp_callback({    
    // Ответ содержит поля error и data. Если возникает ошибка, то поле "error"
    //  содержит код ошибки или описание.
    error: null,
    data: {
        type: 'FeatureCollection',
        features: [
             {
                 type: 'Feature',
                 geometry: {
                     type: 'Point',
                     coordinates: [55, 35]
                 },
                 id: 23,
                 properties: {
                     balloonContent: 'Содержание балуна метки',
                     iconContent: 'Содержание метки'
                 },
                 options: {
                     preset: 'islands#yellowIcon'
                 }
             }
        ]
    }
});

Поля

Имя	Тип	Описание
clusters	objectManager.ClusterCollection	Коллекция кластеров, сгенерированных менеджером.
events	IEventManager	Менеджер событий. Унаследовано от IDomEventEmitter.
geometry	IGeometry\|null	Геометрия геообъекта. Унаследовано от IGeoObject.
objects	objectManager.ObjectCollection	Коллекция объектов, добавленных в слой.
options	IOptionManager	Менеджер опций. Унаследовано от ICustomizable.
properties	IDataManager	Данные геообъекта. Унаследовано от IGeoObject.
state	IDataManager	Состояние геообъекта. Унаследовано от IGeoObject.

События

Имя	Описание
click	Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter.
contextmenu	Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter.
dblclick	Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter.
geometrychange	Изменение геометрии геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get: originalEvent: IEvent - оригинальное событие геометрии. Унаследовано от IGeoObject.
mapchange	Сменилась карта. Поля данных: oldMap - старая карта; newMap - новая карта. Унаследовано от IParentOnMap.
mousedown	Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter.
mouseenter	Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter.
mouseleave	Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter.
mousemove	Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter.
mouseup	Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter.
multitouchend	Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent. Унаследовано от IDomEventEmitter.
multitouchmove	Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля: clientX - координата касания X относительно видимой области браузера; clientY - координата касания Y относительно видимой области браузера; pageX - координата касания X касания относительно начала документа; pageY - координата касания Y касания относительно начала документа. Унаследовано от IDomEventEmitter.
multitouchstart	Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля: clientX - координата касания X относительно видимой области браузера; clientY - координата касания Y относительно видимой области браузера; pageX - координата касания X касания относительно начала документа; pageY - координата касания Y касания относительно начала документа. Унаследовано от IDomEventEmitter.
optionschange	Изменение в опциях объекта. Унаследовано от ICustomizable.
overlaychange	Изменение оверлея геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get: overlay: IOverlay\|null - ссылка на оверлей; oldOverlay: IOverlay\|null - предыдущий оверлей геообъекта. Унаследовано от IGeoObject.
parentchange	Сменился родительский объект. Поля данных: oldParent - старый родитель; newParent - новый родитель. Унаследовано от IChild.
propertieschange	Изменение данных геообъекта. Экземпляр класса Event. Имена полей, доступных через метод Event.get: originalEvent: IEvent - оригинальное событие менеджера данных. Унаследовано от IGeoObject.
wheel	Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager. Унаследовано от IDomEventEmitter.

Методы

Имя	Возвращает	Описание
getBounds()	Number[][]	null	Вычисляет границы области в геокоординатах, охватывающей все загруженные объекты в составе менеджера.
getMap()	Map	Возвращает ссылку на карту. Унаследован от IParentOnMap.
getObjectState(id)	Object	Получение информации о текущем состоянии объекта, добавленного в менеджер.
getOverlay()	vow.Promise	Возвращает объект-обещание, который подтверждается объектом оверлея в момент его фактического создания, либо отклоняется с передачей соответствующей ошибки. Унаследован от IGeoObject.
getOverlaySync()	IOverlay\|null	Метод предоставляет синхронный доступ к оверлею. Унаследован от IGeoObject.
getParent()	IParentOnMap\|null	Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен. Унаследован от IChildOnMap.
getPixelBounds()	Number[][]\|null	Вычисляет границы области в глобальных пиксельных координатах, охватывающей все загруженные объекты в составе менеджера.
getTileUrl()	String\|null	Возвращает URL тайла с данными.
getUrlTemplate()	String	Возвращает URL шаблона данных.
reloadData()		Метод, удаляющий все загруженные ранее данные и отправляющий запрос за новыми данными.
setParent(parent)	IChildOnMap	Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта. Унаследован от IChildOnMap.
setUrlTemplate(urlTemplate)

Описание полей

clusters

{objectManager.ClusterCollection} clusters

Коллекция кластеров, сгенерированных менеджером.

Пример:

objectManager.objects.events.add('click', function (e) {
    var objectId = e.get('objectId');
    objectManager.objects.balloon.open(objectId);
});

objects

{objectManager.ObjectCollection} objects

Коллекция объектов, добавленных в слой.

Пример:

objectManager.objects.events.add('click', function (e) {
    var objectId = e.get('objectId');
    objectManager.objects.balloon.open(objectId);
});

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

getBounds

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

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

Возвращает массив координат области или null, если менеджер не добавлен на карту.

getObjectState

{Object} getObjectState(id)

Получение информации о текущем состоянии объекта, добавленного в менеджер.

Возвращает объект, содержащий следующие поля:

found - признак, указывающий, существует ли объект с переданным идентификатором. Type: Boolean.
isShown - признак, указывающий, находится ли объект в видимой области карты. Type: Boolean.
cluster - JSON-описание кластера, в который добавлен объект. Помимо обязательных полей, содержит поле properties.geoObjects с массивом объектов, попавших в кластер. Поле возвращается только при включенной кластеризации;
isClustered – признак, указывающий, попал ли объект в состав кластера. Поле возвращается только при включенной кластеризации; Type: Boolean.
isFilteredOut - признак, указывающий, прошел ли объект фильтрацию. Если фильтр не задан или объект прошел фильтрацию, значение поля будет false. Type: Boolean.

Параметры:

Параметр

Значение по умолчанию

Описание

id*

—

Тип: Object

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

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

Пример:

// Открытие балуна кластера с выбранным объектом.
// Получим данные о состоянии объекта внутри кластера.
var objectState = objectManager.getObjectState(objects[1].id);
// Проверяем, находится ли объект в видимой области карты.
if (objectState.found && objectState.isShown) {
    // Если объект попадает в кластер, открываем балун кластера с нужным выбранным объектом.
    if (objectState.isClustered) {
        objectManager.clusters.state.set('activeObject', objects[1]);
        objectManager.clusters.balloon.open(objectState.cluster.id);
    } else {
        // Если объект не попал в кластер, открываем его собственный балун.
        objectManager.objects.balloon.open(objects[i].id);
    }
}

getPixelBounds

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

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

Возвращает массив координат области или null, если менеджер не добавлен на карту.

getTileUrl

{String|null} getTileUrl()

Возвращает URL тайла с данными.

Параметры:

Параметр	Значение по умолчанию	Описание
`parameters`*	—	Тип:

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

Пример:

var objectManager = new ymaps.LoadingObjectManager('http://myServer.com/tile?bbox=%b');
objectManager.getTileUrl = function (parameters) {
   var boundingBox = parameters.boundingBox.join('~');
   return this.getUrlTemplate().replace(/%b/g, boundingBox);
};

getUrlTemplate

{String} getUrlTemplate()

Возвращает URL шаблона данных.

reloadData

{} reloadData()

Метод, удаляющий все загруженные ранее данные и отправляющий запрос за новыми данными.

setUrlTemplate

{} setUrlTemplate(urlTemplate)

Параметры:

Параметр

Значение по умолчанию

Описание

urlTemplate*

—

Тип: String

шаблон URL данных.

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

LoadingObjectManager

Конструктор

Поля

События

Методы

Описание полей

clusters

objects

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

getBounds

getObjectState

getPixelBounds

getTileUrl

getUrlTemplate

reloadData

setUrlTemplate

Была ли статья полезна?