Основной сниппет компонента, который реализует вывод карты на фронте.
Параметры
Название | По умолчанию | Описание |
---|---|---|
parents | `` | ID родителя с вложенными ресурсами, у которых есть объекты на карте. |
parent | 0 |
ID ресурса с объектами на карте. |
class | Класс объекта. | |
list | default |
Имя списка. К нему будет привязана карта. |
map | ym2map |
ID блока с картой. |
center | [55.72, 37.64] |
Центральные координаты карты. |
zoom | 10 |
Приближение карты. |
scrollZoom | 1 |
Зуммирование при скролле мышью. |
objectsInScope | 0 |
Установить center и zoom в зависимости от имеющихся на карте объектов. Другими словами, если указано true или 1 , то все объекты карты попадут в область видимости, а свойства center и zoom проигнорированы. |
objects | Массив объектов карты. Если указан, выборка объектов из базы производиться не будет. | |
defaultIconContent | Надпись на иконке. Используется, если у иконки на карте не заполнено. | |
defaultIconCaption | Заголовок иконки. Используется, если у иконки на карте не заполнено. | |
defaultBalloonContent | Текст балуна. Используется, если у объекта на карте не заполнено. | |
mode | default |
Режим сниппета. Варианты: default , mfilter2 |
apiUrl | Ссылка на API Яндекс Карт. Если указан, будет перебивать системную настройку ym2_api_url . |
|
apiKey | Ключ API Яндекс Карт. Если указан, будет перебивать системную настройку ym2_api_key . |
|
scripts | 1 |
Нужно ли подключать скрипты карты. |
jquery | 1 |
Нужно ли подключать jQuery. |
tpl | tpl.YandexMaps2 |
Чанк вывода карты. |
Важно! Указывайте либо параметр
parents
, либоparent
. Они взаимозаменяемы. Ниже есть примеры по их использованию для более детального понимания.
Примеры
Все объекты ресурса 15 с классом modDocument
{'!YandexMaps2' | snippet : [
'parent' => 15,
'class' => 'modDocument',
]}
Все объекты класса modDocument
{'!YandexMaps2' | snippet : [
'class' => 'modDocument',
]}
Все объекты вложенных ресурсов родителя 15 с классом modDocument
{'!YandexMaps2' | snippet : [
'parents' => 15,
'class' => 'modDocument',
]}
Все объекты класса msProduct с отключённым зуммированием при скролле
{'!YandexMaps2' | snippet : [
'class' => 'msProduct',
'scrollZoom' => false,
]}
Все объекты пользователей
{'!YandexMaps2' | snippet : [
'class' => 'modUser',
'map' => 'ym2map-users',
]}