Leaflet API справка
Карта
Центральный класс API — используется для создания карты на странице и её управления.
Пример использования
// initialize the map on the "map" div with a given center and zoom
var map = L.map('map', {
center: [51.505, -0.09],
zoom: 13
});
Создание
| Фабрика | Описание |
|---|---|
L.map( | Создаёт объект карты по заданному идентификатору DOM-элемента и, необязательно, объекту параметров. |
L.map( | Создаёт объект карты по экземпляру HTML-элемента и, необязательно, объекту параметров. |
Параметры
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
preferCanvas | Boolean | false | Определяет, следует ли отображать Path с помощью рендерера Canvas. По умолчанию, все Path отображаются с помощью рендерера SVG. |
Параметры управления
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
attributionControl | Boolean | true | Добавлять ли по умолчанию на карту контроль авторских прав. |
zoomControl | Boolean | true | Добавлять ли по умолчанию на карту контроль масштаба. |
Параметры взаимодействия
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
closePopupOnClick | Boolean | true | Установите в false, чтобы всплывающие окна не закрывались при нажатии на карту. |
boxZoom | Boolean | true | Можно ли изменять масштаб карты на прямоугольную область, перетаскивая мышь, удерживая клавишу Shift. |
doubleClickZoom | Boolean|String | true | Можно ли изменять масштаб карты двойным щелчком, или двойным щелчком с зажатой клавишей Shift для уменьшения масштаба. Если передано 'center', масштабирование двойным щелчком будет происходить относительно центра отображения независимо от положения мыши. |
dragging | Boolean | true | Можно ли перетаскивать карту мышкой/пальцем. |
zoomSnap | Number | 1 | Принудительно устанавливает уровень масштаба карты, чтобы он всегда был кратен этому значению, особенно сразу после fitBounds() или масштабирования двумя пальцами. По умолчанию уровень масштаба привязан к ближайшему целому числу; меньшие значения (например, 0.5 или 0.1) позволяют получить большую точность. Значение 0 означает, что уровень масштаба не будет привязываться после fitBounds или масштабирования двумя пальцами. |
zoomDelta | Number | 1 | Определяет, насколько изменится масштаб карты после zoomIn(), zoomOut(), нажатия клавиш + или - на клавиатуре или использования контролей масштабирования. Значения меньше 1 (например, 0.5) обеспечивают большую точность. |
trackResize | Boolean | true | Следить ли за изменением размеров окна браузера для автоматического обновления карты. |
Параметры инерционного перемещения
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
inertia | Boolean | * | Включить инерционный эффект при перемещении карты: карта набирает скорость во время перетаскивания и продолжает движение в том же направлении некоторое время. Особенно удобно на сенсорных устройствах. Включено по умолчанию. |
inertiaDeceleration | Number | 3000 | Скорость замедления инерционного движения в пикселях/секунду². |
inertiaMaxSpeed | Number | Infinity | Максимальная скорость инерционного движения в пикселях/секунду. |
easeLinearity | Number | 0.2 | |
worldCopyJump | Boolean | false | При включенном параметре карта отслеживает перемещение к другой "копии" мира и мгновенно переходит к исходному, так что все наложения, такие как маркеры и векторные слои, по-прежнему видны. |
maxBoundsViscosity | Number | 0.0 | Если maxBounds задано, этот параметр управляет тем, насколько жёсткие границы при перетаскивании карты. Значение по умолчанию 0.0 позволяет пользователю перетаскивать за пределы границ с нормальной скоростью, более высокие значения замедляет перетаскивание карты за пределы границ, а 1.0 делает границы полностью твёрдыми, предотвращая перетаскивание за их пределы. |
Параметры навигации с клавиатуры
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
keyboard | Boolean | true | Делает карту фокусируемой и позволяет пользователям перемещаться по карте с помощью стрелок на клавиатуре и клавиш +/-. |
keyboardPanDelta | Number | 80 | Количество пикселей для перемещения при нажатии на клавишу со стрелкой. |
Параметры колеса мыши
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
scrollWheelZoom | Boolean|String | true | Возможность изменять масштаб карты с помощью колеса мыши. Если передано 'center', масштабирование будет происходить относительно центра отображения независимо от положения мыши. |
wheelDebounceTime | Number | 40 | Ограничивает скорость срабатывания колеса (в миллисекундах). По умолчанию, пользователь не может масштабировать с помощью колеса мыши чаще, чем раз в 40 мс. |
wheelPxPerZoomLevel | Number | 60 | Сколько пикселей прокрутки (как сообщается L.DomEvent.getWheelDelta) означает изменение на один полный уровень масштабирования. Меньшие значения сделают масштабирование с помощью колеса быстрее (и наоборот). |
Параметры взаимодействия с сенсорным экраном
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
tapHold | Boolean | Включает симуляцию события contextmenu, по умолчанию true для мобильного Safari. | |
tapTolerance | Number | 15 | Максимальное количество пикселей, на которое пользователь может сместить палец во время касания, чтобы это считалось действительным касанием. |
touchZoom | Boolean|String | * | Можно ли изменять масштаб карты с помощью двух пальцев. Если передано 'center', масштабирование будет происходить относительно центра отображения независимо от того, где произошли события касания (пальцы). Включено для браузеров с поддержкой сенсорного ввода. |
bounceAtZoomLimits | Boolean | true | Установите в значение false, если не хотите, чтобы карта масштабировалась за пределы минимального/максимального значения масштабирования, а затем возвращалась обратно при масштабировании двумя пальцами. |
Параметры состояния карты
| Опция | Тип | По умолчанию | Описание |
|---|---|---|---|
crs | CRS | L.CRS.EPSG3857 | Система координат, которую следует использовать. Не изменяйте это значение, если вы не уверены, что знаете, что это значит. |
center | LatLng | undefined | Начальный географический центр карты |
zoom | Number | undefined | Начальный уровень масштабирования карты |
minZoom | Number | * | Минимальный уровень масштабирования карты. Если не указан, и на карте присутствует хотя бы один слой GridLayer или TileLayer, то будет использован наименьший из их minZoom значений. |
maxZoom | Number | * | Максимальный уровень масштабирования карты. Если не указан, и на карте присутствует хотя бы один слой GridLayer или TileLayer, то будет использован наибольший из их maxZoom значений. |
layers | Layer[] | [] | Массив слоев, которые будут добавлены на карту вначале |
maxBounds | LatLngBounds | null | При установке данной опции, карта ограничивает отображение заданными географическими границами, возвращая пользователя к границам, если он пытается переместить карту за пределы отображаемой области. Чтобы динамически установить ограничение, используйте метод setMaxBounds. |
renderer | Renderer | * | Метод по умолчанию для отрисовки векторных слоев на карте. L.SVG или L.Canvas по умолчанию в зависимости от поддержки браузера. |
Параметры анимации
| Опция | Тип | По умолчанию | Описание |
|---|---|---|---|
zoomAnimation | Boolean | true | Включена ли анимация масштабирования карты. По умолчанию включена во всех браузерах, поддерживающих CSS3 Transitions, кроме Android. |
zoomAnimationThreshold | Number | 4 | Анимация масштабирования не будет выполнена, если разница в масштабе превысит это значение. |
fadeAnimation | Boolean | true | Включена ли анимация плавного перехода плиток. По умолчанию включена во всех браузерах, поддерживающих CSS3 Transitions, кроме Android. |
markerZoomAnimation | Boolean | true | Будут ли метки участвовать в анимации масштабирования. Если отключено, метки исчезнут на время анимации. По умолчанию включено во всех браузерах, поддерживающих CSS3 Transitions, кроме Android. |
transform3DLimit | Number | 2^23 | Определяет максимальный размер преобразования CSS-трансформации. Значение по умолчанию не следует изменять, если веб-браузер не правильно позиционирует слои после большого panBy. |
События
События слоев
| Событие | Данные | Описание |
|---|---|---|
baselayerchange | LayersControlEvent | Срабатывает при изменении базового слоя с помощью управления слоями layers control. |
overlayadd | LayersControlEvent | Срабатывает при выборе наложения с помощью управления слоями layers control. |
overlayremove | LayersControlEvent | Срабатывает при отмене выбора наложения с помощью управления слоями layers control. |
layeradd | LayerEvent | Срабатывает при добавлении нового слоя на карту. |
layerremove | LayerEvent | Срабатывает при удалении слоя с карты. |
События изменения состояния карты
| Событие | Данные | Описание |
|---|---|---|
zoomlevelschange | Event | Срабатывает при изменении количества уровней масштабирования на карте из-за добавления или удаления слоя. |
resize | ResizeEvent | Срабатывает при изменении размера карты. |
unload | Event | Срабатывает при уничтожении карты методом remove. |
viewreset | Event | Срабатывает, когда карта нуждается в перерисовке содержимого (обычно происходит при изменении масштаба карты или при загрузке). Очень полезно для создания пользовательских наложений. |
load | Event | Срабатывает при инициализации карты (когда центр и масштаб устанавливаются впервые). |
zoomstart | Event | Срабатывает, когда масштабирование карты вот-вот изменится (например, перед анимацией масштабирования). |
movestart | Event | Срабатывает, когда вид карты начинает изменяться (например, пользователь начинает перетаскивать карту). |
zoom | Event | Срабатывает многократно во время любого изменения уровня масштабирования, включая анимацию масштабирования и полета. |
move | Event | Срабатывает многократно во время любого перемещения карты, включая панорамирование и анимацию полета. |
zoomend | Event | Срабатывает, когда масштабирование карты изменилось после завершения любой анимации. |
moveend | Event | Срабатывает, когда центр карты перестаёт меняться (например, пользователь перестал перетаскивать карту или после масштабирования, не центрированного на текущем центре). |
События всплывающих окон
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Срабатывает при открытии всплывающего окна на карте |
popupclose | PopupEvent | Срабатывает при закрытии всплывающего окна на карте |
autopanstart | Event | Срабатывает при запуске автоматического перемещения карты при открытии всплывающего окна. |
События подсказок
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Срабатывает при открытии подсказки на карте. |
tooltipclose | TooltipEvent | Срабатывает при закрытии подсказки на карте. |
События местоположения
| Событие | Данные | Описание |
|---|---|---|
locationerror | ErrorEvent | Срабатывает при ошибке геолокации (используя метод locate). |
locationfound | LocationEvent | Срабатывает при успешном определении геолокации (используя метод locate). |
События взаимодействия
| Событие | Данные | Описание |
|---|---|---|
click | MouseEvent | Срабатывает при щелчке (или нажатии) на карту. |
dblclick | MouseEvent | Срабатывает при двойном щелчке (или двойном нажатии) на карте. |
mousedown | MouseEvent | Срабатывает при нажатии кнопки мыши на карте. |
mouseup | MouseEvent | Срабатывает при отпускании кнопки мыши на карте. |
mouseover | MouseEvent | Срабатывает при входе курсора мыши на карту. |
mouseout | MouseEvent | Срабатывает при выходе курсора мыши за пределы карты. |
mousemove | MouseEvent | Срабатывает при перемещении курсора мыши по карте. |
contextmenu | MouseEvent | Срабатывает при нажатии правой кнопки мыши на карте. Блокирует стандартное контекстное меню браузера, если есть обработчики этого события. Также срабатывает на мобильных устройствах при удерживании одного касания в течение секунды (также называется удерживанием). |
keypress | KeyboardEvent | Срабатывает при нажатии клавиши на клавиатуре, которая производит значение символа, когда карта имеет фокус. |
keydown | KeyboardEvent | Срабатывает при нажатии клавиши на клавиатуре, когда карта имеет фокус. В отличие от события keypress, событие keydown срабатывает для клавиш, которые производят значение символа, и для клавиш, которые не производят значения символа. |
keyup | KeyboardEvent | Срабатывает при отпускании клавиши на клавиатуре, когда карта имеет фокус. |
preclick | MouseEvent | Срабатывает перед щелчком мыши на карте (иногда полезно, когда нужно что-то сделать при щелчке до того, как начнутся работать существующие обработчики щелчков). |
Другие события
| Событие | Данные | Описание |
|---|---|---|
zoomanim | ZoomAnimEvent | Вызывается как минимум один раз за анимацию масштабирования. При непрерывном масштабировании, например, при масштабировании пинцетом, вызывается один раз за кадр во время масштабирования. |
Методы
| Метод | Возвращаемое значение | Описание |
|---|---|---|
getRenderer( | Renderer |
Возвращает экземпляр |
Методы для слоев и элементов управления
| Метод | Возвращаемое значение | Описание |
|---|---|---|
addControl( | this |
Добавляет заданный элемент управления на карту |
removeControl( | this |
Удаляет заданный элемент управления с карты |
addLayer( | this |
Добавляет заданный слой на карту |
removeLayer( | this |
Удаляет заданный слой с карты. |
hasLayer( | Boolean |
Возвращает |
eachLayer( | this |
Итерируется по слоям карты, необязательно указывая контекст функции итератора. map.eachLayer(function(layer){
layer.bindPopup('Hello');
});
|
openPopup( | this |
Открывает указанный всплывающий элемент, закрывая ранее открытый (чтобы обеспечить одновременное открытие только одного для удобства использования). |
openPopup( | this |
Создаёт всплывающий элемент с указанным содержимым и параметрами и открывает его в заданной точке на карте. |
closePopup( | this |
Закрывает всплывающий элемент, ранее открытый с помощью openPopup (или указанный). |
openTooltip( | this |
Открывает указанный всплывающий подсказку. |
openTooltip( | this |
Создаёт всплывающую подсказку с указанным содержимым и параметрами и открывает её. |
closeTooltip( | this |
Закрывает всплывающую подсказку, переданную в качестве параметра. |
Методы для изменения состояния карты
| Метод | Возвращаемое значение | Описание |
|---|---|---|
setView( | this |
Устанавливает вид карты (географический центр и масштаб) с заданными параметрами анимации. |
setZoom( | this |
Устанавливает масштаб карты. |
zoomIn( | this |
Увеличивает масштаб карты на |
zoomOut( | this |
Уменьшает масштаб карты на |
setZoomAround( | this |
Масштабирует карту, сохраняя указанную географическую точку на карте стационарной (например, используется внутренне для масштабирования прокруткой и двойным щелчком). |
setZoomAround( | this |
Масштабирует карту, сохраняя указанную точку пикселей на карте (относительно верхнего левого угла) стационарной. |
fitBounds( | this |
Устанавливает вид карты, содержащий заданные географические границы с максимально возможным уровнем масштабирования. |
fitWorld( | this |
Устанавливает вид карты, в основном содержащий весь мир с максимально возможным уровнем масштабирования. |
panTo( | this |
Перемещает карту в заданный центр. |
panBy( | this |
Перемещает карту на заданное количество пикселей (анимировано). |
flyTo( | this |
Устанавливает вид карты (географический центр и масштаб), выполняя плавную анимацию перемещения и масштабирования. |
flyToBounds( | this |
Устанавливает вид карты с плавной анимацией, как в |
setMaxBounds( | this |
Ограничивает вид карты заданными границами (см. параметр maxBounds). |
setMinZoom( | this |
Устанавливает нижний предел для доступных уровней масштабирования (см. параметр minZoom). |
setMaxZoom( | this |
Устанавливает верхний предел для доступных уровней масштабирования (см. параметр maxZoom). |
panInsideBounds( | this |
Перемещает карту к ближайшему виду, который находился бы внутри заданных границ (если это не так уже), управляя анимацией с использованием соответствующих параметров, если таковые имеются. |
panInside( | this |
Перемещает карту на минимальное расстояние, чтобы сделать |
invalidateSize( | this |
Проверяет, изменился ли размер контейнера карты, и обновляет карту, если это так — вызовите его после того, как вы динамически изменили размер карты, также анимируя перемещение по умолчанию. Если |
invalidateSize( | this |
Проверяет, изменился ли размер контейнера карты, и обновляет карту, если это так — вызовите его после того, как вы динамически изменили размер карты, также анимируя перемещение по умолчанию. |
stop() | this |
Останавливает текущую анимацию |
Методы геолокации
| Метод | Возвращаемое значение | Описание |
|---|---|---|
locate( | this |
Пытается определить местоположение пользователя с помощью API геолокации, вызывая событие |
stopLocate() | this |
Останавливает отслеживание местоположения, инициированное ранее методом |
Другие методы
| Метод | Возвращаемое значение | Описание |
|---|---|---|
addHandler( | this |
Добавляет новый |
remove() | this |
Уничтожает карту и очищает все связанные слушатели событий. |
createPane( | HTMLElement |
Создаёт новый панель карты с заданным именем, если она ещё не существует, затем возвращает её. Панель создаётся как дочерний элемент |
getPane( | HTMLElement |
Возвращает панель карты по её имени или HTML-элементу (ее идентификатору). |
getPanes() | Object |
Возвращает обычный объект, содержащий имена всех панелей в качестве ключей и панели в качестве значений. |
getContainer() | HTMLElement |
Возвращает HTML-элемент, содержащий карту. |
whenReady( | this |
Выполняет заданную функцию |
Методы для получения состояния карты
| Метод | Возвращает | Описание |
|---|---|---|
getCenter() | LatLng |
Возвращает географический центр представления карты |
getZoom() | Number |
Возвращает текущий уровень масштабирования представления карты |
getBounds() | LatLngBounds |
Возвращает географические границы, видимые в текущем представлении карты |
getMinZoom() | Number |
Возвращает минимальный уровень масштабирования карты (если он задан в опции |
getMaxZoom() | Number |
Возвращает максимальный уровень масштабирования карты (если он задан в опции |
getBoundsZoom( | Number |
Возвращает максимальный уровень масштабирования, при котором заданные границы полностью помещаются в представление карты. Если |
getSize() | Point |
Возвращает текущий размер контейнера карты (в пикселях). |
getPixelBounds() | Bounds |
Возвращает границы текущего представления карты в проекции пиксельных координат (иногда полезно в реализациях слоев и наложений). |
getPixelOrigin() | Point |
Возвращает проекцию пиксельных координат левой верхней точки слоя карты (полезно в реализациях пользовательских слоев и наложений). |
getPixelWorldBounds( | Bounds |
Возвращает границы мира в пиксельных координатах для уровня масштабирования |
Методы преобразования
| Метод | Возвращает | Описание |
|---|---|---|
getZoomScale( | Number |
Возвращает коэффициент масштабирования, который должен быть применён к переходу карты с уровня масштабирования |
getScaleZoom( | Number |
Возвращает уровень масштабирования, до которого карта будет масштабирована, если она находится на уровне |
project( | Point |
Проецирует географическую координату |
unproject( | LatLng |
Обратное значение |
layerPointToLatLng( | LatLng |
Учитывая пиксельную координату, относительную к начальной пиксельной точке, возвращает соответствующую географическую координату (для текущего уровня масштабирования). |
latLngToLayerPoint( | Point |
Учитывая географическую координату, возвращает соответствующую пиксельную координату, относительную к начальной пиксельной точке. |
wrapLatLng( | LatLng |
Возвращает |
wrapLatLngBounds( | LatLngBounds |
Возвращает |
distance( | Number |
Возвращает расстояние между двумя географическими координатами в соответствии с СКС карты. По умолчанию это измеряется в метрах. |
containerPointToLayerPoint( | Point |
Учитывая пиксельную координату, относительную к контейнеру карты, возвращает соответствующую пиксельную координату, относительную к начальной пиксельной точке. |
layerPointToContainerPoint( | Point |
Учитывая пиксельную координату, относительную к начальной пиксельной точке, возвращает соответствующую пиксельную координату, относительную к контейнеру карты. |
containerPointToLatLng( | LatLng |
Учитывая пиксельную координату, относительную к контейнеру карты, возвращает соответствующую географическую координату (для текущего уровня масштабирования). |
latLngToContainerPoint( | Point |
Учитывая географическую координату, возвращает соответствующую пиксельную координату, относительную к контейнеру карты. |
mouseEventToContainerPoint( | Point |
Учитывая объект MouseEvent, возвращает пиксельную координату, относительную к контейнеру карты, где произошло событие. |
mouseEventToLayerPoint( | Point |
Учитывая объект MouseEvent, возвращает пиксельную координату, относительную к начальной пиксельной точке, где произошло событие. |
mouseEventToLatLng( | LatLng |
Учитывая объект MouseEvent, возвращает географическую координату, где произошло событие. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-слушатель ( |
on( | this |
Добавляет набор пар тип/слушатель, например |
off( | this |
Удаляет ранее добавленную функцию-слушатель. Если функция не указана, удалятся все слушатели этого события в объекте. Обратите внимание, что если вы передали пользовательский контекст в |
off( | this |
Удаляет набор пар тип/слушатель. |
off() | this |
Удаляет всех слушателей всех событий в объекте. Это включает неявно прикреплённые события. |
fire( | this |
Вызывает событие указанного типа. Необязательно можно предоставить объект данных — свойства объекта будут первым аргументом функции слушателя. Событие необязательно может быть распространено родительским событиям. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родительское событие — |
removeEventParent( | this |
Удаляет родительское событие, так что оно перестанет получать распространяемые события |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
Свойства
Управление
| Свойство | Тип | Описание |
|---|---|---|
zoomControl | Control.Zoom | Стандартное управление масштабом (доступно только если опция zoomControl была true при создании карты). |
Обработчики
| Свойство | Тип | Описание |
|---|---|---|
boxZoom | Handler | Обработчик масштабирования прямоугольником (сдвиг мышкой при нажатой клавише Shift). |
doubleClickZoom | Handler | Обработчик масштабирования двойным щелчком. |
dragging | Handler | Обработчик перемещения карты (мышью и касанием). |
keyboard | Handler | Обработчик навигации с клавиатуры. |
scrollWheelZoom | Handler | Обработчик масштабирования колесом мыши. |
tapHold | Handler | Обработчик удерживания касания для имитации события contextmenu (полезно в мобильном Safari). |
touchZoom | Handler | Обработчик масштабирования касанием. |
Плани
| План | Тип | Z-индекс | Описание |
|---|---|---|---|
mapPane | HTMLElement | 'auto' | План, содержащий все остальные планы карты |
tilePane | HTMLElement | 200 | План для GridLayer и TileLayer |
overlayPane | HTMLElement | 400 | План для векторов (Path, таких как Polyline и Polygon), ImageOverlay и VideoOverlay |
shadowPane | HTMLElement | 500 | План для теней наложения (например, тени Marker) |
markerPane | HTMLElement | 600 | План для Icon маркеров Marker |
tooltipPane | HTMLElement | 650 | План для Tooltip. |
popupPane | HTMLElement | 700 | План для Popup. |
Опции определения местоположения
Map принимают параметр options. Это обычный javascript-объект со следующими необязательными компонентами:| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
watch | Boolean | false | Если true, начинает непрерывное наблюдение за изменениями местоположения (вместо однократного определения) с помощью метода W3C watchPosition. Позже вы можете прекратить наблюдение с помощью метода map.stopLocate(). |
setView | Boolean | false | Если true, автоматически устанавливает представление карты на местоположение пользователя относительно точности определения или на представление мира, если геолокация не удалась. |
maxZoom | Number | Infinity | Максимальный масштаб для автоматической установки представления при использовании опции setView. |
timeout | Number | 10000 | Количество миллисекунд ожидания ответа от геолокации перед запуском события locationerror. |
maximumAge | Number | 0 | Максимальный возраст определенного местоположения. Если с момента последнего ответа геолокации прошло меньше этого количества миллисекунд, locate вернёт кэшированное местоположение. |
enableHighAccuracy | Boolean | false | Включает высокоточное определение, см. описание в спецификации W3C. |
Опции масштабирования
Map, которые изменяют уровень масштабирования, принимают параметр options. Это обычный javascript-объект со следующими необязательными компонентами:| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
animate | Boolean | Если не указано, анимация масштабирования произойдёт, если точка масштабирования находится внутри текущего представления. Если true, карта попытается выполнить анимацию масштабирования, независимо от того, где находится точка масштабирования. Установка false всегда будет перезагружать представление без анимации. |
Параметры панорамирования
Map методов, которые изменяют центр карты, принимают параметр options. Это обычный объект JavaScript с следующими необязательными компонентами:| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
animate | Boolean | Если true, панорамирование всегда будет анимироваться, если это возможно. Если false, панорамирование не будет анимироваться, а вместо этого карта будет переустанавливаться, если панорамирование происходит более чем на экран, или будет установлено новое смещение для области карты (кроме panBy, которое всегда делает последнее). | |
duration | Number | 0.25 | Продолжительность анимированного панорамирования в секундах. |
easeLinearity | Number | 0.25 | Коэффициент кривизны сглаживания анимации панорамирования (третий параметр кривой Безье). 1.0 означает линейную анимацию, а чем меньше это число, тем более изогнута кривая. |
noMoveStart | Boolean | false | Если true, событие movestart не будет срабатывать при начале панорамирования (используется внутри для инерции панорамирования). |
Параметры масштабирования/панорамирования
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
animate | Boolean | Если не указано, анимация масштабирования произойдет, если точка масштабирования находится внутри текущего вида. Если true, карта попытается анимировать масштабирование, независимо от того, где находится точка масштабирования. Установка false приведет к тому, что карта всегда будет полностью переустанавливаться без анимации. |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
duration | Number | 0.25 | Продолжительность анимированного панорамирования в секундах. |
easeLinearity | Number | 0.25 | Коэффициент кривизны сглаживания анимации панорамирования (третий параметр кривой Безье). 1.0 означает линейную анимацию, а чем меньше это число, тем более изогнута кривая. |
noMoveStart | Boolean | false | Если true, событие movestart не будет срабатывать при начале панорамирования (используется внутри для инерции панорамирования). |
Параметры отступа
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
paddingTopLeft | Point | [0, 0] | Устанавливает величину отступа в верхнем левом углу контейнера карты, который не должен учитываться при установке вида для соответствия границам. Полезно, если у вас есть наложения управления на карте, например, боковая панель, и вы не хотите, чтобы они скрывали объекты, к которым вы приближаетесь. |
paddingBottomRight | Point | [0, 0] | То же самое для нижнего правого угла карты. |
padding | Point | [0, 0] | Эквивалентно установке верхнего левого и нижнего правого отступов одинаковому значению. |
Параметры FitBounds
| Опция | Тип | По умолчанию | Описание |
|---|---|---|---|
maxZoom | Number | null | Максимальный возможный уровень масштабирования. |
| Опция | Тип | По умолчанию | Описание |
|---|---|---|---|
animate | Boolean | Если не указано, анимация масштабирования произойдёт, если точка начала масштабирования находится внутри текущего вида. Если true, карта попытается выполнить анимацию масштабирования, независимо от того, где находится точка начала масштабирования. Установка false сделает так, что карта всегда будет полностью перезагружаться без анимации. |
| Опция | Тип | По умолчанию | Описание |
|---|---|---|---|
duration | Number | 0.25 | Продолжительность анимированного перемещения в секундах. |
easeLinearity | Number | 0.25 | Коэффициент кривизны плавной анимации перемещения (третий параметр кривой Безье). 1.0 означает линейную анимацию, а чем меньше это число, тем более изогнутой будет кривая. |
noMoveStart | Boolean | false | Если true, перемещение не будет вызывать событие movestart при старте (используется внутри для инерции перемещения). |
| Опция | Тип | По умолчанию | Описание |
|---|---|---|---|
paddingTopLeft | Point | [0, 0] | Устанавливает размер отступа в верхнем левом углу контейнера карты, который не должен учитываться при установке вида по границам. Полезно, если на карте есть элементы управления, такие как боковая панель, и вы не хотите, чтобы они скрывали объекты, к которым вы приближаетесь. |
paddingBottomRight | Point | [0, 0] | То же самое для нижнего правого угла карты. |
padding | Point | [0, 0] | Эквивалентно установке отступов сверху слева и снизу справа в одно и то же значение. |
Маркер
L.Marker используется для отображения кликабельных/перетаскиваемых значков на карте. Расширяет Layer.
Пример использования
L.marker([50.5, 30.5]).addTo(map);
Создание
| Фабрика | Описание |
|---|---|
L.marker( | Создает объект Маркер, задавая географическую точку и необязательный объект опций. |
Опции
| Опция | Тип | По умолчанию | Описание |
|---|---|---|---|
icon | Icon | * | Объект значка для отрисовки маркера. Смотрите Документацию по значкам для подробностей о настройке значка маркера. Если не указано, используется общий экземпляр L.Icon.Default. |
keyboard | Boolean | true | Можно ли выбрать маркер с помощью клавиатуры и нажать на него клавишей enter. |
title | String | '' | Текст для всплывающей подсказки браузера, которая появляется при наведении на маркер (по умолчанию подсказка отсутствует). Полезно для обеспечения доступности. |
alt | String | 'Marker' | Текст для атрибута alt изображения значка. Полезно для обеспечения доступности. |
zIndexOffset | Number | 0 | По умолчанию z-индекс изображения маркера устанавливается автоматически на основе его широты. Используйте эту опцию, если вы хотите поместить маркер поверх всех остальных (или ниже), указав большое значение, например, 1000 (или большое отрицательное значение соответственно). |
opacity | Number | 1.0 | Прозрачность маркера. |
riseOnHover | Boolean | false | Если true, маркер будет отображаться поверх других при наведении курсора. |
riseOffset | Number | 250 | Смещение z-индекса, используемое для функции riseOnHover. |
pane | String | 'markerPane' |
Map pane куда будет добавлен значок маркера. |
shadowPane | String | 'shadowPane' |
Map pane куда будет добавлен тень маркера. |
bubblingMouseEvents | Boolean | false | Если true, событие мыши на этом маркеров будет срабатывать и на карте (если не используется L.DomEvent.stopPropagation). |
autoPanOnFocus | Boolean | true | Если true, карта будет перемещаться всякий раз, когда маркер получает фокус (например, при нажатии tab на клавиатуре), чтобы гарантировать, что маркер виден внутри границ карты. |
Опции перетаскиваемого маркера
| Опция | Тип | По умолчанию | Описание |
|---|---|---|---|
draggable | Boolean | false | Можно ли перетаскивать маркер мышью/сенсорным экраном или нет. |
autoPan | Boolean | false | Необходимо ли перемещать карту при перетаскивании маркера около ее края или нет. |
autoPanPadding | Point | Point(50, 50) | Расстояние (в пикселях влево/вправо и сверху/снизу) от края карты, чтобы начать перемещение карты. |
autoPanSpeed | Number | 10 | Количество пикселей, на которое карта должна быть перемещена. |
| Опция | Тип | По умолчанию | Описание |
|---|---|---|---|
interactive | Boolean | true | Если false, слой не будет генерировать события мыши и будет работать как часть основной карты. |
| Опция | Тип | По умолчанию | Описание |
|---|---|---|---|
attribution | String | null | Строка, отображаемая в элементе управления атрибуцией, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является правовой обязанностью перед правообладателями и поставщиками плиток. |
События
| Событие | Данные | Описание |
|---|---|---|
move | Event | Срабатывает, когда маркер перемещается с помощью setLatLng или путем перетаскивания. Старые и новые координаты включены в аргументы события как oldLatLng, latlng. |
События перетаскивания
| Событие | Данные | Описание |
|---|---|---|
dragstart | Event | Срабатывает, когда пользователь начинает перетаскивать маркер. |
movestart | Event | Срабатывает, когда маркер начинает перемещаться (из-за перетаскивания). |
drag | Event | Срабатывает многократно, пока пользователь перетаскивает маркер. |
dragend | DragEndEvent | Срабатывает, когда пользователь прекращает перетаскивание маркера. |
moveend | Event | Срабатывает, когда маркер перестает перемещаться (из-за перетаскивания). |
| Событие | Данные | Описание |
|---|---|---|
click | MouseEvent | Вызывается при щелчке (или тапе) пользователя по слою. |
dblclick | MouseEvent | Вызывается при двойном щелчке (или двойном тапе) пользователя по слою. |
mousedown | MouseEvent | Вызывается при нажатии пользователем кнопки мыши на слое. |
mouseup | MouseEvent | Вызывается при отпускании пользователем кнопки мыши, нажатой на слое. |
mouseover | MouseEvent | Вызывается при входе курсора мыши в слой. |
mouseout | MouseEvent | Вызывается при выходе курсора мыши из слоя. |
contextmenu | MouseEvent | Вызывается при правом щелчке пользователя по слою. Блокирует отображение контекстного меню браузера по умолчанию, если для этого события существуют обработчики. Также вызывается на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется длительным нажатием). |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Вызывается после добавления слоя на карту. |
remove | Event | Вызывается после удаления слоя с карты. |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Вызывается при открытии всплывающего окна, связанного со слоем. |
popupclose | PopupEvent | Вызывается при закрытии всплывающего окна, связанного со слоем. |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Вызывается при открытии подсказки, связанной со слоем. |
tooltipclose | TooltipEvent | Вызывается при закрытии подсказки, связанной со слоем. |
Методы
addTo() и remove() и методов всплывающих окон, таких как bindPopup(), вы также можете использовать следующие методы:| Метод | Возвращает | Описание |
|---|---|---|
getLatLng() | LatLng |
Возвращает текущее географическое положение метки. |
setLatLng( | this |
Изменяет положение метки на заданную точку. |
setZIndexOffset( | this |
Изменяет смещение zIndex метки. |
getIcon() | Icon |
Возвращает текущий значок, используемый меткой. |
setIcon( | this |
Изменяет значок метки. |
setOpacity( | this |
Изменяет непрозрачность метки. |
Другие методы
| Метод | Возвращает | Описание |
|---|---|---|
toGeoJSON( | Object |
Значения координат округляются с помощью функции |
| Метод | Возвращает | Описание |
|---|---|---|
addTo( | this |
Добавляет слой на заданную карту или группу слоев. |
remove() | this |
Удаляет слой с карты, на которой он сейчас активен. |
removeFrom( | this |
Удаляет слой со заданной карты. |
removeFrom( | this |
Удаляет слой из заданной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется |
| Метод | Возвращает | Описание |
|---|---|---|
bindPopup( | this |
Связывает всплывающее окно со слоем с переданным |
unbindPopup() | this |
Удаляет всплывающее окно, ранее связанное с |
openPopup( | this |
Открывает связанное всплывающее окно в указанной |
closePopup() | this |
Закрывает связанное всплывающее окно, если оно открыто. |
togglePopup() | this |
Открывает или закрывает всплывающее окно, связанное с этим слоем, в зависимости от его текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающего окна, связанного с этим слоем. |
getPopup() | Popup |
Возвращает всплывающее окно, связанное с этим слоем. |
| Метод | Возвращает | Описание |
|---|---|---|
bindTooltip( | this |
Связывает подсказку со слоем с переданным |
unbindTooltip() | this |
Удаляет подсказку, ранее связанную с |
openTooltip( | this |
Открывает связанную подсказку в указанной |
closeTooltip() | this |
Закрывает связанную подсказку, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает подсказку, связанную с этим слоем, в зависимости от её текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое подсказки, связанной с этим слоем. |
getTooltip() | Tooltip |
Возвращает подсказку, связанную с этим слоем. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-слушатель ( |
on( | this |
Добавляет набор пар «тип/слушатель», например |
off( | this |
Удаляет ранее добавленную функцию-слушатель. Если функция не указана, она удалит всех слушателей этого конкретного события из объекта. Обратите внимание, что если вы передали пользовательский контекст для |
off( | this |
Удаляет набор пар «тип/слушатель». |
off() | this |
Удаляет всех слушателей всех событий объекта. Это включает неявно присоединенные события. |
fire( | this |
Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — первый аргумент функции-слушателя будет содержать его свойства. Событие необязательно может быть распространено на родительские события. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родителя события — |
removeEventParent( | this |
Удаляет родителя события, поэтому он перестанет получать распространяемые события |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
Свойства
Обработчики взаимодействия
Handler). Пример: marker.dragging.disable();
| Свойство | Тип | Описание |
|---|---|---|
dragging | Handler | Обработчик перетаскивания маркера (как мышкой, так и касанием). Действителен только когда маркер на карте (иначе задайте marker.options.draggable). |
DivOverlay
Базовая модель для L.Popup и L.Tooltip. Наследуйте от неё для пользовательских наложений, таких как плагины.
Параметры
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
interactive | Boolean | false | Если true, всплывающее окно/подсказка будет реагировать на события мыши. |
offset | Point | Point(0, 0) | Смещение позиции наложения. |
className | String | '' | Настраиваемое имя класса CSS для назначения наложению. |
pane | String | undefined |
Map pane куда будет добавлено наложение. |
content | String|HTMLElement|Function | '' | Устанавливает HTML-содержимое наложения при инициализации. Если передана функция, исходный слой будет передан в функцию. Функция должна возвращать String или HTMLElement для использования в наложении. |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
bubblingMouseEvents | Boolean | true | Когда true, событие мыши на этом слое вызовет то же событие на карте (если не используется L.DomEvent.stopPropagation). |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
attribution | String | null | Строка, отображаемая в блоке атрибуции, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридической обязанностью по отношению к правообладателям и поставщикам плиток. |
События
События DivOverlay
| Событие | Данные | Описание |
|---|---|---|
contentupdate | Event | Вызывается при обновлении содержимого наложения |
| Событие | Данные | Описание |
|---|---|---|
click | MouseEvent | Вызывается при клике (или касании) слоя. |
dblclick | MouseEvent | Вызывается при двойном клике (или двойном касании) слоя. |
mousedown | MouseEvent | Вызывается при нажатии кнопки мыши на слое. |
mouseup | MouseEvent | Вызывается при отпускании кнопки мыши, нажатой на слое. |
mouseover | MouseEvent | Вызывается при входе курсора мыши в слой. |
mouseout | MouseEvent | Вызывается при выходе курсора мыши из слоя. |
contextmenu | MouseEvent | Вызывается при правом клике на слое, предотвращает отображение стандартного контекстного меню браузера, если есть слушатели на этом событии. Также срабатывает на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется удержанием). |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Вызывается после добавления слоя на карту |
remove | Event | Вызывается после удаления слоя с карты |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Вызывается при открытии всплывающей подсказки, связанной с этим слоем |
popupclose | PopupEvent | Вызывается при закрытии всплывающей подсказки, связанной с этим слоем |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Вызывается при открытии подсказки, связанной с этим слоем. |
tooltipclose | TooltipEvent | Вызывается при закрытии подсказки, связанной с этим слоем. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
openOn( | this |
Добавляет наложение на карту. Альтернатива |
close() | this |
Закрывает наложение. Альтернатива |
toggle( | this |
Открывает или закрывает наложение, привязанное к слою, в зависимости от его текущего состояния. Аргумент может быть опущен только для наложения, привязанного к слою. Альтернатива |
getLatLng() | LatLng |
Возвращает географическую точку наложения. |
setLatLng( | this |
Устанавливает географическую точку, где откроется наложение. |
getContent() | String|HTMLElement |
Возвращает содержимое наложения. |
setContent( | this |
Устанавливает HTML-содержимое наложения. Если передана функция, исходный слой будет передан в функцию. Функция должна вернуть |
getElement() | String|HTMLElement |
Возвращает HTML-контейнер наложения. |
update() | null |
Обновляет содержимое, макет и положение наложения. Полезно для обновления наложения после изменения чего-либо внутри, например, после загрузки изображения. |
isOpen() | Boolean |
Возвращает |
bringToFront() | this |
Выводит это наложение поверх других наложений (в той же области карты). |
bringToBack() | this |
Выводит это наложение под другие наложения (в той же области карты). |
| Метод | Возвращает | Описание |
|---|---|---|
addTo( | this |
Добавляет слой на заданную карту или группу слоев. |
remove() | this |
Удаляет слой с карты, на которой он в настоящее время активен. |
removeFrom( | this |
Удаляет слой с заданной карты. |
removeFrom( | this |
Удаляет слой с заданной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется |
| Метод | Возвращает | Описание |
|---|---|---|
bindPopup( | this |
Привязывает всплывающую подсказку к слою с переданной |
unbindPopup() | this |
Удаляет всплывающую подсказку, ранее привязанную с помощью |
openPopup( | this |
Открывает привязанную всплывающую подсказку в указанной |
closePopup() | this |
Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта. |
togglePopup() | this |
Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от её текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающей подсказки, привязанной к этому слою. |
getPopup() | Popup |
Возвращает всплывающую подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
bindTooltip( | this |
Привязывает подсказку к слою с переданной |
unbindTooltip() | this |
Удаляет подсказку, ранее привязанную с помощью |
openTooltip( | this |
Открывает привязанную подсказку в указанной |
closeTooltip() | this |
Закрывает подсказку, привязанную к этому слою, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от её текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое подсказки, привязанной к этому слою. |
getTooltip() | Tooltip |
Возвращает подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-обработчик ( |
on( | this |
Добавляет набор пар "тип/обработчик", например, |
off( | this |
Удаляет ранее добавленную функцию-обработчик. Если функция не указана, она удалит всех обработчиков данного события объекта. Обратите внимание, если вы передали пользовательский контекст для |
off( | this |
Удаляет набор пар "тип/обработчик". |
off() | this |
Удаляет всех обработчиков всех событий объекта. Включая неявно присоединённые события. |
fire( | this |
Вызывает событие указанного типа. Необязательно можно передать объект данных — первое аргумент функции-обработчика будет содержать его свойства. Событие необязательно может быть распространено на родительские элементы. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родительский элемент события - |
removeEventParent( | this |
Удаляет родительский элемент события, так что он перестанет получать распространяемые события |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
Поп-ап
Используется для открытия поп-апов в определённых местах карты. Используйте Map.openPopup для открытия поп-апов, гарантируя, что открыт только один поп-ап (рекомендуется для удобства), или используйте Map.addLayer для открытия любого количества.
Пример использования
Если вы хотите просто привязать поп-ап к клику на марке, а затем открыть его, это очень просто:
marker.bindPopup(popupContent).openPopup();
Наложения путей, такие как полилинии, также имеют метод bindPopup.
Поп-ап также может быть самостоятельным:
var popup = L.popup()
.setLatLng(latlng)
.setContent('<p>Hello world!<br />This is a nice popup.</p>')
.openOn(map);
или
var popup = L.popup(latlng, {content: '<p>Hello world!<br />This is a nice popup.</p>'})
.openOn(map);
Создание
| Фабрика | Описание |
|---|---|
L.popup( | Создаёт объект Popup на основе необязательного объекта options, описывающего его внешний вид и расположение, и необязательного объекта source, используемого для маркировки поп-апа с ссылкой на слой, к которому он относится. |
L.popup( | Создаёт объект Popup на основе latlng, где будет открыт поп-ап, и необязательного объекта options, описывающего его внешний вид и расположение. |
Параметры
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
pane | String | 'popupPane' |
Map pane куда будет добавлен поп-ап. |
offset | Point | Point(0, 7) | Смещение позиции поп-апа. |
maxWidth | Number | 300 | Максимальная ширина поп-апа в пикселях. |
minWidth | Number | 50 | Минимальная ширина поп-апа в пикселях. |
maxHeight | Number | null | Если задано, создаёт прокручиваемую область заданной высоты внутри поп-апа, если его содержимое превышает её. Прокручиваемую область можно стилизовать с помощью селектора CSS класса leaflet-popup-scrolled. |
autoPan | Boolean | true | Установите в false, если вы не хотите, чтобы карта выполняла анимацию перемещения для подгонки открытого поп-апа. |
autoPanPaddingTopLeft | Point | null | Отступ между поп-апом и верхним левым углом представления карты после выполнения автоматического перемещения. |
autoPanPaddingBottomRight | Point | null | Отступ между поп-апом и нижним правым углом представления карты после выполнения автоматического перемещения. |
autoPanPadding | Point | Point(5, 5) | Эквивалентно установлению отступов для автоматического перемещения по верхнему левому и нижнему правому углам в одинаковое значение. |
keepInView | Boolean | false | Установите в true, если вы хотите предотвратить перемещение пользователя поп-апа за пределы экрана во время его открытия. |
closeButton | Boolean | true | Управляет наличием кнопки закрытия в поп-апе. |
autoClose | Boolean | true | Установите в false, если вы хотите переопределить стандартное поведение закрытия поп-апа при открытии другого. |
closeOnEscapeKey | Boolean | true | Установите в false, если вы хотите переопределить стандартное поведение клавиши ESC для закрытия поп-апа. |
closeOnClick | Boolean | * | Установите, если вы хотите переопределить стандартное поведение закрытия поп-апа при клике пользователя на карте. По умолчанию использует параметр карты closePopupOnClick. |
className | String | '' | Настраиваемое имя класса CSS для назначения поп-апу. |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
interactive | Boolean | false | Если true, поп-ап/подсказка будет обрабатывать события мыши. |
content | String|HTMLElement|Function | '' | Устанавливает HTML-содержимое наложения при инициализации. Если передана функция, то исходный слой будет передан в функцию. Функция должна возвратить String или HTMLElement для использования в наложении. |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
bubblingMouseEvents | Boolean | true | Когда true, событие мыши на этом слое вызовет такое же событие на карте (если не используется L.DomEvent.stopPropagation). |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
attribution | String | null | Строка, отображаемая в блоке атрибуции, например, "© OpenStreetMap contributors". Описывает данные слоя и часто является правовой обязанностью перед держателями авторских прав и поставщиками плиток. |
События
| Событие | Данные | Описание |
|---|---|---|
contentupdate | Event | Вызывается при обновлении содержимого наложения |
| Событие | Данные | Описание |
|---|---|---|
click | MouseEvent | Срабатывает при щелчке (или нажатии) пользователем по слою. |
dblclick | MouseEvent | Срабатывает при двойном щелчке (или двойном нажатии) пользователем по слою. |
mousedown | MouseEvent | Срабатывает при нажатии пользователем кнопки мыши на слое. |
mouseup | MouseEvent | Срабатывает при отпускании пользователем нажатой кнопки мыши на слое. |
mouseover | MouseEvent | Срабатывает при входе курсора мыши в слой. |
mouseout | MouseEvent | Срабатывает при выходе курсора мыши из слоя. |
contextmenu | MouseEvent | Срабатывает при нажатии правой кнопкой мыши на слое; предотвращает отображение контекстного меню браузера по умолчанию, если есть обработчики этого события. Также срабатывает на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется удерживанием). |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Срабатывает после добавления слоя на карту. |
remove | Event | Срабатывает после удаления слоя с карты. |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Срабатывает при открытии всплывающей подсказки, связанной с этим слоем. |
popupclose | PopupEvent | Срабатывает при закрытии всплывающей подсказки, связанной с этим слоем. |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Срабатывает при открытии подсказки, привязанной к этому слою. |
tooltipclose | TooltipEvent | Срабатывает при закрытии подсказки, привязанной к этому слою. |
Методы
| Метод | Возвращаемое значение | Описание |
|---|---|---|
openOn( | this |
Альтернатива |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
close() | this |
Закрывает наложение. Альтернатива |
toggle( | this |
Открывает или закрывает наложение, привязанное к слою, в зависимости от его текущего состояния. Аргумент может быть опущен только для наложения, привязанного к слою. Альтернатива |
getLatLng() | LatLng |
Возвращает географическую точку наложения. |
setLatLng( | this |
Устанавливает географическую точку, где откроется наложение. |
getContent() | String|HTMLElement |
Возвращает содержимое наложения. |
setContent( | this |
Устанавливает HTML-содержимое наложения. Если передана функция, исходный слой будет передан функции. Функция должна возвращать |
getElement() | String|HTMLElement |
Возвращает HTML-контейнер наложения. |
update() | null |
Обновляет содержимое, макет и положение наложения. Полезно для обновления наложения после изменения чего-либо внутри, например, при загрузке изображения. |
isOpen() | Boolean |
Возвращает |
bringToFront() | this |
Выводит это наложение поверх других наложений (в том же окне карты). |
bringToBack() | this |
Выводит это наложение под другими наложениями (в том же окне карты). |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
addTo( | this |
Добавляет слой на указанную карту или группу слоев. |
remove() | this |
Удаляет слой с карты, на которой он в настоящее время активен. |
removeFrom( | this |
Удаляет слой с указанной карты. |
removeFrom( | this |
Удаляет слой из указанной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
bindPopup( | this |
Привязывает всплывающую подсказку к слою с переданной |
unbindPopup() | this |
Удаляет ранее привязанную всплывающую подсказку с помощью |
openPopup( | this |
Открывает привязанную всплывающую подсказку в указанной |
closePopup() | this |
Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта. |
togglePopup() | this |
Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от ее текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающей подсказки, привязанной к этому слою. |
getPopup() | Popup |
Возвращает всплывающую подсказку, привязанную к этому слою. |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
bindTooltip( | this |
Привязывает подсказку к слою с переданной |
unbindTooltip() | this |
Удаляет ранее привязанную подсказку с помощью |
openTooltip( | this |
Открывает привязанную подсказку в указанной |
closeTooltip() | this |
Закрывает подсказку, привязанную к этому слою, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от ее текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое подсказки, привязанной к этому слою. |
getTooltip() | Tooltip |
Возвращает подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет обработчик событий ( |
on( | this |
Добавляет набор пар тип/обработчик, например, |
off( | this |
Удаляет ранее добавленный обработчик событий. Если функция не указана, будут удалены все обработчики указанного события для объекта. Обратите внимание, что если вы передали пользовательский контекст для |
off( | this |
Удаляет набор пар тип/обработчик. |
off() | this |
Удаляет все обработчики всех событий объекта. Это включает неявные присоединённые события. |
fire( | this |
Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — первый аргумент функции-обработчика будет содержать его свойства. Событие может быть необязательно распространено на родительские элементы. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родительский элемент события — |
removeEventParent( | this |
Удаляет родительский элемент события, чтобы он перестал получать распространяемые события |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
Подсказка
Используется для отображения небольших текстовых сообщений поверх слоев карты.
Пример использования
Если вам нужно просто привязать подсказку к метке:
marker.bindTooltip("my tooltip text").openTooltip();
Для наложений путей, таких как полилинии, также доступен метод bindTooltip.
Подсказка может быть также самостоятельной:
var tooltip = L.tooltip()
.setLatLng(latlng)
.setContent('Hello world!<br />This is a nice tooltip.')
.addTo(map);
или
var tooltip = L.tooltip(latlng, {content: 'Hello world!<br />This is a nice tooltip.'})
.addTo(map);
Примечание о смещении подсказки. Leaflet учитывает два параметра для вычисления смещения подсказки:
- параметр
offsetподсказки: по умолчанию он равен [0, 0], и он специфичен для одной подсказки. Добавьте положительное смещение по x, чтобы переместить подсказку вправо, и положительное смещение по y, чтобы переместить её вниз. Отрицательные значения сместят подсказку влево и вверх. - параметр
tooltipAnchorзначка: это будет учитываться только для маркеров. Вам следует адаптировать это значение, если вы используете пользовательский значок.
Создание
| Фабрика | Описание |
|---|---|
L.tooltip( | Создаёт объект Tooltip с необязательным объектом options, описывающим его внешний вид и расположение, и необязательным объектом source, используемым для маркировки подсказки ссылкой на слой, к которому она относится. |
L.tooltip( | Создаёт объект Tooltip с заданным latlng, где будет открыта подсказка, и необязательным объектом options, описывающим её внешний вид и расположение. |
Параметры
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
pane | String | 'tooltipPane' |
Map pane где будет добавлена подсказка. |
offset | Point | Point(0, 0) | Необязательное смещение положения подсказки. |
direction | String | 'auto' | Направление открытия подсказки. Возможные значения: right, left, top, bottom, center, auto. auto динамически переключается между right и left в зависимости от положения подсказки на карте. |
permanent | Boolean | false | Открывать подсказку постоянно или только при наведении курсора. |
sticky | Boolean | false | Если true, подсказка будет следовать за курсором вместо того, чтобы быть закреплённой в центре объекта. |
opacity | Number | 0.9 | Прозрачность контейнера подсказки. |
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
interactive | Boolean | false | Если true, всплывающее окно/подсказка будет реагировать на события мыши. |
className | String | '' | Пользовательское имя класса CSS для назначения накладке. |
content | String|HTMLElement|Function | '' | Устанавливает HTML-содержимое накладки при инициализации. Если передана функция, исходный слой будет передан в функцию. Функция должна вернуть String или HTMLElement для использования в накладке. |
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
bubblingMouseEvents | Boolean | true | Когда true, событие мыши на этом слое вызовет то же событие на карте (если не используется L.DomEvent.stopPropagation). |
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
attribution | String | null | Строка, отображаемая в элементе управления атрибутами, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридическим обязательством по отношению к правообладателям и поставщикам плиток. |
События
| Событие | Данные | Описание |
|---|---|---|
contentupdate | Event | Вызывается при обновлении содержимого накладки. |
| Событие | Данные | Описание |
|---|---|---|
click | MouseEvent | Вызывается при клике пользователя (или нажатии) на слой. |
dblclick | MouseEvent | Вызывается при двойном клике пользователя (или двойном нажатии) на слой. |
mousedown | MouseEvent | Вызывается при нажатии пользователем кнопки мыши на слой. |
mouseup | MouseEvent | Вызывается при отпускании пользователем нажатой кнопки мыши на слое. |
mouseover | MouseEvent | Вызывается при входе курсора мыши в слой. |
mouseout | MouseEvent | Вызывается при выходе курсора мыши из слоя. |
contextmenu | MouseEvent | Вызывается при правом клике пользователя на слой, предотвращает отображение контекстного меню браузера по умолчанию, если есть обработчики на этом событии. Также вызывается на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется удержанием). |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Срабатывает после добавления слоя на карту |
remove | Event | Срабатывает после удаления слоя с карты |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Срабатывает при открытии всплывающей подсказки, привязанной к этому слою |
popupclose | PopupEvent | Срабатывает при закрытии всплывающей подсказки, привязанной к этому слою |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Срабатывает при открытии подсказки, привязанной к этому слою. |
tooltipclose | TooltipEvent | Срабатывает при закрытии подсказки, привязанной к этому слою. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
openOn( | this |
Добавляет наложение на карту. Альтернатива |
close() | this |
Закрывает наложение. Альтернатива |
toggle( | this |
Открывает или закрывает наложение, привязанное к слою, в зависимости от его текущего состояния. Аргумент может быть опущен только для наложения, привязанного к слою. Альтернатива |
getLatLng() | LatLng |
Возвращает географическую точку наложения. |
setLatLng( | this |
Устанавливает географическую точку, где будет открыто наложение. |
getContent() | String|HTMLElement |
Возвращает содержимое наложения. |
setContent( | this |
Устанавливает HTML-содержимое наложения. Если передана функция, исходный слой будет передан в функцию. Функция должна возвратить |
getElement() | String|HTMLElement |
Возвращает HTML-контейнер наложения. |
update() | null |
Обновляет содержимое, макет и положение наложения. Полезно для обновления наложения после изменения чего-либо внутри него, например, после загрузки изображения. |
isOpen() | Boolean |
Возвращает |
bringToFront() | this |
Выводит это наложение поверх других наложений (в том же окне карты). |
bringToBack() | this |
Переводит это наложение назад за другие наложения (в том же окне карты). |
| Метод | Возвращает | Описание |
|---|---|---|
addTo( | this |
Добавляет слой на указанную карту или группу слоев. |
remove() | this |
Удаляет слой с карты, на которой он в данный момент активен. |
removeFrom( | this |
Удаляет слой с указанной карты |
removeFrom( | this |
Удаляет слой из указанной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется слоем |
| Метод | Возвращает | Описание |
|---|---|---|
bindPopup( | this |
Привязывает всплывающую подсказку к слою с переданной |
unbindPopup() | this |
Удаляет всплывающую подсказку, ранее привязанную с |
openPopup( | this |
Открывает привязанную всплывающую подсказку в указанной |
closePopup() | this |
Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта. |
togglePopup() | this |
Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от ее текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающей подсказки, привязанной к этому слою. |
getPopup() | Popup |
Возвращает всплывающую подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
bindTooltip( | this |
Привязывает подсказку к слою с переданной |
unbindTooltip() | this |
Удаляет подсказку, ранее привязанную с |
openTooltip( | this |
Открывает привязанную подсказку в указанной |
closeTooltip() | this |
Закрывает подсказку, привязанную к этому слою, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от ее текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое подсказки, привязанной к этому слою. |
getTooltip() | Tooltip |
Возвращает подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-слушатель ( |
on( | this |
Добавляет набор пар тип/слушатель, например |
off( | this |
Удаляет ранее добавленную функцию-слушатель. Если функция не указана, удаляются все слушатели этого события для объекта. Обратите внимание, что если вы передали пользовательский контекст для |
off( | this |
Удаляет набор пар тип/слушатель. |
off() | this |
Удаляет всех слушателей всех событий объекта. Это включает в себя неявные присоединённые события. |
fire( | this |
Вызывает событие указанного типа. Можно необязательно предоставить объект данных — свойства этого объекта будут в первом аргументе функции слушателя. Событие можно необязательно распространить на родительские элементы. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родительский элемент события — |
removeEventParent( | this |
Удаляет родительский элемент события, поэтому он перестанет получать распространяемые события |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
Слои плиток
Используется для загрузки и отображения слоёв плиток на карте. Обратите внимание, что большинство служб плиток требуют указания авторских прав, которые можно установить в разделе Layer. Расширяет GridLayer.
Пример использования
L.tileLayer('https://tile.openstreetmap.org/{z}/{x}/{y}.png?{foo}', {foo: 'bar', attribution: '© <a href="https://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors'}).addTo(map);
Шаблон URL
Строка следующего формата:
'https://{s}.somedomain.com/blabla/{z}/{x}/{y}{r}.png'
{s} означает один из доступных поддоменов (используется последовательно для помощи в обработке параллельных запросов браузера по ограничению на домен; значения поддомена указаны в параметрах; a, b или c по умолчанию, могут быть опущены), {z} — уровень масштабирования, {x} и {y} — координаты плитки. {r} может использоваться для добавления "@2x" в URL для загрузки плиток с высокой точкой.
Вы можете использовать пользовательские ключи в шаблоне, которые будут оцениваться из параметров TileLayer, например так:
L.tileLayer('https://{s}.somedomain.com/{foo}/{z}/{x}/{y}.png', {foo: 'bar'});
Создание
Методы расширения
| Фабрика | Описание |
|---|---|
L.tilelayer( | Инициализирует объект слоя плиток, используя URL template и необязательно объект параметров. |
Параметры
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
minZoom | Number | 0 | Минимальный уровень масштабирования, до которого будет отображаться слой (включительно). |
maxZoom | Number | 18 | Максимальный уровень масштабирования, до которого будет отображаться слой (включительно). |
subdomains | String|String[] | 'abc' | Поддомены службы плиток. Можно передать в виде одной строки (где каждый символ — имя поддомена) или массива строк. |
errorTileUrl | String | '' | URL изображения плитки, которое будет показано вместо плитки, которая не загрузилась. |
zoomOffset | Number | 0 | Номер масштабирования, используемый в URL-адресах плиток, будет смещён на это значение. |
tms | Boolean | false | Если true, инвертирует нумерацию оси Y для плиток (включите для сервисов TMS). |
zoomReverse | Boolean | false | Если установлено в true, номер масштабирования, используемый в URL-адресах плиток, будет инвертирован (maxZoom - zoom вместо zoom). |
detectRetina | Boolean | false | Если true и пользователь использует экран с высокой плотностью пикселей, он запросит четыре плитки с половинным указанным размером и большим уровнем масштабирования вместо одной, чтобы использовать высокое разрешение. |
crossOrigin | Boolean|String | false | Добавлять ли атрибут crossOrigin к плиткам. Если передано строковое значение, атрибут crossOrigin всех плиток будет установлен в переданное значение. Это необходимо, если нужно получить данные пикселей плиток. Обратитесь к Настройкам CORS для допустимых строковых значений. |
referrerPolicy | Boolean|String | false | Добавлять ли атрибут referrerPolicy к плиткам. Если передано строковое значение, атрибут referrerPolicy всех плиток будет установлен в переданное значение. Это может потребоваться, если контекст рендеринга вашей карты имеет строгие настройки по умолчанию, но ваш поставщик плиток ожидает допустимый referrer (например, для проверки API-ключа). Обратитесь к HTMLImageElement.referrerPolicy для допустимых строковых значений. |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
tileSize | Number|Point | 256 | Ширина и высота тайлов в сетке. Используйте число, если ширина и высота равны, или L.point(width, height) в противном случае. |
opacity | Number | 1.0 | Непрозрачность тайлов. Может быть использовано в функции createTile(). |
updateWhenIdle | Boolean | (depends) | Загружать новые тайлы только после окончания панорамирования. По умолчанию включено в мобильных браузерах, чтобы избежать большого количества запросов и обеспечить плавную навигацию. false в противном случае, чтобы отображать новые тайлы во время панорамирования, так как легко выйти за пределы параметра keepBuffer в настольных браузерах. |
updateWhenZooming | Boolean | true | По умолчанию, плавная анимация масштабирования (при масштабировании через касание или flyTo()) будет обновлять слои сетки на каждом целочисленном уровне масштабирования. Установка этого параметра в значение false будет обновлять слой сетки только после завершения плавной анимации. |
updateInterval | Number | 200 | Тайлы не будут обновляться чаще, чем раз в updateInterval миллисекунд при панорамировании. |
zIndex | Number | 1 | Явный zIndex слоя тайлов. |
bounds | LatLngBounds | undefined | При установке тайлы будут загружаться только внутри заданного LatLngBounds. |
maxNativeZoom | Number | undefined | Максимальное значение масштабирования, доступное для источника тайлов. Если указано, тайлы на всех уровнях масштабирования выше maxNativeZoom будут загружены с уровня maxNativeZoom и автоматически масштабированы. |
minNativeZoom | Number | undefined | Минимальное значение масштабирования, доступное для источника тайлов. Если указано, тайлы на всех уровнях масштабирования ниже minNativeZoom будут загружены с уровня minNativeZoom и автоматически масштабированы. |
noWrap | Boolean | false | Определяет, будет ли слой обернут вокруг антимеридиана. Если true, GridLayer будет отображаться только один раз на низких уровнях масштабирования. Не оказывает влияния, если система координат карты (CRS карты) не обернута. Может быть использовано в сочетании с bounds для предотвращения запросов тайлов за пределами границ CRS. |
pane | String | 'tilePane' |
Map pane где будет добавлен слой сетки. |
className | String | '' | Настраиваемое имя класса для назначения слою тайлов. По умолчанию пустое. |
keepBuffer | Number | 2 | При панорамировании карты сохранять такое количество строк и столбцов тайлов перед их удалением. |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
attribution | String | null | Строка, отображаемая в элементе управления атрибутами, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является обязательной с точки зрения авторских прав и поставщиков тайлов. |
События
Расширяющие методы
| Событие | Данные | Описание |
|---|---|---|
tileabort | TileEvent | Срабатывает, когда загрузка тайла началась, но больше не требуется. |
| Событие | Данные | Описание |
|---|---|---|
loading | Event | Срабатывает, когда слой сетки начинает загружать тайлы. |
tileunload | TileEvent | Срабатывает, когда тайл удаляется (например, когда тайл выходит за пределы экрана). |
tileloadstart | TileEvent | Срабатывает, когда тайл запрашивается и начинает загружаться. |
tileerror | TileErrorEvent | Срабатывает при ошибке загрузки тайла. |
tileload | TileEvent | Срабатывает, когда тайл загружен. |
load | Event | Срабатывает, когда слой сетки загрузил все видимые тайлы. |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Срабатывает после добавления слоя на карту. |
remove | Event | Срабатывает после удаления слоя с карты. |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Срабатывает, когда всплывающее окно, связанное с этим слоем, открывается. |
popupclose | PopupEvent | Срабатывает, когда всплывающее окно, связанное с этим слоем, закрывается. |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Срабатывает, когда всплывающая подсказка, связанная с этим слоем, открывается. |
tooltipclose | TooltipEvent | Срабатывает, когда всплывающая подсказка, связанная с этим слоем, закрывается. |
Методы
| Метод | Возвращаемое значение | Описание |
|---|---|---|
setUrl( | this |
Обновляет шаблон URL слоя и перерисовывает его (если |
createTile( | HTMLElement |
Вызывается только внутренне, переопределяет |
Расширяющие методы
TileLayer, могут переопределить следующий метод.| Метод | Возвращаемое значение | Описание |
|---|---|---|
getTileUrl( | String |
Вызывается только внутренне, возвращает URL для тайла с заданными координатами. Классы, расширяющие |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
bringToFront() | this |
Выводит слой тайлов вперед всех остальных слоев тайлов. |
bringToBack() | this |
Выводит слой тайлов назад всех остальных слоев тайлов. |
getContainer() | HTMLElement |
Возвращает HTML-элемент, содержащий тайлы для этого слоя. |
setOpacity( | this |
Изменяет непрозрачность слоя сетки. |
setZIndex( | this |
Изменяет zIndex слоя сетки. |
isLoading() | Boolean |
Возвращает |
redraw() | this |
Принудительно очищает все тайлы и запрашивает их заново. |
getTileSize() | Point |
Нормализует параметр tileSize в точку. Используется методом |
| Метод | Возвращает | Описание |
|---|---|---|
addTo( | this |
Добавляет слой на заданную карту или группу слоёв. |
remove() | this |
Удаляет слой с карты, на которой он в данный момент активен. |
removeFrom( | this |
Удаляет слой с заданной карты. |
removeFrom( | this |
Удаляет слой из заданной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется |
| Метод | Возвращает | Описание |
|---|---|---|
bindPopup( | this |
Связывает всплывающее окно со слоем с переданным |
unbindPopup() | this |
Удаляет всплывающее окно, ранее связанное с |
openPopup( | this |
Открывает связанное всплывающее окно в указанной |
closePopup() | this |
Закрывает всплывающее окно, связанное с этим слоем, если оно открыто. |
togglePopup() | this |
Открывает или закрывает всплывающее окно, связанное с этим слоем, в зависимости от его текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающего окна, связанного с этим слоем. |
getPopup() | Popup |
Возвращает всплывающее окно, связанное с этим слоем. |
| Метод | Возвращает | Описание |
|---|---|---|
bindTooltip( | this |
Связывает подсказку со слоем с переданным |
unbindTooltip() | this |
Удаляет подсказку, ранее связанную с |
openTooltip( | this |
Открывает связанную подсказку в указанной |
closeTooltip() | this |
Закрывает подсказку, связанную с этим слоем, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает подсказку, связанную с этим слоем, в зависимости от её текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое подсказки, связанной с этим слоем. |
getTooltip() | Tooltip |
Возвращает подсказку, связанную с этим слоем. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-обработчик ( |
on( | this |
Добавляет набор пар тип/обработчик, например |
off( | this |
Удаляет ранее добавленную функцию-обработчик. Если функция не указана, удаляет все обработчики данного события для объекта. Обратите внимание, что если вы передали пользовательский контекст для |
off( | this |
Удаляет набор пар тип/обработчик. |
off() | this |
Удаляет все обработчики всех событий для объекта. Это включает неявно прикреплённые события. |
fire( | this |
Вызывает событие указанного типа. Можно дополнительно передать объект данных — первый аргумент функции-обработчика будет содержать его свойства. Событие может быть дополнительно распространено на родительские события. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родителя события - |
removeEventParent( | this |
Удаляет родителя события, чтобы он перестал получать распространяемые события. |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
TileLayer.WMS
Используется для отображения WMS-сервисов в качестве слоёв тайлов на карте. Расширяет TileLayer.
Пример использования
var nexrad = L.tileLayer.wms("http://mesonet.agron.iastate.edu/cgi-bin/wms/nexrad/n0r.cgi", {
layers: 'nexrad-n0r-900913',
format: 'image/png',
transparent: true,
attribution: "Weather data © 2012 IEM Nexrad"
});
Создание
| Фабрика | Описание |
|---|---|
L.tileLayer.wms( | Создаёт объект слоя тайлов WMS на основе базового URL WMS-сервиса и объекта параметров/опций WMS. |
Опции
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
layers | String | '' | (обязательно) Список слоев WMS для отображения, разделённых запятыми. |
styles | String | '' | Список стилей WMS, разделённых запятыми. |
format | String | 'image/jpeg' | Формат изображения WMS (используйте 'image/png' для слоев с прозрачностью). |
transparent | Boolean | false | Если true, служба WMS вернёт изображения с прозрачностью. |
version | String | '1.1.1' | Версия службы WMS для использования |
crs | CRS | null | Система координат, которую нужно использовать для запросов WMS, по умолчанию — CRS карты. Не изменяйте это, если не уверены, что это значит. |
uppercase | Boolean | false | Если true, ключи параметров запроса WMS будут в верхнем регистре. |
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
minZoom | Number | 0 | Минимальный уровень масштабирования, до которого этот слой будет отображаться (включительно). |
maxZoom | Number | 18 | Максимальный уровень масштабирования, до которого этот слой будет отображаться (включительно). |
subdomains | String|String[] | 'abc' | Поддомены службы плиток. Может быть передано в виде одной строки (каждая буква — имя поддомена) или массива строк. |
errorTileUrl | String | '' | URL изображения плитки, которое должно отображаться вместо плитки, не загруженной по какой-либо причине. |
zoomOffset | Number | 0 | Номер масштаба, используемый в URL-адресах плиток, будет смещён на это значение. |
tms | Boolean | false | Если true, инвертирует нумерацию оси Y для плиток (включите для TMS -сервисов). |
zoomReverse | Boolean | false | Если установлено в true, номер масштаба, используемый в URL-адресах плиток, будет изменён на обратный (maxZoom - zoom вместо zoom). |
detectRetina | Boolean | false | Если true и пользователь находится на экране с технологией Retina, будут запрошены четыре плитки с половиной указанного размера и более высоким уровнем масштабирования вместо одной, чтобы использовать высокое разрешение. |
crossOrigin | Boolean|String | false | Добавлять ли атрибут crossOrigin к плиткам. Если предоставлена строка, все плитки получат атрибут crossOrigin, установленный на предоставленную строку. Это необходимо, если вы хотите получить доступ к данным пикселей плитки. Обратитесь к Настройкам CORS для допустимых значений строки. |
referrerPolicy | Boolean|String | false | Добавлять ли атрибут referrerPolicy к плиткам. Если предоставлена строка, все плитки получат атрибут referrerPolicy, установленный на предоставленную строку. Это может потребоваться, если контекст рендеринга вашей карты имеет строгие настройки по умолчанию, но ваш поставщик плиток ожидает действительный referrer (например, для проверки токена API). Обратитесь к HTMLImageElement.referrerPolicy для допустимых значений строки. |
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
tileSize | Number|Point | 256 | Ширина и высота плиток в сетке. Используйте число, если ширина и высота равны, или L.point(width, height) в противном случае. |
opacity | Number | 1.0 | Непрозрачность плиток. Может быть использована в функции createTile(). |
updateWhenIdle | Boolean | (depends) | Загружать новые плитки только при завершении панорамирования. По умолчанию true в мобильных браузерах, чтобы избежать большого количества запросов и обеспечить плавную навигацию. false в противном случае, чтобы отображать новые плитки во время панорамирования, так как легко выйти за пределы опции keepBuffer в браузерах на настольных компьютерах. |
updateWhenZooming | Boolean | true | По умолчанию плавная анимация масштабирования (во время тактильного масштабирования или flyTo()) будет обновлять слои сетки каждые целые значения масштабирования. Установка этого параметра в false обновит слой сетки только при завершении плавной анимации. |
updateInterval | Number | 200 | Плитки не будут обновляться чаще, чем один раз каждые updateInterval миллисекунд при панорамировании. |
zIndex | Number | 1 | Явный z-индекс слоя плиток. |
bounds | LatLngBounds | undefined | Если задано, плитки будут загружаться только внутри установленной LatLngBounds. |
maxNativeZoom | Number | undefined | Максимальное значение масштаба, доступное для источника плиток. Если указано, плитки на всех уровнях масштаба, превышающих maxNativeZoom, будут загружаться с уровня maxNativeZoom и автоматически масштабироваться. |
minNativeZoom | Number | undefined | Минимальное значение масштаба, доступное для источника плиток. Если указано, плитки на всех уровнях масштаба, меньших чем minNativeZoom, будут загружаться с уровня minNativeZoom и автоматически масштабироваться. |
noWrap | Boolean | false | Обёртывается ли слой вокруг антимеридиана. Если true, GridLayer будет отображаться только один раз на низких уровнях масштабирования. Не оказывает влияния, когда CRS карты не обёртывается вокруг. Может быть использован совместно с bounds, чтобы предотвратить запрос плиток за пределами ограничений CRS. |
pane | String | 'tilePane' |
Map pane где будет добавлен слой сетки. |
className | String | '' | Пользовательское имя класса, присваиваемое слою плиток. По умолчанию пустое. |
keepBuffer | Number | 2 | При панорамировании карты сохранять это количество строк и столбцов плиток, прежде чем их выгрузить. |
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
attribution | String | null | Строка, отображаемая в элементе управления атрибутами, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридической обязанностью по отношению к правообладателям и поставщикам плиток. |
События
| Событие | Данные | Описание |
|---|---|---|
tileabort | TileEvent | Срабатывает, когда плитка загружалась, но теперь больше не нужна. |
| Событие | Данные | Описание |
|---|---|---|
loading | Event | Срабатывает, когда слой сетки начинает загружать плитки. |
tileunload | TileEvent | Срабатывает, когда плитка удаляется (например, когда плитка выходит за пределы экрана). |
tileloadstart | TileEvent | Срабатывает, когда плитка запрашивается и начинает загружаться. |
tileerror | TileErrorEvent | Срабатывает, когда возникает ошибка при загрузке плитки. |
tileload | TileEvent | Срабатывает, когда плитка загружается. |
load | Event | Срабатывает, когда слой сетки загрузил все видимые плитки. |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Срабатывает после добавления слоя на карту |
remove | Event | Срабатывает после удаления слоя с карты |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Срабатывает при открытии всплывающего окна, привязанного к этому слою |
popupclose | PopupEvent | Срабатывает при закрытии всплывающего окна, привязанного к этому слою |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Срабатывает при открытии подсказки, привязанной к этому слою. |
tooltipclose | TooltipEvent | Срабатывает при закрытии подсказки, привязанной к этому слою. |
Методы
| Метод | Возвращаемое значение | Описание |
|---|---|---|
setParams( | this |
Объединяет объект с новыми параметрами и заново запрашивает тайлы на текущем экране (если |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
setUrl( | this |
Обновляет шаблон URL слоя и перерисовывает его (если |
createTile( | HTMLElement |
Вызывается только во внутреннем режиме. Переопределяет |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
bringToFront() | this |
Выводит слой тайлов поверх всех остальных слоев тайлов. |
bringToBack() | this |
Выводит слой тайлов под все остальные слои тайлов. |
getContainer() | HTMLElement |
Возвращает HTML-элемент, содержащий тайлы для данного слоя. |
setOpacity( | this |
Изменяет прозрачность слоя сетки. |
setZIndex( | this |
Изменяет zIndex слоя сетки. |
isLoading() | Boolean |
Возвращает |
redraw() | this |
Принудительно очищает все тайлы и запрашивает их заново. |
getTileSize() | Point |
Нормализует параметр tileSize в точку. Используется методом |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
addTo( | this |
Добавляет слой на заданную карту или группу слоев. |
remove() | this |
Удаляет слой с карты, на которой он сейчас активен. |
removeFrom( | this |
Удаляет слой с заданной карты |
removeFrom( | this |
Удаляет слой из заданной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется методом |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
bindPopup( | this |
Привязывает всплывающее окно к слою с переданным |
unbindPopup() | this |
Удаляет всплывающее окно, ранее привязанное с |
openPopup( | this |
Открывает привязанное всплывающее окно в указанной |
closePopup() | this |
Закрывает привязанное всплывающее окно, если оно открыто. |
togglePopup() | this |
Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающего окна, привязанного к этому слою. |
getPopup() | Popup |
Возвращает всплывающее окно, привязанное к этому слою. |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
bindTooltip( | this |
Привязывает подсказку к слою с переданным |
unbindTooltip() | this |
Удаляет подсказку, ранее привязанную с |
openTooltip( | this |
Открывает привязанную подсказку в указанной |
closeTooltip() | this |
Закрывает подсказку, привязанную к этому слою, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от ее текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое подсказки, привязанной к этому слою. |
getTooltip() | Tooltip |
Возвращает подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-слушатель ( |
on( | this |
Добавляет набор пар тип/слушатель, например, |
off( | this |
Удаляет ранее добавленную функцию-слушатель. Если функция не указана, удалятся все слушатели этого события для объекта. Обратите внимание, что если вы передали пользовательский контекст для |
off( | this |
Удаляет набор пар тип/слушатель. |
off() | this |
Удаляет всех слушателей всех событий объекта. Это включает в себя неявно прикреплённые события. |
fire( | this |
Вызывает событие указанного типа. Вы можете дополнительно указать объект данных — первое аргумент функции-слушателя будет содержать его свойства. Событие может быть необязательно распространено на родительские элементы. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родительский элемент события — |
removeEventParent( | this |
Удаляет родительский элемент события, так что он перестанет получать распространяемые события. |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
ImageOverlay
Используется для загрузки и отображения одного изображения над определёнными границами карты. Расширяет Layer.
Пример использования
var imageUrl = 'https://maps.lib.utexas.edu/maps/historical/newark_nj_1922.jpg', imageBounds = [[40.712216, -74.22655], [40.773941, -74.12544]]; L.imageOverlay(imageUrl, imageBounds).addTo(map);
Создание
| Фабрика | Описание |
|---|---|
L.imageOverlay( | Создаёт объект наложения изображения по URL изображения и географическим границам, к которым он привязан. |
Параметры
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
opacity | Number | 1.0 | Непрозрачность наложения изображения. |
alt | String | '' | Текст для атрибута alt изображения (полезно для доступности). |
interactive | Boolean | false | Если true, наложение изображения будет генерировать события мыши при нажатии или наведении курсора. |
crossOrigin | Boolean|String | false | Добавлять ли атрибут crossOrigin к изображению. Если указана строка, атрибут crossOrigin изображения будет установлен на переданную строку. Это необходимо, если вам нужно получить данные пикселей изображения. Обратитесь к Настройкам CORS для допустимых значений строк. |
errorOverlayUrl | String | '' | URL наложения изображения, которое будет отображаться вместо наложения, не загрузившегося. |
zIndex | Number | 1 | Явное значение zIndex слоя наложения. |
className | String | '' | Пользовательское имя класса, которое нужно назначить изображению. По умолчанию пустое. |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
bubblingMouseEvents | Boolean | true | Когда true, событие мыши на этом слое будет вызывать то же событие на карте (если не используется L.DomEvent.stopPropagation). |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
pane | String | 'overlayPane' | По умолчанию слой будет добавлен в панель наложения карты. Переопределение этого параметра поместит слой по умолчанию на другую панель. |
attribution | String | null | Строка, которая будет отображаться в элементе атрибуции, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридическим обязательством перед держателями авторских прав и поставщиками плиток. |
События
| Событие | Данные | Описание |
|---|---|---|
load | Event | Срабатывает, когда слой ImageOverlay загрузил своё изображение |
error | Event | Срабатывает, когда слой ImageOverlay не смог загрузить изображение |
| Событие | Данные | Описание |
|---|---|---|
click | MouseEvent | Срабатывает, когда пользователь нажимает на слой. |
dblclick | MouseEvent | Срабатывает, когда пользователь дважды нажимает на слой. |
mousedown | MouseEvent | Срабатывает, когда пользователь нажимает кнопку мыши на слое. |
mouseup | MouseEvent | Срабатывает, когда пользователь отпускает кнопку мыши, нажатую на слое. |
mouseover | MouseEvent | Срабатывает, когда курсор мыши попадает на слой. |
mouseout | MouseEvent | Срабатывает, когда курсор мыши покидает слой. |
contextmenu | MouseEvent | Срабатывает, когда пользователь щелкает правой кнопкой мыши на слое, предотвращает отображение контекстного меню браузера по умолчанию, если есть слушатели на этом событии. Также срабатывает на мобильных устройствах, когда пользователь удерживает одиночное касание в течение секунды (также называется длительным нажатием). |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Срабатывает после добавления слоя на карту |
remove | Event | Срабатывает после удаления слоя с карты |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Срабатывает при открытии всплывающего окна, привязанного к этому слою |
popupclose | PopupEvent | Срабатывает при закрытии всплывающего окна, привязанного к этому слою |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Срабатывает при открытии всплывающей подсказки, связанной с этим слоем. |
tooltipclose | TooltipEvent | Срабатывает при закрытии всплывающей подсказки, связанной с этим слоем. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
setOpacity( | this |
Устанавливает непрозрачность наложения. |
bringToFront() | this |
Переводит слой наверх всех наложений. |
bringToBack() | this |
Переводит слой вниз по отношению к остальным наложениям. |
setUrl( | this |
Изменяет URL изображения. |
setBounds( | this |
Обновляет границы, которые охватывает этот ImageOverlay. |
setZIndex( | this |
Изменяет zIndex наложения изображения. |
getBounds() | LatLngBounds |
Получает границы, которые охватывает этот ImageOverlay. |
getElement() | HTMLElement |
Возвращает экземпляр |
getCenter() | LatLng |
Возвращает центр ImageOverlay. |
| Метод | Возвращает | Описание |
|---|---|---|
addTo( | this |
Добавляет слой на указанную карту или группу слоев. |
remove() | this |
Удаляет слой с карты, на которой он в данный момент активен. |
removeFrom( | this |
Удаляет слой с указанной карты. |
removeFrom( | this |
Удаляет слой из указанной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется |
| Метод | Возвращает | Описание |
|---|---|---|
bindPopup( | this |
Связывает всплывающее окно со слоем с переданным |
unbindPopup() | this |
Удаляет всплывающее окно, ранее связанное с |
openPopup( | this |
Открывает связанное всплывающее окно в указанной |
closePopup() | this |
Закрывает связанное всплывающее окно, если оно открыто. |
togglePopup() | this |
Открывает или закрывает всплывающее окно, связанное с данным слоем, в зависимости от его текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающего окна, связанного с этим слоем. |
getPopup() | Popup |
Возвращает всплывающее окно, связанное с этим слоем. |
| Метод | Возвращает | Описание |
|---|---|---|
bindTooltip( | this |
Связывает подсказку со слоем с переданным |
unbindTooltip() | this |
Удаляет подсказку, ранее связанную с |
openTooltip( | this |
Открывает связанную подсказку в указанной |
closeTooltip() | this |
Закрывает подсказку, связанную с данным слоем, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает подсказку, связанную с данным слоем, в зависимости от ее текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое подсказки, связанной с этим слоем. |
getTooltip() | Tooltip |
Возвращает подсказку, связанную с этим слоем. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-слушатель ( |
on( | this |
Добавляет набор пар тип/слушатель, например |
off( | this |
Удаляет ранее добавленную функцию-слушатель. Если функция не указана, будут удалены все слушатели данного события для объекта. Обратите внимание, что если вы передали пользовательский контекст для |
off( | this |
Удаляет набор пар тип/слушатель. |
off() | this |
Удаляет всех слушателей всех событий для объекта. Включая неявно присоединённые события. |
fire( | this |
Срабатывает событие указанного типа. Вы можете необязательно предоставить объект данных — первое аргумент функции-слушателя будет содержать его свойства. Событие может быть необязательно распространено на родительские события. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родительское событие — |
removeEventParent( | this |
Удаляет родительское событие, поэтому оно перестанет получать распространяемые события. |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
VideoOverlay
Используется для загрузки и отображения видеоплеера поверх определённых границ карты. Расширяет ImageOverlay.
Видео-оверлей использует HTML5 элемент <video>.
Пример использования
var videoUrl = 'https://www.mapbox.com/bites/00188/patricia_nasa.webm', videoBounds = [[ 32, -130], [ 13, -100]]; L.videoOverlay(videoUrl, videoBounds ).addTo(map);
Создание
| Фабрика | Описание |
|---|---|
L.videoOverlay( | Инициализирует объект оверлея изображения по URL видео (или массиву URL, или даже элементу видео) и географическим границам, к которым он привязан. |
Опции
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
autoplay | Boolean | true | Начинает ли видео воспроизведение автоматически при загрузке. В некоторых браузерах автовоспроизведение будет работать только с muted: true
|
loop | Boolean | true | Будет ли видео воспроизводиться циклически, возвращаясь к началу при воспроизведении. |
keepAspectRatio | Boolean | true | Сохраняет ли видео соотношение сторон после проекции. Актуально для поддерживаемых браузеров. См. совместимость с браузерами |
muted | Boolean | false | Начинает ли видео с выключенного звука при загрузке. |
playsInline | Boolean | true | В мобильных браузерах видео будет воспроизводиться прямо там, где оно находится, а не открываться в полноэкранном режиме. |
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
opacity | Number | 1.0 | Прозрачность оверлея изображения. |
alt | String | '' | Текст для атрибута alt изображения (полезно для доступности). |
interactive | Boolean | false | Если true, оверлей изображения будет генерировать события мыши при нажатии или наведении курсора. |
crossOrigin | Boolean|String | false | Добавлять ли атрибут crossOrigin к изображению. Если предоставлена строка, атрибут crossOrigin изображения будет установлен на предоставленную строку. Это необходимо, если вы хотите получить доступ к пиксельным данным изображения. Обратитесь к настройкам CORS для допустимых значений строк. |
errorOverlayUrl | String | '' | URL оверлея изображения, который будет показан вместо оверлея, не загрузившегося. |
zIndex | Number | 1 | Явное значение zIndex слоя оверлея. |
className | String | '' | Пользовательское имя класса для назначения изображению. По умолчанию пустое. |
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
bubblingMouseEvents | Boolean | true | При true, событие мыши на этом слое сработает и на карте (если не используется L.DomEvent.stopPropagation). |
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
pane | String | 'overlayPane' | По умолчанию слой будет добавлен на слой оверлея карты. Переопределение этой опции разместит слой на другом слое по умолчанию. |
attribution | String | null | Строка, отображаемая в элементе управления атрибуцией, например «© OpenStreetMap contributors». Она описывает данные слоя и часто является юридическим обязательством по отношению к правообладателям и поставщикам плиток. |
События
| Событие | Данные | Описание |
|---|---|---|
load | Event | Срабатывает, когда видео завершило загрузку первого кадра |
| Событие | Данные | Описание |
|---|---|---|
error | Event | Срабатывает, когда слой ImageOverlay не может загрузить своё изображение |
| Событие | Данные | Описание |
|---|---|---|
click | MouseEvent | Вызывается при нажатии (или тапе) пользователем на слой. |
dblclick | MouseEvent | Вызывается при двойном нажатии (или двойном тапе) пользователем на слой. |
mousedown | MouseEvent | Вызывается при нажатии пользователем кнопки мыши на слой. |
mouseup | MouseEvent | Вызывается при отпускании пользователем кнопки мыши, нажатой на слой. |
mouseover | MouseEvent | Вызывается при входе курсора мыши в слой. |
mouseout | MouseEvent | Вызывается при выходе курсора мыши из слоя. |
contextmenu | MouseEvent | Вызывается при правом щелчке пользователем по слою. Блокирует отображение контекстного меню браузера по умолчанию, если есть обработчики этого события. Также вызывается на мобильных устройствах при удержании одиночного касания в течение секунды (также называется удерживанием). |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Вызывается после добавления слоя на карту. |
remove | Event | Вызывается после удаления слоя с карты. |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Вызывается при открытии всплывающего окна, привязанного к этому слою. |
popupclose | PopupEvent | Вызывается при закрытии всплывающего окна, привязанного к этому слою. |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Вызывается при открытии всплывающей подсказки, привязанной к этому слою. |
tooltipclose | TooltipEvent | Вызывается при закрытии всплывающей подсказки, привязанной к этому слою. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
getElement() | HTMLVideoElement |
Возвращает экземпляр |
| Метод | Возвращает | Описание |
|---|---|---|
setOpacity( | this |
Устанавливает непрозрачность наложения. |
bringToFront() | this |
Выводит слой поверх всех наложений. |
bringToBack() | this |
Выводит слой под все наложения. |
setUrl( | this |
Изменяет URL изображения. |
setBounds( | this |
Обновляет границы, которые охватывает этот ImageOverlay. |
setZIndex( | this |
Изменяет zIndex наложения изображения. |
getBounds() | LatLngBounds |
Получить границы, которые охватывает этот ImageOverlay. |
getCenter() | LatLng |
Возвращает центр ImageOverlay. |
| Метод | Возвращает | Описание |
|---|---|---|
addTo( | this |
Добавляет слой на указанную карту или группу слоев. |
remove() | this |
Удаляет слой с карты, на которой он в настоящее время активен. |
removeFrom( | this |
Удаляет слой с указанной карты. |
removeFrom( | this |
Удаляет слой из указанной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется |
| Метод | Возвращает | Описание |
|---|---|---|
bindPopup( | this |
Привязывает всплывающее окно к слою с переданным |
unbindPopup() | this |
Удаляет всплывающее окно, ранее привязанное с |
openPopup( | this |
Открывает привязанное всплывающее окно в указанной |
closePopup() | this |
Закрывает привязанное всплывающее окно к слою, если оно открыто. |
togglePopup() | this |
Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающего окна, привязанного к этому слою. |
getPopup() | Popup |
Возвращает всплывающее окно, привязанное к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
bindTooltip( | this |
Привязывает всплывающую подсказку к слою с переданным |
unbindTooltip() | this |
Удаляет всплывающую подсказку, ранее привязанную с |
openTooltip( | this |
Открывает привязанную всплывающую подсказку в указанной |
closeTooltip() | this |
Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от ее текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое всплывающей подсказки, привязанной к этому слою. |
getTooltip() | Tooltip |
Возвращает всплывающую подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-слушатель ( |
on( | this |
Добавляет набор пар тип/слушатель, например |
off( | this |
Удаляет ранее добавленную функцию-слушатель. Если функция не указана, будут удалены все слушатели этого конкретного события от объекта. Обратите внимание, что если вы передали пользовательский контекст для |
off( | this |
Удаляет набор пар тип/слушатель. |
off() | this |
Удаляет всех слушателей всех событий объекта. Включая неявные присоединённые события. |
fire( | this |
Вызывает событие указанного типа. Необязательно можно передать объект данных — свойства которого будут содержаться в первом аргументе функции-слушателя. Событие может необязательно быть распространено на родительские элементы. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родительский элемент события — |
removeEventParent( | this |
Удаляет родительский элемент события, чтобы он перестал получать распространяемые события |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
SVGOverlay
Используется для загрузки, отображения и предоставления доступа к DOM SVG-файлу по определённым границам карты. Расширяет ImageOverlay.
SVG-слой использует элемент <svg>.
Пример использования
var svgElement = document.createElementNS("http://www.w3.org/2000/svg", "svg");
svgElement.setAttribute('xmlns', "http://www.w3.org/2000/svg");
svgElement.setAttribute('viewBox', "0 0 200 200");
svgElement.innerHTML = '<rect width="200" height="200"/><rect x="75" y="23" width="50" height="50" style="fill:red"/><rect x="75" y="123" width="50" height="50" style="fill:#0013ff"/>';
var svgElementBounds = [ [ 32, -130 ], [ 13, -100 ] ];
L.svgOverlay(svgElement, svgElementBounds).addTo(map);
Создание
| Фабрика | Описание |
|---|---|
L.svgOverlay( | Создаёт объект слоя изображения, используя SVG-элемент и географические границы, к которым он привязан. Для правильной работы масштабирования и приближения необходим атрибут viewBox в SVG-элементе. |
Параметры
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
opacity | Number | 1.0 | Непрозрачность слоя изображения. |
alt | String | '' | Текст для атрибута alt изображения (полезно для доступности). |
interactive | Boolean | false | Если true, слой изображения будет генерировать события мыши при нажатии или наведении курсора. |
crossOrigin | Boolean|String | false | Указывает, будет ли добавлен атрибут crossOrigin к изображению. Если предоставлена строка, атрибут crossOrigin изображения будет установлен на предоставленную строку. Это необходимо, если вы хотите получить доступ к пиксельным данным изображения. Обратитесь к настройкам CORS для допустимых строковых значений. |
errorOverlayUrl | String | '' | URL изображения-заместителя, которое будет отображаться вместо слоя изображения, если загрузка не удалась. |
zIndex | Number | 1 | Явное значение zIndex слоя. |
className | String | '' | Пользовательское имя класса для назначения изображению. По умолчанию пустая строка. |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
bubblingMouseEvents | Boolean | true | Если true, событие мыши на этом слое вызовет то же самое событие на карте (если не используется L.DomEvent.stopPropagation). |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
pane | String | 'overlayPane' | По умолчанию слой добавляется в слой перекрытий карты (overlay pane). Изменение этого параметра выведет слой на другой слой по умолчанию. |
attribution | String | null | Строка, отображаемая в элементе подписи, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридической обязанностью в отношении правообладателей и поставщиков тайлов. |
События
| Событие | Данные | Описание |
|---|---|---|
load | Event | Срабатывает при загрузке изображения в ImageOverlay-слой. |
error | Event | Срабатывает, если загрузка ImageOverlay-слоя не удалась. |
| Событие | Данные | Описание |
|---|---|---|
click | MouseEvent | Срабатывает при щелчке мыши (или нажатии) по слою. |
dblclick | MouseEvent | Срабатывает при двойном щелчке мыши (или двойном тапе) по слою. |
mousedown | MouseEvent | Срабатывает при нажатии кнопки мыши на слое. |
mouseup | MouseEvent | Срабатывает при отпускании кнопки мыши, нажатой на слое. |
mouseover | MouseEvent | Срабатывает при входе курсора мыши в слой. |
mouseout | MouseEvent | Срабатывает при выходе курсора мыши из слоя. |
contextmenu | MouseEvent | Срабатывает при правом клике на слое. Блокирует отображение контекстного меню браузера, если есть слушатели этого события. Также срабатывает на мобильных устройствах при удержании одного прикосновения в течение секунды (также называется длительным нажатием). |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Срабатывает после добавления слоя на карту. |
remove | Event | Срабатывает после удаления слоя с карты. |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Срабатывает при открытии всплывающей подсказки, связанной с этим слоем. |
popupclose | PopupEvent | Срабатывает при закрытии всплывающей подсказки, связанной с этим слоем. |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Срабатывает при открытии всплывающей подсказки, привязанной к этому слою. |
tooltipclose | TooltipEvent | Срабатывает при закрытии всплывающей подсказки, привязанной к этому слою. |
Методы
| Метод | Возвращаемое значение | Описание |
|---|---|---|
getElement() | SVGElement |
Возвращает экземпляр |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
setOpacity( | this |
Устанавливает непрозрачность наложения. |
bringToFront() | this |
Выводит слой поверх всех наложений. |
bringToBack() | this |
Выводит слой под все наложения. |
setUrl( | this |
Изменяет URL изображения. |
setBounds( | this |
Обновляет границы, которые покрывает это ImageOverlay |
setZIndex( | this |
Изменяет zIndex наложения изображения. |
getBounds() | LatLngBounds |
Получить границы, которые покрывает этот ImageOverlay |
getCenter() | LatLng |
Возвращает центр ImageOverlay. |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
addTo( | this |
Добавляет слой к заданной карте или группе слоев. |
remove() | this |
Удаляет слой с карты, на которой он сейчас активен. |
removeFrom( | this |
Удаляет слой с заданной карты |
removeFrom( | this |
Удаляет слой из заданной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
bindPopup( | this |
Привязывает всплывающее окно к слою с переданным |
unbindPopup() | this |
Удаляет всплывающее окно, ранее привязанное с |
openPopup( | this |
Открывает привязанное всплывающее окно в указанной |
closePopup() | this |
Закрывает привязанное к этому слою всплывающее окно, если оно открыто. |
togglePopup() | this |
Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающего окна, привязанного к этому слою. |
getPopup() | Popup |
Возвращает привязанное к этому слою всплывающее окно. |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
bindTooltip( | this |
Привязывает всплывающую подсказку к слою с переданным |
unbindTooltip() | this |
Удаляет всплывающую подсказку, ранее привязанную с |
openTooltip( | this |
Открывает привязанную всплывающую подсказку в указанной |
closeTooltip() | this |
Закрывает привязанную к этому слою всплывающую подсказку, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от ее текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое всплывающей подсказки, привязанной к этому слою. |
getTooltip() | Tooltip |
Возвращает привязанную к этому слою всплывающую подсказку. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-обработчик ( |
on( | this |
Добавляет набор пар "тип/обработчик", например |
off( | this |
Удаляет ранее добавленную функцию-обработчик. Если функция не указана, удаляет всех обработчиков данного события от объекта. Обратите внимание, что если вы передали пользовательский контекст для |
off( | this |
Удаляет набор пар "тип/обработчик". |
off() | this |
Удаляет всех обработчиков всех событий объекта. Это включает неявно прикреплённые события. |
fire( | this |
Вызывает событие указанного типа. Необязательно можно передать объект данных — свойства этого объекта будут содержаться в первом аргументе функции-обработчика. Событие может необязательно распространяться к родительским событиям. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родителя события — |
removeEventParent( | this |
Удаляет родителя события, чтобы он перестал получать распространяемые события |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
Путь
Абстрактный класс, содержащий параметры и константы, общие для векторных наложений (Многоугольник, Полилиния, Окружность). Не используйте его напрямую. Расширяет Layer.
Параметры
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
stroke | Boolean | true | Определяет, нужно ли рисовать обводку по пути. Установите в false для отключения границ многоугольников или окружностей. |
color | String | '#3388ff' | Цвет обводки |
weight | Number | 3 | Ширина обводки в пикселях |
opacity | Number | 1.0 | Непрозрачность обводки |
lineCap | String | 'round' | Строка, определяющая форму, используемую в конце обводки. |
lineJoin | String | 'round' | Строка, определяющая форму, используемую в углах обводки. |
dashArray | String | null | Строка, определяющая паттерн штриховки обводки. Не работает на слоях, основанных на Canvas в некоторых старых браузерах. |
dashOffset | String | null | Строка, определяющая расстояние в паттерне штриховки для начала штриха. Не работает на слоях, основанных на Canvas в некоторых старых браузерах. |
fill | Boolean | depends | Определяет, нужно ли заполнять путь цветом. Установите в false для отключения заполнения многоугольников или окружностей. |
fillColor | String | * | Цвет заливки. По умолчанию совпадает со значением параметра color |
fillOpacity | Number | 0.2 | Непрозрачность заливки. |
fillRule | String | 'evenodd' | Строка, определяющая как определяется внутренняя часть фигуры. |
bubblingMouseEvents | Boolean | true | При true, событие мыши на этом пути вызовет то же событие на карте (если не используется L.DomEvent.stopPropagation). |
renderer | Renderer | Используйте этот экземпляр Renderer для этого пути. Имеет приоритет над стандартным рендерером карты. | |
className | String | null | Настраиваемое имя класса, установленное на элементе. Только для рендера SVG. |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
interactive | Boolean | true | Если false, слой не будет генерировать события мыши и будет действовать как часть базовой карты. |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
pane | String | 'overlayPane' | По умолчанию слой будет добавлен на слой наложений карты. Переопределение этого параметра поместит слой на другой слой по умолчанию. |
attribution | String | null | Строка, отображаемая в элементе подписи, например "© OpenStreetMap contributors". Описывает данные слоя и часто является юридической обязанностью перед правообладателями и поставщиками тайлов. |
События
| Событие | Данные | Описание |
|---|---|---|
click | MouseEvent | Вызывается при нажатии пользователем на слой. |
dblclick | MouseEvent | Вызывается при двойном нажатии пользователем на слой. |
mousedown | MouseEvent | Вызывается при нажатии пользователем кнопки мыши на слой. |
mouseup | MouseEvent | Вызывается при отпускании пользователем кнопки мыши, нажатой на слой. |
mouseover | MouseEvent | Вызывается при входе курсора мыши в слой. |
mouseout | MouseEvent | Вызывается при выходе курсора мыши из слоя. |
contextmenu | MouseEvent | Вызывается при правом клике пользователем на слой. Блокирует стандартное контекстное меню браузера, если есть обработчики для этого события. Также вызывается на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется удерживание). |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Вызывается после добавления слоя на карту |
remove | Event | Вызывается после удаления слоя с карты |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Вызывается при открытии всплывающего окна, привязанного к этому слою |
popupclose | PopupEvent | Вызывается при закрытии всплывающего окна, привязанного к этому слою |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Вызывается при открытии подсказки, привязанной к этому слою. |
tooltipclose | TooltipEvent | Вызывается при закрытии подсказки, привязанной к этому слою. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
redraw() | this |
Перерисовывает слой. Иногда полезно после изменения координат, используемых траекторией. |
setStyle( | this |
Изменяет внешний вид траектории на основе опций в объекте |
bringToFront() | this |
Выводит слой наверх всех слоев траекторий. |
bringToBack() | this |
Выводит слой вниз всех слоев траекторий. |
| Метод | Возвращает | Описание |
|---|---|---|
addTo( | this |
Добавляет слой на заданную карту или группу слоев. |
remove() | this |
Удаляет слой с карты, на которой он сейчас активен. |
removeFrom( | this |
Удаляет слой с заданной карты |
removeFrom( | this |
Удаляет слой из заданной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется |
| Метод | Возвращает | Описание |
|---|---|---|
bindPopup( | this |
Привязывает всплывающее окно к слою с переданным |
unbindPopup() | this |
Удаляет всплывающее окно, ранее привязанное с помощью |
openPopup( | this |
Открывает привязанное всплывающее окно в указанной |
closePopup() | this |
Закрывает всплывающее окно, привязанное к этому слою, если оно открыто. |
togglePopup() | this |
Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающего окна, привязанного к этому слою. |
getPopup() | Popup |
Возвращает всплывающее окно, привязанное к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
bindTooltip( | this |
Привязывает подсказку к слою с переданным |
unbindTooltip() | this |
Удаляет подсказку, ранее привязанную с помощью |
openTooltip( | this |
Открывает привязанную подсказку в указанной |
closeTooltip() | this |
Закрывает подсказку, привязанную к этому слою, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от её текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое подсказки, привязанной к этому слою. |
getTooltip() | Tooltip |
Возвращает подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-обработчик ( |
on( | this |
Добавляет набор пар тип/обработчик, например, |
off( | this |
Удаляет ранее добавленную функцию-обработчик. Если функция не указана, удаляются все обработчики этого события из объекта. Обратите внимание, что если вы передали пользовательский контекст в |
off( | this |
Удаляет набор пар тип/обработчик. |
off() | this |
Удаляет всех обработчиков всех событий объекта. Это включает неявно присоединённые события. |
fire( | this |
Вызывает событие указанного типа. Вы можете дополнительно передать объект данных — свойства объекта будут первым аргументом функции обработчика. Событие может быть дополнительно распространено к родительским событиям. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родительский элемент события — |
removeEventParent( | this |
Удаляет родительский элемент события, чтобы он перестал получать передаваемые события. |
addEventListener(…) | this |
Псевдоним к |
removeEventListener(…) | this |
Псевдоним к |
clearAllEventListeners(…) | this |
Псевдоним к |
addOneTimeEventListener(…) | this |
Псевдоним к |
fireEvent(…) | this |
Псевдоним к |
hasEventListeners(…) | Boolean |
Псевдоним к |
Полилиния
Класс для рисования полилиний-наложений на карте. Расширяет Path.
Пример использования
// create a red polyline from an array of LatLng points
var latlngs = [
[45.51, -122.68],
[37.77, -122.43],
[34.04, -118.2]
];
var polyline = L.polyline(latlngs, {color: 'red'}).addTo(map);
// zoom the map to the polyline
map.fitBounds(polyline.getBounds());
Также можно передать двумерный массив для представления MultiPolyline фигуры:
// create a red polyline from an array of arrays of LatLng points var latlngs = [ [[45.51, -122.68], [37.77, -122.43], [34.04, -118.2]], [[40.78, -73.91], [41.83, -87.62], [32.76, -96.72]] ];
Создание
| Фабрика | Описание |
|---|---|
L.polyline( | Инициализирует объект полилинии, заданный массивом географических точек и, необязательно, объектом опций. Можно создать объект Polyline с несколькими отдельными линиями (MultiPolyline) передав массив массивов географических точек. |
Опции
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
smoothFactor | Number | 1.0 | Уровень упрощения полилинии на каждом уровне масштабирования. Большее значение обеспечивает лучшую производительность и более плавный вид, меньшее — более точное отображение. |
noClip | Boolean | false | Отключить обрезку полилинии. |
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
stroke | Boolean | true | Определяет, рисовать ли обводку вдоль пути. Установите в false для отключения границ на многоугольниках или окружностях. |
color | String | '#3388ff' | Цвет обводки |
weight | Number | 3 | Ширина обводки в пикселях |
opacity | Number | 1.0 | Непрозрачность обводки |
lineCap | String | 'round' | Строка, определяющая форму, используемую в конце обводки. |
lineJoin | String | 'round' | Строка, определяющая форму, используемую в углах обводки. |
dashArray | String | null | Строка, определяющая паттерн штрихов обводки. Не работает на слоях, основанных на Canvas, в некоторых старых браузерах. |
dashOffset | String | null | Строка, определяющая расстояние в паттерне штрихов, с которого начинаются штрихи. Не работает на слоях, основанных на Canvas, в некоторых старых браузерах. |
fill | Boolean | depends | Определяет, заполнять ли путь цветом. Установите в false для отключения заполнения на многоугольниках или окружностях. |
fillColor | String | * | Цвет заливки. По умолчанию соответствует значению опции color |
fillOpacity | Number | 0.2 | Непрозрачность заливки. |
fillRule | String | 'evenodd' | Строка, определяющая как определяется внутренняя часть фигуры. |
bubblingMouseEvents | Boolean | true | Если true, событие мыши на этом пути запустит то же событие на карте (если не используется L.DomEvent.stopPropagation). |
renderer | Renderer | Использовать этот экземпляр Renderer для этого пути. Имеет приоритет над по умолчанию рендерером карты. | |
className | String | null | Настраиваемое имя класса, заданное на элементе. Только для рендера SVG. |
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
interactive | Boolean | true | Если false, слой не будет генерировать события мыши и будет действовать как часть базовой карты. |
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
pane | String | 'overlayPane' | По умолчанию слой будет добавлен на слой наложений карты. Переопределение этой опции приведет к размещению слоя на другом слое по умолчанию. |
attribution | String | null | Строка, отображаемая в элементе управления атрибутами, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридическим обязательством по отношению к правообладателям и поставщикам плиток. |
События
| Событие | Данные | Описание |
|---|---|---|
click | MouseEvent | Срабатывает при нажатии пользователем (или касании) слоя. |
dblclick | MouseEvent | Срабатывает при двойном нажатии пользователем (или двойном касании) слоя. |
mousedown | MouseEvent | Срабатывает при нажатии пользователем кнопки мыши на слое. |
mouseup | MouseEvent | Срабатывает при отпускании пользователем кнопки мыши, нажатой на слое. |
mouseover | MouseEvent | Срабатывает при входе курсора мыши в слой. |
mouseout | MouseEvent | Срабатывает при выходе курсора мыши из слоя. |
contextmenu | MouseEvent | Срабатывает при щелчке правой кнопкой мыши по слою, предотвращает отображение стандартного контекстного меню браузера, если есть обработчики на это событие. Также срабатывает на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется удержанием). |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Срабатывает после добавления слоя на карту |
remove | Event | Срабатывает после удаления слоя с карты |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Срабатывает при открытии всплывающего окна, привязанного к этому слою |
popupclose | PopupEvent | Срабатывает при закрытии всплывающего окна, привязанного к этому слою |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Срабатывает при открытии подсказки, привязанной к этому слою. |
tooltipclose | TooltipEvent | Срабатывает при закрытии подсказки, привязанной к этому слою. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
toGeoJSON( | Object |
Значения координат округляются с помощью функции |
getLatLngs() | LatLng[] |
Возвращает массив точек на пути или вложенные массивы точек в случае с многополилинией. |
setLatLngs( | this |
Заменяет все точки полилинии заданным массивом географических точек. |
isEmpty() | Boolean |
Возвращает |
closestLayerPoint( | Point |
Возвращает точку, ближайшую к |
getCenter() | LatLng |
Возвращает центр (центр масс) полилинии. |
getBounds() | LatLngBounds |
Возвращает |
addLatLng( | this |
Добавляет заданную точку в полилинию. По умолчанию добавляет к первому кольцу полилинии в случае многополилинии, но это можно переопределить, передав конкретное кольцо в виде массива LatLng (к которому можно получить доступ ранее с помощью |
| Метод | Возвращает | Описание |
|---|---|---|
redraw() | this |
Перерисовывает слой. Иногда полезно после изменения координат, которые использует путь. |
setStyle( | this |
Изменяет внешний вид Path, основываясь на опциях в объекте |
bringToFront() | this |
Выводит слой поверх всех слоёв пути. |
bringToBack() | this |
Выводит слой под все слои пути. |
| Метод | Возвращает | Описание |
|---|---|---|
addTo( | this |
Добавляет слой на заданную карту или группу слоев. |
remove() | this |
Удаляет слой с карты, на которой он активен. |
removeFrom( | this |
Удаляет слой с заданной карты |
removeFrom( | this |
Удаляет слой из заданной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется |
| Метод | Возвращает | Описание |
|---|---|---|
bindPopup( | this |
Привязывает всплывающее окно к слою с переданным |
unbindPopup() | this |
Удаляет всплывающее окно, ранее привязанное с помощью |
openPopup( | this |
Открывает привязанное всплывающее окно в указанной |
closePopup() | this |
Закрывает привязанное всплывающее окно к этому слою, если оно открыто. |
togglePopup() | this |
Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающего окна, привязанного к этому слою. |
getPopup() | Popup |
Возвращает всплывающее окно, привязанное к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
bindTooltip( | this |
Привязывает подсказку к слою с переданным |
unbindTooltip() | this |
Удаляет подсказку, ранее привязанную с помощью |
openTooltip( | this |
Открывает привязанную подсказку в указанной |
closeTooltip() | this |
Закрывает подсказку, привязанную к этому слою, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от её текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое подсказки, привязанной к этому слою. |
getTooltip() | Tooltip |
Возвращает подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-обработчик ( |
on( | this |
Добавляет набор пар тип/обработчик, например, |
off( | this |
Удаляет ранее добавленную функцию-обработчик. Если функция не указана, будут удалены все обработчики этого определенного события из объекта. Обратите внимание, что если вы передали пользовательский контекст для |
off( | this |
Удаляет набор пар тип/обработчик. |
off() | this |
Удаляет все обработчики всех событий объекта. Это включает неявно присоединённые события. |
fire( | this |
Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — свойства первого аргумента функции-обработчика будут содержать его свойства. Событие может быть необязательно распространено на родительские события. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родительское событие — |
removeEventParent( | this |
Удаляет родительское событие, поэтому оно перестанет получать распространяемые события. |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
Многоугольник
Класс для рисования полигональных наложений на карте. Расширяет Polyline.
Обратите внимание, что точки, которые вы передаёте при создании многоугольника, не должны иметь дополнительную последнюю точку, равную первой — лучше отфильтровать такие точки.
Пример использования
// create a red polygon from an array of LatLng points
var latlngs = [[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]];
var polygon = L.polygon(latlngs, {color: 'red'}).addTo(map);
// zoom the map to the polygon
map.fitBounds(polygon.getBounds());
Вы также можете передать массив массивов latlng, где первый массив представляет внешний контур, а другие массивы представляют отверстия во внешнем контуре:
var latlngs = [ [[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]], // outer ring [[37.29, -108.58],[40.71, -108.58],[40.71, -102.50],[37.29, -102.50]] // hole ];
Кроме того, вы можете передать многомерный массив для представления фигуры Многоугольник.
var latlngs = [
[ // first polygon
[[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]], // outer ring
[[37.29, -108.58],[40.71, -108.58],[40.71, -102.50],[37.29, -102.50]] // hole
],
[ // second polygon
[[41, -111.03],[45, -111.04],[45, -104.05],[41, -104.05]]
]
];
Создание
| Фабрика | Описание |
|---|---|
L.polygon( |
Параметры
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
smoothFactor | Number | 1.0 | Насколько нужно упростить полилинию на каждом уровне масштабирования. Большее значение означает лучшую производительность и более плавный вид, а меньшее — более точное представление. |
noClip | Boolean | false | Отключить обрезку полилинии. |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
stroke | Boolean | true | Рисовать ли контур по пути. Установите значение false для отключения границ на многоугольниках или кругах. |
color | String | '#3388ff' | Цвет контура |
weight | Number | 3 | Ширина контура в пикселях |
opacity | Number | 1.0 | Непрозрачность контура |
lineCap | String | 'round' | Строка, определяющая форму, используемую на конце контура. |
lineJoin | String | 'round' | Строка, определяющая форму, используемую в углах контура. |
dashArray | String | null | Строка, определяющая паттерн штриховки контура. Не работает на слоях, использующих Canvas в некоторых старых браузерах. |
dashOffset | String | null | Строка, определяющая расстояние в шаблоне штриховки для начала штриха. Не работает на слоях, использующих Canvas в некоторых старых браузерах. |
fill | Boolean | depends | Заливать ли путь цветом. Установите значение false для отключения заливки на многоугольниках или кругах. |
fillColor | String | * | Цвет заливки. По умолчанию соответствует значению параметра color |
fillOpacity | Number | 0.2 | Непрозрачность заливки. |
fillRule | String | 'evenodd' | Строка, определяющая как определяется внутренняя часть фигуры. |
bubblingMouseEvents | Boolean | true | Если true, событие мыши на этом пути вызовет то же событие на карте (если не используется L.DomEvent.stopPropagation). |
renderer | Renderer | Использовать этот экземпляр Renderer для этого пути. Имеет приоритет над стандартным рендерером карты . | |
className | String | null | Пользовательское имя класса, устанавливаемое на элементе. Только для рендера SVG. |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
interactive | Boolean | true | Если false, слой не будет генерировать события мыши и будет работать как часть базовой карты. |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
pane | String | 'overlayPane' | По умолчанию слой добавляется в панель наложений (overlay pane) карты. Переопределение этого параметра приведет к размещению слоя в другой панели по умолчанию. |
attribution | String | null | Строка, отображаемая в контроле атрибуции, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридической обязанностью по отношению к держателям авторских прав и поставщикам тайлов. |
События
| Событие | Данные | Описание |
|---|---|---|
click | MouseEvent | Срабатывает при щелчке (или нажатии) пользователем на слой. |
dblclick | MouseEvent | Срабатывает при двойном щелчке (или двойном нажатии) пользователем на слой. |
mousedown | MouseEvent | Срабатывает, когда пользователь нажимает кнопку мыши на слое. |
mouseup | MouseEvent | Срабатывает, когда пользователь отпускает нажатую кнопку мыши на слое. |
mouseover | MouseEvent | Срабатывает, когда курсор мыши попадает на слой. |
mouseout | MouseEvent | Срабатывает, когда курсор мыши покидает слой. |
contextmenu | MouseEvent | Срабатывает, когда пользователь нажимает правую кнопку мыши на слое. Блокирует отображение контекстного меню браузера по умолчанию, если есть обработчики этого события. Также срабатывает на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется удержанием). |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Срабатывает после добавления слоя на карту. |
remove | Event | Срабатывает после удаления слоя с карты. |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Срабатывает при открытии всплывающего окна, привязанного к этому слою. |
popupclose | PopupEvent | Срабатывает при закрытии всплывающего окна, привязанного к этому слою. |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Срабатывает при открытии подсказки, привязанной к этому слою. |
tooltipclose | TooltipEvent | Срабатывает при закрытии подсказки, привязанной к этому слою. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
toGeoJSON( | Object |
Значения координат округляются с помощью функции |
getCenter() | LatLng |
Возвращает центр (центроид) многоугольника. |
| Метод | Возвращает | Описание |
|---|---|---|
getLatLngs() | LatLng[] |
Возвращает массив точек пути или вложенные массивы точек в случае многократной линии. |
setLatLngs( | this |
Заменяет все точки полилинии заданным массивом географических точек. |
isEmpty() | Boolean |
Возвращает |
closestLayerPoint( | Point |
Возвращает точку, ближайшую к |
getBounds() | LatLngBounds |
Возвращает |
addLatLng( | this |
Добавляет заданную точку в полилинию. По умолчанию добавляется к первому кольцу полилинии в случае многократной линии, но может быть переопределено передачей конкретного кольца в качестве массива LatLng (к которому вы можете получить доступ ранее с помощью |
| Метод | Возвращает | Описание |
|---|---|---|
redraw() | this |
Перерисовывает слой. Иногда полезно после изменения координат, которые использует путь. |
setStyle( | this |
Изменяет внешний вид пути на основе параметров в объекте |
bringToFront() | this |
Выводит слой поверх всех слоев пути. |
bringToBack() | this |
Выводит слой под все слои пути. |
| Метод | Возвращает | Описание |
|---|---|---|
addTo( | this |
Добавляет слой на заданную карту или группу слоев. |
remove() | this |
Удаляет слой с карты, на которой он сейчас активен. |
removeFrom( | this |
Удаляет слой с указанной карты. |
removeFrom( | this |
Удаляет слой из заданной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется |
| Метод | Возвращает | Описание |
|---|---|---|
bindPopup( | this |
Привязывает всплывающее окно к слою с переданным |
unbindPopup() | this |
Удаляет ранее привязанное всплывающее окно с помощью |
openPopup( | this |
Открывает привязанное всплывающее окно в указанной |
closePopup() | this |
Закрывает привязанное к этому слою всплывающее окно, если оно открыто. |
togglePopup() | this |
Открывает или закрывает привязанное к этому слою всплывающее окно в зависимости от его текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающего окна, привязанного к этому слою. |
getPopup() | Popup |
Возвращает всплывающее окно, привязанное к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
bindTooltip( | this |
Привязывает подсказку к слою с переданным |
unbindTooltip() | this |
Удаляет ранее привязанную подсказку с помощью |
openTooltip( | this |
Открывает привязанную подсказку в указанной |
closeTooltip() | this |
Закрывает привязанную к этому слою подсказку, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает привязанную к этому слою подсказку в зависимости от её текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое подсказки, привязанной к этому слою. |
getTooltip() | Tooltip |
Возвращает подсказку, привязанную к этому слою. |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
on( | this |
Добавляет функцию-слушатель ( |
on( | this |
Добавляет набор пар тип/слушатель, например |
off( | this |
Удаляет ранее добавленную функцию-слушатель. Если функция не указана, будут удалены все слушатели этого конкретного события из объекта. Обратите внимание, что если вы передали пользовательский контекст в |
off( | this |
Удаляет набор пар тип/слушатель. |
off() | this |
Удаляет всех слушателей всех событий объекта. Это включает неявно присоединённые события. |
fire( | this |
Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — первый аргумент функции-слушателя будет содержать его свойства. Событие может быть необязательно распространено на родительские события. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родительское событие — |
removeEventParent( | this |
Удаляет родительское событие, чтобы оно перестало получать распространяемые события |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
Прямоугольник
Класс для рисования наложений прямоугольников на карте. Расширяет Polygon.
Пример использования
// define rectangle geographical bounds
var bounds = [[54.559322, -5.767822], [56.1210604, -3.021240]];
// create an orange rectangle
L.rectangle(bounds, {color: "#ff7800", weight: 1}).addTo(map);
// zoom the map to the rectangle bounds
map.fitBounds(bounds);
Создание
| Фабрика | Описание |
|---|---|
L.rectangle( |
Параметры
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
smoothFactor | Number | 1.0 | Насколько упрощать полилинию на каждом уровне масштабирования. Больше значение означает лучшую производительность и более плавный вид, а меньше — более точное представление. |
noClip | Boolean | false | Отключить обрезку полилинии. |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
stroke | Boolean | true | Определяет, будет ли нарисован контур вдоль пути. Установите в false , чтобы отключить границы на полигонах или окружностях. |
color | String | '#3388ff' | Цвет контура |
weight | Number | 3 | Ширина контура в пикселях |
opacity | Number | 1.0 | Прозрачность контура |
lineCap | String | 'round' | Строка, определяющая форму, используемую в конце контура. |
lineJoin | String | 'round' | Строка, определяющая форму, используемую в углах контура. |
dashArray | String | null | Строка, определяющая паттерн штриховки контура. Не работает на слоях, основанных на Canvas в некоторых старых браузерах. |
dashOffset | String | null | Строка, определяющая расстояние в шаблоне штриховки, с которого начинается штрих. Не работает на слоях, основанных на Canvas в некоторых старых браузерах. |
fill | Boolean | depends | Определяет, будет ли заполнен путь цветом. Установите в false , чтобы отключить заполнение на полигонах или окружностях. |
fillColor | String | * | Цвет заливки. По умолчанию соответствует значению параметра color |
fillOpacity | Number | 0.2 | Прозрачность заливки. |
fillRule | String | 'evenodd' | Строка, определяющая как определяется внутренняя часть фигуры. |
bubblingMouseEvents | Boolean | true | При true, событие мыши на этом пути вызовет то же самое событие на карте (если не используется L.DomEvent.stopPropagation). |
renderer | Renderer | Используйте этот экземпляр Renderer для этого пути. Имеет приоритет над стандартным рендерером карты. | |
className | String | null | Настраиваемое имя класса, заданное на элементе. Только для рендера SVG. |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
interactive | Boolean | true | Если false, слой не будет генерировать события мыши и будет действовать как часть основной карты. |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
pane | String | 'overlayPane' | По умолчанию слой будет добавлен на слой наложений карты. Переопределение этого параметра приведет к размещению слоя по умолчанию на другом слое. |
attribution | String | null | Строка, отображаемая в контроле атрибуции, например «© OpenStreetMap contributors». Она описывает данные слоя и часто является юридическим обязательством перед правообладателями и поставщиками тайлов. |
События
| Событие | Данные | Описание |
|---|---|---|
click | MouseEvent | Срабатывает при щелчке (или нажатии) пользователя по слою. |
dblclick | MouseEvent | Срабатывает при двойном щелчке (или двойном нажатии) пользователя по слою. |
mousedown | MouseEvent | Срабатывает, когда пользователь нажимает кнопку мыши на слое. |
mouseup | MouseEvent | Срабатывает, когда пользователь отпускает кнопку мыши, нажатую на слое. |
mouseover | MouseEvent | Срабатывает, когда курсор мыши попадает на слой. |
mouseout | MouseEvent | Срабатывает, когда курсор мыши покидает слой. |
contextmenu | MouseEvent | Срабатывает, когда пользователь щелкает правой кнопкой мыши на слое. Блокирует стандартное контекстное меню браузера, если на данном событии есть обработчики. Также срабатывает на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется удержанием). |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Срабатывает после добавления слоя на карту. |
remove | Event | Срабатывает после удаления слоя с карты. |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Срабатывает при открытии всплывающего окна, привязанного к этому слою. |
popupclose | PopupEvent | Срабатывает при закрытии всплывающего окна, привязанного к этому слою. |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Срабатывает при открытии всплывающей подсказки, привязанной к этому слою. |
tooltipclose | TooltipEvent | Срабатывает при закрытии всплывающей подсказки, привязанной к этому слою. |
Методы
| Метод | Возвращаемое значение | Описание |
|---|---|---|
setBounds( | this |
Перерисовывает прямоугольник с переданными границами. |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
toGeoJSON( | Object |
Значения координат округляются с помощью функции |
getCenter() | LatLng |
Возвращает центр (центр масс) многоугольника. |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
getLatLngs() | LatLng[] |
Возвращает массив точек пути, или вложенные массивы точек в случае многополилиний. |
setLatLngs( | this |
Заменяет все точки полилинии заданным массивом географических точек. |
isEmpty() | Boolean |
Возвращает |
closestLayerPoint( | Point |
Возвращает точку, ближайшую к |
getBounds() | LatLngBounds |
Возвращает |
addLatLng( | this |
Добавляет заданную точку в полилинию. По умолчанию, добавляется в первый контур полилинии в случае многополилиний, но может быть переопределён путём передачи конкретного контура в виде массива LatLng (к которому можно получить доступ с помощью |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
redraw() | this |
Перерисовывает слой. Иногда полезно после изменения координат, используемых путём. |
setStyle( | this |
Изменяет внешний вид пути на основе опций в объекте |
bringToFront() | this |
Выводит слой поверх всех слоёв путей. |
bringToBack() | this |
Выводит слой под все слои путей. |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
addTo( | this |
Добавляет слой на заданную карту или группу слоёв. |
remove() | this |
Удаляет слой с карты, на которой он в настоящее время активен. |
removeFrom( | this |
Удаляет слой с заданной карты. |
removeFrom( | this |
Удаляет слой из заданной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
bindPopup( | this |
Привязывает всплывающее окно к слою с переданным |
unbindPopup() | this |
Удаляет всплывающее окно, ранее привязанное с |
openPopup( | this |
Открывает привязанное всплывающее окно в указанной |
closePopup() | this |
Закрывает привязанное к этому слою всплывающее окно, если оно открыто. |
togglePopup() | this |
Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающего окна, привязанного к этому слою. |
getPopup() | Popup |
Возвращает всплывающее окно, привязанное к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
bindTooltip( | this |
Привязывает всплывающую подсказку к слою с переданным |
unbindTooltip() | this |
Удаляет всплывающую подсказку, ранее привязанную с помощью |
openTooltip( | this |
Открывает привязанную всплывающую подсказку по указанному |
closeTooltip() | this |
Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от ее текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое всплывающей подсказки, привязанной к этому слою. |
getTooltip() | Tooltip |
Возвращает всплывающую подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-обработчик ( |
on( | this |
Добавляет набор пар тип/обработчик, например, |
off( | this |
Удаляет ранее добавленную функцию-обработчик. Если функция не указана, удалит всех обработчиков этого события из объекта. Обратите внимание, если вы передали пользовательский контекст в |
off( | this |
Удаляет набор пар тип/обработчик. |
off() | this |
Удаляет всех обработчиков всех событий объекта. Это включает неявные привязанные события. |
fire( | this |
Вызывает событие указанного типа. Можно дополнительно передать объект данных — свойства объекта будут первым аргументом функции-обработчика. Событие может быть распространено к родительским объектам событий. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведет себя как |
addEventParent( | this |
Добавляет родительский объект события - |
removeEventParent( | this |
Удаляет родительский объект события, поэтому он перестанет получать распространяемые события. |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
Круг
Класс для отрисовки круговых наложений на карту. Расширяет CircleMarker.
Это приближение, и оно начинает отклоняться от истинного круга ближе к полюсам (из-за искажений проекции).
Пример использования
L.circle([50.5, 30.5], {radius: 200}).addTo(map);
Создание
| Фабрика | Описание |
|---|---|
L.circle( | Создает объект круга на основе географической точки и объекта опций, содержащего радиус круга. |
L.circle( | Устаревший способ создания круга, для совместимости с кодом 0.7.x. Не использовать в новых приложениях или плагинах. |
Параметры
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
radius | Number | Радиус круга в метрах. |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
stroke | Boolean | true | Отрисовывать ли обводку по пути. Установите в false для отключения границ многоугольников или кругов. |
color | String | '#3388ff' | Цвет обводки |
weight | Number | 3 | Ширина обводки в пикселях |
opacity | Number | 1.0 | Непрозрачность обводки |
lineCap | String | 'round' | Строка, определяющая форму, используемую в конце обводки. |
lineJoin | String | 'round' | Строка, определяющая форму, используемую в углах обводки. |
dashArray | String | null | Строка, определяющая паттерн штриховки обводки. Не работает на слоях, основанных на Canvas, в некоторых старых браузерах. |
dashOffset | String | null | Строка, определяющая расстояние в шаблоне штриховки для начала штриха. Не работает на слоях, основанных на Canvas, в некоторых старых браузерах. |
fill | Boolean | depends | Заливать ли путь цветом. Установите в false для отключения заливки многоугольников или кругов. |
fillColor | String | * | Цвет заливки. По умолчанию соответствует значению параметра color |
fillOpacity | Number | 0.2 | Непрозрачность заливки. |
fillRule | String | 'evenodd' | Строка, определяющая как определяется внутренняя часть фигуры. |
bubblingMouseEvents | Boolean | true | При true, событие мыши на этом пути вызовет то же событие на карте (если не используется L.DomEvent.stopPropagation). |
renderer | Renderer | Использовать этот конкретный экземпляр Renderer для этого пути. Имеет приоритет над стандартным рендерером карты. | |
className | String | null | Пользовательское имя класса, заданное на элементе. Только для рендерера SVG. |
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
interactive | Boolean | true | Если false, слой не будет генерировать события мыши и будет действовать как часть базовой карты. |
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
pane | String | 'overlayPane' | По умолчанию слой будет добавлен на панель наложения (панель наложения) карты. Переопределение этой опции приведет к размещению слоя по умолчанию на другой панели. |
attribution | String | null | Строка, отображаемая в элементе управления атрибутами, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является правовой обязанностью перед держателями авторских прав и поставщиками тайлов. |
События
| Событие | Данные | Описание |
|---|---|---|
move | Event | Вызывается при перемещении маркера с помощью setLatLng. Старые и новые координаты включены в аргументы события как oldLatLng, latlng. |
| Событие | Данные | Описание |
|---|---|---|
click | MouseEvent | Вызывается при щелчке (или нажатии) пользователем по слою. |
dblclick | MouseEvent | Вызывается при двойном щелчке (или двойном нажатии) пользователем по слою. |
mousedown | MouseEvent | Вызывается при нажатии пользователем кнопки мыши на слое. |
mouseup | MouseEvent | Вызывается при отпускании пользователем кнопки мыши, нажатой на слое. |
mouseover | MouseEvent | Вызывается при входе курсора мыши в слой. |
mouseout | MouseEvent | Вызывается при выходе курсора мыши из слоя. |
contextmenu | MouseEvent | Вызывается при правом щелчке пользователя по слою. Блокирует отображение контекстного меню браузера по умолчанию, если имеются обработчики этого события. Также вызывается на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется длительным нажатием). |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Вызывается после добавления слоя на карту. |
remove | Event | Вызывается после удаления слоя с карты. |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Вызывается при открытии всплывающего окна, привязанного к этому слою. |
popupclose | PopupEvent | Вызывается при закрытии всплывающего окна, привязанного к этому слою. |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Вызывается при открытии подсказки, привязанной к этому слою. |
tooltipclose | TooltipEvent | Вызывается при закрытии подсказки, привязанной к этому слою. |
Методы
| Метод | Возвращаемое значение | Описание |
|---|---|---|
setRadius( | this |
Устанавливает радиус круга. Единицы измерения — метры. |
getRadius() | Number |
Возвращает текущий радиус круга. Единицы измерения — метры. |
getBounds() | LatLngBounds |
Возвращает |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
toGeoJSON( | Object |
Значения координат округляются с помощью функции |
setLatLng( | this |
Устанавливает положение маркера круга в новом месте. |
getLatLng() | LatLng |
Возвращает текущее географическое положение маркера круга. |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
redraw() | this |
Перерисовывает слой. Иногда полезно после изменения координат, используемых путем. |
setStyle( | this |
Изменяет внешний вид объекта Path на основе опций в объекте |
bringToFront() | this |
Переводит слой наверх всех слоев пути. |
bringToBack() | this |
Переводит слой вниз по всем слоям пути. |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
addTo( | this |
Добавляет слой на заданную карту или группу слоев. |
remove() | this |
Удаляет слой с карты, на которой он сейчас активен. |
removeFrom( | this |
Удаляет слой с заданной карты. |
removeFrom( | this |
Удаляет слой из заданной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется элементом |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
bindPopup( | this |
Привязывает всплывающее окно к слою с переданным |
unbindPopup() | this |
Удаляет всплывающее окно, ранее привязанное с помощью |
openPopup( | this |
Открывает привязанное всплывающее окно в указанной |
closePopup() | this |
Закрывает привязанное всплывающее окно, если оно открыто. |
togglePopup() | this |
Открывает или закрывает привязанное всплывающее окно в зависимости от его текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающего окна, привязанного к этому слою. |
getPopup() | Popup |
Возвращает привязанное к этому слою всплывающее окно. |
| Метод | Возвращает | Описание |
|---|---|---|
bindTooltip( | this |
Привязывает всплывающую подсказку к слою с переданным |
unbindTooltip() | this |
Удаляет ранее привязанную всплывающую подсказку с |
openTooltip( | this |
Открывает привязанную всплывающую подсказку в указанной |
closeTooltip() | this |
Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от ее текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое всплывающей подсказки, привязанной к этому слою. |
getTooltip() | Tooltip |
Возвращает всплывающую подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-обработчик ( |
on( | this |
Добавляет набор пар тип/обработчик, например, |
off( | this |
Удаляет ранее добавленную функцию-обработчик. Если функция не указана, будут удалены все обработчики этого события из объекта. Обратите внимание, что если вы передали пользовательский контекст в |
off( | this |
Удаляет набор пар тип/обработчик. |
off() | this |
Удаляет все обработчики всех событий объекта. Это включает неявно прикрепленные события. |
fire( | this |
Срабатывает событие указанного типа. Вы можете необязательно предоставить объект данных — свойства первого аргумента функции-обработчика будут содержать его свойства. Событие необязательно может быть распространено родительским элементам. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родительский элемент события — |
removeEventParent( | this |
Удаляет родительский элемент события, поэтому он перестанет получать распространяемые события |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
CircleMarker
Окружность фиксированного размера с радиусом, заданным в пикселях. Расширяет Path.
Создание
| Фабрика | Описание |
|---|---|
L.circleMarker( | Создаёт объект маркера окружности, задавая географическую точку и необязательный объект опций. |
Опции
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
radius | Number | 10 | Радиус маркера окружности в пикселях |
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
stroke | Boolean | true | Определяет, рисовать ли обводку по пути. Установите в false для отключения границ на многоугольниках или окружностях. |
color | String | '#3388ff' | Цвет обводки |
weight | Number | 3 | Ширина обводки в пикселях |
opacity | Number | 1.0 | Непрозрачность обводки |
lineCap | String | 'round' | Строка, определяющая форму, используемую в конце обводки. |
lineJoin | String | 'round' | Строка, определяющая форму, используемую в углах обводки. |
dashArray | String | null | Строка, определяющая паттерн штриховки обводки. Не работает на слоях, основанных на Canvas, в некоторых старых браузерах. |
dashOffset | String | null | Строка, определяющая расстояние в паттерн штриховки для начала штриха. Не работает на слоях, основанных на Canvas, в некоторых старых браузерах. |
fill | Boolean | depends | Определяет, заливать ли путь цветом. Установите в false для отключения заливки на многоугольниках или окружностях. |
fillColor | String | * | Цвет заливки. По умолчанию совпадает со значением опции color |
fillOpacity | Number | 0.2 | Непрозрачность заливки. |
fillRule | String | 'evenodd' | Строка, определяющая как определяется внутренняя часть формы. |
bubblingMouseEvents | Boolean | true | При true, событие мыши на этом пути вызовет то же событие на карте (если не используется L.DomEvent.stopPropagation). |
renderer | Renderer | Используйте этот экземпляр Renderer для этого пути. Имеет приоритет над стандартным рендерером карты. | |
className | String | null | Пользовательское имя класса, заданное для элемента. Только для SVG-рендерера. |
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
interactive | Boolean | true | Если false, слой не будет генерировать события мыши и будет действовать как часть базовой карты. |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
pane | String | 'overlayPane' | По умолчанию слой будет добавлен на панель наложения карты. Переопределение этого параметра приведет к размещению слоя на другой панели по умолчанию. |
attribution | String | null | Строка, отображаемая в элементе управления атрибутами, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридической обязанностью перед правообладателями и поставщиками плиток. |
События
| Событие | Данные | Описание |
|---|---|---|
move | Event | Срабатывает, когда маркер перемещается с помощью setLatLng. Старые и новые координаты включены в аргументы события как oldLatLng, latlng. |
| Событие | Данные | Описание |
|---|---|---|
click | MouseEvent | Срабатывает при щелчке (или нажатии) пользователем по слою. |
dblclick | MouseEvent | Срабатывает при двойном щелчке (или двойном нажатии) пользователем по слою. |
mousedown | MouseEvent | Срабатывает при нажатии пользователем кнопки мыши на слое. |
mouseup | MouseEvent | Срабатывает при отпускании пользователем кнопки мыши, нажатой на слое. |
mouseover | MouseEvent | Срабатывает при входе курсора в слой. |
mouseout | MouseEvent | Срабатывает при выходе курсора из слоя. |
contextmenu | MouseEvent | Срабатывает при правом щелчке пользователя на слое, предотвращает отображение контекстного меню браузера по умолчанию, если есть обработчики для этого события. Также срабатывает на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется длительным нажатием). |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Срабатывает после добавления слоя на карту. |
remove | Event | Срабатывает после удаления слоя с карты. |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Срабатывает при открытии всплывающего окна, привязанного к этому слою. |
popupclose | PopupEvent | Срабатывает при закрытии всплывающего окна, привязанного к этому слою. |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Срабатывает при открытии всплывающей подсказки, привязанной к этому слою. |
tooltipclose | TooltipEvent | Срабатывает при закрытии всплывающей подсказки, привязанной к этому слою. |
Методы
| Метод | Возвращаемое значение | Описание |
|---|---|---|
toGeoJSON( | Object |
Значения координат округляются с помощью функции |
setLatLng( | this |
Устанавливает позицию кругового маркера в новое местоположение. |
getLatLng() | LatLng |
Возвращает текущее географическое положение кругового маркера. |
setRadius( | this |
Устанавливает радиус кругового маркера. Единицы измерения — пиксели. |
getRadius() | Number |
Возвращает текущий радиус круга. |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
redraw() | this |
Перерисовывает слой. Иногда полезно после изменения координат, используемых путем. |
setStyle( | this |
Изменяет внешний вид пути на основе параметров в объекте |
bringToFront() | this |
Выводит слой наверх всех слоев путей. |
bringToBack() | this |
Выводит слой вниз всех слоев путей. |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
addTo( | this |
Добавляет слой на заданную карту или группу слоев. |
remove() | this |
Удаляет слой с карты, на которой он активен в данный момент. |
removeFrom( | this |
Удаляет слой с заданной карты. |
removeFrom( | this |
Удаляет слой из заданной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется |
| Метод | Возвращаемое значение | Описание |
|---|---|---|
bindPopup( | this |
Привязывает всплывающее окно к слою с переданным |
unbindPopup() | this |
Удаляет всплывающее окно, ранее привязанное с помощью |
openPopup( | this |
Открывает привязанное всплывающее окно в указанной |
closePopup() | this |
Закрывает привязанное всплывающее окно к слою, если оно открыто. |
togglePopup() | this |
Открывает или закрывает привязанное всплывающее окно в зависимости от его текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающего окна, привязанного к этому слою. |
getPopup() | Popup |
Возвращает всплывающее окно, привязанное к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
bindTooltip( | this |
Привязывает всплывающую подсказку к слою с переданным |
unbindTooltip() | this |
Удаляет всплывающую подсказку, ранее привязанную с помощью |
openTooltip( | this |
Открывает привязанную всплывающую подсказку в указанной |
closeTooltip() | this |
Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от ее текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое всплывающей подсказки, привязанной к этому слою. |
getTooltip() | Tooltip |
Возвращает всплывающую подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-обработчик ( |
on( | this |
Добавляет набор пар "тип/обработчик", например, |
off( | this |
Удаляет ранее добавленную функцию-обработчик. Если функция не указана, она удалит всех обработчиков этого события от объекта. Обратите внимание, что если вы передали пользовательский контекст в |
off( | this |
Удаляет набор пар "тип/обработчик". |
off() | this |
Удаляет всех обработчиков всех событий в объекте. Это включает неявные присоединенные события. |
fire( | this |
Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — первый аргумент функции-обработчика будет содержать его свойства. Событие может быть необязательно распространено на родительские события. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родителя события - |
removeEventParent( | this |
Удаляет родителя события, чтобы он перестал получать распространяемые события |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
SVG
Позволяет отображать векторные слои с помощью SVG. Наследует Renderer.
Из-за технических ограничений, SVG недоступен во всех веб-браузерах, в частности в Android 2.x и 3.x.
Хотя SVG недоступен в IE7 и IE8, эти браузеры поддерживают VML (сейчас устаревшая технология), и рендер SVG будет использовать VML в этом случае.
VML был устаревшим в 2012 году, что означает, что функциональность VML существует только для обратной совместимости со старыми версиями Internet Explorer.
Пример использования
Используйте SVG по умолчанию для всех путей на карте:
var map = L.map('map', {
renderer: L.svg()
});
Используйте рендер SVG с дополнительным отступом для определенных векторных геометрий:
var map = L.map('map');
var myRenderer = L.svg({ padding: 0.5 });
var line = L.polyline( coordinates, { renderer: myRenderer } );
var circle = L.circle( center, { renderer: myRenderer } );
Создание
| Фабрика | Описание |
|---|---|
L.svg( | Создаёт рендер SVG с заданными параметрами. |
Параметры
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
padding | Number | 0.1 | Насколько расширить область обрезки вокруг представления карты (относительно её размера), например, 0,1 будет составлять 10% представления карты в каждом направлении |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
pane | String | 'overlayPane' | По умолчанию слой будет добавлен на панель перекрытия карты overlay pane. Переопределение этого параметра приведет к размещению слоя на другой панели по умолчанию. |
attribution | String | null | Строка, отображаемая в элементе управления подписью, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридической обязанностью перед правообладателями и поставщиками тайлов. |
События
| Событие | Данные | Описание |
|---|---|---|
update | Event | Вызывается, когда рендер обновляет свои границы, центр и масштаб, например, когда карта перемещена |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Вызывается после добавления слоя на карту |
remove | Event | Вызывается после удаления слоя с карты |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Вызывается при открытии всплывающего окна, привязанного к этому слою |
popupclose | PopupEvent | Вызывается при закрытии всплывающего окна, привязанного к этому слою |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Вызывается при открытии всплывающей подсказки, привязанной к этому слою. |
tooltipclose | TooltipEvent | Вызывается при закрытии всплывающей подсказки, привязанной к этому слою. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
addTo( | this |
Добавляет слой на заданную карту или группу слоёв. |
remove() | this |
Удаляет слой с карты, на которой он в данный момент активен. |
removeFrom( | this |
Удаляет слой с заданной карты. |
removeFrom( | this |
Удаляет слой из заданной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется |
| Метод | Возвращает | Описание |
|---|---|---|
bindPopup( | this |
Привязывает всплывающую подсказку к слою с переданным |
unbindPopup() | this |
Удаляет всплывающую подсказку, ранее привязанную с помощью |
openPopup( | this |
Открывает привязанную всплывающую подсказку в указанной |
closePopup() | this |
Закрывает привязанную к этому слою всплывающую подсказку, если она открыта. |
togglePopup() | this |
Открывает или закрывает привязанную к этому слою всплывающую подсказку в зависимости от её текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающей подсказки, привязанной к этому слою. |
getPopup() | Popup |
Возвращает привязанную к этому слою всплывающую подсказку. |
| Метод | Возвращает | Описание |
|---|---|---|
bindTooltip( | this |
Привязывает всплывающую подсказку к слою с переданным |
unbindTooltip() | this |
Удаляет всплывающую подсказку, ранее привязанную с помощью |
openTooltip( | this |
Открывает привязанную всплывающую подсказку в указанной |
closeTooltip() | this |
Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от её текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое всплывающей подсказки, привязанной к этому слою. |
getTooltip() | Tooltip |
Возвращает всплывающую подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-обработчик ( |
on( | this |
Добавляет набор пар тип/обработчик, например, |
off( | this |
Удаляет ранее добавленную функцию-обработчик. Если функция не указана, удаляет всех обработчиков этого события из объекта. Обратите внимание, что если вы передали пользовательский контекст для |
off( | this |
Удаляет набор пар тип/обработчик. |
off() | this |
Удаляет всех обработчиков всех событий объекта. Это включает неявно привязанные события. |
fire( | this |
Вызывает событие указанного типа. Можно необязательно передать объект данных — свойства объекта будут содержаться в первом аргументе функции-обработчика. Событие может необязательно распространяться на родительские элементы. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родительский элемент события — |
removeEventParent( | this |
Удаляет родительский элемент события, так что он перестанет получать распространяемые события. |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
Функции
| Функция | Возвращает | Описание |
|---|---|---|
create( | SVGElement | Возвращает экземпляр SVGElement, соответствующий переданному имени класса. Например, использование 'line' вернёт экземпляр SVGLineElement. |
pointsToPath( | String | Генерирует строку SVG path для нескольких колец, где каждое кольцо преобразуется в инструкции "M..L..L..". |
Канвас
Позволяет отображать векторные слои с помощью <canvas>. Наследует Renderer.
Из-за технических ограничений, Канвас недоступен во всех веб-браузерах, в частности в IE8, а перекрывающиеся геометрии могут отображаться некорректно в некоторых случаях.
Пример использования
Используйте Канвас по умолчанию для всех путей на карте:
var map = L.map('map', {
renderer: L.canvas()
});
Используйте рендерер Канвас с дополнительным отступом для определённых векторных геометрий:
var map = L.map('map');
var myRenderer = L.canvas({ padding: 0.5 });
var line = L.polyline( coordinates, { renderer: myRenderer } );
var circle = L.circle( center, { renderer: myRenderer } );
Создание
| Фабрика | Описание |
|---|---|
L.canvas( | Создаёт рендерер Канвас с заданными опциями. |
Опции
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
tolerance | Number | 0 | На сколько расширить толерантность щелчка вокруг пути/объекта на карте. |
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
padding | Number | 0.1 | Насколько нужно расширить область обрезки вокруг представления карты (относительно ее размера), например, 0,1 будет составлять 10% от представления карты в каждом направлении |
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
pane | String | 'overlayPane' | По умолчанию слой будет добавлен в панель наложения карты панель наложения. Переопределение этой опции приведет к размещению слоя по умолчанию на другой панели. |
attribution | String | null | Строка, отображаемая в элементе управления атрибутами, например, «© OpenStreetMap contributors». Она описывает данные слоя и часто является юридическим обязательством перед правообладателями и поставщиками тайлов. |
События
| Событие | Данные | Описание |
|---|---|---|
update | Event | Срабатывает, когда рендерер обновляет свои границы, центр и масштаб, например, когда карта сдвинута |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Срабатывает после добавления слоя на карту |
remove | Event | Срабатывает после удаления слоя с карты |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Срабатывает при открытии всплывающего окна, связанного со слоем |
popupclose | PopupEvent | Срабатывает при закрытии всплывающего окна, связанного со слоем |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Срабатывает при открытии подсказки, связанной со слоем. |
tooltipclose | TooltipEvent | Срабатывает при закрытии подсказки, связанной со слоем. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
addTo( | this |
Добавляет слой на указанную карту или группу слоев. |
remove() | this |
Удаляет слой с карты, на которой он в настоящее время активен. |
removeFrom( | this |
Удаляет слой с указанной карты |
removeFrom( | this |
Удаляет слой из заданной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется элементом |
| Метод | Возвращает | Описание |
|---|---|---|
bindPopup( | this |
Связывает всплывающее окно со слоем с переданным |
unbindPopup() | this |
Удаляет всплывающее окно, ранее связанное с |
openPopup( | this |
Открывает связанное всплывающее окно в указанной |
closePopup() | this |
Закрывает всплывающее окно, связанное со слоем, если оно открыто. |
togglePopup() | this |
Открывает или закрывает всплывающее окно, связанное со слоем, в зависимости от его текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающего окна, связанного со слоем. |
getPopup() | Popup |
Возвращает всплывающее окно, связанное со слоем. |
| Метод | Возвращает | Описание |
|---|---|---|
bindTooltip( | this |
Связывает подсказку со слоем с переданным |
unbindTooltip() | this |
Удаляет подсказку, ранее связанную с |
openTooltip( | this |
Открывает привязанную подсказку в указанной |
closeTooltip() | this |
Закрывает подсказку, связанную со слоем, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает подсказку, связанную со слоем, в зависимости от ее текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое подсказки, связанной со слоем. |
getTooltip() | Tooltip |
Возвращает подсказку, связанную со слоем. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-слушатель ( |
on( | this |
Добавляет набор пар тип/слушатель, например, |
off( | this |
Удаляет ранее добавленную функцию-слушатель. Если функция не указана, удаляются все слушатели этого конкретного события из объекта. Обратите внимание, что если вы передали пользовательский контекст для |
off( | this |
Удаляет набор пар тип/слушатель. |
off() | this |
Удаляет всех слушателей всех событий объекта. Это включает неявно прикрепленные события. |
fire( | this |
Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — первый аргумент функции-слушателя будет содержать его свойства. Событие может необязательно распространяться на родительские события. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведет себя как |
addEventParent( | this |
Добавляет родителя события — |
removeEventParent( | this |
Удаляет родителя события, поэтому он перестанет получать распространяемые события |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
Группа слоёв
Используется для группировки нескольких слоёв и обработки их как одного. Если вы добавляете его на карту, все слои, добавленные или удалённые из группы, также будут добавлены/удалены на карте. Расширяет Layer.
Пример использования
L.layerGroup([marker1, marker2]) .addLayer(polyline) .addTo(map);
Создание
| Фабрика | Описание |
|---|---|
L.layerGroup( | Создаёт группу слоёв, необязательно с начальным набором слоёв и объектом options. |
Параметры
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
interactive | Boolean | true | Если false, слой не будет генерировать события мыши и будет действовать как часть базовой карты. |
bubblingMouseEvents | Boolean | true | Когда true, событие мыши на этом слое вызовет такое же событие на карте (если не используется L.DomEvent.stopPropagation). |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
pane | String | 'overlayPane' | По умолчанию слой будет добавлен на слой перекрытия карты. Переопределение этого параметра приведет к размещению слоя на другом слое по умолчанию. |
attribution | String | null | Строка, отображаемая в блоке авторских прав, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является обязательством по отношению к правообладателям и поставщикам плиток. |
События
| Событие | Данные | Описание |
|---|---|---|
click | MouseEvent | Вызывается при щелчке (или нажатии) пользователя на слое. |
dblclick | MouseEvent | Вызывается при двойном щелчке (или двойном нажатии) пользователя на слое. |
mousedown | MouseEvent | Вызывается при нажатии пользователем кнопки мыши на слое. |
mouseup | MouseEvent | Вызывается при отпускании пользователем нажатой кнопки мыши на слое. |
mouseover | MouseEvent | Вызывается при входе курсора мыши в слой. |
mouseout | MouseEvent | Вызывается при выходе курсора мыши из слоя. |
contextmenu | MouseEvent | Вызывается при щелчке правой кнопкой мыши на слое, предотвращает отображение контекстного меню браузера по умолчанию, если есть слушатели на этом событии. Также вызывается на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется удерживанием). |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Вызывается после добавления слоя на карту |
remove | Event | Вызывается после удаления слоя с карты |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Вызывается при открытии всплывающего окна, привязанного к этому слою |
popupclose | PopupEvent | Вызывается при закрытии всплывающего окна, привязанного к этому слою |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Вызывается при открытии всплывающей подсказки, привязанной к этому слою. |
tooltipclose | TooltipEvent | Вызывается при закрытии всплывающей подсказки, привязанной к этому слою. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
toGeoJSON( | Object |
Значения координат округляются с помощью функции |
addLayer( | this |
Добавляет указанный слой в группу. |
removeLayer( | this |
Удаляет указанный слой из группы. |
removeLayer( | this |
Удаляет слой с заданным внутренним идентификатором из группы. |
hasLayer( | Boolean |
Возвращает |
hasLayer( | Boolean |
Возвращает |
clearLayers() | this |
Удаляет все слои из группы. |
invoke( | this |
Вызывает |
eachLayer( | this |
Итерируется по слоям группы, необязательно указывая контекст функции итератора. group.eachLayer(function (layer) {
layer.bindPopup('Hello');
});
|
getLayer( | Layer |
Возвращает слой с заданным внутренним идентификатором. |
getLayers() | Layer[] |
Возвращает массив всех слоёв, добавленных в группу. |
setZIndex( | this |
Вызывает |
getLayerId( | Number |
Возвращает внутренний идентификатор слоя. |
| Метод | Возвращает | Описание |
|---|---|---|
addTo( | this |
Добавляет слой на заданную карту или в группу слоёв. |
remove() | this |
Удаляет слой с карты, на которой он сейчас активен. |
removeFrom( | this |
Удаляет слой с указанной карты. |
removeFrom( | this |
Удаляет слой из указанной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется в |
| Метод | Возвращает | Описание |
|---|---|---|
bindPopup( | this |
Привязывает всплывающую подсказку к слою с переданным |
unbindPopup() | this |
Удаляет всплывающую подсказку, предварительно привязанную с помощью |
openPopup( | this |
Открывает привязанную всплывающую подсказку в указанной |
closePopup() | this |
Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта. |
togglePopup() | this |
Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от её текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающей подсказки, привязанной к этому слою. |
getPopup() | Popup |
Возвращает всплывающую подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
bindTooltip( | this |
Привязывает подсказку к слою с переданным |
unbindTooltip() | this |
Удаляет подсказку, предварительно привязанную с помощью |
openTooltip( | this |
Открывает привязанную подсказку в указанной |
closeTooltip() | this |
Закрывает подсказку, привязанную к этому слою, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от её текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое подсказки, привязанной к этому слою. |
getTooltip() | Tooltip |
Возвращает подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-слушатель ( |
on( | this |
Добавляет набор пар "тип/слушатель", например |
off( | this |
Удаляет ранее добавленную функцию-слушатель. Если функция не указана, будут удалены все слушатели этого события для объекта. Обратите внимание, что если вы передали пользовательский контекст для |
off( | this |
Удаляет набор пар "тип/слушатель". |
off() | this |
Удаляет всех слушателей всех событий объекта. Это включает неявно присоединённые события. |
fire( | this |
Вызывает событие указанного типа. Можно необязательно передать объект данных — свойства этого объекта будут первым аргументом функции слушателя. Событие может быть необязательно распространено на родительские события. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родительское событие — |
removeEventParent( | this |
Удаляет родительское событие, чтобы оно перестало получать распространяемые события |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
FeatureGroup
Расширенный LayerGroup, который упрощает выполнение одних и тех же действий со всеми его слоями:
-
bindPopupпривязывает всплывающее окно ко всем слоям сразу (аналогичноbindTooltip) - События распространяются на
FeatureGroup, поэтому, если у группы есть обработчик событий, она будет обрабатывать события из любого из слоёв. Это включает события мыши и пользовательские события. - Имеет события
layeraddиlayerremove
Пример использования
L.featureGroup([marker1, marker2, polyline])
.bindPopup('Hello world!')
.on('click', function() { alert('Clicked on a member of the group!'); })
.addTo(map);
Создание
| Фабрика | Описание |
|---|---|
L.featureGroup( | Создаёт группу слоёв, необязательно с начальным набором слоёв и объектом options. |
Параметры
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
interactive | Boolean | true | Если false, слой не будет генерировать события мыши и будет выступать частью базовой карты. |
bubblingMouseEvents | Boolean | true | Если true, событие мыши на этом слое будет вызывать то же событие на карте (если не используется L.DomEvent.stopPropagation). |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
pane | String | 'overlayPane' | По умолчанию слой будет добавлен на слой наложения карты. Переопределение этого параметра приведет к размещению слоя по умолчанию на другом слое. |
attribution | String | null | Строка, отображаемая в элементе управления атрибутами, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является правовой обязанностью перед держателями авторских прав и поставщиками плиток. |
События
| Событие | Данные | Описание |
|---|---|---|
layeradd | LayerEvent | Срабатывает при добавлении слоя в эту FeatureGroup
|
layerremove | LayerEvent | Срабатывает при удалении слоя из этой FeatureGroup
|
| Событие | Данные | Описание |
|---|---|---|
click | MouseEvent | Срабатывает при щелчке (или нажатии) на слое пользователем. |
dblclick | MouseEvent | Срабатывает при двойном щелчке (или двойном нажатии) на слое пользователем. |
mousedown | MouseEvent | Срабатывает при нажатии пользователем кнопки мыши на слое. |
mouseup | MouseEvent | Срабатывает при отпускании пользователем кнопки мыши, нажатой на слое. |
mouseover | MouseEvent | Срабатывает при входе курсора мыши на слой. |
mouseout | MouseEvent | Срабатывает при выходе курсора мыши со слоя. |
contextmenu | MouseEvent | Срабатывает при щелчке правой кнопкой мыши на слое, предотвращает отображение контекстного меню браузера по умолчанию, если существуют слушатели на этом событии. Также срабатывает на мобильных устройствах, когда пользователь удерживает одно прикосновение в течение секунды (также называется удерживанием). |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Срабатывает после добавления слоя на карту |
remove | Event | Срабатывает после удаления слоя с карты |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Срабатывает при открытии всплывающего окна, привязанного к этому слою |
popupclose | PopupEvent | Срабатывает при закрытии всплывающего окна, привязанного к этому слою |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Срабатывает при открытии всплывающей подсказки, привязанной к этому слою. |
tooltipclose | TooltipEvent | Срабатывает при закрытии всплывающей подсказки, привязанной к этому слою. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
setStyle( | this |
Устанавливает заданные параметры пути каждому слою группы, имеющему метод |
bringToFront() | this |
Перемещает группу слоёв вперёд наверх всех остальных слоёв |
bringToBack() | this |
Перемещает группу слоёв назад на самый низ всех остальных слоёв |
getBounds() | LatLngBounds |
Возвращает LatLngBounds группы слоёв (созданные из границ и координат её дочерних элементов). |
| Метод | Возвращает | Описание |
|---|---|---|
toGeoJSON( | Object |
Значения координат округляются с помощью функции |
addLayer( | this |
Добавляет указанный слой в группу. |
removeLayer( | this |
Удаляет указанный слой из группы. |
removeLayer( | this |
Удаляет слой с заданным внутренним идентификатором из группы. |
hasLayer( | Boolean |
Возвращает |
hasLayer( | Boolean |
Возвращает |
clearLayers() | this |
Удаляет все слои из группы. |
invoke( | this |
Вызывает |
eachLayer( | this |
Итерируется по слоям группы, необязательно указывая контекст функции итератора. group.eachLayer(function (layer) {
layer.bindPopup('Hello');
});
|
getLayer( | Layer |
Возвращает слой с заданным внутренним идентификатором. |
getLayers() | Layer[] |
Возвращает массив всех слоёв, добавленных в группу. |
setZIndex( | this |
Вызывает |
getLayerId( | Number |
Возвращает внутренний идентификатор слоя. |
| Метод | Возвращает | Описание |
|---|---|---|
addTo( | this |
Добавляет слой к заданной карте или группе слоёв. |
remove() | this |
Удаляет слой с карты, на которой он активен в настоящее время. |
removeFrom( | this |
Удаляет слой с заданной карты. |
removeFrom( | this |
Удаляет слой из указанной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется |
| Метод | Возвращает | Описание |
|---|---|---|
bindPopup( | this |
Связывает всплывающее окно со слоем с переданным |
unbindPopup() | this |
Удаляет всплывающее окно, ранее привязанное с помощью |
openPopup( | this |
Открывает привязанное всплывающее окно в указанной |
closePopup() | this |
Закрывает всплывающее окно, привязанное к этому слою, если оно открыто. |
togglePopup() | this |
Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающего окна, привязанного к этому слою. |
getPopup() | Popup |
Возвращает всплывающее окно, привязанное к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
bindTooltip( | this |
Связывает подсказку со слоем с переданным |
unbindTooltip() | this |
Удаляет подсказку, ранее привязанную с помощью |
openTooltip( | this |
Открывает привязанную подсказку в указанной |
closeTooltip() | this |
Закрывает подсказку, привязанную к этому слою, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от её текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое подсказки, привязанной к этому слою. |
getTooltip() | Tooltip |
Возвращает подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-слушатель ( |
on( | this |
Добавляет набор пар тип/слушатель, например |
off( | this |
Удаляет ранее добавленную функцию-слушатель. Если функция не указана, удаляет всех слушателей данного события из объекта. Обратите внимание, что если вы передали пользовательский контекст для |
off( | this |
Удаляет набор пар тип/слушатель. |
off() | this |
Удаляет всех слушателей всех событий объекта. Включая неявно присоединённые события. |
fire( | this |
Вызывает событие указанного типа. Можно необязательно предоставить объект данных — первый аргумент функции-слушателя будет содержать его свойства. Событие можно необязательно распространить на родительские элементы. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родительский элемент события — |
removeEventParent( | this |
Удаляет родительский элемент события, чтобы он перестал получать распространяемые события |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
GeoJSON
Представляет объект GeoJSON или массив объектов GeoJSON. Позволяет парсить данные GeoJSON и отображать их на карте. Расширяет FeatureGroup.
Пример использования
L.geoJSON(data, {
style: function (feature) {
return {color: feature.properties.color};
}
}).bindPopup(function (layer) {
return layer.feature.properties.description;
}).addTo(map);
Создание
| Фабрика | Описание |
|---|---|
L.geoJSON( | Создаёт слой GeoJSON. Необязательно принимает объект в формате GeoJSON для отображения на карте (можно добавить его позже с помощью метода addData) и объект options. |
Параметры
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
pointToLayer | Function | * | Функция, определяющая, как точки GeoJSON создают слои Leaflet. Вызывается внутренне при добавлении данных, передавая объект GeoJSON и его LatLng. По умолчанию создается стандартный маркер Marker: function(geoJsonPoint, latlng) {
return L.marker(latlng);
}
|
style | Function | * | Функция, определяющая Path options для стилизации линий и полигонов GeoJSON, вызываемая внутренне при добавлении данных. По умолчанию не переопределяет стандартные значения: function (geoJsonFeature) {
return {}
}
|
onEachFeature | Function | * | Функция, которая будет вызвана один раз для каждого созданного Feature, после его создания и стилизации. Полезно для добавления событий и всплывающих окон к объектам. По умолчанию ничего не делает с вновь созданными слоями: function (feature, layer) {}
|
filter | Function | * | Функция, которая будет использоваться для определения того, следует ли включать объект или нет. По умолчанию включает все объекты: function (geoJsonFeature) {
return true;
}
Примечание: динамическое изменение параметра |
coordsToLatLng | Function | * | Функция, которая будет использоваться для преобразования координат GeoJSON в LatLng. По умолчанию используется статический метод coordsToLatLng. |
markersInheritOptions | Boolean | false | Указывает, наследуют ли маркеры по умолчанию для объектов типа "Point" опции группы. |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
interactive | Boolean | true | Если false, слой не будет генерировать события мыши и будет действовать как часть базовой карты. |
bubblingMouseEvents | Boolean | true | Когда true, событие мыши на данном слое вызовет такое же событие на карте (если не используется L.DomEvent.stopPropagation). |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
pane | String | 'overlayPane' | По умолчанию слой будет добавлен на слой overlay карты. Переопределение этого параметра приведет к размещению слоя на другом слое по умолчанию. |
attribution | String | null | Строка, отображаемая в контроле атрибуции, например, "© OpenStreetMap contributors". Описывает данные слоя и часто является юридическим обязательством перед правообладателями и поставщиками плиток. |
События
| Событие | Данные | Описание |
|---|---|---|
layeradd | LayerEvent | Срабатывает при добавлении слоя в данный FeatureGroup
|
layerremove | LayerEvent | Срабатывает при удалении слоя из данного FeatureGroup
|
| Событие | Данные | Описание |
|---|---|---|
click | MouseEvent | Срабатывает при щелчке пользователя (или касании) слоя. |
dblclick | MouseEvent | Срабатывает при двойном щелчке пользователя (или двойном касании) слоя. |
mousedown | MouseEvent | Срабатывает при нажатии пользователем кнопки мыши на слое. |
mouseup | MouseEvent | Срабатывает при отпускании пользователем кнопки мыши, нажатой на слое. |
mouseover | MouseEvent | Срабатывает при входе курсора мыши на слой. |
mouseout | MouseEvent | Срабатывает при выходе курсора мыши со слоя. |
contextmenu | MouseEvent | Срабатывает при правом клике пользователя на слое, предотвращает отображение стандартного контекстного меню браузера, если есть слушатели на этом событии. Также срабатывает на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется длительным нажатием). |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Срабатывает после добавления слоя на карту |
remove | Event | Срабатывает после удаления слоя с карты |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Срабатывает при открытии всплывающей подсказки, привязанной к этому слою. |
popupclose | PopupEvent | Срабатывает при закрытии всплывающей подсказки, привязанной к этому слою. |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Срабатывает при открытии подсказки, привязанной к этому слою. |
tooltipclose | TooltipEvent | Срабатывает при закрытии подсказки, привязанной к этому слою. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
addData(data) | this |
Добавляет объект GeoJSON в слой. |
resetStyle(layer?) | this |
Сбрасывает стиль заданного векторного слоя на исходный стиль GeoJSON, полезно для сброса стиля после событий наведения. Если |
setStyle(style) | this |
Изменяет стили векторных слоёв GeoJSON с помощью заданной функции стиля. |
| Метод | Возвращает | Описание |
|---|---|---|
bringToFront() | this |
Выводит группу слоёв поверх всех остальных слоёв. |
bringToBack() | this |
Выводит группу слоёв за все остальные слои. |
getBounds() | LatLngBounds |
Возвращает LatLngBounds группы объектов (созданный из границ и координат её дочерних элементов). |
| Метод | Возвращает | Описание |
|---|---|---|
toGeoJSON( | Object |
Координаты округляются с помощью функции |
addLayer( | this |
Добавляет указанный слой в группу. |
removeLayer( | this |
Удаляет указанный слой из группы. |
removeLayer( | this |
Удаляет слой с заданным внутренним идентификатором из группы. |
hasLayer( | Boolean |
Возвращает |
hasLayer( | Boolean |
Возвращает |
clearLayers() | this |
Удаляет все слои из группы. |
invoke( | this |
Вызывает |
eachLayer( | this |
Итерируется по слоям группы, необязательно указывая контекст функции итератора. group.eachLayer(function (layer) {
layer.bindPopup('Hello');
});
|
getLayer( | Layer |
Возвращает слой с данным внутренним идентификатором. |
getLayers() | Layer[] |
Возвращает массив всех слоёв, добавленных в группу. |
setZIndex( | this |
Вызывает |
getLayerId( | Number |
Возвращает внутренний идентификатор для слоя. |
| Метод | Возвращает | Описание |
|---|---|---|
addTo( | this |
Добавляет слой к заданной карте или группе слоёв. |
remove() | this |
Удаляет слой с карты, на которой он в данный момент активен. |
removeFrom( | this |
Удаляет слой с заданной карты. |
removeFrom( | this |
Удаляет слой из заданной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется |
| Метод | Возвращает | Описание |
|---|---|---|
bindPopup( | this |
Привязывает всплывающую подсказку к слою с переданным |
unbindPopup() | this |
Удаляет всплывающую подсказку, предварительно привязанную с помощью |
openPopup( | this |
Открывает привязанную всплывающую подсказку в указанной |
closePopup() | this |
Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта. |
togglePopup() | this |
Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающей подсказки, привязанной к этому слою. |
getPopup() | Popup |
Возвращает всплывающую подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
bindTooltip( | this |
Привязывает подсказку к слою с переданным |
unbindTooltip() | this |
Удаляет подсказку, ранее привязанную с помощью |
openTooltip( | this |
Открывает привязанную подсказку в указанной |
closeTooltip() | this |
Закрывает подсказку, привязанную к этому слою, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое подсказки, привязанной к этому слою. |
getTooltip() | Tooltip |
Возвращает подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-слушатель ( |
on( | this |
Добавляет набор пар тип/слушатель, например, |
off( | this |
Удаляет ранее добавленную функцию-слушатель. Если функция не указана, удаляются все слушатели этого события для объекта. Обратите внимание, что если вы передали пользовательский контекст в |
off( | this |
Удаляет набор пар тип/слушатель. |
off() | this |
Удаляет всех слушателей всех событий для объекта. Это включает неявные прикрепленные события. |
fire( | this |
Вызывает событие указанного типа. Вы можете дополнительно предоставить объект данных — свойства этого объекта будут первым аргументом функции-слушателя. Событие может быть опционально распространено на родительские события. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родительский элемент события — |
removeEventParent( | this |
Удаляет родительский элемент события, поэтому он перестанет получать распространяемые события. |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
Функции
| Функция | Возвращает | Описание |
|---|---|---|
geometryToLayer( | Layer | Создаёт Layer из заданного GeoJSON объекта. Можно использовать пользовательские функции pointToLayer и/или coordsToLatLng в качестве опций. |
coordsToLatLng( | LatLng | Создаёт объект LatLng из массива из 2 чисел (долгота, широта) или 3 чисел (долгота, широта, высота), используемых в GeoJSON для точек. |
coordsToLatLngs( | Array | Создаёт многомерный массив объектов LatLng из массива координат GeoJSON. levelsDeep определяет уровень вложенности (0 — для массива точек, 1 — для массива массивов точек и т. д., по умолчанию 0). Можно использовать пользовательскую функцию coordsToLatLng. |
latLngToCoords( | Array | Обратное преобразование к coordsToLatLng. Значения координат округляются с помощью функции formatNum. |
latLngsToCoords( | Array | Обратное преобразование к coordsToLatLngs. closed определяет, следует ли добавить первую точку в конец массива для закрытия объекта, используется только когда levelsDeep равно 0. По умолчанию false. Значения координат округляются с помощью функции formatNum. |
asFeature( | Object | Нормализует геометрии/объекты GeoJSON в GeoJSON объекты. |
GridLayer
Общий класс для работы с разбиением на плитки сетки HTML-элементов. Это базовый класс для всех слоёв плиток и заменяет TileLayer.Canvas. GridLayer можно расширить, чтобы создать разбиение на плитки сетки HTML-элементов, таких как <canvas>, <img> или <div>. GridLayer будет обрабатывать создание и анимацию этих DOM-элементов за вас.
Пример использования
Синхронное использование
Для создания пользовательского слоя, расширьте GridLayer и реализуйте метод createTile(), который получит объект Point с координатами x, y, и z (уровень масштаба) для отрисовки вашей плитки.
var CanvasLayer = L.GridLayer.extend({
createTile: function(coords){
// create a <canvas> element for drawing
var tile = L.DomUtil.create('canvas', 'leaflet-tile');
// setup tile width and height according to the options
var size = this.getTileSize();
tile.width = size.x;
tile.height = size.y;
// get a canvas context and draw something on it using coords.x, coords.y and coords.z
var ctx = tile.getContext('2d');
// return the tile so it can be rendered on screen
return tile;
}
});
Асинхронное использование
Создание плиток также может быть асинхронным, это полезно при использовании сторонней библиотеки отрисовки. После завершения отрисовки плитки её можно передать в коллбэк done().
var CanvasLayer = L.GridLayer.extend({
createTile: function(coords, done){
var error;
// create a <canvas> element for drawing
var tile = L.DomUtil.create('canvas', 'leaflet-tile');
// setup tile width and height according to the options
var size = this.getTileSize();
tile.width = size.x;
tile.height = size.y;
// draw something asynchronously and pass the tile to the done() callback
setTimeout(function() {
done(error, tile);
}, 1000);
return tile;
}
});
Создание
| Фабрика | Описание |
|---|---|
L.gridLayer( | Создаёт новый экземпляр GridLayer с заданными опциями. |
Опции
| Опция | Тип | По умолчанию | Описание |
|---|---|---|---|
tileSize | Number|Point | 256 | Ширина и высота тайлов в сетке. Используйте число, если ширина и высота равны, или L.point(width, height) в противном случае. |
opacity | Number | 1.0 | Непрозрачность тайлов. Может использоваться в функции createTile(). |
updateWhenIdle | Boolean | (depends) | Загрузка новых тайлов только при завершении панорамирования. По умолчанию включено в мобильных браузерах, чтобы избежать большого числа запросов и обеспечить плавную навигацию. false в противном случае, для отображения новых тайлов во время панорамирования, так как легко выйти за пределы опции keepBuffer в браузерах на настольных компьютерах. |
updateWhenZooming | Boolean | true | По умолчанию, плавная анимация масштабирования (во время масштабирования касанием или flyTo()) будет обновлять слои сетки на каждом целочисленном уровне масштабирования. Установка этого параметра в false обновит слой сетки только после завершения плавной анимации. |
updateInterval | Number | 200 | Тайлы не будут обновляться чаще, чем раз в updateInterval миллисекунд при панорамировании. |
zIndex | Number | 1 | Явный zIndex слоя тайлов. |
bounds | LatLngBounds | undefined | Если установлено, тайлы будут загружаться только внутри заданной LatLngBounds. |
minZoom | Number | 0 | Минимальный уровень масштабирования, до которого будет отображаться этот слой (включительно). |
maxZoom | Number | undefined | Максимальный уровень масштабирования, до которого будет отображаться этот слой (включительно). |
maxNativeZoom | Number | undefined | Максимальное значение масштабирования, доступное для источника тайлов. Если оно указано, тайлы на всех уровнях масштабирования, превышающих maxNativeZoom будут загружены с уровня maxNativeZoom и автоматически отмасштабированы. |
minNativeZoom | Number | undefined | Минимальное значение масштабирования, доступное для источника тайлов. Если оно указано, тайлы на всех уровнях масштабирования, ниже minNativeZoom будут загружены с уровня minNativeZoom и автоматически отмасштабированы. |
noWrap | Boolean | false | Определяет, обернут ли слой вокруг антимеридиана. Если true, GridLayer будет отображаться только один раз на низких уровнях масштабирования. Не оказывает влияния, если система координат карты (map CRS) не обернута. Может использоваться в сочетании с bounds для предотвращения запроса тайлов за пределами границ системы координат. |
pane | String | 'tilePane' |
Map pane куда будет добавлен слой сетки. |
className | String | '' | Пользовательское имя класса для назначения слою тайлов. По умолчанию пустое. |
keepBuffer | Number | 2 | При панорамировании карты, сохраняется столько строк и столбцов тайлов, прежде чем они будут загружены. |
| Опция | Тип | По умолчанию | Описание |
|---|---|---|---|
attribution | String | null | Строка, отображаемая в элементе управления атрибутами, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридическим обязательством перед правообладателями и поставщиками тайлов. |
События
| Событие | Данные | Описание |
|---|---|---|
loading | Event | Срабатывает, когда слой сетки начинает загружать тайлы. |
tileunload | TileEvent | Срабатывает, когда тайл удаляется (например, когда тайл выходит за пределы экрана). |
tileloadstart | TileEvent | Срабатывает, когда тайл запрашивается и начинает загружаться. |
tileerror | TileErrorEvent | Срабатывает, когда возникает ошибка при загрузке тайла. |
tileload | TileEvent | Срабатывает, когда тайл загружен. |
load | Event | Срабатывает, когда слой сетки загрузил все видимые тайлы. |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Срабатывает после добавления слоя на карту |
remove | Event | Срабатывает после удаления слоя с карты |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Срабатывает, когда всплывающее окно, привязанное к этому слою, открывается |
popupclose | PopupEvent | Срабатывает, когда всплывающее окно, привязанное к этому слою, закрывается |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Срабатывает, когда подсказка, привязанная к этому слою, открывается. |
tooltipclose | TooltipEvent | Срабатывает, когда подсказка, привязанная к этому слою, закрывается. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
bringToFront() | this |
Переводит слой тайлов в самый верхний слой тайлов. |
bringToBack() | this |
Переводит слой тайлов в самый нижний слой тайлов. |
getContainer() | HTMLElement |
Возвращает HTML-элемент, содержащий тайлы для данного слоя. |
setOpacity( | this |
Изменяет непрозрачность слоя сетки. |
setZIndex( | this |
Изменяет zIndex слоя сетки. |
isLoading() | Boolean |
Возвращает |
redraw() | this |
Принудительно очищает все тайлы и запрашивает их заново. |
getTileSize() | Point |
Нормализует опцию tileSize в точку. Используется методом |
Методы расширений
GridLayer, должны переопределить следующий метод.| Метод | Возвращает | Описание |
|---|---|---|
createTile( | HTMLElement |
Вызывается только внутри, должен быть переопределён классами, расширяющими |
| Метод | Возвращает | Описание |
|---|---|---|
addTo( | this |
Добавляет слой на заданную карту или группу слоёв. |
remove() | this |
Удаляет слой с карты, на которой он в настоящее время активен. |
removeFrom( | this |
Удаляет слой с заданной карты. |
removeFrom( | this |
Удаляет слой из заданной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется |
| Метод | Возвращает | Описание |
|---|---|---|
bindPopup( | this |
Привязывает всплывающее окно к слою с переданным |
unbindPopup() | this |
Удаляет всплывающее окно, ранее привязанное с помощью |
openPopup( | this |
Открывает привязанное всплывающее окно в указанной |
closePopup() | this |
Закрывает привязанное к этому слою всплывающее окно, если оно открыто. |
togglePopup() | this |
Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающего окна, привязанного к этому слою. |
getPopup() | Popup |
Возвращает всплывающее окно, привязанное к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
bindTooltip( | this |
Привязывает подсказку к слою с переданным |
unbindTooltip() | this |
Удаляет подсказку, ранее привязанную с помощью |
openTooltip( | this |
Открывает привязанную подсказку в указанной |
closeTooltip() | this |
Закрывает привязанную к этому слою подсказку, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от её текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое подсказки, привязанной к этому слою. |
getTooltip() | Tooltip |
Возвращает подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-обработчик ( |
on( | this |
Добавляет набор пар "тип/обработчик", например, |
off( | this |
Удаляет ранее добавленную функцию-обработчик. Если функция не указана, удаляет все обработчики этого события из объекта. Обратите внимание, что если вы передали пользовательский контекст для |
off( | this |
Удаляет набор пар "тип/обработчик". |
off() | this |
Удаляет все обработчики всех событий в объекте. Это включает неявно присоединённые события. |
fire( | this |
Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — первый аргумент функции-обработчика будет содержать его свойства. Событие может быть необязательно распространено на родительские события. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родительский объект события — |
removeEventParent( | this |
Удаляет родительский объект события, чтобы он перестал получать распространяемые события. |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
LatLng
Представляет географическую точку с определённой широтой и долготой.
Пример использования
var latlng = L.latLng(50.5, 30.5);
Все методы Leaflet, принимающие объекты LatLng, также принимают их в простом массиве и простом формате объекта (если не указано иное), поэтому эти строки эквивалентны:
map.panTo([50, 30]);
map.panTo({lng: 30, lat: 50});
map.panTo({lat: 50, lng: 30});
map.panTo(L.latLng(50, 30));
Обратите внимание, что LatLng не наследуется от объекта Leaflet Class, что означает, что новые классы не могут наследоваться от него, и новые методы не могут быть добавлены к нему с помощью функции include.
Создание
| Фабрика | Описание |
|---|---|
L.latLng( | Создаёт объект, представляющий географическую точку с заданной широтой и долготой (и, необязательно, высотой). |
L.latLng( | Ожидает массив в формате [Number, Number] или [Number, Number, Number] вместо него. |
L.latLng( | Ожидает простой объект в формате {lat: Number, lng: Number} или {lat: Number, lng: Number, alt: Number} вместо него. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
equals( | Boolean |
Возвращает |
toString() | String |
Возвращает строковое представление точки (для отладки). |
distanceTo( | Number |
Возвращает расстояние (в метрах) до заданной точки |
wrap() | LatLng |
Возвращает новый объект |
toBounds( | LatLngBounds |
Возвращает новый объект |
Свойства
| Свойство | Тип | Описание |
|---|---|---|
lat | Number | Широта в градусах |
lng | Number | Долгота в градусах |
alt | Number | Высота в метрах (необязательно) |
LatLngBounds
Представляет прямоугольную географическую область на карте.
Пример использования
var corner1 = L.latLng(40.712, -74.227), corner2 = L.latLng(40.774, -74.125), bounds = L.latLngBounds(corner1, corner2);
Все методы Leaflet, принимающие объекты LatLngBounds, также принимают их в простом формате массива (если не указано иное), поэтому пример с границами можно передать так:
map.fitBounds([ [40.712, -74.227], [40.774, -74.125] ]);
Внимание: если область пересекает антимеридиан (часто путают с Линией перемены дат), необходимо указать углы вне диапазона долготы [-180, 180] градусов.
Обратите внимание, что LatLngBounds не наследуется от объекта Class Leaflet, что означает, что новые классы не могут наследовать от него, и новые методы не могут быть добавлены к нему с помощью функции include.
Создание
| Фабрика | Описание |
|---|---|
L.latLngBounds( | Создает объект LatLngBounds, определяя две диагонально противоположные вершины прямоугольника. |
L.latLngBounds( | Создает объект LatLngBounds, определяемый географическими точками, которые он содержит. Очень полезно для масштабирования карты так, чтобы она соответствовала определенному набору местоположений с помощью fitBounds. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
extend( | this |
Расширить границы, чтобы они содержали заданную точку |
extend( | this |
Расширить границы, чтобы они содержали заданные границы |
pad( | LatLngBounds |
Возвращает границы, созданные путем расширения или сужения текущих границ на заданное отношение в каждом направлении. Например, отношение 0,5 расширяет границы на 50% в каждом направлении. Отрицательные значения сужают границы. |
getCenter() | LatLng |
Возвращает центральную точку границ. |
getSouthWest() | LatLng |
Возвращает юго-западную точку границ. |
getNorthEast() | LatLng |
Возвращает северо-восточную точку границ. |
getNorthWest() | LatLng |
Возвращает северо-западную точку границ. |
getSouthEast() | LatLng |
Возвращает юго-восточную точку границ. |
getWest() | Number |
Возвращает западную долготу границ |
getSouth() | Number |
Возвращает южную широту границ |
getEast() | Number |
Возвращает восточную долготу границ |
getNorth() | Number |
Возвращает северную широту границ |
contains( | Boolean |
Возвращает |
contains( | Boolean |
Возвращает |
intersects( | Boolean |
Возвращает |
overlaps( | Boolean |
Возвращает |
toBBoxString() | String |
Возвращает строку с координатами рамки в формате 'southwest_lng,southwest_lat,northeast_lng,northeast_lat'. Полезно для отправки запросов к веб-сервисам, возвращающим геоданные. |
equals( | Boolean |
Возвращает |
isValid() | Boolean |
Возвращает |
Точка
Представляет точку с координатами x и y в пикселях.
Пример использования
var point = L.point(200, 300);
Все методы и параметры Leaflet, принимающие объекты Point, также принимают их в простом формате массива (если не указано иное), поэтому эти строки эквивалентны:
map.panBy([200, 300]); map.panBy(L.point(200, 300));
Обратите внимание, что Point не наследуется от объекта Class Leaflet, что означает, что новые классы не могут наследовать от него, и новые методы не могут быть добавлены к нему с помощью функции include.
Создание
| Фабрика | Описание |
|---|---|
L.point( | Создает объект Point с заданными координатами x и y. Если необязательный round установлен в true, округляет значения x и y. |
L.point( | Ожидает массив в формате [x, y]. |
L.point( | Ожидает простой объект в формате {x: Number, y: Number}. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
clone() | Point |
Возвращает копию текущей точки. |
add( | Point |
Возвращает результат сложения текущей и заданной точек. |
subtract( | Point |
Возвращает результат вычитания заданной точки из текущей. |
divideBy( | Point |
Возвращает результат деления текущей точки на заданное число. |
multiplyBy( | Point |
Возвращает результат умножения текущей точки на заданное число. |
scaleBy( | Point |
Умножает каждую координату текущей точки на соответствующую координату |
unscaleBy( | Point |
Обратная операция к |
round() | Point |
Возвращает копию текущей точки с округленными координатами. |
floor() | Point |
Возвращает копию текущей точки с координатами, округленными вниз. |
ceil() | Point |
Возвращает копию текущей точки с координатами, округленными вверх. |
trunc() | Point |
Возвращает копию текущей точки с усечёнными координатами (округление к нулю). |
distanceTo( | Number |
Возвращает евклидово расстояние между текущей и заданной точками. |
equals( | Boolean |
Возвращает |
contains( | Boolean |
Возвращает |
toString() | String |
Возвращает строковое представление точки для отладки. |
Свойства
| Свойство | Тип | Описание |
|---|---|---|
x | Number | Координата x точки |
y | Number | Координата y точки |
Прямоугольник
Представляет прямоугольную область в пикселях.
Пример использования
var p1 = L.point(10, 10), p2 = L.point(40, 60), bounds = L.bounds(p1, p2);
Все методы Leaflet, принимающие объекты Bounds, также принимают их в виде простого массива (если не указано иное), поэтому пример с прямоугольником можно передать так:
otherBounds.intersects([[10, 10], [40, 60]]);
Обратите внимание, что Bounds не наследуется от объекта Class Leaflet, что означает, что новые классы не могут наследоваться от него, и новые методы не могут быть добавлены к нему с помощью функции include.
Создание
| Фабрика | Описание |
|---|---|
L.bounds( | Создаёт объект прямоугольника из двух пар координат углов. |
L.bounds( | Создаёт объект прямоугольника из заданного массива точек. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
extend( | this |
Расширяет прямоугольник, чтобы он содержал заданную точку. |
extend( | this |
Расширяет прямоугольник, чтобы он содержал заданный прямоугольник |
getCenter( | Point |
Возвращает центральную точку прямоугольника. |
getBottomLeft() | Point |
Возвращает нижнюю левую точку прямоугольника. |
getTopRight() | Point |
Возвращает верхнюю правую точку прямоугольника. |
getTopLeft() | Point |
Возвращает верхнюю левую точку прямоугольника (т.е. |
getBottomRight() | Point |
Возвращает нижнюю правую точку прямоугольника (т.е. |
getSize() | Point |
Возвращает размер заданного прямоугольника. |
contains( | Boolean |
Возвращает |
contains( | Boolean |
Возвращает |
intersects( | Boolean |
Возвращает |
overlaps( | Boolean |
Возвращает |
isValid() | Boolean |
Возвращает |
pad( | Bounds |
Возвращает прямоугольник, созданный путем расширения или сужения текущего прямоугольника на заданный коэффициент в каждом направлении. Например, коэффициент 0,5 расширит прямоугольник на 50% в каждом направлении. Отрицательные значения сузят прямоугольник. |
equals( | Boolean |
Возвращает |
Свойства
| Свойство | Тип | Описание |
|---|---|---|
min | Point | Левый верхний угол прямоугольника. |
max | Point | Правый нижний угол прямоугольника. |
Иконка
Представляет иконку для использования при создании метки.
Пример использования
var myIcon = L.icon({
iconUrl: 'my-icon.png',
iconSize: [38, 95],
iconAnchor: [22, 94],
popupAnchor: [-3, -76],
shadowUrl: 'my-icon-shadow.png',
shadowSize: [68, 95],
shadowAnchor: [22, 94]
});
L.marker([50.505, 30.57], {icon: myIcon}).addTo(map);
L.Icon.Default наследуется от L.Icon и является синей иконкой, используемой Leaflet для меток по умолчанию.
Создание
| Фабрика | Описание |
|---|---|
L.icon( | Создаёт экземпляр иконки с заданными параметрами. |
Параметры
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
iconUrl | String | null | (обязательно) URL изображения значка (абсолютный или относительный к пути вашего скрипта). |
iconRetinaUrl | String | null | URL изображения значка с высоким разрешением (абсолютный или относительный к пути вашего скрипта). Используется для устройств с Retina-дисплеями. |
iconSize | Point | null | Размер изображения значка в пикселях. |
iconAnchor | Point | null | Координаты «кончика» значка (относительно его верхнего левого угла). Значок будет выровнен так, чтобы эта точка находилась в географическом месте метки. По умолчанию центрируется, если задан размер, также может быть установлен в CSS с отрицательными отступами. |
popupAnchor | Point | [0, 0] | Координаты точки, от которой будут «открываться» всплывающие окна, относительно якоря значка. |
tooltipAnchor | Point | [0, 0] | Координаты точки, от которой будут «открываться» подсказки, относительно якоря значка. |
shadowUrl | String | null | URL изображения тени значка. Если не указано, изображение тени не будет создано. |
shadowRetinaUrl | String | null | |
shadowSize | Point | null | Размер изображения тени в пикселях. |
shadowAnchor | Point | null | Координаты «кончика» тени (относительно её верхнего левого угла) (то же, что и iconAnchor, если не указано иначе). |
className | String | '' | Пользовательское имя класса для присваивания как изображению значка, так и изображению тени. По умолчанию пустое. |
crossOrigin | Boolean|String | false | Добавлять ли атрибут crossOrigin к тайлам. Если указана строка, все тайлы будут иметь атрибут crossOrigin, установленный на предоставленную строку. Это необходимо, если вы хотите получить доступ к данным пикселей тайлов. Обратитесь к Настройкам CORS для получения допустимых значений строки. |
Методы
| Метод | Возвращаемое значение | Описание |
|---|---|---|
createIcon( | HTMLElement |
Вызывается в процессе отображения значка, возвращает |
createShadow( | HTMLElement |
Как |
Icon.Default
Icon, представляет значок, используемый в Marker при отсутствии указанного значка. Указывает на изображение синей метки, распространяемое вместе с выпусками Leaflet. Для настройки значка по умолчанию просто измените свойства L.Icon.Default.prototype.options (который является набором Icon options).
Если вы хотите полностью заменить значок по умолчанию, переопределите L.Marker.prototype.options.icon своим собственным значком.
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
imagePath | String |
Icon.Default попытается автоматически определить местоположение изображений синего значка. Если вы размещаете эти изображения нестандартным способом, установите эту опцию, чтобы указать правильный путь. |
DivIcon
Представляет лёгкий значок для меток, использующий простой <div>-элемент вместо изображения. Наследуется от Icon, но игнорирует iconUrl и опцию тени.
Пример использования
var myIcon = L.divIcon({className: 'my-div-icon'});
// you can set .my-div-icon styles in CSS
L.marker([50.505, 30.57], {icon: myIcon}).addTo(map);
По умолчанию он имеет CSS-класс 'leaflet-div-icon' и стилизован как небольшой белый квадрат с тенью.
Создание
| Фабрика | Описание |
|---|---|
L.divIcon( | Создаёт экземпляр DivIcon с заданными параметрами. |
Параметры
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
html | String|HTMLElement | '' | Пользовательский HTML-код для вставки в div-элемент, по умолчанию пустое. В качестве альтернативы, экземпляр HTMLElement. |
bgPos | Point | [0, 0] | Необязательная относительная позиция фона в пикселях. |
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
iconUrl | String | null | (обязательно) URL изображения значка (абсолютный или относительный к пути вашего скрипта). |
iconRetinaUrl | String | null | URL изображения значка с высоким разрешением (абсолютный или относительный к пути вашего скрипта). Используется для устройств с Retina-дисплеями. |
iconSize | Point | null | Размер изображения значка в пикселях. |
iconAnchor | Point | null | Координаты «кончика» значка (относительно его верхнего левого угла). Значок будет выровнен так, чтобы эта точка находилась в географическом месте метки. По умолчанию центрируется, если задан размер, также может быть установлен в CSS с отрицательными отступами. |
popupAnchor | Point | [0, 0] | Координаты точки, от которой будут «открываться» всплывающие окна, относительно якоря значка. |
tooltipAnchor | Point | [0, 0] | Координаты точки, от которой будут «открываться» подсказки, относительно якоря значка. |
shadowUrl | String | null | URL изображения тени значка. Если не указано, изображение тени не будет создано. |
shadowRetinaUrl | String | null | |
shadowSize | Point | null | Размер изображения тени в пикселях. |
shadowAnchor | Point | null | Координаты «кончика» тени (относительно её верхнего левого угла) (то же, что и iconAnchor, если не указано иначе). |
className | String | '' | Пользовательское имя класса для присваивания как изображению значка, так и изображению тени. По умолчанию пустое. |
crossOrigin | Boolean|String | false | Добавлять ли атрибут crossOrigin к тайлам. Если указана строка, все тайлы будут иметь атрибут crossOrigin, установленный на предоставленную строку. Это необходимо, если вы хотите получить доступ к данным пикселей тайлов. Обратитесь к Настройкам CORS для получения допустимых значений строки. |
Методы
| Метод | Возвращаемое значение | Описание |
|---|---|---|
createIcon( | HTMLElement |
Вызывается в процессе отображения значка, возвращает |
createShadow( | HTMLElement |
Как |
Управление масштабом
Базовое управление масштабом с двумя кнопками (увеличение и уменьшение масштаба). По умолчанию добавляется на карту, если не установлено значение опции zoomControl равное false. Расширяет Control.
Создание
| Фабрика | Описание |
|---|---|
L.control.zoom( | Создаёт управление масштабом |
Параметры
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
zoomInText | String | '<span aria-hidden="true">+</span>' | Текст, устанавливаемый на кнопке «Увеличить». |
zoomInTitle | String | 'Zoom in' | Заголовок, устанавливаемый на кнопке «Увеличить». |
zoomOutText | String | '<span aria-hidden="true">−</span>' | Текст, устанавливаемый на кнопке «Уменьшить». |
zoomOutTitle | String | 'Zoom out' | Заголовок, устанавливаемый на кнопке «Уменьшить». |
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
position | String | 'topright' | Положение элемента управления (один из углов карты). Возможные значения: 'topleft', 'topright', 'bottomleft' или 'bottomright'
|
Методы
| Метод | Возвращает | Описание |
|---|---|---|
getPosition() | string |
Возвращает положение элемента управления. |
setPosition( | this |
Устанавливает положение элемента управления. |
getContainer() | HTMLElement |
Возвращает HTMLElement, содержащий элемент управления. |
addTo( | this |
Добавляет элемент управления на заданную карту. |
remove() | this |
Удаляет элемент управления с карты, на которой он сейчас активен. |
Control.Attribution
Элемент управления Attribution позволяет отображать данные об авторских правах в небольшом текстовом поле на карте. Он добавляется на карту по умолчанию, если не установлено значение опции attributionControl в false, и автоматически извлекает текст авторских прав из слоёв с помощью метода getAttribution. Расширяет Control.
Создание
| Фабрика | Описание |
|---|---|
L.control.attribution( | Создаёт элемент управления Attribution. |
Опции
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
prefix | String|false | 'Leaflet' | HTML-текст, отображаемый перед данными об авторских правах. Используйте false, чтобы отключить. |
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
position | String | 'topright' | Положение элемента управления (один из углов карты). Возможные значения: 'topleft', 'topright', 'bottomleft' или 'bottomright'
|
Методы
| Метод | Возвращает | Описание |
|---|---|---|
setPrefix( | this |
HTML-текст, отображаемый перед данными об авторских правах. Используйте |
addAttribution( | this |
Добавляет текст авторских прав (например, |
removeAttribution( | this |
Удаляет текст авторских прав. |
| Метод | Возвращает | Описание |
|---|---|---|
getPosition() | string |
Возвращает положение элемента управления. |
setPosition( | this |
Устанавливает положение элемента управления. |
getContainer() | HTMLElement |
Возвращает HTMLElement, содержащий элемент управления. |
addTo( | this |
Добавляет элемент управления на заданную карту. |
remove() | this |
Удаляет элемент управления с карты, на которой он сейчас активен. |
Control.Layers
Элемент управления слоями позволяет пользователям переключаться между различными базовыми слоями и включать/выключать наложения (см. подробный пример). Расширяет Control.
Пример использования
var baseLayers = {
"Mapbox": mapbox,
"OpenStreetMap": osm
};
var overlays = {
"Marker": marker,
"Roads": roadsLayer
};
L.control.layers(baseLayers, overlays).addTo(map);
Параметры baseLayers и overlays — это литералы объектов, где ключами являются имена слоёв, а значениями — объекты Layer:
{
"<someName1>": layer1,
"<someName2>": layer2
}
Имена слоёв могут содержать HTML, что позволяет добавлять дополнительное форматирование элементов:
{"<img src='my-layer-icon' /> <span class='my-layer-item'>My Layer</span>": myLayer}
Создание
| Фабрика | Описание |
|---|---|
L.control.layers( | Создаёт элемент управления слоями с заданными слоями. Базовые слои будут переключаться с помощью радиокнопок, а наложения — с помощью флажков. Обратите внимание, что все базовые слои должны быть переданы в объекте base layers, но только один должен быть добавлен на карту во время инициализации карты. |
Опции
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
collapsed | Boolean | true | Если true, элемент управления будет свёрнут в иконку и развернётся при наведении, касании или активации с помощью клавиатуры. |
autoZIndex | Boolean | true | Если true, элемент управления назначит zIndexes в возрастающем порядке всем своим слоям, чтобы порядок сохранялся при включении/выключении. |
hideSingleBase | Boolean | false | Если true, базовые слои в элементе управления будут скрыты, если их только один. |
sortLayers | Boolean | false | Сортировать слои. Если false, слои сохранят порядок, в котором они были добавлены в элемент управления. |
sortFunction | Function | * | Функция сравнения (compare function), которая будет использоваться для сортировки слоёв, если sortLayers — true. Функция получает оба экземпляра L.Layer и их имена, как в sortFunction(layerA, layerB, nameA, nameB). По умолчанию слои сортируются в алфавитном порядке по имени. |
| Опция | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
position | String | 'topright' | Положение элемента управления (один из углов карты). Возможные значения: 'topleft', 'topright', 'bottomleft' или 'bottomright'
|
Методы
| Метод | Возвращает | Описание |
|---|---|---|
addBaseLayer( | this |
Добавляет базовый слой (элемент управления радиокнопкой) с заданным именем в элемент управления. |
addOverlay( | this |
Добавляет наложение (элемент управления флажком) с заданным именем в элемент управления. |
removeLayer( | this |
Удаляет заданный слой из элемента управления. |
expand() | this |
Развернуть контейнер элемента управления, если он свёрнут. |
collapse() | this |
Свернуть контейнер элемента управления, если он развернут. |
| Метод | Возвращает | Описание |
|---|---|---|
getPosition() | string |
Возвращает позицию элемента управления. |
setPosition( | this |
Устанавливает позицию элемента управления. |
getContainer() | HTMLElement |
Возвращает HTMLElement, содержащий элемент управления. |
addTo( | this |
Добавляет элемент управления на данную карту. |
remove() | this |
Удаляет элемент управления с карты, на которой он сейчас активен. |
Control.Scale
Простой элемент управления масштабом, отображающий масштаб текущего центра экрана в метрической (м/км) и имперской (ми/футы) системах. Расширяет Control.
Пример использования
L.control.scale().addTo(map);
Создание
| Фабрика | Описание |
|---|---|
L.control.scale( | Создаёт элемент управления масштабом с заданными параметрами. |
Параметры
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
maxWidth | Number | 100 | Максимальная ширина элемента управления в пикселях. Ширина устанавливается динамически для отображения круглых значений (например, 100, 200, 500). |
metric | Boolean | True | Показывать ли метрическую шкалу (м/км). |
imperial | Boolean | True | Показывать ли имперскую шкалу (ми/футы). |
updateWhenIdle | Boolean | false | Если true, элемент управления обновляется при moveend, в противном случае он всегда обновлён (обновляется при move). |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
position | String | 'topright' | Позиция элемента управления (один из углов карты). Возможные значения: 'topleft', 'topright', 'bottomleft' или 'bottomright'
|
Методы
| Метод | Возвращает | Описание |
|---|---|---|
getPosition() | string |
Возвращает позицию элемента управления. |
setPosition( | this |
Устанавливает позицию элемента управления. |
getContainer() | HTMLElement |
Возвращает HTMLElement, содержащий элемент управления. |
addTo( | this |
Добавляет элемент управления на данную карту. |
remove() | this |
Удаляет элемент управления с карты, на которой он сейчас активен. |
Браузер
Пространство имён со статическими свойствами для определения браузера/функций, используемых Leaflet внутри.
Пример использования
if (L.Browser.ielt9) {
alert('Upgrade your browser, dude!');
}
Свойства
| Свойство | Тип | Описание |
|---|---|---|
ie | Boolean |
true для всех версий Internet Explorer (кроме Edge). |
ielt9 | Boolean |
true для версий Internet Explorer меньше 9. |
edge | Boolean |
true для веб-браузера Edge. |
webkit | Boolean; |
true для браузеров на основе WebKit, таких как Chrome и Safari (включая мобильные версии). |
android | Boolean |
Устарело. true для любого браузера, работающего на платформе Android. |
android23 | Boolean |
Устарело. true для браузеров, работающих на Android 2 или Android 3. |
androidStock | Boolean |
Устарело. true для браузера по умолчанию Android (т. е. не Chrome). |
opera | Boolean |
true для браузера Opera. |
chrome | Boolean |
true для браузера Chrome. |
gecko | Boolean |
true для браузеров на основе Gecko, таких как Firefox. |
safari | Boolean |
true для браузера Safari. |
opera12 | Boolean |
true для браузера Opera, поддерживающего CSS-трансформации (версия 12 или выше). |
win | Boolean |
true когда браузер работает в Windows. |
ie3d | Boolean |
true для всех версий Internet Explorer, поддерживающих CSS-трансформации. |
webkit3d | Boolean |
true для браузеров на основе WebKit, поддерживающих CSS-трансформации. |
gecko3d | Boolean |
true для браузеров на основе Gecko, поддерживающих CSS-трансформации. |
any3d | Boolean |
true для всех браузеров, поддерживающих CSS-трансформации. |
mobile | Boolean |
true для всех браузеров, работающих на мобильном устройстве. |
mobileWebkit | Boolean |
true для всех браузеров на основе WebKit на мобильном устройстве. |
mobileWebkit3d | Boolean |
true для всех браузеров на основе WebKit на мобильном устройстве, поддерживающих CSS-трансформации. |
msPointer | Boolean |
true для браузеров, реализующих модель Microsoft touch events (в основном IE10). |
pointer | Boolean |
true для всех браузеров, поддерживающих pointer events. |
touchNative | Boolean |
true для всех браузеров, поддерживающих touch events. Это не обязательно означает, что браузер работает на компьютере со сенсорным экраном, это лишь означает, что браузер способен понимать touch events. |
touch | Boolean |
true для всех браузеров, поддерживающих либо touch, либо pointer события. Примечание: pointer events будут предпочтительны (если доступны), и обрабатываются для всех touch* listeners. |
mobileOpera | Boolean |
true для браузера Opera на мобильном устройстве. |
mobileGecko | Boolean |
true для браузеров на основе Gecko, работающих на мобильном устройстве. |
retina | Boolean |
true для браузеров на экранах с высоким разрешением "retina" или на любом экране, когда масштаб отображения браузера больше 100%. |
passiveEvents | Boolean |
true для браузеров, поддерживающих пассивные события. |
canvas | Boolean |
true когда браузер поддерживает <canvas>. |
svg | Boolean |
true когда браузер поддерживает SVG. |
vml | Boolean |
true если браузер поддерживает VML. |
mac | Boolean |
true когда браузер работает на Mac true когда браузер работает на Linux |
Утилиты
Различные вспомогательные функции, используемые Leaflet внутри.
Функции
| Функция | Возвращает | Описание |
|---|---|---|
extend( | Object | Объединяет свойства объекта src (или нескольких объектов) в объект dest и возвращает последний. Имеет сокращение L.extend. |
create( | Object | Полифил для совместимости с Object.create |
bind( | Function | Возвращает новую функцию, связанную с переданными аргументами, подобно Function.prototype.bind. Имеет сокращение L.bind(). |
stamp( | Number | Возвращает уникальный идентификатор объекта, присваивая его, если он отсутствует. |
throttle( | Function | Возвращает функцию, которая выполняет функцию fn с заданным контекстом context (так что ключевое слово this относится к context внутри кода fn). Функция fn будет вызываться не более одного раза за заданное количество time. Аргументы, полученные связанной функцией, будут любыми аргументами, переданными при связывании функции, за которыми последуют любые аргументы, переданные при вызове связанной функции. Имеет сокращение L.throttle. |
wrapNum( | Number | Возвращает число num по модулю range таким образом, чтобы оно находилось в пределах от range[0] до range[1]. Возвращаемое значение всегда будет меньше range[1], если только includeMax не установлено в значение true. |
falseFn() | Function | Возвращает функцию, которая всегда возвращает false. |
formatNum( | Number | Возвращает число num, округленное до заданной precision. Значение по умолчанию precision равно 6 десятичным знакам. false может быть передано для пропуска обработки (может быть полезно для избежания ошибок округления). |
trim( | String | Полифил для совместимости с String.prototype.trim |
splitWords( | String[] | Обрезает и разделяет строку по пробелам и возвращает массив частей. |
setOptions( | Object | Объединяет заданные свойства в options объекта obj, возвращая результирующие параметры. См. Class options. Имеет сокращение L.setOptions. |
getParamString( | String | Преобразует объект в строку параметров URL, например, {a: "foo", b: "bar"} преобразуется в '?a=foo&b=bar'. Если existingUrl установлено, параметры будут добавлены в конец. Если uppercase равно true, имена параметров будут приведены к верхнему регистру (например, '?A=foo&B=bar') |
template( | String | Простая система шаблонов, принимает строку шаблона вида 'Hello {a}, {b}' и объект данных, подобный {a: 'foo', b: 'bar'}, возвращает обработанную строку ('Hello foo, bar'). Также можно указать функции вместо строк для значений данных — они будут вычислены, передавая data в качестве аргумента. |
isArray(obj) | Boolean | Полифил для совместимости с Array.isArray |
indexOf( | Number | Полифил для совместимости с Array.prototype.indexOf |
requestAnimFrame( | Number | Планирует выполнение fn при перерисовке браузера. fn привязано к context, если указано. Если immediate установлено, fn вызывается немедленно, если браузер не поддерживает window.requestAnimationFrame в родном виде, в противном случае он отложен. Возвращает идентификатор запроса, который может быть использован для отмены запроса. |
cancelAnimFrame( | undefined | Отменяет предыдущий requestAnimFrame. См. также window.cancelAnimationFrame. |
Свойства
| Свойство | Тип | Описание |
|---|---|---|
lastId | Number | Последний уникальный идентификатор, используемый stamp()
|
emptyImageUrl | String | Строка данных URI, содержащая закодированное в base64 пустое изображение GIF. Используется как хак для освобождения памяти от неиспользуемых изображений на мобильных устройствах на основе WebKit (путем установки свойства изображения src в эту строку). |
Преобразование
Представляет аффинное преобразование: набор коэффициентов a, b, c, d для преобразования точки вида (x, y) в (a*x + b, c*y + d) и обратного преобразования. Используется Leaflet в его коде проекций.
Пример использования
var transformation = L.transformation(2, 5, -1, 10), p = L.point(1, 2), p2 = transformation.transform(p), // L.point(7, 8) p3 = transformation.untransform(p2); // L.point(1, 2)
Создание
| Фабрика | Описание |
|---|---|
L.transformation( | Инициализирует объект Transformation заданными коэффициентами. |
L.transformation( | Ожидает массив коэффициентов вида [a: Number, b: Number, c: Number, d: Number]. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
transform( | Point |
Возвращает преобразованную точку, необязательно умноженную на заданный масштаб. Принимает только объекты |
untransform( | Point |
Возвращает обратное преобразование заданной точки, необязательно деленное на заданный масштаб. Принимает только объекты |
LineUtil
Различные вспомогательные функции для обработки полилинейных точек, используемые Leaflet внутри для ускорения работы с полилиниями.
Функции
| Функция | Возвращает | Описание |
|---|---|---|
simplify( | Point[] | Значительно уменьшает количество точек в полилинии, сохраняя её форму, и возвращает новый массив упрощенных точек, используя алгоритм Рамера-Доугласа-Пекера. Используется для значительного повышения производительности при обработке/отображении полилиний Leaflet на каждом уровне масштабирования, а также для уменьшения визуального шума. tolerance влияет на степень упрощения (меньшее значение означает более высокое качество, но медленнее и с большим количеством точек). Также выпущен в виде отдельной микробиблиотеки Simplify.js. |
pointToSegmentDistance( | Number | Возвращает расстояние между точкой p и отрезком p1 до p2. |
closestPointOnSegment( | Number | Возвращает ближайшую точку от точки p на отрезке p1 до p2. |
clipSegment( | Point[]|Boolean | Обрезает отрезок a до b прямоугольными границами с помощью алгоритма Кохена-Сазерленда (непосредственно изменяя точки отрезка!). Используется Leaflet для отображения только тех точек полилинии, которые находятся на экране или рядом, повышая производительность. |
isFlat( | Boolean | Возвращает true, если latlngs является плоским массивом, false — если вложенный. |
polylineCenter( | LatLng | Возвращает центр (центроид) переданных LatLng (первого кольца) из полилинии. |
PolyUtil
Различные вспомогательные функции для геометрий полигонов.
Функции
| Функция | Возвращает | Описание |
|---|---|---|
clipPolygon( | Point[] | Обрезает геометрию многоугольника, определённую заданными points, по заданным границам (используя алгоритм Сутерленда-Ходжмана). Используется Leaflet для отображения только точек многоугольника, которые находятся на экране или рядом, увеличивая производительность. Обратите внимание, что для обрезки точек многоугольника требуется другой алгоритм, чем для полилиний, поэтому для него есть отдельный метод. |
polygonCenter( | LatLng | Возвращает центр (центр тяжести) переданных LatLng (первое кольцо) из многоугольника. |
centroid( | LatLng | Возвращает центр масс переданных LatLng. |
DomEvent
Утилитарные функции для работы с событиями DOM, используемые Leaflet внутри.
Функции
| Функция | Возвращает | Описание |
|---|---|---|
on( | this | Добавляет функцию-обработчик (fn) для определённого типа событий DOM элемента el. Можно необязательно указать контекст обработчика (объект, на который будет указывать ключевое слово this) . Также можно передавать несколько типов через пробел (например, 'click dblclick'). |
on( | this | Добавляет набор пар тип/обработчик, например {click: onClick, mousemove: onMouseMove}
|
off( | this | Удаляет ранее добавленную функцию-обработчик. Обратите внимание, что если вы передали пользовательский контекст в on, вы должны передать тот же контекст в off для удаления обработчика. |
off( | this | Удаляет набор пар тип/обработчик, например {click: onClick, mousemove: onMouseMove}
|
off( | this | Удаляет все ранее добавленные обработчики заданных типов. |
off( | this | Удаляет все ранее добавленные обработчики для заданного HTMLElement |
stopPropagation( | this | Прекращает распространение данного события к родительским элементам. Используется внутри функций-обработчиков: L.DomEvent.on(div, 'click', function (ev) {
L.DomEvent.stopPropagation(ev);
});
|
disableScrollPropagation( | this | Добавляет stopPropagation к событиям прокрутки элемента 'wheel' (плюс варианты браузеров). |
disableClickPropagation( | this | Добавляет stopPropagation к событиям клика элемента 'click', 'dblclick', 'contextmenu', 'mousedown' и 'touchstart' (плюс варианты браузеров). |
preventDefault( | this | Предотвращает выполнение действия по умолчанию события DOM ev (например, переход по ссылке в href элемента a или выполнение запроса POST с перезагрузкой страницы при отправке <form>). Используйте внутри функций-обработчиков. |
stop( | this | Выполняет stopPropagation и preventDefault одновременно. |
getPropagationPath( | Array | Полифил для совместимости с Event.composedPath(). Возвращает массив, содержащий HTMLElementы, которым должно распространяться данное событие DOM (если оно не остановлено). |
getMousePosition( | Point | Получает нормализованную позицию мыши из события DOM относительно container (без учёта границы) или относительно всей страницы, если не указано иное. |
getWheelDelta( | Number | Получает нормализованное значение изменения прокрутки колеса из события колеса DOM в вертикальных пикселях, прокрученных (отрицательное значение при прокрутке вниз). События от указательных устройств без точной прокрутки сопоставляются с наиболее подходящим значением в 60 пикселей. |
addListener(…) | this | Псевдоним для L.DomEvent.on
|
removeListener(…) | this | Псевдоним для L.DomEvent.off
|
DomUtil
Утилитарные функции для работы с деревом DOM, используемые Leaflet внутри.
Большинство функций, ожидающих или возвращающих HTMLElement, также работают для элементов SVG. Единственное различие заключается в том, что классы относятся к классам CSS в HTML и классам SVG в SVG.
Функции
| Функция | Возвращает | Описание |
|---|---|---|
get( | HTMLElement | Возвращает элемент по его идентификатору DOM или сам элемент, если он был передан напрямую. |
getStyle( | String | Возвращает значение атрибута стиля элемента, включая вычисленные значения или значения, установленные через CSS. |
create( | HTMLElement | Создаёт HTML-элемент с tagName, устанавливает его класс в className, и, по желанию, добавляет его в элемент container. |
remove( | Удаляет el из его родительского элемента | |
empty( | Удаляет все дочерние элементы el из el
| |
toFront( | Делает el последним дочерним элементом его родителя, так что он отображается поверх других дочерних элементов. | |
toBack( | Делает el первым дочерним элементом его родителя, так что он отображается под другими дочерними элементами. | |
hasClass( | Boolean | Возвращает true, если атрибут класса элемента содержит name. |
addClass( | Добавляет name к атрибуту класса элемента. | |
removeClass( | Удаляет name из атрибута класса элемента. | |
setClass( | Устанавливает класс элемента. | |
getClass( | String | Возвращает класс элемента. |
setOpacity( | Устанавливает непрозрачность элемента (включая поддержку старых IE). opacity должно быть числом от 0 до 1. | |
testProp( | String|false | Проходит по массиву имён стилей и возвращает первое имя, которое является допустимым именем стиля для элемента. Если такое имя не найдено, возвращает false. Полезно для стилей с префиксом производителя, таких как transform. |
setTransform( | Сбрасывает 3D CSS преобразование el, чтобы оно было смещено на offset пикселей и, по желанию, масштабировано на scale. Не оказывает влияния, если браузер не поддерживает 3D CSS преобразования. | |
setPosition( | Устанавливает положение el в координаты, заданные position, используя CSS translate или позиционирование top/left в зависимости от браузера (используется Leaflet внутри для позиционирования его слоёв). | |
getPosition( | Point | Возвращает координаты элемента, ранее позиционированного с помощью setPosition. |
disableTextSelection() | Предотвращает генерацию пользователем selectstart событий DOM, которые обычно генерируются при перетаскивании мышью текста по странице. Внутренне используется Leaflet для переопределения поведения любого взаимодействия с нажатием и перетаскиванием на карте. Влияет на взаимодействия с перетаскиванием на всей странице. | |
enableTextSelection() | Отменяет действие предыдущего L.DomUtil.disableTextSelection. | |
disableImageDrag() | Как L.DomUtil.disableTextSelection, но для dragstart событий DOM, которые обычно генерируются при перетаскивании изображения. | |
enableImageDrag() | Отменяет действие предыдущего L.DomUtil.disableImageDrag. | |
preventOutline( | Делает рамку элемента el невидимой. Внутренне используется Leaflet для предотвращения отображения рамки фокусируемых элементов при выполнении пользователем взаимодействия с перетаскиванием. | |
restoreOutline() | Отменяет действие предыдущего L.DomUtil.preventOutline. | |
getSizedParentNode( | HTMLElement | Находит ближайшего родительского узла, размер (ширина и высота) которого не равен null. |
getScale( | Object | Вычисляет текущее CSS масштабирование, применённое к элементу. Возвращает объект с x и y членами в качестве горизонтального и вертикального масштаба соответственно, а также boundingClientRect в качестве результата getBoundingClientRect(). |
Свойства
| Свойство | Тип | Описание |
|---|---|---|
TRANSFORM | String | Имя стиля трансформации с префиксом производителя (например, 'webkitTransform' для WebKit). |
TRANSITION | String | Имя стиля перехода с префиксом производителя. |
TRANSITION_END | String | Имя события transitionend с префиксом производителя. |
PosAnimation
Используется во внутренних анимациях перемещения, используя CSS3 переходы для современных браузеров и таймер в качестве резерва для IE6-9.
Пример использования
var myPositionMarker = L.marker([48.864716, 2.294694]).addTo(map);
myPositionMarker.on("click", function() {
var pos = map.latLngToLayerPoint(myPositionMarker.getLatLng());
pos.y -= 25;
var fx = new L.PosAnimation();
fx.once('end',function() {
pos.y += 25;
fx.run(myPositionMarker._icon, pos, 0.8);
});
fx.run(myPositionMarker._icon, pos, 0.3);
});
Конструктор
| Конструктор | Описание |
|---|---|
L.PosAnimation() | Создаёт объект PosAnimation. |
События
| Событие | Данные | Описание |
|---|---|---|
start | Event | Срабатывает при запуске анимации |
step | Event | Срабатывает непрерывно во время анимации. |
end | Event | Срабатывает по завершении анимации. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
run( |
Запускает анимацию данного элемента в новое положение, опционально устанавливая продолжительность в секундах ( | |
stop() |
Останавливает анимацию (если она в настоящее время выполняется). |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-обработчик ( |
on( | this |
Добавляет набор пар тип/обработчик, например, |
off( | this |
Удаляет ранее добавленную функцию-обработчик. Если функция не указана, будут удалены все обработчики данного события для объекта. Обратите внимание, что если вы передали пользовательский контекст для |
off( | this |
Удаляет набор пар тип/обработчик. |
off() | this |
Удаляет всех обработчиков всех событий объекта. Включая неявно присоединённые события. |
fire( | this |
Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — свойства этого объекта будут в первом аргументе функции-обработчика. Событие необязательно может быть распространено на родительские элементы. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родительский элемент события — |
removeEventParent( | this |
Удаляет родительский элемент события, чтобы он перестал получать распространяемые события |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
Перетаскиваемый
Класс для создания перетаскиваемых элементов DOM (включая поддержку сенсорного ввода). Используется внутри для перетаскивания карт и маркеров. Работает только с элементами, позиционированными с помощью L.DomUtil.setPosition.
Пример использования
var draggable = new L.Draggable(elementToDrag); draggable.enable();
Конструктор
| Конструктор | Описание |
|---|---|
L.Draggable( | Создаёт объект Draggable для перемещения el при начальном перетаскивании элемента dragHandle (по умолчанию совпадает с самим el). |
Параметры
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
clickTolerance | Number | 3 | Максимальное количество пикселей, которое пользователь может сместить указатель мыши во время нажатия, чтобы оно считалось допустимым нажатием (в отличие от перетаскивания мыши). |
События
| Событие | Данные | Описание |
|---|---|---|
down | Event | Вызывается, когда начинается перетаскивание. |
dragstart | Event | Вызывается при начале перетаскивания. |
predrag | Event | Вызывается непрерывно во время перетаскивания до каждого соответствующего обновления позиции элемента. |
drag | Event | Вызывается непрерывно во время перетаскивания. |
dragend | DragEndEvent | Вызывается при завершении перетаскивания. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
enable() |
Включает возможность перетаскивания | |
disable() |
Отключает возможность перетаскивания |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-обработчик ( |
on( | this |
Добавляет набор пар тип/обработчик, например, |
off( | this |
Удаляет ранее добавленную функцию-обработчик. Если функция не указана, удаляет всех обработчиков данного события из объекта. Обратите внимание, что если вы передавали пользовательский контекст для |
off( | this |
Удаляет набор пар тип/обработчик. |
off() | this |
Удаляет все обработчики всех событий объекта. Включая неявные присоединенные события. |
fire( | this |
Вызывает событие указанного типа. Вы можете дополнительно предоставить объект данных — первое аргумент функции-обработчика будет содержать его свойства. Событие может быть дополнительно распространено на родительские элементы. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родительский элемент события — |
removeEventParent( | this |
Удаляет родительский элемент события, чтобы он перестал получать распространяемые события |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
Класс
L.Class обеспечивает возможности ООП в Leaflet и используется для создания почти всех классов Leaflet, описанных здесь.
Помимо реализации простой модели наследования, он вводит несколько специальных свойств для удобной организации кода — параметры, включения и статические свойства.
Пример использования
var MyClass = L.Class.extend({
initialize: function (greeter) {
this.greeter = greeter;
// class constructor
},
greet: function (name) {
alert(this.greeter + ', ' + name)
}
});
// create instance of MyClass, passing "Hello" to the constructor
var a = new MyClass("Hello");
// call greet method, alerting "Hello, World"
a.greet("World");
Фабрики классов
Вы могли заметить, что объекты Leaflet создаются без использования ключевого слова new. Это достигается путем дополнения каждого класса методом-фабрикой в нижнем регистре:
new L.Map('map'); // becomes:
L.map('map');
Фабрики реализуются очень просто, и вы можете сделать это для собственных классов:
L.map = function (id, options) {
return new L.Map(id, options);
};
Наследование
Вы используете L.Class.extend для определения новых классов, но вы можете использовать этот же метод для любого класса, чтобы унаследовать от него:
var MyChildClass = MyClass.extend({
// ... new properties and methods
});
Это создаст класс, который наследует все методы и свойства родительского класса (через правильную цепочку прототипов), добавляя или переопределяя те, которые вы передаёте для расширения. Он также будет корректно реагировать на instanceof:
var a = new MyChildClass(); a instanceof MyChildClass; // true a instanceof MyClass; // true
Вы можете вызывать методы родительского класса (включая конструктор) из соответствующих методов дочернего класса (как вы делаете с вызовами super в других языках), обращаясь к прототипу родительского класса и используя JavaScript's call или apply:
var MyChildClass = MyClass.extend({
initialize: function () {
MyClass.prototype.initialize.call(this, "Yo");
},
greet: function (name) {
MyClass.prototype.greet.call(this, 'bro ' + name + '!');
}
});
var a = new MyChildClass();
a.greet('Jason'); // alerts "Yo, bro Jason!"
Параметры
options — это специальное свойство, которое, в отличие от других объектов, которые вы передаёте в extend, будет слито с родительским объектом вместо полного его переопределения, что делает удобным управление конфигурацией объектов и значениями по умолчанию:
var MyClass = L.Class.extend({
options: {
myOption1: 'foo',
myOption2: 'bar'
}
});
var MyChildClass = MyClass.extend({
options: {
myOption1: 'baz',
myOption3: 5
}
});
var a = new MyChildClass();
a.options.myOption1; // 'baz'
a.options.myOption2; // 'bar'
a.options.myOption3; // 5
Также есть L.Util.setOptions, метод для удобного слияния параметров, переданных конструктору, со значениями по умолчанию, определёнными в классе:
var MyClass = L.Class.extend({
options: {
foo: 'bar',
bla: 5
},
initialize: function (options) {
L.Util.setOptions(this, options);
...
}
});
var a = new MyClass({bla: 10});
a.options; // {foo: 'bar', bla: 10}
Обратите внимание, что объект параметров допускает любые ключи, а не только те, которые определены классом и его базовыми классами. Это означает, что вы можете использовать объект параметров для хранения информации, специфичной для приложения, при условии, что вы избегаете ключей, уже используемых в рассматриваемом классе.
Включения
includes — это специальное свойство класса, которое сливает все указанные объекты в класс (такие объекты называются миксинами).
var MyMixin = {
foo: function () { ... },
bar: 5
};
var MyClass = L.Class.extend({
includes: MyMixin
});
var a = new MyClass();
a.foo();
Вы также можете выполнять такие включения во время выполнения с помощью метода include:
MyClass.include(MyMixin);
statics — это просто свойство для удобства, которое вставляет указанные свойства объекта в качестве статических свойств класса, полезное для определения констант:
var MyClass = L.Class.extend({
statics: {
FOO: 'bar',
BLA: 5
}
});
MyClass.FOO; // 'bar'
Обработчики конструктора
Если вы разработчик плагинов, вам часто нужно добавлять дополнительный код инициализации к существующим классам (например, редактирование обработчиков для L.Polyline). Leaflet предоставляет способ сделать это легко с помощью метода addInitHook:
MyClass.addInitHook(function () {
// ... do something in constructor additionally
// e.g. add event listeners, set custom properties etc.
});
Вы также можете использовать следующее сокращение, когда вам нужно просто выполнить один дополнительный вызов метода:
MyClass.addInitHook('methodName', arg1, arg2, …);
Функции
| Функция | Возвращает | Описание |
|---|---|---|
extend( | Function |
Расширяет текущий класс с учётом переданных свойств. Возвращает функцию JavaScript, которая является конструктором класса (для вызова с new). |
include( | this | Включает миксин в текущий класс. |
mergeOptions( | this |
Объединяет options со значениями по умолчанию класса. |
addInitHook( | this | Добавляет обработчик конструктора в класс. |
Событийный
Набор методов, общих для классов, работающих с событиями (например, Map и Marker). Как правило, события позволяют вам выполнить некоторую функцию, когда что-то происходит с объектом (например, пользователь нажимает на карту, вызывая событие 'click').
Пример использования
map.on('click', function(e) {
alert(e.latlng);
} );
Leaflet обрабатывает слушателей событий по ссылке, поэтому, если вы хотите добавить слушателя, а затем удалить его, определите его как функцию:
function onClick(e) { ... }
map.on('click', onClick);
map.off('click', onClick);
Методы
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-слушатель ( |
on( | this |
Добавляет набор пар тип/слушатель, например |
off( | this |
Удаляет ранее добавленную функцию-слушателя. Если функция не указана, он удалит всех слушателей этого конкретного события из объекта. Обратите внимание, что если вы передали пользовательский контекст в |
off( | this |
Удаляет набор пар тип/слушатель. |
off() | this |
Удаляет всех слушателей всех событий в объекте. Это включает неявно присоединённые события. |
fire( | this |
Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — первый аргумент функции слушателя будет содержать его свойства. Событие может быть необязательно распространено на родительские события. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родителя события — |
removeEventParent( | this |
Удаляет родителя события, так что он перестанет получать распространяемые события |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
Слой
Набор методов из базового класса Layer, которые используют все слои Leaflet. Наследует все методы, параметры и события из L.Evented.
Пример использования
var layer = L.marker(latlng).addTo(map); layer.addTo(map); layer.remove();
Параметры
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
pane | String | 'overlayPane' | По умолчанию слой будет добавлен к слою наложения карты. Переопределение этого параметра вызовет размещение слоя по умолчанию на другом слое. |
attribution | String | null | Строка, отображаемая в элементе управления атрибуцией, например, «© OpenStreetMap contributors». Она описывает данные слоя и часто является юридическим обязательством перед правообладателями и поставщиками тайлов. |
События
| Событие | Данные | Описание |
|---|---|---|
add | Event | Срабатывает после добавления слоя на карту |
remove | Event | Срабатывает после удаления слоя с карты |
События всплывающей подсказки
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Срабатывает при открытии всплывающей подсказки, привязанной к этому слою |
popupclose | PopupEvent | Срабатывает при закрытии всплывающей подсказки, привязанной к этому слою |
События всплывающей подсказки
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Срабатывает при открытии всплывающей подсказки, привязанной к этому слою. |
tooltipclose | TooltipEvent | Срабатывает при закрытии всплывающей подсказки, привязанной к этому слою. |
Методы
L.Layer, унаследуют следующие методы:| Метод | Возвращает | Описание |
|---|---|---|
addTo( | this |
Добавляет слой на заданную карту или группу слоев. |
remove() | this |
Удаляет слой с карты, на которой он в настоящее время активен. |
removeFrom( | this |
Удаляет слой со заданной карты. |
removeFrom( | this |
Удаляет слой из заданной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется |
Методы расширения
L.Layer и (пере)реализовывать следующие методы.| Метод | Возвращает | Описание |
|---|---|---|
onAdd( | this |
Должно содержать код, который создает DOM-элементы для слоя, добавляет их в |
onRemove( | this |
Должно содержать весь код очистки, который удаляет элементы слоя из DOM и удаляет обработчики событий, добавленные ранее в |
getEvents() | Object |
Этот необязательный метод должен возвращать объект, подобный |
getAttribution() | String |
Этот необязательный метод должен возвращать строку, содержащую HTML, который будет отображаться на |
beforeAdd( | this |
Необязательный метод. Вызывается при |
Методы всплывающих окон
var layer = L.Polygon(latlngs).bindPopup('Hi There!').addTo(map);
layer.openPopup();
layer.closePopup();
Всплывающие окна также будут автоматически открываться при щелчке по слою и закрываться при удалении слоя с карты или открытии другого всплывающего окна.
| Метод | Возвращает | Описание |
|---|---|---|
bindPopup( | this |
Привязывает всплывающее окно к слою с переданным |
unbindPopup() | this |
Удаляет всплывающее окно, ранее связанное с |
openPopup( | this |
Открывает связанное всплывающее окно в указанной |
closePopup() | this |
Закрывает привязанное к этому слою всплывающее окно, если оно открыто. |
togglePopup() | this |
Открывает или закрывает связанное с этим слоем всплывающее окно в зависимости от его текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающего окна, связанного с этим слоем. |
getPopup() | Popup |
Возвращает всплывающее окно, привязанное к этому слою. |
Методы подсказок
var layer = L.Polygon(latlngs).bindTooltip('Hi There!').addTo(map);
layer.openTooltip();
layer.closeTooltip();
| Метод | Возвращает | Описание |
|---|---|---|
bindTooltip( | this |
Привязывает подсказку к слою с переданным |
unbindTooltip() | this |
Удаляет подсказку, ранее связанную с |
openTooltip( | this |
Открывает привязанную подсказку в указанной |
closeTooltip() | this |
Закрывает привязанную к этому слою подсказку, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает привязанную к этому слою подсказку в зависимости от её текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое подсказки, привязанной к этому слою. |
getTooltip() | Tooltip |
Возвращает подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-обработчик ( |
on( | this |
Добавляет набор пар тип/обработчик, например |
off( | this |
Удаляет ранее добавленную функцию-обработчик. Если функция не указана, она удалит все обработчики этого конкретного события из объекта. Обратите внимание, что если вы передали пользовательский контекст в |
off( | this |
Удаляет набор пар тип/обработчик. |
off() | this |
Удаляет все обработчики всех событий в объекте. Это включает и неявные события. |
fire( | this |
Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — первый аргумент функции-обработчика будет содержать его свойства. Событие необязательно может быть распространено на родительские события. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родительский элемент события — |
removeEventParent( | this |
Удаляет родительский элемент события, так что он перестанет получать распространяемые события. |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
Интерактивный слой
Некоторые Layer можно сделать интерактивными — при взаимодействии пользователя с таким слоем можно обработать события мыши, такие как click и mouseover. Используйте методы обработки событий обработки событий для обработки этих событий.
Параметры
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
interactive | Boolean | true | Если false, слой не будет генерировать события мыши и будет действовать как часть базовой карты. |
bubblingMouseEvents | Boolean | true | Когда true, событие мыши на этом слое вызовет то же событие на карте (если не используется L.DomEvent.stopPropagation). |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
pane | String | 'overlayPane' | По умолчанию слой будет добавлен на панель перекрытий (overlay pane) карты. Переопределение этого параметра приведет к размещению слоя на другой панели по умолчанию. |
attribution | String | null | Строка, отображаемая в элементе управления атрибутами, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридической обязанностью по отношению к правообладателям и поставщикам тайлов. |
События
События мыши
| Событие | Данные | Описание |
|---|---|---|
click | MouseEvent | Вызывается при щелчке (или нажатии) по слою пользователем. |
dblclick | MouseEvent | Вызывается при двойном щелчке (или двойном нажатии) по слою пользователем. |
mousedown | MouseEvent | Вызывается при нажатии пользователем кнопки мыши на слое. |
mouseup | MouseEvent | Вызывается при отпускании пользователем кнопки мыши, нажатой на слое. |
mouseover | MouseEvent | Вызывается при входе курсора мыши в слой. |
mouseout | MouseEvent | Вызывается при выходе курсора мыши из слоя. |
contextmenu | MouseEvent | Вызывается при правом щелчке на слое пользователем. Блокирует отображение контекстного меню браузера по умолчанию, если имеются обработчики этого события. Также вызывается на мобильных устройствах при удержании одного касания в течение секунды (также называется удержанием). |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Вызывается после добавления слоя на карту. |
remove | Event | Вызывается после удаления слоя с карты. |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Вызывается при открытии всплывающего окна, привязанного к этому слою. |
popupclose | PopupEvent | Вызывается при закрытии всплывающего окна, привязанного к этому слою. |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Вызывается при открытии всплывающей подсказки, привязанной к этому слою. |
tooltipclose | TooltipEvent | Вызывается при закрытии всплывающей подсказки, привязанной к этому слою. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
addTo( | this |
Добавляет слой на заданную карту или группу слоев. |
remove() | this |
Удаляет слой с карты, на которой он в настоящее время активен. |
removeFrom( | this |
Удаляет слой со заданной карты. |
removeFrom( | this |
Удаляет слой из заданной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется элементом управления атрибутами, возвращает параметр атрибута. |
| Метод | Возвращает | Описание |
|---|---|---|
bindPopup( | this |
Привязывает всплывающее окно к слою с переданным |
unbindPopup() | this |
Удаляет всплывающее окно, ранее привязанное с помощью |
openPopup( | this |
Открывает привязанное всплывающее окно в указанной |
closePopup() | this |
Закрывает всплывающее окно, привязанное к этому слою, если оно открыто. |
togglePopup() | this |
Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающего окна, привязанного к этому слою. |
getPopup() | Popup |
Возвращает всплывающее окно, привязанное к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
bindTooltip( | this |
Привязывает всплывающую подсказку к слою с переданным |
unbindTooltip() | this |
Удаляет всплывающую подсказку, ранее привязанную с помощью |
openTooltip( | this |
Открывает привязанную всплывающую подсказку в указанной |
closeTooltip() | this |
Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от ее текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое всплывающей подсказки, привязанной к этому слою. |
getTooltip() | Tooltip |
Возвращает всплывающую подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-слушатель ( |
on( | this |
Добавляет набор пар тип/слушатель, например, |
off( | this |
Удаляет ранее добавленную функцию-слушатель. Если функция не указана, удаляются все слушатели этого конкретного события от объекта. Обратите внимание, что если вы передали пользовательский контекст для |
off( | this |
Удаляет набор пар тип/слушатель. |
off() | this |
Удаляет всех слушателей всех событий объекта. Это включает неявные привязанные события. |
fire( | this |
Вызывает событие указанного типа. Можно дополнительно указать объект данных — свойства этого объекта будут содержаться в первом аргументе функции-слушателя. Событие можно распространить на родительские элементы. |
listens( | Boolean |
Возвращает |
once(…) | this |
Ведёт себя как |
addEventParent( | this |
Добавляет родительский элемент события — |
removeEventParent( | this |
Удаляет родительский элемент события, чтобы он перестал получать распространяемые события |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
Управление
L.Control — базовый класс для реализации элементов управления картой. Обрабатывает позиционирование. Все остальные элементы управления наследуются от этого класса.
Параметры
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
position | String | 'topright' | Позиция элемента управления (один из углов карты). Возможные значения: 'topleft', 'topright', 'bottomleft' или 'bottomright'
|
Методы
| Метод | Возвращает | Описание |
|---|---|---|
getPosition() | string |
Возвращает позицию элемента управления. |
setPosition( | this |
Устанавливает позицию элемента управления. |
getContainer() | HTMLElement |
Возвращает HTMLElement, содержащий элемент управления. |
addTo( | this |
Добавляет элемент управления на данную карту. |
remove() | this |
Удаляет элемент управления с карты, на которой он сейчас активен. |
Расширяющие методы
L.Control и (пере)определять следующие методы.| Метод | Возвращает | Описание |
|---|---|---|
onAdd( | HTMLElement |
Должен вернуть элемент DOM-контейнера для элемента управления и добавить слушатели на соответствующие события карты. Вызывается при |
onRemove( |
Необязательный метод. Должен содержать весь код очистки, удаляющий слушателей, добавленных ранее в |
Обработчик
Абстрактный класс для обработчиков взаимодействия с картой
Методы
| Метод | Возвращает | Описание |
|---|---|---|
enable() | this |
Включает обработчик |
disable() | this |
Отключает обработчик |
enabled() | Boolean |
Возвращает |
Расширяющие методы
Handler, должны реализовать два следующих метода:| Метод | Возвращает | Описание |
|---|---|---|
addHooks() |
Вызывается при включении обработчика, должен добавить крючки событий. | |
removeHooks() |
Вызывается при отключении обработчика, должен удалить ранее добавленные крючки событий. |
Функции
Существует статическая функция, которую можно вызвать без создания экземпляра L.Handler:
| Функция | Возвращает | Описание |
|---|---|---|
addTo( | this | Добавляет новый Handler на данную карту с заданным именем. |
Проекция
Объект с методами для проектирования географических координат мира на плоскую поверхность (и обратно). См. Проекция карты.
Методы
| Метод | Возвращает | Описание |
|---|---|---|
project( | Point |
Проецирует географические координаты в 2D точку. Принимает только экземпляры |
unproject( | LatLng |
Обратная функция Обратите внимание, что экземпляры проекции не наследуются от объекта Leaflet's |
Свойства
| Свойство | Тип | Описание |
|---|---|---|
bounds | Bounds | Границы (указанные в единицах CRS), где проекция действительна |
Определённые проекции
| Проекция | Описание |
|---|---|
L.Projection.LonLat | Прямоугольная, или проекция Плана Карре — самая простая проекция, чаще всего используемая энтузиастами ГИС. Прямо отображает x как долготу, а y как широту. Также подходит для плоских миров, например, карт игр. Используется CRS EPSG:4326 и Simple. |
L.Projection.Mercator | Эллиптическая проекция Меркатора — более сложная, чем сферическая Меркатора. Предполагает, что Земля — эллипсоид. Используется CRS EPSG:3395. |
L.Projection.SphericalMercator | Сферическая проекция Меркатора — наиболее распространённая проекция для онлайн-карт, используемая почти всеми бесплатными и коммерческими поставщиками тайлов. Предполагает, что Земля — сфера. Используется CRS EPSG:3857. |
CRS
Методы
| Метод | Возвращает | Описание |
|---|---|---|
latLngToPoint( | Point |
Проецирует географические координаты в пиксельные координаты для заданного масштаба. |
pointToLatLng( | LatLng |
Обратное преобразование к |
project( | Point |
Проецирует географические координаты в координаты, используемые в данной СКС (например, метры для EPSG:3857, для передачи в службы WMS). |
unproject( | LatLng |
Для заданной спроецированной координаты возвращает соответствующую LatLng. Обратное преобразование к |
scale( | Number |
Возвращает масштаб, используемый при преобразовании спроецированных координат в пиксельные координаты для конкретного масштаба. Например, он возвращает |
zoom( | Number |
Обратное преобразование к |
getProjectedBounds( | Bounds |
Возвращает границы проекции, масштабированные и преобразованные для предоставленного |
distance( | Number |
Возвращает расстояние между двумя географическими координатами. |
wrapLatLng( | LatLng |
Возвращает |
wrapLatLngBounds( | LatLngBounds |
Возвращает |
Свойства
| Свойство | Тип | Описание |
|---|---|---|
code | String | Стандартное кодовое имя СКС, передаваемое в службы WMS (например, 'EPSG:3857'). |
wrapLng | Number[] | Массив из двух чисел, определяющий, обёртывается ли ось координат долготы (горизонтальная) вокруг заданного диапазона и как. По умолчанию [-180, 180] в большинстве географических СКС. Если undefined, ось долготы не обёртывается. |
wrapLat | Number[] | Как wrapLng, но для оси широты (вертикальной). |
infinite | Boolean | Если true, координатное пространство будет неограниченным (бесконечным по обеим осям). |
Определенные СКС
| СКС | Описание |
|---|---|
L.CRS.Earth | Служит основой для СКС, которые являются глобальными, так что они покрывают Землю. Может использоваться только как основа для других СКС и не может использоваться напрямую, так как не имеет code, projection или transformation. distance() возвращает метры. |
L.CRS.EPSG3395 | Редко используется некоторыми коммерческими поставщиками плиток. Использует эллиптическую проекцию Меркатора. |
L.CRS.EPSG3857 | Самая распространённая СКС для онлайн-карт, используемая почти всеми бесплатными и коммерческими поставщиками плиток. Использует сферическую проекцию Меркатора. Устанавливается по умолчанию в опции Map's crs . |
L.CRS.EPSG4326 | Распространённая СКС среди специалистов по ГИС. Использует простую прямоугольную проекцию. Leaflet 1.0.x соответствует схеме координат TMS для EPSG:4326, что является изменением поведения по сравнению с 0.7.x. Если вы используете |
L.CRS.Base | Объект, определяющий системы координат для проецирования географических точек в пиксельные (экранные) координаты и обратно (и в координаты в других единицах для сервисов WMS). См. систему пространственной привязки. Leaflet по умолчанию определяет наиболее распространённые СКС. Если вы хотите использовать СКС, не определённую по умолчанию, ознакомьтесь с плагином Proj4Leaflet. Обратите внимание, что экземпляры CRS не наследуются от объекта Leaflet's |
L.CRS.Simple | Простая СКС, которая отображает долготу и широту в x и y напрямую. Может использоваться для карт плоских поверхностей (например, карт игр). Обратите внимание, что ось y всё равно должна быть инвертирована (идёт снизу вверх). distance() возвращает простое евклидово расстояние. |
Рендерер
Базовый класс для реализаций рендереров векторов (SVG, Canvas). Обрабатывает контейнер DOM рендерера, его границы и анимацию масштаба.
Рендерер работает как неявная группа слоёв для всех Path - сам рендерер может быть добавлен или удалён на карту. Все пути используют рендерер, который может быть неявным (карта сама определит тип рендерера и автоматически его использует) или явным (используя опцию renderer пути).
Не используйте этот класс напрямую, используйте SVG и Canvas вместо него.
Параметры
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
padding | Number | 0.1 | Насколько нужно расширить область обрезки вокруг представления карты (относительно её размера), например, 0,1 будет 10% от представления карты в каждом направлении |
| Параметр | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
pane | String | 'overlayPane' | По умолчанию слой будет добавлен к слою наложения карты. Переопределение этого параметра заставит слой размещаться на другом слое по умолчанию. |
attribution | String | null | Строка, отображаемая в элементе управления подписями, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридическим обязательством по отношению к правообладателям и поставщикам плиток. |
События
| Событие | Данные | Описание |
|---|---|---|
update | Event | Вызывается, когда рендерер обновляет свои границы, центр и масштаб, например, когда его карта перемещена |
| Событие | Данные | Описание |
|---|---|---|
add | Event | Вызывается после добавления слоя на карту |
remove | Event | Вызывается после удаления слоя с карты |
| Событие | Данные | Описание |
|---|---|---|
popupopen | PopupEvent | Вызывается при открытии всплывающего окна, привязанного к этому слою |
popupclose | PopupEvent | Вызывается при закрытии всплывающего окна, привязанного к этому слою |
| Событие | Данные | Описание |
|---|---|---|
tooltipopen | TooltipEvent | Вызывается при открытии подсказки, привязанной к этому слою. |
tooltipclose | TooltipEvent | Вызывается при закрытии подсказки, привязанной к этому слою. |
Методы
| Метод | Возвращает | Описание |
|---|---|---|
addTo( | this |
Добавляет слой на заданную карту или группу слоев. |
remove() | this |
Удаляет слой с карты, на которой он в настоящее время активен. |
removeFrom( | this |
Удаляет слой с указанной карты. |
removeFrom( | this |
Удаляет слой из указанной |
getPane( | HTMLElement |
Возвращает |
getAttribution() | String |
Используется |
| Метод | Возвращает | Описание |
|---|---|---|
bindPopup( | this |
Привязывает всплывающее окно к слою с переданным |
unbindPopup() | this |
Удаляет всплывающее окно, ранее привязанное с помощью |
openPopup( | this |
Открывает привязанное всплывающее окно в указанной |
closePopup() | this |
Закрывает всплывающее окно, привязанное к этому слою, если оно открыто. |
togglePopup() | this |
Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния. |
isPopupOpen() | boolean |
Возвращает |
setPopupContent( | this |
Устанавливает содержимое всплывающего окна, привязанного к этому слою. |
getPopup() | Popup |
Возвращает всплывающее окно, привязанное к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
bindTooltip( | this |
Привязывает подсказку к слою с переданным |
unbindTooltip() | this |
Удаляет подсказку, ранее привязанную с помощью |
openTooltip( | this |
Открывает привязанную подсказку в указанной |
closeTooltip() | this |
Закрывает подсказку, привязанную к этому слою, если она открыта. |
toggleTooltip() | this |
Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от её текущего состояния. |
isTooltipOpen() | boolean |
Возвращает |
setTooltipContent( | this |
Устанавливает содержимое подсказки, привязанной к этому слою. |
getTooltip() | Tooltip |
Возвращает подсказку, привязанную к этому слою. |
| Метод | Возвращает | Описание |
|---|---|---|
on( | this |
Добавляет функцию-обработчик ( |
on( | this |
Добавляет набор пар тип/обработчик, например, |
off( | this |
Удаляет ранее добавленную функцию-обработчик. Если функция не указана, удалит всех обработчиков указанного события из объекта. Обратите внимание, если вы передали пользовательский контекст в |
off( | this |
Удаляет набор пар тип/обработчик. |
off() | this |
Удаляет всех обработчиков всех событий в объекте. Включает неявные привязки событий. |
fire( | this |
Вызывает событие указанного типа. Можно дополнительно передать объект данных — свойства объекта будут первым аргументом функции-обработчика. Событие может быть распространено на родительские объекты. |
listens( | Boolean |
Возвращает |
once(…) | this |
Поведение как |
addEventParent( | this |
Добавляет родительский объект события — |
removeEventParent( | this |
Удаляет родительский объект события, чтобы он перестал получать распространяемые события. |
addEventListener(…) | this |
Псевдоним для |
removeEventListener(…) | this |
Псевдоним для |
clearAllEventListeners(…) | this |
Псевдоним для |
addOneTimeEventListener(…) | this |
Псевдоним для |
fireEvent(…) | this |
Псевдоним для |
hasEventListeners(…) | Boolean |
Псевдоним для |
Объекты событий
Всякий раз, когда класс, унаследованный от Evented, вызывает событие, функция-обработчик будет вызвана с аргументом события, который является обычным объектом, содержащим информацию о событии. Например:
map.on('click', function(ev) {
alert(ev.latlng); // ev is an event object (MouseEvent in this case)
});
Доступная информация зависит от типа события:
Событие
| Свойство | Тип | Описание |
|---|---|---|
type | String | Тип события (например, 'click'). |
target | Object | Объект, вызвавший событие. Для распространяемых событий — последний объект в цепочке распространения, который вызвал событие. |
sourceTarget | Object | Объект, который первоначально вызвал событие. Для неспраространяемых событий — это будет то же, что и target. |
propagatedFrom | Object | Для распространяемых событий — последний объект, который распространил событие к его родительскому объекту события. |
layer | Object |
Устаревшее. То же, что и propagatedFrom. |
KeyboardEvent
| Свойство | Тип | Описание |
|---|---|---|
originalEvent | DOMEvent | Исходное DOM KeyboardEvent, которое спровоцировало это событие Leaflet. |
| Свойство | Тип | Описание |
|---|---|---|
type | String | Тип события (например, 'click'). |
target | Object | Объект, сгенерировавший событие. Для прошедших событий - последний объект в цепочке распространения, который сгенерировал событие. |
sourceTarget | Object | Объект, первоначально сгенерировавший событие. Для непрошедших событий, этот объект будет таким же, как target. |
propagatedFrom | Object | Для прошедших событий, последний объект, который распространил событие к его родительскому объекту события. |
layer | Object |
Устаревшее. То же самое, что и propagatedFrom. |
MouseEvent
| Свойство | Тип | Описание |
|---|---|---|
latlng | LatLng | Географическая точка, где произошло событие мыши. |
layerPoint | Point | Координаты пикселей точки, где произошло событие мыши относительно слоя карты. |
containerPoint | Point | Координаты пикселей точки, где произошло событие мыши относительно контейнера карты. |
originalEvent | DOMEvent | Исходное DOM-событие MouseEvent или DOM-событие TouchEvent, которое вызвало это событие Leaflet. |
| Свойство | Тип | Описание |
|---|---|---|
type | String | Тип события (например, 'click'). |
target | Object | Объект, сгенерировавший событие. Для прошедших событий - последний объект в цепочке распространения, который сгенерировал событие. |
sourceTarget | Object | Объект, первоначально сгенерировавший событие. Для непрошедших событий, этот объект будет таким же, как target. |
propagatedFrom | Object | Для прошедших событий, последний объект, который распространил событие к его родительскому объекту события. |
layer | Object |
Устаревшее. То же самое, что и propagatedFrom. |
LocationEvent
| Свойство | Тип | Описание |
|---|---|---|
latlng | LatLng | Обнаруженное географическое местоположение пользователя. |
bounds | LatLngBounds | Географические границы области, в которой находится пользователь (с учетом точности местоположения). |
accuracy | Number | Точность местоположения в метрах. |
altitude | Number | Высота положения над эллипсоидом WGS84 в метрах. |
altitudeAccuracy | Number | Точность высоты в метрах. |
heading | Number | Направление движения в градусах по часовой стрелке от истинного севера. |
speed | Number | Текущая скорость в метрах в секунду. |
timestamp | Number | Время получения позиции. |
| Свойство | Тип | Описание |
|---|---|---|
type | String | Тип события (например, 'click'). |
target | Object | Объект, сгенерировавший событие. Для прошедших событий - последний объект в цепочке распространения, который сгенерировал событие. |
sourceTarget | Object | Объект, первоначально сгенерировавший событие. Для непрошедших событий, этот объект будет таким же, как target. |
propagatedFrom | Object | Для прошедших событий, последний объект, который распространил событие к его родительскому объекту события. |
layer | Object |
Устаревшее. То же самое, что и propagatedFrom. |
ErrorEvent
| Свойство | Тип | Описание |
|---|---|---|
message | String | Сообщение об ошибке. |
code | Number | Код ошибки (если применимо). |
| Свойство | Тип | Описание |
|---|---|---|
type | String | Тип события (например, 'click'). |
target | Object | Объект, сгенерировавший событие. Для прошедших событий - последний объект в цепочке распространения, который сгенерировал событие. |
sourceTarget | Object | Объект, первоначально сгенерировавший событие. Для непрошедших событий, этот объект будет таким же, как target. |
propagatedFrom | Object | Для прошедших событий, последний объект, который распространил событие к его родительскому объекту события. |
layer | Object |
Устаревшее. То же самое, что и propagatedFrom. |
LayerEvent
| Свойство | Тип | Описание |
|---|---|---|
layer | Layer | Слой, который был добавлен или удален. |
| Свойство | Тип | Описание |
|---|---|---|
type | String | Тип события (например, 'click'). |
target | Object | Объект, сгенерировавший событие. Для прошедших событий - последний объект в цепочке распространения, который сгенерировал событие. |
sourceTarget | Object | Объект, первоначально сгенерировавший событие. Для непрошедших событий, этот объект будет таким же, как target. |
propagatedFrom | Object | Для прошедших событий, последний объект, который распространил событие к его родительскому объекту события. |
LayersControlEvent
| Свойство | Тип | Описание |
|---|---|---|
layer | Layer | Слой, который был добавлен или удален. |
name | String | Имя слоя, который был добавлен или удален. |
| Свойство | Тип | Описание |
|---|---|---|
type | String | Тип события (например, 'click'). |
target | Object | Объект, сгенерировавший событие. Для прошедших событий - последний объект в цепочке распространения, который сгенерировал событие. |
sourceTarget | Object | Объект, первоначально сгенерировавший событие. Для непрошедших событий, этот объект будет таким же, как target. |
propagatedFrom | Object | Для прошедших событий, последний объект, который распространил событие к его родительскому объекту события. |
TileEvent
| Свойство | Тип | Описание |
|---|---|---|
tile | HTMLElement | Элемент тайла (изображение). |
coords | Point | Объект точки с координатами тайла: x, y, и z (уровень масштабирования). |
| Свойство | Тип | Описание |
|---|---|---|
type | String | Тип события (например, 'click'). |
target | Object | Объект, сгенерировавший событие. Для проксированных событий — последний объект в цепочке распространения, сгенерировавший событие. |
sourceTarget | Object | Объект, который изначально сгенерировал событие. Для непроксированных событий — совпадает с target. |
propagatedFrom | Object | Для проксированных событий — последний объект, который распространил событие к его родительскому элементу. |
layer | Object |
Устаревшее. То же, что и propagatedFrom. |
TileErrorEvent
| Свойство | Тип | Описание |
|---|---|---|
tile | HTMLElement | Элемент тайла (изображение). |
coords | Point | Объект точки с координатами тайла: x, y, и z (уровень масштабирования). |
error | * | Ошибка, переданная в коллбэк тайла done() . |
| Свойство | Тип | Описание |
|---|---|---|
type | String | Тип события (например, 'click'). |
target | Object | Объект, сгенерировавший событие. Для проксированных событий — последний объект в цепочке распространения, сгенерировавший событие. |
sourceTarget | Object | Объект, который изначально сгенерировал событие. Для непроксированных событий — совпадает с target. |
propagatedFrom | Object | Для проксированных событий — последний объект, который распространил событие к его родительскому элементу. |
layer | Object |
Устаревшее. То же, что и propagatedFrom. |
ResizeEvent
| Свойство | Тип | Описание |
|---|---|---|
oldSize | Point | Размер до события изменения размера. |
newSize | Point | Размер после события изменения размера. |
| Свойство | Тип | Описание |
|---|---|---|
type | String | Тип события (например, 'click'). |
target | Object | Объект, сгенерировавший событие. Для проксированных событий — последний объект в цепочке распространения, сгенерировавший событие. |
sourceTarget | Object | Объект, который изначально сгенерировал событие. Для непроксированных событий — совпадает с target. |
propagatedFrom | Object | Для проксированных событий — последний объект, который распространил событие к его родительскому элементу. |
layer | Object |
Устаревшее. То же, что и propagatedFrom. |
GeoJSONEvent
| Свойство | Тип | Описание |
|---|---|---|
layer | Layer | Слой для геообъекта GeoJSON, который добавляется на карту. |
properties | Object | Свойства геообъекта GeoJSON. |
geometryType | String | Тип геометрии геообъекта GeoJSON. |
id | String | Идентификатор геообъекта GeoJSON (если есть). |
| Свойство | Тип | Описание |
|---|---|---|
type | String | Тип события (например, 'click'). |
target | Object | Объект, сгенерировавший событие. Для проксированных событий — последний объект в цепочке распространения, сгенерировавший событие. |
sourceTarget | Object | Объект, который изначально сгенерировал событие. Для непроксированных событий — совпадает с target. |
propagatedFrom | Object | Для проксированных событий — последний объект, который распространил событие к его родительскому элементу. |
PopupEvent
| Свойство | Тип | Описание |
|---|---|---|
popup | Popup | Открытый или закрытый всплывающее окно. |
| Свойство | Тип | Описание |
|---|---|---|
type | String | Тип события (например, 'click'). |
target | Object | Объект, сгенерировавший событие. Для проксированных событий — последний объект в цепочке распространения, сгенерировавший событие. |
sourceTarget | Object | Объект, который изначально сгенерировал событие. Для непроксированных событий — совпадает с target. |
propagatedFrom | Object | Для проксированных событий — последний объект, который распространил событие к его родительскому элементу. |
layer | Object |
Устаревшее. То же, что и propagatedFrom. |
TooltipEvent
| Свойство | Тип | Описание |
|---|---|---|
tooltip | Tooltip | Подсказка, которая была открыта или закрыта. |
| Свойство | Тип | Описание |
|---|---|---|
type | String | Тип события (например, 'click'). |
target | Object | Объект, сгенерировавший событие. Для проксированных событий — последний объект в цепочке распространения, сгенерировавший событие. |
sourceTarget | Object | Объект, который изначально сгенерировал событие. Для непроксированных событий — совпадает с target. |
propagatedFrom | Object | Для проксированных событий — последний объект, который распространил событие к его родительскому элементу. |
layer | Object |
Устаревшее. То же, что и propagatedFrom. |
DragEndEvent
| Свойство | Тип | Описание |
|---|---|---|
distance | Number | Расстояние в пикселях, на которое было перемещено элемент, подлежащий перетаскиванию. |
| Свойство | Тип | Описание |
|---|---|---|
type | String | Тип события (например, 'click'). |
target | Object | Объект, сгенерировавший событие. Для проксированных событий — последний объект в цепочке распространения, сгенерировавший событие. |
sourceTarget | Object | Объект, который изначально сгенерировал событие. Для непроксированных событий — совпадает с target. |
propagatedFrom | Object | Для проксированных событий — последний объект, который распространил событие к его родительскому элементу. |
layer | Object |
Устаревшее. То же, что и propagatedFrom. |
ZoomAnimEvent
| Свойство | Тип | Описание |
|---|---|---|
center | LatLng | Текущий центр карты |
zoom | Number | Текущий уровень масштабирования карты |
noUpdate | Boolean | Нужно ли слоям обновлять своё содержимое из-за этого события |
| Свойство | Тип | Описание |
|---|---|---|
type | String | Тип события (например, 'click'). |
target | Object | Объект, который сгенерировал событие. Для распространяемых событий — последний объект в цепочке распространения, сгенерировавший событие. |
sourceTarget | Object | Объект, который изначально сгенерировал событие. Для нераспространяемых событий — тот же, что и target. |
propagatedFrom | Object | Для распространяемых событий — последний объект, который распространил событие к его родительскому объекту события. |
layer | Object |
Устаревшее. То же самое, что и propagatedFrom. |
Глобальные переключатели
Глобальные переключатели созданы для редких случаев и, как правило, заставляют Leaflet игнорировать определённую функцию браузера, даже если она есть. Вам нужно установить переключатель как глобальную переменную в true перед включением Leaflet на странице, например так:
<script>L_NO_TOUCH = true;</script> <script src="leaflet.js"></script>
| Переключатель | Описание |
|---|---|
L_NO_TOUCH | Принудительно отключает использование событий touch, даже если они обнаружены. |
L_DISABLE_3D | Принудительно отключает использование аппаратного ускорения CSS 3D преобразований для позиционирования (что может вызвать сбои в некоторых редких средах), даже если они поддерживаются. |
noConflict
Этот метод восстанавливает глобальную переменную L до исходного значения, которое она имела до включения Leaflet, и возвращает реальное пространство имён Leaflet, чтобы вы могли поместить его в другое место, например так:
<script src='libs/l.js'> <!-- L points to some other library --> <script src='leaflet.js'> <!-- you include Leaflet, it replaces the L variable to Leaflet namespace --> <script> var Leaflet = L.noConflict(); // now L points to that other library again, and you can use Leaflet.Map etc. </script>
версия
Константа, которая представляет используемую версию Leaflet.
L.version; // contains "1.0.0" (or whatever version is currently in use)
© 2010–2022 Vladimir Agafonkin
© 2010–2011, CloudMade
Maps © OpenStreetMap contributors.
https://leafletjs.com/reference.html
map.getPaneилиmap.getPanes. Новые планы можно создать с помощью методаmap.createPane.Каждая карта имеет следующие стандартные планы, отличающиеся только zIndex.