Элементы управления

Описание

Элементы управления — это компоненты пользовательского интерфейса, с помощью которых пользователь может взаимодействовать с картой.

Класс DG.Control

Базовый класс для всех элементов управления. Реализует интерфейс IControl. Элементы добавляются на карту следующим образом:

control.addTo(map);
// то же самое, что
map.addControl(control);

Конструктор

Конструктор	Использование	Описание
`DG.Control( <Control options> options? )`	`DG.control(…)`	Создает элемент управления с переданными опциями.

Опции

Опция	Тип	По умолчанию	Описание
`position`	`String`	`'topright'`	Расположение элемента управления (один из углов карты). См. позиции элементов управления.

Методы

Метод	Возвращает	Описание
`setPosition( <String> position )`	`this`	Устанавливает позицию элемента управления См. позиции элементов управления.
`getPosition()`	`String`	Возвращает текущую позицию элемента управления.
`addTo( <Map> map )`	`this`	Добавляет элемент управления на карту.
`getContainer()`	`HTMLElement`	Возвращает HTML контейнер элемента управления.

Позиции элементов управления

Позиции элементов управления (углы карты, в которых располагаются элементы) устанавливаются с помощью строк. Отступы между границами карты и элементами управления можно установить с помощью CSS.

Позиция	Описание
`'topleft'`	Верхний левый угол карты.
`'topright'`	Верхний правый угол карты.
`'bottomleft'`	Нижний левый угол карты.
`'bottomright'`	Нижний правый угол карты.

Класс DG.Control.Zoom

Базовый элемент управления масштабом с двумя кнопками (приблизить и отдалить). Добавляется на карту по умолчанию, если не передана опция zoomControl со значением false. Расширяет Control.

Конструктор

Конструктор	Использование	Описание
`DG.Control.Zoom( <Control.Zoom options> options? )`	`DG.control.zoom(…)`	Создает элемент управления масштабом.

Опции

Опция	Тип	По умолчанию	Описание
`position`	`String`	`'topleft'`	Расположение элемента управления (один из углов карты). См. позиции элементов управления.
`zoomInText`	`String`	`'+'`	Текст кнопки Приблизить.
`zoomOutText`	`String`	`'-'`	Текст кнопки Отдалить.
`zoomInTitle`	`String`	`'Zoom in'`	Значение атрибута title для конпки Приблизить.
`zoomInTitle`	`String`	`'Zoom out'`	Значение атрибута title для конпки Отдалить.

Класс DG.Control.Fullscreen

Кнопка, при клике на которую карта разворачивается на весь экран, повторный клик восстанавливает предыдущий размер. Добавляется на карту по умолчанию, если не передана опция fullscreenControl со значением false. Расширяет Control.

Конструктор

Конструктор	Использование	Описание
`DG.Control.Fullscreen( <Control.Fullscreen options> options? )`	`DG.Control.Fullscreen(…)`	Создает элемент управления полноэкранным режимом.

Опции

Опция	Тип	По умолчанию	Описание
`position`	`String`	`'topright'`	Расположение элемента управления (один из углов карты). См. позиции элементов управления.

Класс DG.Control.LocationControl

Кнопка, при клике на которую определяется и отображается текущее месторасположение пользователя. Если API геолокации не поддерживается устройством, тогда элемент управления не выводится.

DG.control.location().addTo(map);

Конструктор

Конструктор	Использование	Описание
`DG.Control.LocationControl( <Control.Locate options> options? )`	`DG.Control.LocationControl(…)`	Создает элемент управления геопозиционированием.

Опции

Опция	Тип	По умолчанию	Описание
`position`	`String`	`'topleft'`	Расположение элемента управления (один из углов карты). См. позиции элементов управления.
`drawCircle`	`Boolean`	`true`	Будет ли отображаться круг, показывающий точность определения месторасположения.
`follow`	`Boolean`	`false`	Динамическое обновление месторасположения пользователя, работает если `watch` и `setView` выставлены в true в locateOptions.
`stopFollowingOnDrag`	`Boolean`	`false`	Включает или отключает обновление месторасположения пользователя при перетаскивании карты.
`metric`	`Boolean`	`true`	Использовать метрические или английские единицы измерения.
`locateOptions`	`Object`		См. параметры определения расположения.

Класс DG.Control.Attribution

Позволяет показать атрибутику в небольшом текстовом контейнере на карте. Расширяет Control.

Конструктор

Конструктор	Использование	Описание
`DG.Control.Attribution( <Control.Attribution options> options? )`	`DG.control.attribution(…)`	Создает элемент атрибутики.

Опции

Опция	Тип	По умолчанию	Описание
`position`	`String`	`'bottomright'`	Расположение элемента управления (один из углов карты). См. позиции элементов управления.
`prefix`	`String`	`'Leaflet'`	Текст, который будет показан перед атрибутикой. Для отключения необходимо указать `false`.

Методы

Метод	Возвращает	Описание
`setPrefix( <String> prefix )`	`this`	Устанавливает текст перед атрибутикой.
`addAttribution( <String> text )`	`this`	Добавляет текст атрибутики (например, `'Картографические данные © 2GIS'`).
`removeAttribution( <String> text )`	`this`	Удаляет текст атрибутики.

Класс DG.Control.Ruler

Кнопка, при клике на которую включается линейка измерения расстояний на карте. Расширяет Control.

DG.control.ruler().addTo(map);

Конструктор

Конструктор	Использование	Описание
`DG.Control.Ruler( <Control.Ruler options> options? )`	`DG.control.ruler(…)`	Создает элемент управления линейкой.

Опции

Опция	Тип	По умолчанию	Описание
`position`	`String`	`'topright'`	Расположение элемента управления (один из углов карты). См. позиции элементов управления.

Класс DG.Control.Traffic

Кнопка, при клике на которую на карте отображается слой пробок. Расширяет Control.

DG.control.traffic().addTo(map);

Конструктор

Конструктор	Использование	Описание
`DG.Control.Traffic( <Control.Traffic options> options? )`	`DG.control.traffic(…)`	Создает элемент управления слоем пробок.

Опции

Опция	Тип	По умолчанию	Описание
`position`	`String`	`'topright'`	Расположение элемента управления (один из углов карты). См. позиции элементов управления.

Класс DG.Control.Scale

Показывает масштаб карты в метрической (метры, километры) и английской (мили, футы) системах измерений. Расширяет Control.

DG.control.scale().addTo(map);

Конструктор

Конструктор	Использование	Описание
`DG.Control.Scale( <Control.Scale options> options? )`	`DG.control.scale(…)`	Создает индикатор масштаба с переданными опциями.

Опции

Опция	Тип	По умолчанию	Описание
`position`	`String`	`'bottomleft'`	Расположение элемента управления (один из углов карты). См. позиции элементов управления.
`maxWidth`	`Number`	`100`	Максимальная ширина элемента в пикселях.
`metric`	`Boolean`	`true`	Включает или отключает метрическую систему измерений (метры, километры).
`imperial`	`Boolean`	`true`	Включает или отключает английскую систему измерений (мили, футы).
`updateWhenIdle`	`Boolean`	`false`	Если `true`, тогда элемент обновляется при событии `moveend`, иначе всегда будет отображена актуальная информация (обновляется при событии `move`).