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(<String> id, <Map options> options?)`	Инициализирует объект карты, используя ID DOM-элемента `<div>` и необязательно объект-литерал с `Map options`.
`L.map(<HTMLElement> el, <Map options> options?)`	Инициализирует объект карты, используя экземпляр HTML-элемента `<div>` и необязательно объект-литерал с `Map options`.

Параметры

Параметр	Тип	Значение по умолчанию	Описание
`preferCanvas`	`Boolean`	`false`	Определяет, должны ли `Path` отображаться с помощью рендерера `Canvas`. По умолчанию все `Path` отображаются с помощью рендерера `SVG`.

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

Параметр	Тип	Значение по умолчанию	Описание
`attributionControl`	`Boolean`	`true`	Определяет, добавляется ли по умолчанию контроль авторских прав на карту.
`zoomControl`	`Boolean`	`true`	Определяет, добавляется ли по умолчанию контроль масштабирования на карту.

Параметры взаимодействия

Параметр	Тип	Значение по умолчанию	Описание
`closePopupOnClick`	`Boolean`	`true`	Установите в `false`, если вы не хотите, чтобы всплывающие окна закрывались при щелчке по карте.
`zoomSnap`	`Number`	`1`	Принудительно устанавливает уровень масштаба карты, чтобы он всегда был кратным этому значению, особенно сразу после `fitBounds()` или при масштабировании пинцетом. По умолчанию уровень масштаба округляется до ближайшего целого числа; меньшие значения (например, `0.5` или `0.1`) позволяют большей точности. Значение `0` означает, что уровень масштаба не будет округляться после `fitBounds` или при масштабировании пинцетом.
`zoomDelta`	`Number`	`1`	Управляет тем, насколько изменится уровень масштаба карты после `zoomIn()`, `zoomOut()`, нажатия клавиш `+` или `-` на клавиатуре или использования контролей масштабирования. Меньшие значения, чем `1` (например, `0.5`) позволяют большей точности.
`trackResize`	`Boolean`	`true`	Определяет, автоматически ли карта обрабатывает изменение размера окна браузера для обновления себя.
`boxZoom`	`Boolean`	`true`	Определяет, можно ли масштабировать карту до прямоугольной области, перетаскивая мышь, удерживая клавишу Shift.
`doubleClickZoom`	`Boolean\|String`	`true`	Определяет, можно ли увеличивать масштаб карты двойным щелчком мыши и уменьшать удерживая Shift. Если передано `'center'`, масштабирование двойным щелчком будет выполняться относительно центра просмотра независимо от положения мыши.
`dragging`	`Boolean`	`true`	Определяет, можно ли перетаскивать карту с помощью мыши/сенсорного устройства.

Параметры состояния карты

Параметр	Тип	Значение по умолчанию	Описание
`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`.

Параметры инерции при панорамировании

Опция	Тип	По умолчанию	Описание
`inertia`	`Boolean`	`*`	Если включено, перемещение карты будет иметь эффект инерции, где карта набирает импульс во время перетаскивания и продолжает двигаться в том же направлении некоторое время. Особенно удобно на сенсорных устройствах. Включено по умолчанию, если не используется старое устройство Android.
`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), означающее изменение на один полный уровень масштабирования. Меньшие значения сделают масштабирование колесом быстрее (и наоборот).

Опции взаимодействия с сенсорным экраном

Опция	Тип	По умолчанию	Описание
`tap`	`Boolean`	`true`	Включает мобильные ухищрения для поддержки мгновенных нажатий (исправление задержки клика 200 мс на iOS/Android) и удерживания касаний (срабатывает как `contextmenu` события).
`tapTolerance`	`Number`	`15`	Максимальное количество пикселей, на которое пользователь может сместить палец во время касания, чтобы это считалось действительным нажатием.
`touchZoom`	`Boolean\|String`	`*`	Возможность масштабирования карты с помощью двух пальцев. Если передано `'center'`, масштабирование будет происходить относительно центра просмотра, независимо от того, где произошли сенсорные события (пальцы). Включено для веб-браузеров, поддерживающих сенсорный ввод, за исключением старых Android устройств.
`bounceAtZoomLimits`	`Boolean`	`true`	Установите в значение false, если не хотите, чтобы карта масштабировалась за пределы минимального/максимального масштабирования и затем возвращалась назад при масштабировании пинцетом.

События

События слоя

Событие	Данные	Описание
`baselayerchange`	`LayersControlEvent`	Вызывается при изменении базового слоя с помощью управления слоями слоёв.
`overlayadd`	`LayersControlEvent`	Вызывается, когда наложение выбирается через управление слоями.
`overlayremove`	`LayersControlEvent`	Вызывается, когда наложение снимается с выбора через управление слоями.
`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(<Path> layer)`	`Renderer`	Возвращает экземпляр `Renderer`, который следует использовать для отрисовки заданного `Path`. Он гарантирует, что параметры `renderer` карты и путей соблюдаются, и что отрисовщики существуют на карте.

Методы для слоев и элементов управления

Метод	Возвращает	Описание
`addControl(<Control> control)`	`this`	Добавляет данный элемент управления на карту
`removeControl(<Control> control)`	`this`	Удаляет данный элемент управления с карты
`addLayer(<Layer> layer)`	`this`	Добавляет данный слой на карту
`removeLayer(<Layer> layer)`	`this`	Удаляет данный слой с карты.
`hasLayer(<Layer> layer)`	`Boolean`	Возвращает `true`, если данный слой в данный момент добавлен на карту
`eachLayer(<Function> fn, <Object> context?)`	`this`	Итерируется по слоям карты, необязательно указывая контекст функции итератора. map.eachLayer(function(layer){ layer.bindPopup('Hello'); });
`openPopup(<Popup> popup)`	`this`	Открывает указанный всплывающий элемент, закрывая ранее открытый (для обеспечения удобства, чтобы в один момент времени был открыт только один).
`openPopup(<String\|HTMLElement> content, <LatLng> latlng, <Popup options> options?)`	`this`	Создаёт всплывающий элемент с указанным содержимым и опциями и открывает его в заданной точке на карте.
`closePopup(<Popup> popup?)`	`this`	Закрывает всплывающий элемент, ранее открытый с помощью openPopup (или данный).
`openTooltip(<Tooltip> tooltip)`	`this`	Открывает указанный всплывающий подсказку.
`openTooltip(<String\|HTMLElement> content, <LatLng> latlng, <Tooltip options> options?)`	`this`	Создаёт подсказку с указанным содержимым и опциями и открывает её.
`closeTooltip(<Tooltip> tooltip?)`	`this`	Закрывает подсказку, переданную в качестве параметра.

Методы для изменения состояния карты

Метод	Возвращает	Описание
`setView(<LatLng> center, <Number> zoom, <Zoom/pan options> options?)`	`this`	Устанавливает вид карты (географический центр и масштаб) с заданными параметрами анимации.
`setZoom(<Number> zoom, <Zoom/pan options> options?)`	`this`	Устанавливает масштаб карты.
`zoomIn(<Number> delta?, <Zoom options> options?)`	`this`	Увеличивает масштаб карты на `delta` (`zoomDelta` по умолчанию).
`zoomOut(<Number> delta?, <Zoom options> options?)`	`this`	Уменьшает масштаб карты на `delta` (`zoomDelta` по умолчанию).
`setZoomAround(<LatLng> latlng, <Number> zoom, <Zoom options> options)`	`this`	Изменяет масштаб карты, сохраняя заданную географическую точку на карте неподвижной (например, используется во внутреннем масштабировании при прокрутке и двойном щелчке).
`setZoomAround(<Point> offset, <Number> zoom, <Zoom options> options)`	`this`	Изменяет масштаб карты, сохраняя заданную точку в пикселях на карте (относительно левого верхнего угла) неподвижной.
`fitBounds(<LatLngBounds> bounds, <fitBounds options> options?)`	`this`	Устанавливает вид карты, содержащий заданные географические границы с максимальным возможным уровнем масштаба.
`fitWorld(<fitBounds options> options?)`	`this`	Устанавливает вид карты, в основном содержащий весь мир с максимальным возможным уровнем масштаба.
`panTo(<LatLng> latlng, <Pan options> options?)`	`this`	Перемещает карту в заданный центр.
`panBy(<Point> offset, <Pan options> options?)`	`this`	Перемещает карту на заданное количество пикселей (с анимацией).
`flyTo(<LatLng> latlng, <Number> zoom?, <Zoom/pan options> options?)`	`this`	Устанавливает вид карты (географический центр и масштаб) с плавной анимацией перемещения и изменения масштаба.
`flyToBounds(<LatLngBounds> bounds, <fitBounds options> options?)`	`this`	Устанавливает вид карты с плавной анимацией, как в `flyTo`, но использует параметр границ, как в `fitBounds`.
`setMaxBounds(<LatLngBounds> bounds)`	`this`	Ограничивает вид карты заданными границами (см. параметр maxBounds).
`setMinZoom(<Number> zoom)`	`this`	Устанавливает нижний предел доступных уровней масштаба (см. параметр minZoom).
`setMaxZoom(<Number> zoom)`	`this`	Устанавливает верхний предел доступных уровней масштаба (см. параметр maxZoom).
`panInsideBounds(<LatLngBounds> bounds, <Pan options> options?)`	`this`	Перемещает карту к ближайшему виду, который находился бы внутри заданных границ (если это не так), контролируя анимацию с использованием соответствующих опций, если они есть.
`panInside(<LatLng> latlng, <options> options?)`	`this`	Перемещает карту минимально, чтобы сделать `latlng` видимым. Используйте параметры `padding`, `paddingTopLeft` и `paddingTopRight` для подгонки отображения к более ограниченным границам, как в `fitBounds`. Если `latlng` уже находится в пределах (опционально заполненных) границ отображения, карта не будет перемещена.
`invalidateSize(<Zoom/pan options> options)`	`this`	Проверяет, изменился ли размер контейнера карты, и обновляет карту, если это так — вызовите её после динамического изменения размера карты, а также анимируйте перемещение по умолчанию. Если `options.pan` равно `false`, перемещение не произойдёт. Если `options.debounceMoveend` равно `true`, это задержит событие `moveend`, чтобы оно не происходило часто, даже если метод вызывается много раз подряд.
`invalidateSize(<Boolean> animate)`	`this`	Проверяет, изменился ли размер контейнера карты, и обновляет карту, если это так — вызовите её после динамического изменения размера карты, а также анимируйте перемещение по умолчанию.
`stop()`	`this`	Останавливает текущую анимацию `panTo` или `flyTo`, если она есть.

Методы геолокации

Метод	Возвращает	Описание
`locate(<Locate options> options?)`	`this`	Попытка определить местоположение пользователя с помощью API геолокации, вызывая событие `locationfound` с данными о местоположении при успехе или событие `locationerror` при ошибке, а также необязательно устанавливает представление карты в соответствии с местоположением пользователя с учётом точности определения (или устанавливает представление карты на весь мир, если геолокация не удалась). Обратите внимание, что если ваша страница не использует HTTPS, этот метод завершится ошибкой в современных браузерах (Chrome 50 и выше). Подробнее см. `Locate options`.
`stopLocate()`	`this`	Прекращает отслеживание местоположения, ранее инициированного `map.locate({watch: true})`, и отменяет переустановку представления карты, если map.locate был вызван с `{setView: true}`.

Другие методы

Метод	Возвращает	Описание
`addHandler(<String> name, <Function> HandlerClass)`	`this`	Добавляет новый `Handler` на карту, указав его имя и конструкторскую функцию.
`remove()`	`this`	Уничтожает карту и очищает все связанные обработчики событий.
`createPane(<String> name, <HTMLElement> container?)`	`HTMLElement`	Создаёт новый слой карты с заданным именем, если он ещё не существует, затем возвращает его. Слой создаётся как дочерний элемент `container`, или как дочерний элемент основного слоя карты, если не указано иное.
`getPane(<String\|HTMLElement> pane)`	`HTMLElement`	Возвращает слой карты по его имени или HTML элементу (его идентификатору).
`getPanes()`	`Object`	Возвращает обычный объект, содержащий имена всех слоёв в качестве ключей и сами слои в качестве значений.
`getContainer()`	`HTMLElement`	Возвращает HTML-элемент, содержащий карту.
`whenReady(<Function> fn, <Object> context?)`	`this`	Выполняет заданную функцию `fn` при инициализации карты с представлением (центром и масштабом) и по крайней мере одним слоем, или немедленно, если она уже инициализирована, необязательно передавая контекст функции.

Методы для получения состояния карты

Метод	Возвращает	Описание
`getCenter()`	`LatLng`	Возвращает географический центр представления карты.
`getZoom()`	`Number`	Возвращает текущий уровень масштаба представления карты.
`getBounds()`	`LatLngBounds`	Возвращает географические границы, видимые в текущем представлении карты.
`getMinZoom()`	`Number`	Возвращает минимальный уровень масштаба карты (если он задан в параметре `minZoom` карты или любого слоя), или `0` по умолчанию.
`getMaxZoom()`	`Number`	Возвращает максимальный уровень масштаба карты (если он задан в параметре `maxZoom` карты или любого слоя).
`getBoundsZoom(<LatLngBounds> bounds, <Boolean> inside?, <Point> padding?)`	`Number`	Возвращает максимальный уровень масштаба, при котором заданные границы полностью помещаются в представление карты. Если `inside` (необязательный параметр) установлен в `true`, метод вместо этого возвращает минимальный уровень масштаба, при котором представление карты полностью помещается в заданные границы.
`getSize()`	`Point`	Возвращает текущий размер контейнера карты (в пикселях).
`getPixelBounds()`	`Bounds`	Возвращает границы текущего представления карты в проекции пиксельных координат (иногда полезно при реализации слоёв и наложений).
`getPixelOrigin()`	`Point`	Возвращает проекционные пиксельные координаты верхней левой точки слоя карты (полезно при реализации пользовательских слоёв и наложений).
`getPixelWorldBounds(<Number> zoom?)`	`Bounds`	Возвращает границы мира в пиксельных координатах для уровня масштаба `zoom`. Если `zoom` опущено, используется текущий уровень масштаба карты.

Методы преобразования

Метод	Возвращает	Описание
`getZoomScale(<Number> toZoom, <Number> fromZoom)`	`Number`	Возвращает коэффициент масштабирования, который необходимо применить к переходу карты с уровня масштабирования `fromZoom` до `toZoom`. Используется в анимациях масштабирования.
`getScaleZoom(<Number> scale, <Number> fromZoom)`	`Number`	Возвращает уровень масштабирования, до которого карта будет увеличена, если она находится на уровне `fromZoom` и все масштабируется с коэффициентом `scale`. Обратная функция `getZoomScale`.
`project(<LatLng> latlng, <Number> zoom)`	`Point`	Проецирует географическую координату `LatLng` согласно проекции CRS карты, затем масштабирует её согласно `zoom` и `Transformation` CRS. Результатом является координата пикселя, относящаяся к началу CRS.
`unproject(<Point> point, <Number> zoom)`	`LatLng`	Обратная функция `project`.
`layerPointToLatLng(<Point> point)`	`LatLng`	При заданной координате пикселя относительно начального пикселя возвращает соответствующую географическую координату (для текущего уровня масштабирования).
`latLngToLayerPoint(<LatLng> latlng)`	`Point`	При заданной географической координате возвращает соответствующую координату пикселя относительно начального пикселя.
`wrapLatLng(<LatLng> latlng)`	`LatLng`	Возвращает `LatLng`, где `lat` и `lng` были обернуты согласно свойствам `wrapLat` и `wrapLng` CRS карты, если они находятся за пределами границ CRS. По умолчанию это означает, что долгота обернута вокруг линии перемены дат, так что ее значение находится в диапазоне от -180 до +180 градусов.
`wrapLatLngBounds(<LatLngBounds> bounds)`	`LatLngBounds`	Возвращает `LatLngBounds` того же размера, что и заданный, обеспечивая, что его центр находится в пределах границ CRS. По умолчанию это означает, что центральная долгота обернута вокруг линии перемены дат, так что ее значение находится в диапазоне от -180 до +180 градусов, и большая часть границ перекрывается границами CRS.
`distance(<LatLng> latlng1, <LatLng> latlng2)`	`Number`	Возвращает расстояние между двумя географическими координатами согласно CRS карты. По умолчанию расстояние измеряется в метрах.
`containerPointToLayerPoint(<Point> point)`	`Point`	При заданной координате пикселя относительно контейнера карты возвращает соответствующую координату пикселя относительно начального пикселя.
`layerPointToContainerPoint(<Point> point)`	`Point`	При заданной координате пикселя относительно начального пикселя возвращает соответствующую координату пикселя относительно контейнера карты.
`containerPointToLatLng(<Point> point)`	`LatLng`	При заданной координате пикселя относительно контейнера карты возвращает соответствующую географическую координату (для текущего уровня масштабирования).
`latLngToContainerPoint(<LatLng> latlng)`	`Point`	При заданной географической координате возвращает соответствующую координату пикселя относительно контейнера карты.
`mouseEventToContainerPoint(<MouseEvent> ev)`	`Point`	При заданном объекте MouseEvent возвращает координату пикселя относительно контейнера карты, где произошло событие.
`mouseEventToLayerPoint(<MouseEvent> ev)`	`Point`	При заданном объекте MouseEvent возвращает координату пикселя относительно начального пикселя, где произошло событие.
`mouseEventToLatLng(<MouseEvent> ev)`	`LatLng`	При заданном объекте MouseEvent возвращает географическую координату, где произошло событие.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-слушатель (`fn`) к определенному типу события объекта. Вы можете необязательно указать контекст слушателя (объект, на который будет указывать this). Вы также можете передать несколько типов, разделенных пробелом (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар тип/слушатель, например `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-слушатель. Если функция не указана, будут удалены все слушатели этого события для объекта. Обратите внимание, что если вы передали пользовательский контекст для `on`, вы должны передать тот же контекст для `off` для удаления слушателя.
`off(<Object> eventMap)`	`this`	Удаляет набор пар тип/слушатель.
`off()`	`this`	Удаляет всех слушателей всех событий для объекта. Это включает неявно присоединённые события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — первый аргумент функции-слушателя будет содержать его свойства. Событие может необязательно распространяться на родительские события.
`listens(<String> type)`	`Boolean`	Возвращает `true` , если у определённого типа события есть какие-либо присоединённые слушатели.
`once(…)`	`this`	Ведёт себя как `on(…)`, за исключением того, что слушатель будет вызван только один раз, а затем удалён.
`addEventParent(<Evented> obj)`	`this`	Добавляет родителя события — `Evented`, который будет получать распространяемые события
`removeEventParent(<Evented> obj)`	`this`	Удаляет родителя события, чтобы он перестал получать распространяемые события
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

Свойства

Управление

Свойство	Тип	Описание
`zoomControl`	`Control.Zoom`	Стандартное средство управления масштабом (доступно только в том случае, если опция `zoomControl` была `true` при создании карты).

Обработчики

Свойство	Тип	Описание
`boxZoom`	`Handler`	Обработчик масштабирования рамкой (удерживание Shift и перетаскивание мышью).
`doubleClickZoom`	`Handler`	Обработчик масштабирования двойным щелчком.
`dragging`	`Handler`	Обработчик перетаскивания карты (мышью и сенсорным управлением).
`keyboard`	`Handler`	Обработчик навигации по клавиатуре.
`scrollWheelZoom`	`Handler`	Обработчик масштабирования колесом мыши.
`tap`	`Handler`	Обработчик мобильных взаимодействий (быстрое нажатие и удержание).
`touchZoom`	`Handler`	Обработчик масштабирования сенсорным управлением.

Панели карты

Панели — это DOM-элементы, используемые для управления порядком слоёв на карте. Вы можете получить доступ к панелям с помощью методов map.getPane или map.getPanes. Новые панели можно создать с помощью метода map.createPane.

Каждая карта имеет следующие стандартные панели, отличающиеся только zIndex.

Pane	Type	Z-индекс	Описание
`mapPane`	`HTMLElement`	`'auto'`	Панель, содержащая все остальные панели карты
`tilePane`	`HTMLElement`	`200`	Панель для `GridLayer` и `TileLayer`
`overlayPane`	`HTMLElement`	`400`	Панель для наложений теней (например, тени `Marker`)
`shadowPane`	`HTMLElement`	`500`	Панель для векторов (`Path`, например, `Polyline` и `Polygon`), `ImageOverlay` и `VideoOverlay`
`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` не будет срабатывать при начале перемещения (используется для инерции перемещения).

Опции FitBounds

Опция	Тип	Значение по умолчанию	Описание
`paddingTopLeft`	`Point`	`[0, 0]`	Устанавливает отступ в левом верхнем углу контейнера карты, который не должен учитываться при установке отображения для соответствия границам. Полезно, если у вас есть элементы управления на карте, такие как боковая панель, и вы не хотите, чтобы они скрывали объекты, к которым вы приближаетесь.
`paddingBottomRight`	`Point`	`[0, 0]`	То же самое для правого нижнего угла карты.
`padding`	`Point`	`[0, 0]`	Эквивалентно установке отступов для левого верхнего и правого нижнего углов одинаковым значением.
`maxZoom`	`Number`	`null`	Максимальный возможный масштаб.

Наследованные опции из Опций масштабирования

Опция	Тип	Значение по умолчанию	Описание
`animate`	`Boolean`		Если не указано, анимация масштабирования произойдёт, если точка масштабирования находится внутри текущего представления. Если `true`, карта попытается анимировать масштабирование, независимо от расположения точки масштабирования. Установка `false` сделает так, что отображение всегда будет полностью сброшено без анимации.

Наследованные опции из Опций перемещения

Опция	Тип	Значение по умолчанию	Описание
`duration`	`Number`	`0.25`	Продолжительность анимационного перемещения, в секундах.
`easeLinearity`	`Number`	`0.25`	Коэффициент кривизны сглаживания анимации перемещения (третий параметр кривой Безье). Значение 1.0 соответствует линейной анимации, а чем меньше это число, тем более изогнутой будет кривая.
`noMoveStart`	`Boolean`	`false`	Если `true`, перемещение не будет вызывать событие `movestart` при запуске (используется внутри для инерции перемещения).

Маркер

L.Marker используется для отображения кликабельных/перетаскиваемых значков на карте. Расширяет Layer.

Пример использования

L.marker([50.5, 30.5]).addTo(map);

Создание

Фабрика	Описание
`L.marker(<LatLng> latlng, <Marker options> options?)`	Создаёт объект Маркера на основе географической точки и (необязательно) объекта опций.

Опции

Опция	Тип	Значение по умолчанию	Описание
`icon`	`Icon`	`*`	Объект значка, используемый для отображения маркера. Подробности по настройке значка маркера см. в документации по значкам. Если не указано, используется стандартный значок `L.Icon.Default`.
`keyboard`	`Boolean`	`true`	Можно ли перейти к маркеру с помощью клавиатуры и щелкнуть по нему нажатием клавиши Enter.
`title`	`String`	`''`	Текст всплывающей подсказки браузера, появляющейся при наведении курсора на маркер (по умолчанию подсказки нет).
`alt`	`String`	`''`	Текст для атрибута `alt` изображения значка (полезно для доступности).
`zIndexOffset`	`Number`	`0`	По умолчанию zIndex изображений маркеров устанавливается автоматически на основе широты. Используйте эту опцию, если вы хотите поместить маркер поверх всех остальных (или ниже), указав высокое значение, например, `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`).

Опции перетаскиваемого маркера

Опция	Тип	Значение по умолчанию	Описание
`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(<LatLng> latlng)`	`this`	Изменяет положение метки на заданную точку.
`setZIndexOffset(<Number> offset)`	`this`	Изменяет смещение zIndex метки.
`getIcon()`	`Icon`	Возвращает текущий значок, используемый меткой.
`setIcon(<Icon> icon)`	`this`	Изменяет значок метки.
`setOpacity(<Number> opacity)`	`this`	Изменяет непрозрачность метки.

Другие методы

Метод	Возвращает	Описание
`toGeoJSON(<Number> precision?)`	`Object`	`precision` — количество десятичных знаков для координат. Значение по умолчанию — 6 знаков. Возвращает представление метки в формате `GeoJSON` (как объект GeoJSON `Point` Feature).

Наследованные методы из Слой

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой на заданную карту или группу слоев.
`remove()`	`this`	Удаляет слой с карты, на которой он сейчас активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с заданной карты.
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из заданной `LayerGroup`.
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий заданный на карте слой. Если `name` опущено, возвращает слой для данного слоя.
`getAttribution()`	`String`	Используется `attribution control`, возвращает опцию атрибуции.

Методы всплывающей подсказки, унаследованные из Слой

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Привязывает всплывающую подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающую подсказку, ранее привязанную с помощью `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает привязанную всплывающую подсказку в указанной `latlng` или в стандартной точке привязки всплывающей подсказки, если `latlng` не передано.
`closePopup()`	`this`	Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта.
`togglePopup()`	`this`	Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от её текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true`, если всплывающая подсказка, привязанная к этому слою, в данный момент открыта.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.
`getPopup()`	`Popup`	Возвращает всплывающую подсказку, привязанную к этому слою.

Методы всплывающей подсказки, унаследованные из Слой

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Привязывает всплывающую подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет всплывающую подсказку, ранее привязанную с помощью `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает привязанную всплывающую подсказку в указанной `latlng` или по умолчанию, если `latlng` не указано.
`closeTooltip()`	`this`	Закрывает привязанную к этому слою всплывающую подсказку, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает привязанную к этому слою всплывающую подсказку в зависимости от текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true` , если привязанная к этому слою всплывающая подсказка открыта в данный момент.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.
`getTooltip()`	`Tooltip`	Возвращает всплывающую подсказку, привязанную к этому слою.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-обработчик (`fn`) к определенному типу события объекта. Можно необязательно указать контекст обработчика (объект, к которому будет относиться ключевое слово this). Также можно передать несколько типов через пробел (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар тип/обработчик, например, `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-обработчик. Если функция не указана, удаляет все обработчики данного типа события из объекта. Обратите внимание, что если вы передали пользовательский контекст в `on`, вы должны передать тот же контекст в `off` для удаления обработчика.
`off(<Object> eventMap)`	`this`	Удаляет набор пар тип/обработчик.
`off()`	`this`	Удаляет все обработчики всех событий объекта. Это включает неявно присоединенные события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Необязательно можно передать объект данных — свойства этого объекта будут первым аргументом функции-обработчика. Событие необязательно может быть распространено на родительские объекты.
`listens(<String> type)`	`Boolean`	Возвращает `true` , если для определенного типа события есть присоединенные обработчики.
`once(…)`	`this`	Ведёт себя как `on(…)`, за исключением того, что обработчик будет запущен только один раз, а затем удалён.
`addEventParent(<Evented> obj)`	`this`	Добавляет родителя события — `Evented`, который будет получать распространяемые события
`removeEventParent(<Evented> obj)`	`this`	Удаляет родителя события, чтобы он перестал получать распространяемые события
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

Свойства

Обработчики взаимодействия

Обработчики взаимодействия — свойства экземпляра маркера, позволяющие управлять поведением взаимодействия во время выполнения, включать или отключать определённые функции, такие как перетаскивание (см. методы Handler). Пример:

marker.dragging.disable();

Свойство	Тип	Описание
`dragging`	`Handler`	Обработчик перетаскивания маркера (с помощью мыши и касания). Действителен только при наличии маркера на карте (в противном случае установите `marker.options.draggable`).

Используется для открытия всплывающих окон (поп-апов) в определённых местах карты. Используйте 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);

Фабрика	Описание
`L.popup(<Popup options> options?, <Layer> source?)`	Создаёт объект `Popup`, принимая необязательный объект `options` , описывающий его внешний вид и расположение, и необязательный объект `source`, используемый для маркировки поп-апа с ссылкой на слой, к которому он относится.

Параметр	Тип	Значение по умолчанию	Описание
`maxWidth`	`Number`	`300`	Максимальная ширина всплывающего окна в пикселях.
`minWidth`	`Number`	`50`	Минимальная ширина всплывающего окна в пикселях.
`maxHeight`	`Number`	`null`	Если установлено, создаёт прокручиваемый контейнер заданной высоты внутри всплывающего окна, если его содержимое превышает эту высоту.
`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-класса для присвоения всплывающему окну.

Параметры, унаследованные от DivOverlay

Параметр	Тип	Значение по умолчанию	Описание
`offset`	`Point`	`Point(0, 7)`	Смещение позиции всплывающего окна. Полезно для управления якорем всплывающего окна при открытии его на некоторых наложениях.
`pane`	`String`	`'popupPane'`	`Map pane` куда будет добавлен всплывающий элемент.

Наследуемые параметры из Layer

Параметр	Тип	Значение по умолчанию	Описание
`attribution`	`String`	`null`	Строка, отображаемая в поле авторских прав, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является правовой обязанностью перед держателями авторских прав и поставщиками тайлов.

События

Наследуемые события из Layer

Событие	Данные	Описание
`add`	`Event`	Срабатывает после добавления слоя на карту
`remove`	`Event`	Срабатывает после удаления слоя с карты

События всплывающей подсказки, наследуемые из Layer

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Срабатывает при открытии всплывающей подсказки, связанной с этим слоем
`popupclose`	`PopupEvent`	Срабатывает при закрытии всплывающей подсказки, связанной с этим слоем

События подсказки, наследуемые из Layer

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Срабатывает при открытии подсказки, связанной с этим слоем.
`tooltipclose`	`TooltipEvent`	Срабатывает при закрытии подсказки, связанной с этим слоем.

Метод	Возвращаемое значение	Описание
`getLatLng()`	`LatLng`	Возвращает географическую точку всплывающей подсказки.
`setLatLng(<LatLng> latlng)`	`this`	Устанавливает географическую точку, где будет открыта всплывающая подсказка.
`getContent()`	`String\|HTMLElement`	Возвращает содержимое всплывающей подсказки.
`setContent(<String\|HTMLElement\|Function> htmlContent)`	`this`	Устанавливает HTML-содержимое всплывающей подсказки. Если передается функция, функция получит исходный слой. Функция должна вернуть `String` или `HTMLElement` для использования во всплывающей подсказке.
`getElement()`	`String\|HTMLElement`	Возвращает HTML-контейнер всплывающей подсказки.
`update()`	`null`	Обновляет содержимое, расположение и позицию всплывающей подсказки. Полезно для обновления всплывающей подсказки после изменения чего-либо внутри нее, например, при загрузке изображения.
`isOpen()`	`Boolean`	Возвращает `true` когда всплывающая подсказка видна на карте.
`bringToFront()`	`this`	Выводит эту всплывающую подсказку поверх других всплывающих подсказок (в том же окне карты).
`bringToBack()`	`this`	Перемещает эту всплывающую подсказку за другие всплывающие подсказки (в том же окне карты).
`openOn(<Map> map)`	`this`	Добавляет всплывающую подсказку на карту и закрывает предыдущую. То же, что и `map.openPopup(popup)`.

Методы, наследуемые из Layer

Метод	Возвращаемое значение	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой на заданную карту или группу слоев.
`remove()`	`this`	Удаляет слой с карты, на которой он сейчас активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с заданной карты
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из заданной `LayerGroup`
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement` представляющее окно с заданным именем на карте. Если `name` опущено, возвращает окно для этого слоя.
`getAttribution()`	`String`	Используется `attribution control`, возвращает параметр авторских прав.

Методы всплывающей подсказки, наследуемые из Layer

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Связывает всплывающее окно с слоем с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающее окно, ранее связанное с `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает связанное всплывающее окно в указанной `latlng` или по умолчанию, если `latlng` не указан.
`closePopup()`	`this`	Закрывает связанное всплывающее окно для этого слоя, если оно открыто.
`togglePopup()`	`this`	Открывает или закрывает связанное всплывающее окно для этого слоя в зависимости от его текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true` , если связанное всплывающее окно для этого слоя в данный момент открыто.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое связанного всплывающего окна для этого слоя.
`getPopup()`	`Popup`	Возвращает связанное всплывающее окно для этого слоя.

Методы всплывающих подсказок унаследованные от Layer

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Связывает подсказку с слоем с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет подсказку, ранее связанную с `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает связанную подсказку в указанной `latlng` или по умолчанию, если `latlng` не указан.
`closeTooltip()`	`this`	Закрывает связанную подсказку для этого слоя, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает связанную подсказку для этого слоя в зависимости от ее текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true` , если связанная подсказка для этого слоя в данный момент открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое связанной подсказки для этого слоя.
`getTooltip()`	`Tooltip`	Возвращает связанную подсказку для этого слоя.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-слушатель (`fn`) к определенному типу события объекта. Можно необязательно указать контекст слушателя (объект, к которому будет относиться ключевое слово this). Также можно передать несколько типов через пробел (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар "тип/слушатель", например, `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-слушатель. Если функция не указана, удаляются все слушатели данного события для объекта. Обратите внимание, что если вы передали пользовательский контекст для `on`, вы должны передать тот же контекст для `off` для удаления слушателя.
`off(<Object> eventMap)`	`this`	Удаляет набор пар "тип/слушатель".
`off()`	`this`	Удаляет всех слушателей всех событий объекта. Это включает неявные присоединенные события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Необязательно можно передать объект данных — первый аргумент функции-слушателя будет содержать его свойства. Событие необязательно может быть распространено на родительские события.
`listens(<String> type)`	`Boolean`	Возвращает `true` , если для определенного типа события есть присоединенные слушатели.
`once(…)`	`this`	Ведёт себя как `on(…)`, за исключением того, что слушатель будет вызван только один раз и затем удалён.
`addEventParent(<Evented> obj)`	`this`	Добавляет родительское событие — `Evented`, которое будет получать распространяемые события
`removeEventParent(<Evented> obj)`	`this`	Удаляет родительское событие, чтобы оно перестало получать распространяемые события
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

Используется для отображения небольших текстов поверх слоёв карты.

marker.bindTooltip("my tooltip text").openTooltip();

Примечание об отступе подсказки. Leaflet учитывает два варианта для вычисления отступа подсказки:

параметр offset подсказки: по умолчанию равен [0, 0], и он специфичен для одной подсказки. Добавьте положительный сдвиг x, чтобы переместить подсказку вправо, и положительный сдвиг y, чтобы переместить её вниз. Отрицательные значения сместят её влево и вверх.
параметр tooltipAnchor значка: это будет учитываться только для маркеров. Вам нужно будет скорректировать это значение, если вы используете пользовательский значок.

Фабрика Описание

L.tooltip(<Tooltip options> options?, <Layer> source?) Создаёт объект Tooltip на основе необязательного объекта options, описывающего его внешний вид и расположение, и необязательного объекта source, который используется для маркировки подсказки ссылкой на слой, к которому она относится.

Опция	Тип	По умолчанию	Описание
`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, всплывающая подсказка будет следовать за курсором вместо того, чтобы оставаться закреплённой в центре объекта.
`interactive`	`Boolean`	`false`	Если true, всплывающая подсказка будет реагировать на события объекта.
`opacity`	`Number`	`0.9`	Непрозрачность контейнера всплывающей подсказки.

Опции, унаследованные от DivOverlay

Опция	Тип	По умолчанию	Описание
`className`	`String`	`''`	Имя пользовательского класса CSS для назначения всплывающему окну.

Опции, унаследованные от Слой

Опция	Тип	По умолчанию	Описание
`attribution`	`String`	`null`	Строка, отображаемая в поле атрибуции, например, «© OpenStreetMap contributors». Описывает данные слоя и часто является юридическим обязательством по отношению к правообладателям и поставщикам плиток.

События

События, унаследованные от Слой

Событие	Данные	Описание
`add`	`Event`	Срабатывает после добавления слоя на карту.
`remove`	`Event`	Срабатывает после удаления слоя с карты.

События всплывающих окон, унаследованные от Слой

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Срабатывает при открытии всплывающего окна, связанного с этим слоем.
`popupclose`	`PopupEvent`	Срабатывает при закрытии всплывающего окна, связанного с этим слоем.

События всплывающих подсказок, унаследованные от Слой

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Срабатывает при открытии всплывающей подсказки, связанной с этим слоем.
`tooltipclose`	`TooltipEvent`	Срабатывает при закрытии всплывающей подсказки, связанной с этим слоем.

Методы

Методы, унаследованные от Слой

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой на указанную карту или группу слоёв.
`remove()`	`this`	Удаляет слой с карты, на которой он в данный момент активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с указанной карты.
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из указанной `LayerGroup`
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий именованный слой на карте. Если `name` опущен, возвращает слой для данного слоя.
`getAttribution()`	`String`	Используется `attribution control`, возвращает опцию атрибуции.

Методы всплывающих окон, унаследованные от Слой

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Связывает всплывающее окно с слоем с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающее окно, ранее связанное с `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает связанное всплывающее окно в указанной `latlng` или в стандартном якоре всплывающего окна, если `latlng` не передан.
`closePopup()`	`this`	Закрывает связанное с этим слоем всплывающее окно, если оно открыто.
`togglePopup()`	`this`	Открывает или закрывает связанное с этим слоем всплывающее окно в зависимости от его текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true`, если всплывающее окно, связанное с этим слоем, в настоящее время открыто.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающего окна, связанного с этим слоем.
`getPopup()`	`Popup`	Возвращает всплывающее окно, связанное с этим слоем.

Методы всплывающего окна, унаследованные от Слой

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Связывает подсказку со слоем с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет подсказку, ранее связанную с `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает связанную подсказку в указанной `latlng` или в стандартном якоре подсказки, если `latlng` не передан.
`closeTooltip()`	`this`	Закрывает связанную с этим слоем подсказку, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает подсказку, связанную с этим слоем, в зависимости от ее текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true`, если подсказка, связанная с этим слоем, в настоящее время открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое подсказки, связанной с этим слоем.
`getTooltip()`	`Tooltip`	Возвращает подсказку, связанную с этим слоем.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-слушатель (`fn`) к определённому типу события объекта. Вы можете указать контекст слушателя (объект, к которому будет относиться ключевое слово this). Также можно передать несколько типов через пробел (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар тип/слушатель, например, `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-слушатель. Если функция не указана, удаляются все слушатели этого конкретного события для объекта. Обратите внимание, что если вы передали пользовательский контекст для `on`, вы должны передать тот же контекст в `off` для удаления слушателя.
`off(<Object> eventMap)`	`this`	Удаляет набор пар тип/слушатель.
`off()`	`this`	Удаляет всех слушателей всех событий объекта. Включая неявные присоединённые события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Вы можете необязательно передать объект данных — первый аргумент функции-слушателя будет содержать его свойства. Событие может быть необязательно распространено на родительские события.
`listens(<String> type)`	`Boolean`	Возвращает `true`, если для определённого типа события есть какие-либо присоединённые слушатели.
`once(…)`	`this`	Ведёт себя как `on(…)`, за исключением того, что слушатель будет вызван только один раз, а затем удалён.
`addEventParent(<Evented> obj)`	`this`	Добавляет родительское событие — `Evented`, которое будет получать распространяемые события
`removeEventParent(<Evented> obj)`	`this`	Удаляет родительское событие, поэтому оно перестанет получать распространяемые события
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

Слой плиток

Используется для загрузки и отображения слоёв плиток на карте. Обратите внимание, что большинство серверов плиток требуют указания авторских прав, которые вы можете установить в Layer. Расширяет GridLayer.

Пример использования

L.tileLayer('https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png?{foo}', {foo: 'bar', attribution: 'Map data &copy; <a href="https://www.openstreetmap.org/">OpenStreetMap</a> contributors, <a href="https://creativecommons.org/licenses/by-sa/2.0/">CC-BY-SA</a>'}).addTo(map);

Шаблон URL

Строка следующего формата:

'http://{s}.somedomain.com/blabla/{z}/{x}/{y}{r}.png'

{s} означает один из доступных поддоменов (используется последовательно для помощи с одновременными запросами браузера по ограничению на домен; значения поддоменов указаны в параметрах; a, b или c по умолчанию, могут быть опущены), {z} — уровень масштаба, {x} и {y} — координаты плитки. {r} может использоваться для добавления "@2x" в URL для загрузки плиток с высокой чёткостью.

Вы можете использовать пользовательские ключи в шаблоне, которые будут оцениваться из параметров TileLayer, например так:

L.tileLayer('http://{s}.somedomain.com/{foo}/{z}/{x}/{y}.png', {foo: 'bar'});

Создание

Методы расширения

Фабрика	Описание
`L.tilelayer(<String> urlTemplate, <TileLayer options> options?)`	Создаёт объект слоя плиток, заданного `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` и пользователь находится на дисплее Retina, будет запрошено четыре тайла с половиной указанного размера и большим уровнем масштабирования вместо одного для использования высокого разрешения.
`crossOrigin`	`Boolean\|String`	`false`	Указывает, будет ли добавляться атрибут crossOrigin к тайлам. Если предоставлена строка, атрибут crossOrigin всех тайлов будет установлен на предоставленную строку. Это необходимо, если вы хотите получить доступ к пиксельным данным тайлов. Обратитесь к Настройкам CORS для допустимых строковых значений.

Опции, унаследованные от 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`.
`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». Она описывает данные слоя и часто является юридической обязанностью по отношению к правообладателям и поставщикам тайлов.

События

События, унаследованные от GridLayer

Событие	Данные	Описание
`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(<String> url, <Boolean> noRedraw?)`	`this`	Обновляет шаблон URL слоя и перерисовывает его (если `noRedraw` установлено в `true`). Если URL не изменился, слой не будет перерисован, если параметр noRedraw не установлен в false.
`createTile(<Object> coords, <Function> done?)`	`HTMLElement`	Вызывается только внутри, переопределяет `createTile()` GridLayer, чтобы вернуть HTML-элемент `<img>` с соответствующим URL изображения, учитывая `coords`. Кэллбек `done` вызывается, когда плитка загружена.

Расширяемые методы

Слои, расширяющие TileLayer, могут повторно реализовать следующий метод.

Метод	Возвращаемое значение	Описание
`getTileUrl(<Object> coords)`	`String`	Вызывается только внутри, возвращает URL для плитки по ее координатам. Классы, расширяющие `TileLayer`, могут переопределить эту функцию для предоставления пользовательских схем именования URL плиток.

Методы, унаследованные от GridLayer

Метод	Возвращает	Описание
`bringToFront()`	`this`	Перемещает слой тайлов в верхний слой всех слоев тайлов.
`bringToBack()`	`this`	Перемещает слой тайлов в нижний слой всех слоев тайлов.
`getContainer()`	`HTMLElement`	Возвращает HTML-элемент, содержащий тайлы для этого слоя.
`setOpacity(<Number> opacity)`	`this`	Изменяет прозрачность слоя.
`setZIndex(<Number> zIndex)`	`this`	Изменяет zIndex слоя.
`isLoading()`	`Boolean`	Возвращает `true`, если какой-либо тайл в слое еще загружается.
`redraw()`	`this`	Заставляет слой очистить все тайлы и запросить их заново.
`getTileSize()`	`Point`	Нормализует параметр tileSize в точку. Используется методом `createTile()`.

Наследованные методы из Layer

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой к заданной карте или группе слоев.
`remove()`	`this`	Удаляет слой с карты, на которой он в данный момент активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с заданной карты
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из заданной `LayerGroup`
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий именованный слой на карте. Если `name` опущено, возвращает слой для этого слоя.
`getAttribution()`	`String`	Используется методом `attribution control`, возвращает параметр атрибуции.

Методы всплывающей подсказки, унаследованные из Layer

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Связывает всплывающую подсказку со слоем с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающую подсказку, ранее привязанную с помощью `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает привязанную всплывающую подсказку в указанной `latlng` или в стандартной точке привязки всплывающей подсказки, если `latlng` не передан.
`closePopup()`	`this`	Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта.
`togglePopup()`	`this`	Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от ее текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true`, если всплывающая подсказка, привязанная к этому слою, в данный момент открыта.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.
`getPopup()`	`Popup`	Возвращает всплывающую подсказку, привязанную к этому слою.

Методы всплывающей подсказки, унаследованные из Layer

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Привязывает всплывающую подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет всплывающую подсказку, ранее привязанную с помощью `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает привязанную всплывающую подсказку в указанной `latlng` или в стандартном якоре всплывающей подсказки, если `latlng` не передан.
`closeTooltip()`	`this`	Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от ее текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true`, если всплывающая подсказка, привязанная к этому слою, в настоящее время открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.
`getTooltip()`	`Tooltip`	Возвращает всплывающую подсказку, привязанную к этому слою.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет обработчик событий (`fn`) к определенному типу событий объекта. Можно указать контекст обработчика (объект, к которому будет относиться ключевое слово this). Также можно передавать несколько типов, разделенных пробелом (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар тип/обработчик, например `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленный обработчик событий. Если обработчик не указан, удаляются все обработчики этого события для данного объекта. Обратите внимание, что если вы передали пользовательский контекст для `on`, вы должны передать тот же контекст в `off` для удаления обработчика.
`off(<Object> eventMap)`	`this`	Удаляет набор пар тип/обработчик.
`off()`	`this`	Удаляет все обработчики всех событий объекта. Это включает неявно прикрепленные события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Можно дополнительно передать объект данных — свойства объекта будут доступны в качестве первого аргумента функции-обработчика. Событие может быть передано родительским объектам.
`listens(<String> type)`	`Boolean`	Возвращает `true` , если для определенного типа события есть какие-либо прикрепленные обработчики.
`once(…)`	`this`	Ведёт себя как `on(…)`, за исключением того, что обработчик будет вызван только один раз, а затем удалён.
`addEventParent(<Evented> obj)`	`this`	Добавляет родителя события — `Evented`, который будет получать распространяемые события
`removeEventParent(<Evented> obj)`	`this`	Удаляет родителя события, чтобы он перестал получать распространяемые события
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

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(<String> baseUrl, <TileLayer.WMS options> options)`	Создаёт объект слоя тайлов WMS, задавая базовый URL службы WMS и объект параметров/опций WMS.

Параметры

Если используются какие-либо пользовательские параметры, не документированные здесь, они будут отправлены на сервер WMS как дополнительные параметры в каждом запросе URL. Это может быть полезно для параметров 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 будут в верхнем регистре.

Параметры, унаследованные от TileLayer

Параметр	Тип	Значение по умолчанию	Описание
`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 для получения допустимых значений строк.

Параметры, унаследованные от 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`	Явный z-индекс слоя тайлов.
`bounds`	`LatLngBounds`	`undefined`	При установке тайлы будут загружаться только внутри заданных `LatLngBounds`.
`maxNativeZoom`	`Number`	`undefined`	Максимальное значение масштабирования, доступное для источника тайлов. Если указано, тайлы на всех уровнях масштабирования выше `maxNativeZoom` будут загружаться с уровня `maxNativeZoom` и автоматически масштабироваться.
`minNativeZoom`	`Number`	`undefined`	Минимальное значение масштабирования, доступное для источника тайлов. Если указано, тайлы на всех уровнях масштабирования ниже `minNativeZoom` будут загружаться с уровня `minNativeZoom` и автоматически масштабироваться.
`noWrap`	`Boolean`	`false`	Является ли слой обернутым вокруг антимеридиана. Если `true`, слой сетки будет отображаться только один раз на низких уровнях масштабирования. Не имеет эффекта, если система координат карты `bounds` не обернута вокруг. Может использоваться в сочетании с `bounds` для предотвращения запросов тайлов за пределами пределов системы координат.
`pane`	`String`	`'tilePane'`	`Map pane` куда будет добавлен слой сетки.
`className`	`String`	`''`	Пользовательское имя класса, которое будет назначено слою тайлов. По умолчанию пустое.
`keepBuffer`	`Number`	`2`	При панорамировании карты сохраните столько строк и столбцов тайлов, прежде чем разгрузить их.

Опции, унаследованные от Слой

Опция	Тип	По умолчанию	Описание
`attribution`	`String`	`null`	Строка, отображаемая в элементе управления атрибутами, например, «© OpenStreetMap contributors». Она описывает данные слоя и часто является юридическим обязательством перед правообладателями и поставщиками тайлов.

События

События, унаследованные от GridLayer

Событие	Данные	Описание
`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(<Object> params, <Boolean> noRedraw?)`	`this`	Объединяет объект с новыми параметрами и повторно запрашивает плитки на текущем экране (если `noRedraw` не было установлено в значение true).

Методы, унаследованные от TileLayer

Метод	Возвращает	Описание
`setUrl(<String> url, <Boolean> noRedraw?)`	`this`	Обновляет шаблон URL слоя и перерисовывает его (если `noRedraw` не установлено в значение `true`). Если URL не изменился, слой не будет перерисован, если параметр noRedraw не установлен в значение false.
`createTile(<Object> coords, <Function> done?)`	`HTMLElement`	Вызывается только внутренне, переопределяет `createTile()` GridLayer для возвращения HTML-элемента `<img>` с соответствующим URL изображения, учитывая `coords`. Вызывается коллбэк `done`, когда плитка загрузилась.

Методы, унаследованные от GridLayer

Метод	Возвращает	Описание
`bringToFront()`	`this`	Выводит слой плиток поверх всех других слоев плиток.
`bringToBack()`	`this`	Выводит слой плиток под все другие слои плиток.
`getContainer()`	`HTMLElement`	Возвращает HTML-элемент, содержащий плитки для этого слоя.
`setOpacity(<Number> opacity)`	`this`	Изменяет прозрачность слоя сетки.
`setZIndex(<Number> zIndex)`	`this`	Изменяет zIndex слоя сетки.
`isLoading()`	`Boolean`	Возвращает `true`, если какая-либо плитка в слое сетки еще не завершила загрузку.
`redraw()`	`this`	Принудительно очищает все плитки и запрашивает их снова.
`getTileSize()`	`Point`	Нормализует параметр tileSize в точку. Используется методом `createTile()`.

Наследники методов от Layer

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой к заданной карте или группе слоев.
`remove()`	`this`	Удаляет слой с карты, на которой он в данный момент активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с заданной карты.
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из заданной `LayerGroup`.
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий именованный фрагмент на карте. Если `name` опущено, возвращает фрагмент для данного слоя.
`getAttribution()`	`String`	Используется `attribution control`, возвращает параметр подписи.

Методы всплывающего окна, унаследованные от Layer

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Привязывает всплывающее окно к слою с переданным `content` и настраивает необходимые обработчики событий. Если передано `Function`, оно получит слой в качестве первого аргумента и должно вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающее окно, ранее привязанное с помощью `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает привязанное всплывающее окно в указанном `latlng` или в стандартном якоре всплывающего окна, если `latlng` не передано.
`closePopup()`	`this`	Закрывает всплывающее окно, привязанное к этому слою, если оно открыто.
`togglePopup()`	`this`	Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true`, если всплывающее окно, привязанное к этому слою, в данный момент открыто.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающего окна, привязанного к этому слою.
`getPopup()`	`Popup`	Возвращает всплывающее окно, привязанное к этому слою.

Методы всплывающих подсказок, унаследованные от Layer

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Привязывает подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передано `Function`, оно получит слой в качестве первого аргумента и должно вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет подсказку, ранее привязанную с помощью `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает привязанную подсказку в указанном `latlng` или по умолчанию, если `latlng` не передано.
`closeTooltip()`	`this`	Закрывает подсказку, привязанную к этому слою, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от ее текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true`, если подсказка, привязанная к этому слою, в данный момент открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое подсказки, привязанной к этому слою.
`getTooltip()`	`Tooltip`	Возвращает подсказку, привязанную к этому слою.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-обработчик (`fn`) к определенному типу события объекта. Вы можете указать контекст обработчика (объект, к которому будет относиться ключевое слово this). Также вы можете передать несколько типов, разделённых пробелами (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар тип/обработчик, например, `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-обработчик. Если функция не указана, будут удалены все обработчики данного события для объекта. Обратите внимание, если вы передали пользовательский контекст для `on`, вы должны передать тот же контекст для `off` для удаления обработчика.
`off(<Object> eventMap)`	`this`	Удаляет набор пар тип/обработчик.
`off()`	`this`	Удаляет все обработчики всех событий объекта. Это включает неявно прикреплённые события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Вы можете необязательно передать объект данных — первое аргумент функции-обработчика будет содержать его свойства. Событие может быть необязательно распространено на родительские события.
`listens(<String> type)`	`Boolean`	Возвращает `true`, если для определённого типа события прикреплены обработчики.
`once(…)`	`this`	Ведёт себя как `on(…)`, за исключением того, что обработчик будет вызван только один раз, а затем удалён.
`addEventParent(<Evented> obj)`	`this`	Добавляет родительский обработчик событий — `Evented`, который будет получать распространяемые события.
`removeEventParent(<Evented> obj)`	`this`	Удаляет родительский обработчик событий, так что он перестанет получать распространяемые события.
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

ImageOverlay

Используется для загрузки и отображения одного изображения над определёнными границами карты. Расширяет Layer.

Пример использования

var imageUrl = 'http://www.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(<String> imageUrl, <LatLngBounds> bounds, <ImageOverlay options> options?)`	Создаёт объект наложения изображения на основе 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(<Number> opacity)`	`this`	Устанавливает непрозрачность наложения.
`bringToFront()`	`this`	Выводит слой поверх всех других наложений.
`bringToBack()`	`this`	Перемещает слой в самый низ списка наложений.
`setUrl(<String> url)`	`this`	Изменяет URL изображения.
`setBounds(<LatLngBounds> bounds)`	`this`	Обновляет область, которую покрывает ImageOverlay.
`setZIndex(<Number> value)`	`this`	Изменяет значение zIndex изображения наложения.
`getBounds()`	`LatLngBounds`	Получает область, которую покрывает ImageOverlay.
`getElement()`	`HTMLElement`	Возвращает экземпляр `HTMLImageElement`, используемый этим наложением.

Методы, унаследованные от Слой

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой к заданной карте или группе слоев.
`remove()`	`this`	Удаляет слой с карты, на которой он сейчас активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с заданной карты.
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из заданной `LayerGroup`
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий собой именованный слой на карте. Если `name` опущено, возвращает слой для этого слоя.
`getAttribution()`	`String`	Используется `attribution control`, возвращает опцию подписи.

Методы всплывающих окон, унаследованные от Слой

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Привязывает всплывающее окно к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающее окно, ранее привязанное с помощью `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает привязанное всплывающее окно в указанной `latlng` или в стандартном якоре всплывающего окна, если `latlng` не передан.
`closePopup()`	`this`	Закрывает всплывающее окно, привязанное к этому слою, если оно открыто.
`togglePopup()`	`this`	Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true` , если всплывающее окно, привязанное к этому слою, в данный момент открыто.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающего окна, привязанного к этому слою.
`getPopup()`	`Popup`	Возвращает всплывающее окно, привязанное к этому слою.

Методы, унаследованные от Layer

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Привязывает всплывающую подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет всплывающую подсказку, ранее привязанную с помощью `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает привязанную всплывающую подсказку в указанной `latlng` или в стандартном якоре всплывающей подсказки, если `latlng` не передан.
`closeTooltip()`	`this`	Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от её текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true` , если всплывающая подсказка, привязанная к этому слою, в данный момент открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.
`getTooltip()`	`Tooltip`	Возвращает всплывающую подсказку, привязанную к этому слою.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-слушатель (`fn`) к определённому типу события объекта. Вы можете необязательно указать контекст слушателя (объект, к которому будет относиться this). Также вы можете передать несколько типов, разделённых пробелами (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар тип/слушатель, например `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-слушатель. Если функция не указана, удалятся все слушатели этого конкретного события от объекта. Обратите внимание, что если вы передали пользовательский контекст для `on`, вы должны передать тот же контекст для `off` для удаления слушателя.
`off(<Object> eventMap)`	`this`	Удаляет набор пар тип/слушатель.
`off()`	`this`	Удаляет всех слушателей всех событий объекта. Включая неявные прикреплённые события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — первый аргумент функции-слушателя будет содержать его свойства. Событие может быть необязательно распространено на родительские события.
`listens(<String> type)`	`Boolean`	Возвращает `true`, если для определённого типа события есть какие-либо прикреплённые слушатели.
`once(…)`	`this`	Ведёт себя как `on(…)`, за исключением того, что слушатель будет вызван только один раз, а затем удалён.
`addEventParent(<Evented> obj)`	`this`	Добавляет родительское событие — `Evented`, которое будет получать распространяемые события
`removeEventParent(<Evented> obj)`	`this`	Удаляет родительское событие, чтобы оно перестало получать распространяемые события
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

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(<String\|Array\|HTMLVideoElement> video, <LatLngBounds> bounds, <VideoOverlay options> options?)`	Инициализирует объект оверлея изображения, используя URL видео (или массив URL, или даже элемент видео) и географические границы, к которым он привязан.

Опции

Опция	Тип	По умолчанию	Описание
`autoplay`	`Boolean`	`true`	Автоматически запускать видео при загрузке.
`loop`	`Boolean`	`true`	Повторять видео с начала при воспроизведении.
`keepAspectRatio`	`Boolean`	`true`	Сохранять пропорции видео после проекции. Актуально для поддерживаемых браузеров. Смотрите совместимость браузеров
`muted`	`Boolean`	`false`	Начать воспроизведение видео с отключённым звуком при загрузке.

Параметры, унаследованные от ImageOverlay

Параметр	Тип	Значение по умолчанию	Описание
`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`	Вызывается, когда пользователь щелкает правой кнопкой мыши по слою. Блокирует отображение контекстного меню браузера по умолчанию, если существуют обработчики этого события. Также вызывается на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется удержанием).

События, унаследованные от Layer

Событие	Данные	Описание
`add`	`Event`	Срабатывает после добавления слоя на карту
`remove`	`Event`	Срабатывает после удаления слоя с карты

События всплывающих окон, унаследованные от Layer

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Срабатывает при открытии всплывающего окна, привязанного к этому слою
`popupclose`	`PopupEvent`	Срабатывает при закрытии всплывающего окна, привязанного к этому слою

События подсказок, унаследованные от Layer

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Срабатывает при открытии подсказки, привязанной к этому слою.
`tooltipclose`	`TooltipEvent`	Срабатывает при закрытии подсказки, привязанной к этому слою.

Методы

Метод	Возвращаемое значение	Описание
`getElement()`	`HTMLVideoElement`	Возвращает экземпляр `HTMLVideoElement`, используемый этим наложением.

Методы, унаследованные от ImageOverlay

Метод	Возвращаемое значение	Описание
`setOpacity(<Number> opacity)`	`this`	Устанавливает непрозрачность наложения.
`bringToFront()`	`this`	Переводит слой наверх всех наложений.
`bringToBack()`	`this`	Переводит слой вниз всех наложений.
`setUrl(<String> url)`	`this`	Изменяет URL изображения.
`setBounds(<LatLngBounds> bounds)`	`this`	Обновляет область, покрываемую этим ImageOverlay.
`setZIndex(<Number> value)`	`this`	Изменяет значение zIndex наложения изображения.
`getBounds()`	`LatLngBounds`	Получает область, покрываемую этим ImageOverlay.

Методы, унаследованные от Layer

Метод	Возвращаемое значение	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой на заданную карту или группу слоев.
`remove()`	`this`	Удаляет слой с карты, на которой он в настоящее время активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с указанной карты.
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из заданной `LayerGroup`
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий именованный слой на карте. Если `name` опущен, возвращает слой для этого слоя.
`getAttribution()`	`String`	Используется `attribution control`, возвращает опцию атрибуции.

Методы всплывающих окон, унаследованные от Layer

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Привязывает всплывающее окно к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающее окно, ранее привязанное с помощью `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает привязанное всплывающее окно по указанному `latlng` или по умолчанию, если `latlng` не передан.
`closePopup()`	`this`	Закрывает привязанное к этому слою всплывающее окно, если оно открыто.
`togglePopup()`	`this`	Открывает или закрывает привязанное к этому слою всплывающее окно в зависимости от его текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true`, если привязанное к этому слою всплывающее окно открыто.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое привязанного к этому слою всплывающего окна.
`getPopup()`	`Popup`	Возвращает привязанное к этому слою всплывающее окно.

Методы, унаследованные от Layer

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Привязывает всплывающую подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет всплывающую подсказку, ранее привязанную с помощью `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает привязанную всплывающую подсказку по указанному `latlng` или по умолчанию, если `latlng` не передан.
`closeTooltip()`	`this`	Закрывает привязанную к этому слою всплывающую подсказку, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает привязанную к этому слою всплывающую подсказку в зависимости от ее текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true`, если привязанная к этому слою всплывающая подсказка открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое привязанной к этому слою всплывающей подсказки.
`getTooltip()`	`Tooltip`	Возвращает привязанную к этому слою всплывающую подсказку.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-слушатель (`fn`) к определенному типу события объекта. Можно указать контекст слушателя (объект, к которому будет относиться ключевое слово this). Также можно передать несколько типов через пробел (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар тип/слушатель, например, `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-слушатель. Если функция не указана, удалит всех слушателей этого конкретного события из объекта. Обратите внимание, что если вы передали пользовательский контекст в `on`, вы должны передать тот же контекст в `off` для удаления слушателя.
`off(<Object> eventMap)`	`this`	Удаляет набор пар тип/слушатель.
`off()`	`this`	Удаляет всех слушателей всех событий объекта. Это включает неявно присоединённые события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Можно дополнительно указать объект данных — свойства этого объекта будут первым аргументом функции-слушателя. Событие может быть распространено на родительские элементы.
`listens(<String> type)`	`Boolean`	Возвращает `true` , если определённый тип события имеет присоединённых слушателей.
`once(…)`	`this`	Поведение как `on(…)`, за исключением того, что слушатель будет вызван только один раз, а затем удалён.
`addEventParent(<Evented> obj)`	`this`	Добавляет родительский элемент события - `Evented`, который будет получать распространяемые события
`removeEventParent(<Evented> obj)`	`this`	Удаляет родительский элемент события, чтобы он перестал получать распространяемые события
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

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(<String\|SVGElement> svg, <LatLngBounds> bounds, <SVGOverlay options> options?)`	Инициализирует объект слоя изображения на основе SVG-элемента и географических границ, к которым он привязан. Атрибут viewBox должен быть задан в SVG-элементе для корректного масштабирования.

Параметры

Параметры унаследованы от ImageOverlay

Опция	Тип	Значение по умолчанию	Описание
`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". Она описывает данные слоя и часто является юридическим обязательством по отношению к правообладателям и поставщикам плиток.

События

Наследуемые события из ImageOverlay

Событие	Данные	Описание
`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`	Возвращает экземпляр `SVGElement`, используемый этим наложением.

Методы, унаследованные от ImageOverlay

Метод	Возвращает	Описание
`setOpacity(<Number> opacity)`	`this`	Устанавливает непрозрачность наложения.
`bringToFront()`	`this`	Выводит слой поверх всех других наложений.
`bringToBack()`	`this`	Выводит слой под все остальные наложения.
`setUrl(<String> url)`	`this`	Изменяет URL изображения.
`setBounds(<LatLngBounds> bounds)`	`this`	Обновляет область, которую покрывает это ImageOverlay
`setZIndex(<Number> value)`	`this`	Изменяет zIndex изображения наложения.
`getBounds()`	`LatLngBounds`	Получить область, которую покрывает это ImageOverlay

Методы, унаследованные от Слой

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой на указанную карту или группу слоев.
`remove()`	`this`	Удаляет слой с карты, на которой он активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с заданной карты
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из заданной `LayerGroup`
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий именованный слой на карте. Если `name` опущено, возвращает слой для данного слоя.
`getAttribution()`	`String`	Используется `attribution control`, возвращает параметр атрибуции.

Методы всплывающих окон, унаследованные от Слой

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Привязывает всплывающее окно к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающее окно, ранее привязанное с помощью `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает привязанное всплывающее окно в указанной `latlng` или в стандартной точке привязки всплывающего окна, если `latlng` не указано.
`closePopup()`	`this`	Закрывает всплывающее окно, привязанное к этому слою, если оно открыто.
`togglePopup()`	`this`	Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true` если всплывающее окно, привязанное к этому слою, в настоящее время открыто.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающего окна, привязанного к этому слою.
`getPopup()`	`Popup`	Возвращает всплывающее окно, привязанное к этому слою.

Методы, унаследованные от Layer

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Привязывает подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет подсказку, ранее привязанную с помощью `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает привязанную подсказку в указанной `latlng` или в стандартной точке привязки подсказки, если `latlng` не указано.
`closeTooltip()`	`this`	Закрывает подсказку, привязанную к этому слою, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от её текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true` если подсказка, привязанная к этому слою, в настоящее время открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое подсказки, привязанной к этому слою.
`getTooltip()`	`Tooltip`	Возвращает подсказку, привязанную к этому слою.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-слушатель (`fn`) к определенному типу события объекта. Вы можете необязательно указать контекст слушателя (объект, к которому будет относиться ключевое слово this). Вы также можете передать несколько типов, разделенных пробелами (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар тип/слушатель, например `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-слушатель. Если функция не указана, будут удалены все слушатели этого конкретного события из объекта. Обратите внимание, что если вы передали пользовательский контекст для `on`, вы должны передать тот же контекст в `off` для удаления слушателя.
`off(<Object> eventMap)`	`this`	Удаляет набор пар тип/слушатель.
`off()`	`this`	Удаляет всех слушателей всех событий объекта. Это включает неявно присоединенные события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — первый аргумент функции-слушателя будет содержать его свойства. Событие может быть необязательно распространено на родительские события.
`listens(<String> type)`	`Boolean`	Возвращает `true` если для определенного типа события есть какие-либо присоединенные слушатели.
`once(…)`	`this`	Ведет себя как `on(…)`, за исключением того, что слушатель будет вызван только один раз, а затем удален.
`addEventParent(<Evented> obj)`	`this`	Добавляет родительское событие — `Evented`, которое будет получать распространяемые события
`removeEventParent(<Evented> obj)`	`this`	Удаляет родительское событие, поэтому оно перестанет получать распространяемые события
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

Путь

Абстрактный класс, содержащий опции и константы, общие для векторных наложений (многоугольник, полилиния, окружность). Не используйте его напрямую. Расширяет 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(<Path options> style)`	`this`	Изменяет внешний вид пути на основе параметров в объекте `Path options`.
`bringToFront()`	`this`	Перемещает слой наверх всех слоев пути.
`bringToBack()`	`this`	Перемещает слой вниз всех слоев пути.

Методы, унаследованные от Слой

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой на заданную карту или группу слоев.
`remove()`	`this`	Удаляет слой с карты, на которой он сейчас активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с заданной карты.
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из заданной `LayerGroup`
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий именованный слой на карте. Если `name` опущено, возвращает слой для этого слоя.
`getAttribution()`	`String`	Используется `attribution control`, возвращает параметр атрибуции.

Методы всплывающих окон, унаследованные от Слой

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Привязывает всплывающее окно к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающее окно, ранее привязанное с помощью `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает привязанное всплывающее окно в указанной `latlng` или в стандартном якоре всплывающего окна, если `latlng` не указан.
`closePopup()`	`this`	Закрывает привязанное к этому слою всплывающее окно, если оно открыто.
`togglePopup()`	`this`	Открывает или закрывает привязанное к этому слою всплывающее окно в зависимости от его текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true` если всплывающее окно, привязанное к этому слою, в настоящее время открыто.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающего окна, привязанного к этому слою.
`getPopup()`	`Popup`	Возвращает всплывающее окно, привязанное к этому слою.

Методы всплывающего подсказки унаследованные от Layer

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Привязывает подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет подсказку, ранее привязанную с помощью `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает привязанную подсказку в указанной `latlng` или в стандартном якоре подсказки, если `latlng` не указан.
`closeTooltip()`	`this`	Закрывает подсказку, привязанную к этому слою, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от ее текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true` если подсказка, привязанная к этому слою, в настоящее время открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое подсказки, привязанной к этому слою.
`getTooltip()`	`Tooltip`	Возвращает подсказку, привязанную к этому слою.

Методы унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-слушатель (`fn`) к определенному типу события объекта. Вы можете указать контекст слушателя (объект, к которому будет относиться ключевое слово this). Также можно передать несколько типов через пробел (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар "тип/слушатель", например, `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-слушатель. Если функция не указана, удаляются все слушатели этого конкретного события из объекта. Обратите внимание, что если вы передали пользовательский контекст для `on`, вы должны передать тот же контекст для `off`, чтобы удалить слушателя.
`off(<Object> eventMap)`	`this`	Удаляет набор пар "тип/слушатель".
`off()`	`this`	Удаляет всех слушателей всех событий объекта. Это включает неявно прикрепленные события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Вы можете дополнительно указать объект данных — свойства этого объекта будут первым аргументом функции-слушателя. Событие может быть дополнительно распространено на родительские события.
`listens(<String> type)`	`Boolean`	Возвращает `true` , если для определенного типа события прикреплены какие-либо слушатели.
`once(…)`	`this`	Ведет себя как `on(…)`, за исключением того, что слушатель будет вызван только один раз, а затем удален.
`addEventParent(<Evented> obj)`	`this`	Добавляет родительское событие - `Evented`, который будет получать распространяемые события
`removeEventParent(<Evented> obj)`	`this`	Удаляет родительское событие, поэтому оно перестанет получать распространяемые события
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

Полилиния

Класс для отрисовки наложений полилиний на карте. Расширяет 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(<LatLng[]> latlngs, <Polyline options> options?)`	Создаёт объект полилинии на основе массива географических точек и, необязательно, объекта опций. Можно создать объект `Polyline` с несколькими отдельными линиями (`MultiPolyline`) передав массив массивов географических точек.

Параметры

Параметр	Тип	Значение по умолчанию	Описание
`smoothFactor`	`Number`	`1.0`	Насколько нужно упрощать полилинию на каждом уровне масштабирования. Большее значение означает лучшую производительность и более плавный вид, а меньшее - более точное отображение.
`noClip`	`Boolean`	`false`	Отключить обрезку полилинии.

Параметры, унаследованные от Path

Параметр	Тип	Значение по умолчанию	Описание
`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(<Number> precision?)`	`Object`	Число десятичных знаков для координат. По умолчанию 6 знаков. Возвращает представление полилинии в формате GeoJSON (как объект Feature геоданных или FeatureCollection).
`getLatLngs()`	`LatLng[]`	Возвращает массив точек пути или вложенные массивы точек в случае многополилинии.
`setLatLngs(<LatLng[]> latlngs)`	`this`	Заменяет все точки полилинии заданным массивом географических точек.
`isEmpty()`	`Boolean`	Возвращает `true`, если у полилинии нет координат LatLng.
`closestLayerPoint(<Point> p)`	`Point`	Возвращает точку, ближайшую к `p` на полилинии.
`getCenter()`	`LatLng`	Возвращает центр (центроид) полилинии.
`getBounds()`	`LatLngBounds`	Возвращает границы пути.
`addLatLng(<LatLng> latlng, <LatLng[]> latlngs?)`	`this`	Добавляет заданную точку в полилинию. По умолчанию добавляет к первому кольцу полилинии в случае многополилинии, но можно переопределить, передав конкретное кольцо в качестве массива LatLng (к которому вы можете получить доступ с помощью `getLatLngs`).

Методы, унаследованные от Путь

Метод	Возвращает	Описание
`redraw()`	`this`	Перерисовывает слой. Иногда полезно после изменения координат, используемых путём.
`setStyle(<Path options> style)`	`this`	Изменяет внешний вид пути на основе параметров в объекте `Path options`.
`bringToFront()`	`this`	Выводит слой наверх всех слоёв путей.
`bringToBack()`	`this`	Выводит слой в низ всех слоёв путей.

Методы, унаследованные от Слой

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой в заданную карту или группу слоёв.
`remove()`	`this`	Удаляет слой с карты, на которой он сейчас активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с заданной карты.
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из заданной `LayerGroup`
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий именованный экран карты. Если `name` опущено, возвращает экран для данного слоя.
`getAttribution()`	`String`	Используется `attribution control`, возвращает опцию атрибуции.

Методы всплывающих окон, унаследованные от Слой

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Привязывает всплывающее окно к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающее окно, ранее привязанное с помощью `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает привязанное всплывающее окно в указанном `latlng` или в стандартном якоре всплывающего окна, если `latlng` не передан.
`closePopup()`	`this`	Закрывает привязанное всплывающее окно для этого слоя, если оно открыто.
`togglePopup()`	`this`	Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true`, если всплывающее окно, привязанное к этому слою, сейчас открыто.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающего окна, привязанного к этому слою.
`getPopup()`	`Popup`	Возвращает всплывающее окно, привязанное к этому слою.

Методы подсказок, унаследованные от Слой

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Привязывает всплывающую подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет всплывающую подсказку, ранее привязанную с помощью `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает привязанную всплывающую подсказку в указанной `latlng` или в стандартном якоре всплывающей подсказки, если `latlng` не передан.
`closeTooltip()`	`this`	Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от её текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true`, если всплывающая подсказка, привязанная к этому слою, в настоящее время открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.
`getTooltip()`	`Tooltip`	Возвращает всплывающую подсказку, привязанную к этому слою.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-слушатель (`fn`) к определенному типу события объекта. Вы можете указать контекст слушателя (объект, на который будет указывать this). Также можно передать несколько типов, разделенных пробелом (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар тип/слушатель, например, `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-слушатель. Если функция не указана, удаляются все слушатели данного события из объекта. Обратите внимание, что если вы передали пользовательский контекст для `on`, вы должны передать тот же контекст в `off` для удаления слушателя.
`off(<Object> eventMap)`	`this`	Удаляет набор пар тип/слушатель.
`off()`	`this`	Удаляет всех слушателей всех событий объекта. Это включает неявные присоединенные события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — свойства этого объекта будут содержаться в первом аргументе функции-слушателя. Событие можно необязательно распространить на родительские события.
`listens(<String> type)`	`Boolean`	Возвращает `true` если для определенного типа события есть какие-либо присоединенные слушатели.
`once(…)`	`this`	Ведет себя как `on(…)`, за исключением того, что слушатель будет вызван только один раз, а затем удален.
`addEventParent(<Evented> obj)`	`this`	Добавляет родителя события — `Evented`, который будет получать распространяемые события.
`removeEventParent(<Evented> obj)`	`this`	Удаляет родителя события, чтобы он перестал получать распространяемые события.
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

Многоугольник

Класс для отрисовки многоугольных наложений на карте. Расширяет 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(<LatLng[]> latlngs, <Polyline options> options?)`

Параметры

Параметры, унаследованные от Полилиния

Параметр	Тип	Значение по умолчанию	Описание
`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(<Number> precision?)`	`Object`	Число десятичных знаков для координат. По умолчанию 6 знаков. Возвращает представление многоугольника в формате GeoJSON (как GeoJSON-представление многоугольника или `MultiPolygon` Feature).

Методы, унаследованные от Полилиния

Метод	Возвращает	Описание
`getLatLngs()`	`LatLng[]`	Возвращает массив точек в траектории или вложенные массивы точек в случае многократной полилинии.
`setLatLngs(<LatLng[]> latlngs)`	`this`	Заменяет все точки в полилинии заданным массивом географических точек.
`isEmpty()`	`Boolean`	Возвращает `true` если у Полилинии нет LatLng.
`closestLayerPoint(<Point> p)`	`Point`	Возвращает точку, ближайшую к `p` на Полилинии.
`getCenter()`	`LatLng`	Возвращает центр (центр тяжести) полилинии.
`getBounds()`	`LatLngBounds`	Возвращает `LatLngBounds` траектории.
`addLatLng(<LatLng> latlng, <LatLng[]> latlngs?)`	`this`	Добавляет заданную точку к полилинии. По умолчанию добавляет к первому кольцу полилинии в случае многократной полилинии, но это можно переопределить, передав конкретное кольцо в виде массива LatLng (к которому вы можете получить доступ ранее с помощью `getLatLngs`).

Методы, унаследованные от Путь

Метод	Возвращает	Описание
`redraw()`	`this`	Перерисовывает слой. Иногда полезно после изменения координат, используемых путём.
`setStyle(<Path options> style)`	`this`	Изменяет внешний вид Path на основе параметров в объекте `Path options`.
`bringToFront()`	`this`	Выводит слой на верхний уровень всех слоёв путей.
`bringToBack()`	`this`	Выводит слой на нижний уровень всех слоёв путей.

Наследуемые методы от Layer

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой на заданную карту или группу слоёв.
`remove()`	`this`	Удаляет слой с карты, на которой он сейчас активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с заданной карты
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из заданной `LayerGroup`
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий указанную область на карте. Если `name` опущено, возвращает область для этого слоя.
`getAttribution()`	`String`	Используется `attribution control`, возвращает параметр атрибуции.

Методы всплывающих окон, унаследованные от Layer

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Привязывает всплывающее окно к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающее окно, ранее привязанное с помощью `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает привязанное всплывающее окно в указанной `latlng` или по умолчанию в якоре всплывающего окна, если `latlng` не передан.
`closePopup()`	`this`	Закрывает привязанное к этому слою всплывающее окно, если оно открыто.
`togglePopup()`	`this`	Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true`, если всплывающее окно, привязанное к этому слою, открыто в данный момент.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающего окна, привязанного к этому слою.
`getPopup()`	`Popup`	Возвращает всплывающее окно, привязанное к этому слою.

Методы всплывающих подсказок, унаследованные от Layer

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Привязывает всплывающую подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет всплывающую подсказку, ранее привязанную с помощью `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает привязанную всплывающую подсказку в указанной `latlng` или в стандартном якоре всплывающей подсказки, если `latlng` не передан.
`closeTooltip()`	`this`	Закрывает привязанную к этому слою всплывающую подсказку, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает привязанную к этому слою всплывающую подсказку в зависимости от ее текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true`, если привязанная к этому слою всплывающая подсказка в настоящее время открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.
`getTooltip()`	`Tooltip`	Возвращает всплывающую подсказку, привязанную к этому слою.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-обработчик (`fn`) к определенному типу события объекта. Вы можете необязательно указать контекст обработчика (объект, к которому будет относиться ключевое слово this). Также вы можете передать несколько типов через пробел (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар "тип/обработчик", например, `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-обработчик. Если функция не указана, она удалит всех обработчиков данного события от объекта. Обратите внимание, если вы передали пользовательский контекст в `on`, вы должны передать тот же контекст в `off` для удаления обработчика.
`off(<Object> eventMap)`	`this`	Удаляет набор пар "тип/обработчик".
`off()`	`this`	Удаляет всех обработчиков всех событий объекта. Это включает неявные присоединенные события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Вы можете необязательно указать объект данных — свойства которого будут первым аргументом функции-обработчика. Событие может быть необязательно распространено на родительские события.
`listens(<String> type)`	`Boolean`	Возвращает `true` , если для определенного типа события есть какие-либо присоединенные обработчики.
`once(…)`	`this`	Ведет себя как `on(…)`, за исключением того, что обработчик будет вызван только один раз, а затем удален.
`addEventParent(<Evented> obj)`	`this`	Добавляет родителя события — `Evented`, который будет получать распространяемые события.
`removeEventParent(<Evented> obj)`	`this`	Удаляет родителя события, так что он перестанет получать распространяемые события.
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

Прямоугольник

Класс для отрисовки прямоугольных наложений на карту. Расширяет 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(<LatLngBounds> latLngBounds, <Polyline options> options?)`

Параметры

Наследованные параметры из Полилинии

Параметр	Тип	Значение по умолчанию	Описание
`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(<LatLngBounds> latLngBounds)`	`this`	Перерисовывает прямоугольник с переданными границами.

Методы, унаследованные от Многоугольник

Метод	Возвращаемое значение	Описание
`toGeoJSON(<Number> precision?)`	`Object`	`precision` — количество десятичных знаков для координат. Значение по умолчанию — 6 знаков. Возвращает представление многоугольника в формате GeoJSON (представление многоугольника в GeoJSON или Feature).

Методы, унаследованные от Полилиния

Метод	Возвращает	Описание
`getLatLngs()`	`LatLng[]`	Возвращает массив точек в пути или вложенные массивы точек в случае многолинейного пути.
`setLatLngs(<LatLng[]> latlngs)`	`this`	Заменяет все точки полилинии заданным массивом географических точек.
`isEmpty()`	`Boolean`	Возвращает `true`, если у полилинии нет LatLng.
`closestLayerPoint(<Point> p)`	`Point`	Возвращает точку, ближайшую к `p` на полилинии.
`getCenter()`	`LatLng`	Возвращает центр (центроид) полилинии.
`getBounds()`	`LatLngBounds`	Возвращает `LatLngBounds` пути.
`addLatLng(<LatLng> latlng, <LatLng[]> latlngs?)`	`this`	Добавляет заданную точку в полилинию. По умолчанию добавляет в первый контур полилинии в случае многолинейного пути, но это можно переопределить, передав определённый контур в качестве массива LatLng (к которому можно получить доступ с помощью `getLatLngs`).

Методы, унаследованные от Path

Метод	Возвращает	Описание
`redraw()`	`this`	Перерисовывает слой. Иногда полезно после изменения координат, которые использует путь.
`setStyle(<Path options> style)`	`this`	Изменяет внешний вид пути на основе параметров в объекте `Path options`.
`bringToFront()`	`this`	Выводит слой поверх всех слоёв пути.
`bringToBack()`	`this`	Выводит слой под все слои пути.

Методы, унаследованные от Layer

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой на заданную карту или группу слоёв.
`remove()`	`this`	Удаляет слой с карты, на которой он активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с указанной карты.
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из заданной `LayerGroup`
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий собой указанный слой на карте. Если `name` опущено, возвращает слой для этого слоя.
`getAttribution()`	`String`	Используется `attribution control`, возвращает параметр авторских прав.

Методы всплывающей подсказки, унаследованные от Layer

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Привязывает всплывающее окно к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающее окно, ранее привязанное с помощью `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает привязанное всплывающее окно в указанной `latlng` или по умолчанию, если `latlng` не передан.
`closePopup()`	`this`	Закрывает привязанное к слою всплывающее окно, если оно открыто.
`togglePopup()`	`this`	Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true`, если всплывающее окно, привязанное к этому слою, открыто в данный момент.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающего окна, привязанного к этому слою.
`getPopup()`	`Popup`	Возвращает всплывающее окно, привязанное к этому слою.

Методы, унаследованные от Layer

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Привязывает подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет подсказку, ранее привязанную с помощью `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает привязанную подсказку в указанной `latlng` или по умолчанию, если `latlng` не передан.
`closeTooltip()`	`this`	Закрывает подсказку, привязанную к этому слою, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от ее текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true`, если подсказка, привязанная к этому слою, открыта в данный момент.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое подсказки, привязанной к этому слою.
`getTooltip()`	`Tooltip`	Возвращает подсказку, привязанную к этому слою.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-обработчик (`fn`) к определенному типу события объекта. Вы можете необязательно указать контекст обработчика (объект, к которому будет относиться ключевое слово this). Вы также можете передать несколько типов через пробел (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар тип/обработчик, например, `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-обработчик. Если функция не указана, она удалит всех обработчиков данного события из объекта. Обратите внимание, что если вы передали пользовательский контекст для `on`, вы должны передать тот же контекст в `off` для удаления обработчика.
`off(<Object> eventMap)`	`this`	Удаляет набор пар тип/обработчик.
`off()`	`this`	Удаляет всех обработчиков всех событий объекта. Это включает неявно прикрепленные события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — первый аргумент функции обработчика будет содержать его свойства. Событие может быть необязательно распространено на родительские события.
`listens(<String> type)`	`Boolean`	Возвращает `true` если для определенного типа события есть какие-либо прикреплённые обработчики.
`once(…)`	`this`	Ведёт себя как `on(…)`, за исключением того, что обработчик будет вызван только один раз, а затем удалён.
`addEventParent(<Evented> obj)`	`this`	Добавляет родительский обработчик событий — `Evented`, который будет получать распространяемые события
`removeEventParent(<Evented> obj)`	`this`	Удаляет родительский обработчик событий, чтобы он перестал получать распространяемые события
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

Окружность

Класс для рисования наложений окружностей на карте. Расширяет CircleMarker.

Это приближение, и оно начинает отклоняться от реальной окружности ближе к полюсам (из-за искажений проекции).

Пример использования

L.circle([50.5, 30.5], {radius: 200}).addTo(map);

Создание

Фабрика	Описание
`L.circle(<LatLng> latlng, <Circle options> options?)`	Создаёт объект окружности, заданный географической точкой и объектом параметров, содержащим радиус окружности.
`L.circle(<LatLng> latlng, <Number> radius, <Circle options> options?)`	Устаревший способ создания окружности, для совместимости с кодом 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». Она описывает данные слоя и часто является юридическим обязательством перед правообладателями и поставщиками плиток.

События

Наследуемые события от CircleMarker

Событие	Данные	Описание
`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(<Number> radius)`	`this`	Устанавливает радиус круга. Единицы измерения - метры.
`getRadius()`	`Number`	Возвращает текущий радиус круга. Единицы измерения - метры.
`getBounds()`	`LatLngBounds`	Возвращает `LatLngBounds` пути.

Методы, унаследованные от CircleMarker

Метод	Возвращаемое значение	Описание
`toGeoJSON(<Number> precision?)`	`Object`	`precision` — количество десятичных знаков для координат. Значение по умолчанию — 6 знаков. Возвращает представление маркера круга в формате `GeoJSON` (как Feature типа `Point`).
`setLatLng(<LatLng> latLng)`	`this`	Устанавливает позицию маркера круга в новом местоположении.
`getLatLng()`	`LatLng`	Возвращает текущее географическое положение маркера круга.

Методы, унаследованные от Path

Метод	Возвращает	Описание
`redraw()`	`this`	Перерисовывает слой. Иногда полезно после изменения координат, используемых траекторией.
`setStyle(<Path options> style)`	`this`	Изменяет внешний вид траектории на основе параметров в объекте `Path options`.
`bringToFront()`	`this`	Выводит слой поверх всех слоев траекторий.
`bringToBack()`	`this`	Выводит слой под все слои траекторий.

Методы, унаследованные от Layer

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой к заданной карте или группе слоев.
`remove()`	`this`	Удаляет слой с карты, на которой он в данный момент активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с заданной карты.
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из заданной `LayerGroup`
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий заданный слой на карте. Если `name` опущено, возвращает слой для этого слоя.
`getAttribution()`	`String`	Используется `attribution control`, возвращает параметр атрибуции.

Методы всплывающей подсказки, унаследованные от Layer

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Привязывает всплывающую подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающую подсказку, ранее привязанную с `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает привязанную всплывающую подсказку в указанном `latlng` или в стандартном якоре всплывающей подсказки, если `latlng` не передан.
`closePopup()`	`this`	Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта.
`togglePopup()`	`this`	Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от ее текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true`, если всплывающая подсказка, привязанная к этому слою, в настоящее время открыта.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.
`getPopup()`	`Popup`	Возвращает всплывающую подсказку, привязанную к этому слою.

Методы подсказки, унаследованные от Layer

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Привязывает всплывающую подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет всплывающую подсказку, ранее привязанную с помощью `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает привязанную всплывающую подсказку в указанной `latlng` или по умолчанию в якорной точке всплывающей подсказки, если `latlng` не передан.
`closeTooltip()`	`this`	Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от ее текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true`, если всплывающая подсказка, привязанная к этому слою, в данный момент открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.
`getTooltip()`	`Tooltip`	Возвращает всплывающую подсказку, привязанную к этому слою.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-обработчик (`fn`) к определенному типу события объекта. Вы можете необязательно указать контекст обработчика (объект, к которому будет относиться ключевое слово this). Также вы можете передать несколько типов, разделенных пробелом (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар тип/обработчик, например, `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-обработчик. Если функция не указана, она удалит всех обработчиков данного события из объекта. Обратите внимание, что если вы передали пользовательский контекст в `on`, вы должны передать тот же контекст в `off` для удаления обработчика.
`off(<Object> eventMap)`	`this`	Удаляет набор пар тип/обработчик.
`off()`	`this`	Удаляет всех обработчиков всех событий в объекте. Это включает в себя неявные привязанные события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Срабатывает событие указанного типа. Вы можете необязательно передать объект данных — свойства этого объекта будут первым аргументом функции-обработчика. Событие может быть необязательно распространено на родительские элементы.
`listens(<String> type)`	`Boolean`	Возвращает `true` , если для определенного типа события прикреплены обработчики.
`once(…)`	`this`	Поведение аналогично `on(…)`, за исключением того, что обработчик будет вызван один раз и затем удалён.
`addEventParent(<Evented> obj)`	`this`	Добавляет родителя события — `Evented`, который будет получать распространяемые события.
`removeEventParent(<Evented> obj)`	`this`	Удаляет родителя события, так что он перестанет получать распространяемые события.
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

CircleMarker

Окружность фиксированного размера с радиусом, указанным в пикселях. Расширяет Path.

Создание

Фабрика	Описание
`L.circleMarker(<LatLng> latlng, <CircleMarker options> options?)`	Создаёт объект маркера окружности, задавая географическую точку и необязательный объект опций.

Опции

Опция	Тип	Значение по умолчанию	Описание
`radius`	`Number`	`10`	Радиус маркера окружности в пикселях

Опции, унаследованные от Path

Опция	Тип	Значение по умолчанию	Описание
`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(<Number> precision?)`	`Object`	`precision` — количество десятичных знаков для координат. Значение по умолчанию — 6 знаков. Возвращает представление маркера окружности в формате `GeoJSON` (как GeoJSON-признак `Point`).
`setLatLng(<LatLng> latLng)`	`this`	Устанавливает положение маркера окружности в новом месте.
`getLatLng()`	`LatLng`	Возвращает текущее географическое положение маркера окружности.
`setRadius(<Number> radius)`	`this`	Устанавливает радиус маркера окружности. Единицы измерения — пиксели.
`getRadius()`	`Number`	Возвращает текущий радиус окружности.

Методы, унаследованные от Путь

Метод	Возвращает	Описание
`redraw()`	`this`	Перерисовывает слой. Иногда полезно после изменения координат, используемых траекторией.
`setStyle(<Path options> style)`	`this`	Изменяет внешний вид траектории на основе параметров в объекте `Path options`.
`bringToFront()`	`this`	Выводит слой наверх всех слоев траекторий.
`bringToBack()`	`this`	Выводит слой вниз всех слоев траекторий.

Наследуемые методы от Слой

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой на заданную карту или группу слоев.
`remove()`	`this`	Удаляет слой с карты, на которой он активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с указанной карты
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из заданной `LayerGroup`
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий указанный на карте слой. Если `name` опущено, возвращает слой для этого уровня.
`getAttribution()`	`String`	Используется `attribution control`, возвращает опцию атрибуции.

Методы всплывающей подсказки, унаследованные от Слой

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Привязывает всплывающую подсказку к слою с переданным `content` и устанавливает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающую подсказку, ранее привязанную с помощью `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает привязанную всплывающую подсказку в указанной `latlng` или по умолчанию, если `latlng` не передан.
`closePopup()`	`this`	Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта.
`togglePopup()`	`this`	Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от ее текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true`, если всплывающая подсказка, привязанная к этому слою, открыта.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.
`getPopup()`	`Popup`	Возвращает всплывающую подсказку, привязанную к этому слою.

Методы всплывающей подсказки, унаследованные от Слой

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Привязывает всплывающую подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет всплывающую подсказку, ранее привязанную с `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает привязанную всплывающую подсказку в указанной `latlng` или по умолчанию, если `latlng` не передан.
`closeTooltip()`	`this`	Закрывает привязанную к слою всплывающую подсказку, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает привязанную к слою всплывающую подсказку в зависимости от ее текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true`, если всплывающая подсказка, привязанная к этому слою, в данный момент открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.
`getTooltip()`	`Tooltip`	Возвращает всплывающую подсказку, привязанную к этому слою.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-слушатель (`fn`) к определённому типу события объекта. Вы можете необязательно указать контекст слушателя (объект, к которому будет относиться ключевое слово this). Также вы можете передать несколько типов, разделённых пробелом (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар тип/слушатель, например, `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-слушатель. Если функция не указана, удаляются все слушатели этого конкретного события от объекта. Обратите внимание, что если вы передали пользовательский контекст для `on`, вы должны передать тот же контекст для `off` для удаления слушателя.
`off(<Object> eventMap)`	`this`	Удаляет набор пар тип/слушатель.
`off()`	`this`	Удаляет всех слушателей всех событий объекта. Это включает неявно прикреплённые события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — первое аргумент функции-слушателя будет содержать его свойства. Событие необязательно может быть распространено на родительские события.
`listens(<String> type)`	`Boolean`	Возвращает `true` если у конкретного типа события есть прикреплённые слушатели.
`once(…)`	`this`	Ведёт себя как `on(…)`, за исключением того, что слушатель будет вызван только один раз, а затем удалён.
`addEventParent(<Evented> obj)`	`this`	Добавляет родительское событие — `Evented`, который будет получать распространяемые события
`removeEventParent(<Evented> obj)`	`this`	Удаляет родительское событие, поэтому оно перестанет получать распространяемые события
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

SVG

Технология VML устарела в 2012 году, что означает, что функциональность VML существует только для обратной совместимости со старыми версиями Internet Explorer.

Позволяет отображать векторные слои с помощью SVG. Наследует Renderer.

Из-за технических ограничений, SVG недоступен во всех веб-браузерах, в частности, в Android 2.x и 3.x.

Хотя SVG недоступен в IE7 и IE8, эти браузеры поддерживают VML (теперь устаревшая технология), и рендерер SVG переключится на VML в этом случае.

Пример использования

Используйте 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(<Renderer options> options?)`	Создаёт рендерер SVG с заданными параметрами.

Параметры

Параметры, унаследованные от Рендерер

Параметр	Тип	Значение по умолчанию	Описание
`padding`	`Number`	`0.1`	Насколько нужно расширить область обрезки вокруг представления карты (относительно её размера), например, 0,1 будет 10% представления карты в каждом направлении
`tolerance`	`Number`	`0`	Насколько нужно расширить радиус толерантности клика вокруг пути/объекта на карте

Наследованные параметры из Layer

Параметр	Тип	По умолчанию	Описание
`pane`	`String`	`'overlayPane'`	По умолчанию слой будет добавлен на панель наложения карты overlay pane. Переопределение этого параметра разместит слой по умолчанию на другой панели.
`attribution`	`String`	`null`	Строка, отображаемая в блоке атрибуции, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридическим обязательством перед правообладателями и поставщиками тайлов.

События

События, унаследованные от Renderer

Событие	Данные	Описание
`update`	`Event`	Вызывается, когда рендерер обновляет свои границы, центр и масштаб, например, при перемещении карты

События, унаследованные от Layer

Событие	Данные	Описание
`add`	`Event`	Вызывается после добавления слоя на карту
`remove`	`Event`	Вызывается после удаления слоя с карты

События всплывающих окон, унаследованные от Layer

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Вызывается при открытии всплывающего окна, связанного с этим слоем
`popupclose`	`PopupEvent`	Вызывается при закрытии всплывающего окна, связанного с этим слоем

События всплывающих подсказок, унаследованные от Layer

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Вызывается при открытии всплывающей подсказки, связанной с этим слоем.
`tooltipclose`	`TooltipEvent`	Вызывается при закрытии всплывающей подсказки, связанной с этим слоем.

Методы

Методы, унаследованные от Layer

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой на заданную карту или группу слоёв.
`remove()`	`this`	Удаляет слой с карты, на которой он в настоящее время активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с заданной карты.
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой с заданной `LayerGroup`
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий собой панель с заданным именем на карте. Если `name` опущено, возвращает панель для этого слоя.
`getAttribution()`	`String`	Используется модулем `attribution control`, возвращает параметр атрибуции.

Методы всплывающих окон, унаследованные от Layer

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Привязывает всплывающее окно к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающее окно, ранее привязанное с помощью `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает привязанное всплывающее окно по указанному `latlng` или по умолчанию, если `latlng` не передан.
`closePopup()`	`this`	Закрывает всплывающее окно, привязанное к этому слою, если оно открыто.
`togglePopup()`	`this`	Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true` , если всплывающее окно, привязанное к этому слою, в настоящее время открыто.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающего окна, привязанного к этому слою.
`getPopup()`	`Popup`	Возвращает всплывающее окно, привязанное к этому слою.

Методы, унаследованные от Слой

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Привязывает всплывающую подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет всплывающую подсказку, ранее привязанную с помощью `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает привязанную всплывающую подсказку по указанному `latlng` или по умолчанию, если `latlng` не передан.
`closeTooltip()`	`this`	Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от её текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true` , если всплывающая подсказка, привязанная к этому слою, в настоящее время открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.
`getTooltip()`	`Tooltip`	Возвращает всплывающую подсказку, привязанную к этому слою.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-слушатель (`fn`) к определённому типу события объекта. Можно указать контекст слушателя (объект, к которому будет относиться ключевое слово this). Можно также передать несколько типов, разделённых пробелами (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар тип/слушатель, например `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-слушатель. Если функция не указана, будут удалены все слушатели данного события для объекта. Обратите внимание, что если вы передали пользовательский контекст в `on`, вы должны передать тот же контекст в `off` для удаления слушателя.
`off(<Object> eventMap)`	`this`	Удаляет набор пар тип/слушатель.
`off()`	`this`	Удаляет всех слушателей всех событий на объекте. Это включает неявно прикреплённые события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Можно дополнительно передать объект данных — его свойства будут доступны в качестве первого аргумента функции-слушателя. Событие может быть распространено на родительские элементы.
`listens(<String> type)`	`Boolean`	Возвращает `true` если для определённого типа события есть прикреплённые слушатели.
`once(…)`	`this`	Ведёт себя как `on(…)`, за исключением того, что слушатель будет вызван только один раз, а затем удалён.
`addEventParent(<Evented> obj)`	`this`	Добавляет родительский элемент события — `Evented`, который будет получать распространяемые события.
`removeEventParent(<Evented> obj)`	`this`	Удаляет родительский элемент события, так что он перестанет получать распространяемые события.
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

Функции

Есть несколько статических функций, которые можно вызывать без создания экземпляра L.SVG:

Функция	Возвращает	Описание
`create(<String> name)`	`SVGElement`	Возвращает экземпляр SVGElement, соответствующий переданному имени класса. Например, использование 'line' вернёт экземпляр SVGLineElement.
`pointsToPath(<Point[]> rings, <Boolean> closed)`	`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(<Renderer options> options?)`	Создаёт рендерер Полотно с заданными параметрами.

Параметры

Параметры унаследованы от Рендерера

Опция	Тип	По умолчанию	Описание
`padding`	`Number`	`0.1`	Насколько следует расширить область обрезки вокруг представления карты (относительно её размера). Например, 0,1 соответствует 10% представления карты в каждом направлении
`tolerance`	`Number`	`0`	Насколько следует расширить область толерантности щелчка вокруг пути/объекта на карте

Наследуемые опции из Слой

Опция	Тип	По умолчанию	Описание
`pane`	`String`	`'overlayPane'`	По умолчанию слой будет добавлен в панель наложения карты. Переопределение этой опции заставит слой по умолчанию разместиться на другой панели.
`attribution`	`String`	`null`	Строка, отображаемая в элементе управления подписями, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридической обязанностью по отношению к правообладателям и поставщикам плиток.

События

Наследуемые события из Рендерер

Событие	Данные	Описание
`update`	`Event`	Срабатывает, когда рендерер обновляет свои границы, центр и масштаб, например, когда перемещена карта

Наследуемые события из Слой

Событие	Данные	Описание
`add`	`Event`	Срабатывает после добавления слоя на карту
`remove`	`Event`	Срабатывает после удаления слоя с карты

События всплывающих окон, наследуемые из Слой

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Срабатывает при открытии всплывающего окна, связанного с этим слоем
`popupclose`	`PopupEvent`	Срабатывает при закрытии всплывающего окна, связанного с этим слоем

События всплывающих подсказок, наследуемые из Слой

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Срабатывает при открытии подсказки, связанной с этим слоем.
`tooltipclose`	`TooltipEvent`	Срабатывает при закрытии подсказки, связанной с этим слоем.

Методы

Наследуемые методы из Слой

Метод	Возвращаемое значение	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой на указанную карту или группу слоёв.
`remove()`	`this`	Удаляет слой с карты, на которой он сейчас активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с указанной карты
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из указанной `LayerGroup`
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий указанную панель на карте. Если `name` опущено, возвращает панель для этого слоя.
`getAttribution()`	`String`	Используется элементом `attribution control`, возвращает опцию подписи.

Методы всплывающих окон, наследуемые из Слой

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Привязывает всплывающее окно к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающее окно, ранее привязанное с помощью `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает привязанное всплывающее окно по указанному `latlng` или по умолчанию, если `latlng` не передан.
`closePopup()`	`this`	Закрывает всплывающее окно, привязанное к этому слою, если оно открыто.
`togglePopup()`	`this`	Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true`, если всплывающее окно, привязанное к этому слою, в данный момент открыто.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающего окна, привязанного к этому слою.
`getPopup()`	`Popup`	Возвращает всплывающее окно, привязанное к этому слою.

Методы всплывающего подсказки унаследованные от Слой

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Привязывает подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function` , он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет подсказку, ранее привязанную с помощью `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает привязанную подсказку по указанному `latlng` или по умолчанию, если `latlng` не передан.
`closeTooltip()`	`this`	Закрывает подсказку, привязанную к этому слою, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от её текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true` , если подсказка, привязанная к этому слою, в данный момент открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое подсказки, привязанной к этому слою.
`getTooltip()`	`Tooltip`	Возвращает подсказку, привязанную к этому слою.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-слушатель (`fn`) к определенному типу события объекта. Вы можете необязательно указать контекст слушателя (объект, к которому будет относиться ключевое слово this). Вы также можете передать несколько типов, разделенных пробелами (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар тип/слушатель, например, `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-слушатель. Если функция не указана, она удалит всех слушателей этого конкретного события из объекта. Обратите внимание, что если вы передали пользовательский контекст в `on`, вы должны передать тот же контекст в `off` для удаления слушателя.
`off(<Object> eventMap)`	`this`	Удаляет набор пар тип/слушатель.
`off()`	`this`	Удаляет всех слушателей всех событий объекта. Это включает неявные присоединенные события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — первый аргумент функции-слушателя будет содержать его свойства. Событие может быть необязательно распространено на родительские события.
`listens(<String> type)`	`Boolean`	Возвращает `true`, если для определенного типа события есть какие-либо присоединенные слушатели.
`once(…)`	`this`	Ведет себя как `on(…)`, за исключением того, что слушатель будет вызван один раз, а затем удален.
`addEventParent(<Evented> obj)`	`this`	Добавляет родительское событие — `Evented`, которое будет получать распространяемые события
`removeEventParent(<Evented> obj)`	`this`	Удаляет родительское событие, так что оно перестанет получать распространяемые события
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

Группа слоев (LayerGroup)

Используется для группировки нескольких слоев и обработки их как одного. Если вы добавляете его на карту, любые слои, добавленные или удаленные из группы, также будут добавлены/удалены на карте. Расширяет Layer.

Пример использования (LayerGroup-example)

L.layerGroup([marker1, marker2])
	.addLayer(polyline)
	.addTo(map);

Создание (Layergroup-factory)

Фабрика	Описание
`L.layerGroup(<Layer[]> layers?, <Object> options?)`	Создает группу слоев, необязательно с начальным набором слоев и объектом `options`.

Параметры

Параметры, унаследованные от Слой (Layer)

Параметр	Тип	Значение по умолчанию	Описание
`pane`	`String`	`'overlayPane'`	По умолчанию слой будет добавлен на панель наложения карты (панель наложения). Переопределение этого параметра приведет к размещению слоя на другой панели по умолчанию.
`attribution`	`String`	`null`	Строка, отображаемая в элементе управления атрибутами, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является правовой обязанностью перед держателями авторских прав и поставщиками тайлов.

События

События, унаследованные от Слой (Layer)

Событие	Данные	Описание
`add`	`Event`	Срабатывает после добавления слоя на карту
`remove`	`Event`	Срабатывает после удаления слоя с карты

События всплывающих окон, унаследованные от Слой

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Срабатывает при открытии всплывающего окна, привязанного к этому слою
`popupclose`	`PopupEvent`	Срабатывает при закрытии всплывающего окна, привязанного к этому слою

События подсказок, унаследованные от Слой

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Срабатывает при открытии подсказки, привязанной к этому слою.
`tooltipclose`	`TooltipEvent`	Срабатывает при закрытии подсказки, привязанной к этому слою.

Методы

Метод	Возвращает	Описание
`toGeoJSON(<Number> precision?)`	`Object`	`precision` — количество знаков после запятой для координат. Значение по умолчанию — 6 знаков. Возвращает представление группы слоев в формате `GeoJSON` (как GeoJSON `FeatureCollection`, `GeometryCollection`, или `MultiPoint`).
`addLayer(<Layer> layer)`	`this`	Добавляет указанный слой в группу.
`removeLayer(<Layer> layer)`	`this`	Удаляет указанный слой из группы.
`removeLayer(<Number> id)`	`this`	Удаляет слой с заданным внутренним идентификатором из группы.
`hasLayer(<Layer> layer)`	`Boolean`	Возвращает `true`, если указанный слой в настоящее время добавлен в группу.
`hasLayer(<Number> id)`	`Boolean`	Возвращает `true`, если указанный внутренний идентификатор в настоящее время добавлен в группу.
`clearLayers()`	`this`	Удаляет все слои из группы.
`invoke(<String> methodName, …)`	`this`	Вызывает `methodName` для каждого слоя, содержащегося в этой группе, передавая любые дополнительные параметры. Не оказывает влияния, если содержащиеся слои не реализуют `methodName`.
`eachLayer(<Function> fn, <Object> context?)`	`this`	Итерируется по слоям группы, необязательно указывая контекст функции-итератора. group.eachLayer(function (layer) { layer.bindPopup('Hello'); });
`getLayer(<Number> id)`	`Layer`	Возвращает слой с заданным внутренним идентификатором.
`getLayers()`	`Layer[]`	Возвращает массив всех слоев, добавленных в группу.
`setZIndex(<Number> zIndex)`	`this`	Вызывает `setZIndex` для каждого слоя, содержащегося в этой группе, передавая значение z-индекса.
`getLayerId(<Layer> layer)`	`Number`	Возвращает внутренний идентификатор слоя

Методы, унаследованные от Слой

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой на заданную карту или в группу слоев.
`remove()`	`this`	Удаляет слой с карты, на которой он сейчас активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой со заданной карты
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из заданной `LayerGroup`
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий именованный слой на карте. Если `name` опущен, возвращает слой для этого слоя.
`getAttribution()`	`String`	Используется `attribution control`, возвращает параметр атрибуции.

Методы всплывающего окна, унаследованные от Layer

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Связывает всплывающее окно со слоем с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающее окно, ранее связанное с `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает связанное всплывающее окно в указанной `latlng` или в стандартном якоре всплывающего окна, если `latlng` не передан.
`closePopup()`	`this`	Закрывает всплывающее окно, связанное с этим слоем, если оно открыто.
`togglePopup()`	`this`	Открывает или закрывает всплывающее окно, связанное с этим слоем, в зависимости от его текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true`, если всплывающее окно, связанное с этим слоем, в настоящее время открыто.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающего окна, связанного с этим слоем.
`getPopup()`	`Popup`	Возвращает всплывающее окно, связанное с этим слоем.

Методы всплывающих подсказок, унаследованные от Layer

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Связывает подсказку со слоем с переданной `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет подсказку, ранее связанную с `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает связанную подсказку в указанном `latlng` или в стандартном якоре подсказки, если `latlng` не передан.
`closeTooltip()`	`this`	Закрывает подсказку, связанную с этим слоем, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает подсказку, связанную с этим слоем, в зависимости от ее текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true`, если подсказка, связанная с этим слоем, в настоящее время открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое подсказки, связанной с этим слоем.
`getTooltip()`	`Tooltip`	Возвращает подсказку, связанную с этим слоем.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет обработчик событий (`fn`) к определенному типу события объекта. Вы можете указать контекст обработчика (объект, к которому будет относиться ключевое слово this). Также можно передать несколько типов через пробел (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар тип/обработчик событий, например, `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленный обработчик событий. Если обработчик не указан, удаляются все обработчики данного события для объекта. Обратите внимание, что если вы передали пользовательский контекст для `on`, вы должны передать тот же контекст в `off` для удаления обработчика.
`off(<Object> eventMap)`	`this`	Удаляет набор пар тип/обработчик событий.
`off()`	`this`	Удаляет все обработчики всех событий объекта. Это включает неявно присоединённые события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — первое аргумент функции обработчика будет содержать его свойства. Событие может необязательно распространяться на родительские события.
`listens(<String> type)`	`Boolean`	Возвращает `true` если определенный тип события имеет присоединённые обработчики.
`once(…)`	`this`	Ведёт себя как `on(…)`, за исключением того, что обработчик будет вызван только один раз, а затем удалён.
`addEventParent(<Evented> obj)`	`this`	Добавляет родителя события — `Evented`, который будет получать распространяемые события.
`removeEventParent(<Evented> obj)`	`this`	Удаляет родителя события, чтобы он перестал получать распространяемые события.
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

Группа слоев

Расширенная 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(<Layer[]> layers?, <Object> options?)`	Создаёт группу слоёв, необязательно задав начальный набор слоёв и `options` объект.

Параметры

Параметры, унаследованные от Слой

Параметр	Тип	Значение по умолчанию	Описание
`pane`	`String`	`'overlayPane'`	По умолчанию слой будет добавлен на панель наложения карты overlay pane. Переопределение этого параметра разместит слой на другой панели по умолчанию.
`attribution`	`String`	`null`	Строка, отображаемая в элементе управления атрибуцией, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридическим обязательством перед правообладателями и поставщиками плиток.

События

Событие	Данные	Описание
`layeradd`	`LayerEvent`	Срабатывает при добавлении слоя в этот `FeatureGroup`
`layerremove`	`LayerEvent`	Срабатывает при удалении слоя из этого `FeatureGroup`

События, унаследованные от Слой

Событие	Данные	Описание
`add`	`Event`	Срабатывает после добавления слоя на карту
`remove`	`Event`	Срабатывает после удаления слоя с карты

События всплывающих окон, унаследованные от Слой

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Срабатывает при открытии всплывающего окна, связанного с этим слоем
`popupclose`	`PopupEvent`	Срабатывает при закрытии всплывающего окна, связанного с этим слоем

События подсказок, унаследованные от Слой

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Срабатывает при открытии подсказки, связанной с этим слоем.
`tooltipclose`	`TooltipEvent`	Срабатывает при закрытии подсказки, связанной с этим слоем.

Методы

Метод	Возвращает	Описание
`setStyle(<Path options> style)`	`this`	Устанавливает заданные параметры стиля для каждого слоя группы, имеющего метод `setStyle`.
`bringToFront()`	`this`	Выводит группу слоев поверх всех остальных.
`bringToBack()`	`this`	Выводит группу слоев под все остальные слои.
`getBounds()`	`LatLngBounds`	Возвращает LatLngBounds группы Feature (созданную из границ и координат ее дочерних элементов).

Методы, унаследованные от Группа слоев

Метод	Возвращает	Описание
`toGeoJSON(<Number> precision?)`	`Object`	`precision` — это количество десятичных знаков для координат. Значение по умолчанию — 6 знаков. Возвращает представление группы слоев в формате `GeoJSON` (как GeoJSON `FeatureCollection`, `GeometryCollection`, или `MultiPoint`).
`addLayer(<Layer> layer)`	`this`	Добавляет заданный слой в группу.
`removeLayer(<Layer> layer)`	`this`	Удаляет заданный слой из группы.
`removeLayer(<Number> id)`	`this`	Удаляет слой с заданным внутренним ID из группы.
`hasLayer(<Layer> layer)`	`Boolean`	Возвращает `true`, если заданный слой в данный момент добавлен в группу.
`hasLayer(<Number> id)`	`Boolean`	Возвращает `true`, если заданный внутренний ID в данный момент добавлен в группу.
`clearLayers()`	`this`	Удаляет все слои из группы.
`invoke(<String> methodName, …)`	`this`	Вызывает `methodName` для каждого слоя, содержащегося в этой группе, передавая любые дополнительные параметры. Не имеет эффекта, если содержащиеся слои не реализуют `methodName`.
`eachLayer(<Function> fn, <Object> context?)`	`this`	Итерируется по слоям группы, необязательно указывая контекст функции-итератора. group.eachLayer(function (layer) { layer.bindPopup('Hello'); });
`getLayer(<Number> id)`	`Layer`	Возвращает слой с заданным внутренним ID.
`getLayers()`	`Layer[]`	Возвращает массив всех слоев, добавленных в группу.
`setZIndex(<Number> zIndex)`	`this`	Вызывает `setZIndex` для каждого слоя, содержащегося в этой группе, передавая z-индекс.
`getLayerId(<Layer> layer)`	`Number`	Возвращает внутренний ID слоя.

Методы, унаследованные от Слой

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой в заданную карту или группу слоёв.
`remove()`	`this`	Удаляет слой с карты, на которой он сейчас активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с заданной карты.
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из заданной `LayerGroup`
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий собой указанный слой на карте. Если `name` опущен, возвращает слой для этого слоя.
`getAttribution()`	`String`	Используется `attribution control`, возвращает опцию `attribution control`.

Методы всплывающей подсказки, унаследованные от Слой

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Привязывает всплывающее окно к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающее окно, ранее привязанное с `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает привязанное всплывающее окно по указанному `latlng` или по умолчанию, если `latlng` не передан.
`closePopup()`	`this`	Закрывает всплывающее окно, привязанное к этому слою, если оно открыто.
`togglePopup()`	`this`	Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true`, если всплывающее окно, привязанное к этому слою, в данный момент открыто.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающего окна, привязанного к этому слою.
`getPopup()`	`Popup`	Возвращает всплывающее окно, привязанное к этому слою.

Методы, унаследованные от Layer

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Привязывает подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет подсказку, ранее привязанную с `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает привязанную подсказку по указанному `latlng` или по умолчанию, если `latlng` не передан.
`closeTooltip()`	`this`	Закрывает подсказку, привязанную к этому слою, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от её текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true`, если подсказка, привязанная к этому слою, в данный момент открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое подсказки, привязанной к этому слою.
`getTooltip()`	`Tooltip`	Возвращает подсказку, привязанную к этому слою.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет обработчик событий (`fn`) к объекту для определенного типа событий. Вы можете указать контекст обработчика (объект, к которому будет относиться ключевое слово this). Вы также можете передать несколько типов через пробел (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар "тип/обработчик", например `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленный обработчик событий. Если функция не указана, будут удалены все обработчики этого события для объекта. Обратите внимание, что если вы передали пользовательский контекст в `on`, вы должны передать тот же контекст в `off` для удаления обработчика.
`off(<Object> eventMap)`	`this`	Удаляет набор пар "тип/обработчик".
`off()`	`this`	Удаляет все обработчики всех событий объекта. Включая неявные обработчики событий.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Вы можете дополнительно предоставить объект данных — первое аргумент функции обработчика будет содержать его свойства. Событие может быть распространено на родительские элементы.
`listens(<String> type)`	`Boolean`	Возвращает `true` если для определенного типа события прикреплены какие-либо обработчики.
`once(…)`	`this`	Действует как `on(…)`, за исключением того, что обработчик будет вызван только один раз, а затем удалён.
`addEventParent(<Evented> obj)`	`this`	Добавляет родительский элемент события — `Evented`, который будет получать распространяемые события.
`removeEventParent(<Evented> obj)`	`this`	Удаляет родительский элемент события, чтобы он перестал получать распространяемые события.
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

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(<Object> geojson?, <GeoJSON options> options?)`	Создаёт слой 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; } Примечание: динамическое изменение опции `filter` повлияет только на новые данные. Она не переоценит уже включённые объекты.
`coordsToLatLng`	`Function`	`*`	Функция для преобразования координат GeoJSON в `LatLng`. По умолчанию используется статический метод `coordsToLatLng`.
`markersInheritOptions`	`Boolean`	`false`	Наследуют ли маркеры по умолчанию для объектов типа "Точка" опции группы.

Опции, унаследованные от Слой

Опция	Тип	По умолчанию	Описание
`pane`	`String`	`'overlayPane'`	По умолчанию слой добавляется в панель наложений карты overlay pane. Переопределение этой опции поместит слой на другую панель по умолчанию.
`attribution`	`String`	`null`	Строка, отображаемая в элементе управления атрибутами, например, "© OpenStreetMap contributors". Описывает данные слоя и часто является юридической обязанностью перед правообладателями и поставщиками тайлов.

События

События, унаследованные от FeatureGroup

Событие	Данные	Описание
`layeradd`	`LayerEvent`	Срабатывает при добавлении слоя в эту `FeatureGroup`
`layerremove`	`LayerEvent`	Срабатывает при удалении слоя из этой `FeatureGroup`

События, унаследованные от Слой

Событие	Данные	Описание
`add`	`Event`	Срабатывает после добавления слоя на карту
`remove`	`Event`	Срабатывает после удаления слоя с карты

События всплывающей подсказки, унаследованные от Слой

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Срабатывает при открытии всплывающей подсказки, привязанной к этому слою
`popupclose`	`PopupEvent`	Срабатывает при закрытии всплывающей подсказки, привязанной к этому слою

События подсказки, унаследованные от Слой

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Срабатывает при открытии подсказки, привязанной к этому слою.
`tooltipclose`	`TooltipEvent`	Срабатывает при закрытии подсказки, привязанной к этому слою.

Методы

Метод	Возвращает	Описание
`addData(data)`	`this`	Добавляет объект GeoJSON в слой.
`resetStyle(layer?)`	`this`	Сбрасывает стиль заданного векторного слоя до исходного стиля GeoJSON, что полезно для сброса стиля после событий наведения. Если `layer` опущено, стиль всех объектов в текущем слое сбрасывается.
`setStyle(style)`	`this`	Изменяет стили векторных слоёв GeoJSON с помощью заданной функции стиля.

Методы, унаследованные от FeatureGroup

Метод	Возвращает	Описание
`bringToFront()`	`this`	Выводит группу слоёв поверх всех остальных слоёв.
`bringToBack()`	`this`	Выводит группу слоёв под все остальные слои.
`getBounds()`	`LatLngBounds`	Возвращает LatLngBounds группы объектов (созданной из границ и координат её дочерних элементов).

Методы, унаследованные от LayerGroup

Метод	Возвращает	Описание
`toGeoJSON(<Number> precision?)`	`Object`	`precision` — количество десятичных знаков для координат. Значение по умолчанию — 6 знаков. Возвращает представление группы слоёв в формате `GeoJSON` (как GeoJSON `FeatureCollection`, `GeometryCollection`, или `MultiPoint`).
`addLayer(<Layer> layer)`	`this`	Добавляет заданный слой в группу.
`removeLayer(<Layer> layer)`	`this`	Удаляет заданный слой из группы.
`removeLayer(<Number> id)`	`this`	Удаляет слой с заданным внутренним идентификатором из группы.
`hasLayer(<Layer> layer)`	`Boolean`	Возвращает `true`, если заданный слой в данный момент добавлен в группу.
`hasLayer(<Number> id)`	`Boolean`	Возвращает `true`, если заданный внутренний идентификатор в данный момент добавлен в группу.
`clearLayers()`	`this`	Удаляет все слои из группы.
`invoke(<String> methodName, …)`	`this`	Вызывает `methodName` для каждого слоя в этой группе, передавая дополнительные параметры. Не имеет эффекта, если содержащиеся слои не реализуют `methodName`.
`eachLayer(<Function> fn, <Object> context?)`	`this`	Итерирует по слоям группы, необязательно указывая контекст функции-итератора. group.eachLayer(function (layer) { layer.bindPopup('Hello'); });
`getLayer(<Number> id)`	`Layer`	Возвращает слой с заданным внутренним идентификатором.
`getLayers()`	`Layer[]`	Возвращает массив всех слоёв, добавленных в группу.
`setZIndex(<Number> zIndex)`	`this`	Вызывает `setZIndex` для каждого слоя в этой группе, передавая z-индекс.
`getLayerId(<Layer> layer)`	`Number`	Возвращает внутренний идентификатор слоя.

Методы, унаследованные от Слой

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой на заданную карту или группу слоев.
`remove()`	`this`	Удаляет слой с карты, на которой он в настоящее время активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой со заданной карты.
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из заданной `LayerGroup`
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий заданный на карте слой. Если `name` опущено, возвращает слой для этого слоя.
`getAttribution()`	`String`	Используется `attribution control`, возвращает опцию атрибуции.

Методы всплывающих окон, унаследованные от Слой

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Привязывает всплывающее окно к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающее окно, ранее привязанное с помощью `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает привязанное всплывающее окно в указанной `latlng` или в стандартном якоре всплывающего окна, если `latlng` не передан.
`closePopup()`	`this`	Закрывает привязанное всплывающее окно для этого слоя, если оно открыто.
`togglePopup()`	`this`	Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true`, если всплывающее окно, привязанное к этому слою, в настоящее время открыто.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающего окна, привязанного к этому слою.
`getPopup()`	`Popup`	Возвращает всплывающее окно, привязанное к этому слою.

Методы подсказок, унаследованные от Слой

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Привязывает подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет подсказку, ранее привязанную с помощью `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает привязанную подсказку в указанной `latlng` или в стандартном якоре подсказки, если `latlng` не передан.
`closeTooltip()`	`this`	Закрывает подсказку, привязанную к этому слою, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от ее текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true` если подсказка, привязанная к этому слою, в настоящее время открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое подсказки, привязанной к этому слою.
`getTooltip()`	`Tooltip`	Возвращает подсказку, привязанную к этому слою.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-слушатель (`fn`) к определенному типу события объекта. Вы можете указать контекст слушателя (объект, к которому будет относиться ключевое слово this). Также вы можете передать несколько типов, разделенных пробелом (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар тип/слушатель, например, `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-слушатель. Если функция не указана, будут удалены все слушатели этого конкретного события из объекта. Обратите внимание, что если вы передали пользовательский контекст для `on`, вы должны передать тот же контекст для `off` для удаления слушателя.
`off(<Object> eventMap)`	`this`	Удаляет набор пар тип/слушатель.
`off()`	`this`	Удаляет всех слушателей всех событий объекта. Включает неявно присоединённые события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Вы можете дополнительно передать объект данных — свойства этого объекта будут доступны как первый аргумент функции-слушателя. Событие может быть дополнительно распространено на родительские события.
`listens(<String> type)`	`Boolean`	Возвращает `true` , если для конкретного типа события есть какие-либо присоединенные слушатели.
`once(…)`	`this`	Ведет себя как `on(…)`, за исключением того, что слушатель будет вызван только один раз, а затем удален.
`addEventParent(<Evented> obj)`	`this`	Добавляет родительский элемент события — `Evented`, который будет получать распространяемые события
`removeEventParent(<Evented> obj)`	`this`	Удаляет родительский элемент события, поэтому он перестанет получать распространяемые события
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

Функции

Существует несколько статических функций, которые можно вызывать без создания экземпляра L.GeoJSON:

Функция	Возвращает	Описание
`geometryToLayer(<Object> featureData, <GeoJSON options> options?)`	`Layer`	Создаёт `Layer` из заданного GeoJSON-объекта. Может использовать пользовательские функции `pointToLayer` и/или `coordsToLatLng` в качестве опций.
`coordsToLatLng(<Array> coords)`	`LatLng`	Создаёт объект `LatLng` из массива из 2 чисел (долгота, широта) или 3 чисел (долгота, широта, высота), используемых в GeoJSON для точек.
`coordsToLatLngs(<Array> coords, <Number> levelsDeep?, <Function> coordsToLatLng?)`	`Array`	Создаёт многомерный массив объектов `LatLng` из массива координат GeoJSON. `levelsDeep` определяет уровень вложенности (0 — массив точек, 1 — массив массивов точек и т. д., по умолчанию 0). Может использовать пользовательскую функцию `coordsToLatLng`.
`latLngToCoords(<LatLng> latlng, <Number> precision?)`	`Array`	Обратная функция `coordsToLatLng`
`latLngsToCoords(<Array> latlngs, <Number> levelsDeep?, <Boolean> closed?)`	`Array`	Обратная функция `coordsToLatLngs`. `closed` определяет, следует ли добавлять первую точку в конец массива для закрытия фигуры, используется только при `levelsDeep` равном 0. По умолчанию false.
`asFeature(<Object> geojson)`	`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 options> options?)`	Создаёт новый экземпляр 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 будет отображаться только один раз на низких уровнях масштабирования. Не имеет эффекта, если система координат карты `bounds` не перематывается. Может использоваться в сочетании с `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(<Number> opacity)`	`this`	Изменяет прозрачность слоя сетки.
`setZIndex(<Number> zIndex)`	`this`	Изменяет zIndex слоя сетки.
`isLoading()`	`Boolean`	Возвращает `true`, если какой-либо тайл в слое сетки еще не завершил загрузку.
`redraw()`	`this`	Принудительно очищает все тайлы слоя и запрашивает их снова.
`getTileSize()`	`Point`	Нормализует опцию tileSize в точку. Используется методом `createTile()`.

Методы расширения

Слои, расширяющие GridLayer, должны переопределять следующий метод.

Метод	Возвращает	Описание
`createTile(<Object> coords, <Function> done?)`	`HTMLElement`	Вызывается только внутренне, должен быть переопределён классами, расширяющими `GridLayer`. Возвращает `HTMLElement` , соответствующий данному `coords`. Если указана коллбэк-функция `done`, она должна быть вызвана после завершения загрузки и отрисовки тайла.

Методы, унаследованные от Слой

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой на заданную карту или группу слоёв.
`remove()`	`this`	Удаляет слой с карты, на которой он в данный момент активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой со заданной карты.
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из заданной `LayerGroup`.
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий собой указанную область на карте. Если `name` опущено, возвращает область для данного слоя.
`getAttribution()`	`String`	Используется `attribution control`, возвращает опцию атрибуции.

Методы всплывающих окон, унаследованные от Слой

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Привязывает всплывающее окно к слою с переданным `content` и устанавливает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет ранее привязанное всплывающее окно с помощью `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает привязанное всплывающее окно в указанной `latlng` или по умолчанию в якоре всплывающего окна, если `latlng` не передан.
`closePopup()`	`this`	Закрывает всплывающее окно, привязанное к этому слою, если оно открыто.
`togglePopup()`	`this`	Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true`, если всплывающее окно, привязанное к этому слою, в данный момент открыто.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающего окна, привязанного к этому слою.
`getPopup()`	`Popup`	Возвращает всплывающее окно, привязанное к этому слою.

Методы всплывающих подсказок, унаследованные от Слой

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Привязывает подсказку к слою с переданным `content` и устанавливает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет ранее привязанную подсказку с помощью `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает привязанную подсказку в указанной `latlng` или по умолчанию в якоре подсказки, если `latlng` не передан.
`closeTooltip()`	`this`	Закрывает подсказку, привязанную к этому слою, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от её текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true`, если подсказка, привязанная к этому слою, в данный момент открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое подсказки, привязанной к этому слою.
`getTooltip()`	`Tooltip`	Возвращает подсказку, привязанную к этому слою.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-слушатель (`fn`) к определенному типу события объекта. Вы можете указать контекст слушателя (объект, к которому будет относиться ключевое слово this). Также можно передать несколько типов через пробел (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар "тип/слушатель", например, `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-слушатель. Если функция не указана, удаляются все слушатели этого конкретного события из объекта. Обратите внимание, что если вы передали пользовательский контекст в `on`, вы должны передать тот же контекст в `off` для удаления слушателя.
`off(<Object> eventMap)`	`this`	Удаляет набор пар "тип/слушатель".
`off()`	`this`	Удаляет всех слушателей всех событий объекта. Это включает неявно прикрепленные события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Вы можете дополнительно предоставить объект данных — свойства этого объекта будут доступны в качестве первого аргумента функции-слушателя. Событие может быть необязательно распространено на родительские события.
`listens(<String> type)`	`Boolean`	Возвращает `true` , если для определенного типа события прикреплены какие-либо слушатели.
`once(…)`	`this`	Ведет себя как `on(…)`, за исключением того, что слушатель будет вызван только один раз, а затем удален.
`addEventParent(<Evented> obj)`	`this`	Добавляет родительское событие — `Evented`, которое будет получать распространяемые события.
`removeEventParent(<Evented> obj)`	`this`	Удаляет родительское событие, чтобы оно перестало получать распространяемые события.
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

LatLng

Представляет географическую точку с определенной широтой и долготой.

Пример использования

var latlng = L.latLng(50.5, 30.5);

Все методы Leaflet, принимающие объекты LatLng, также принимают их в простом формате массива и простом формате объекта (если не указано иное), поэтому эти строки эквивалентны:

map.panTo([50, 30]);
map.panTo({lon: 30, lat: 50});
map.panTo({lat: 50, lng: 30});
map.panTo(L.latLng(50, 30));

Обратите внимание, что LatLng не наследуется от объекта Class Leaflet, что означает, что новые классы не могут наследоваться от него, и новые методы не могут быть добавлены к нему с помощью функции include.

Создание

Фабрика	Описание
`L.latLng(<Number> latitude, <Number> longitude, <Number> altitude?)`	Создает объект, представляющий географическую точку с заданной широтой и долготой (и, необязательно, высотой).
`L.latLng(<Array> coords)`	Ожидает массив вида `[Number, Number]` или `[Number, Number, Number]` вместо него.
`L.latLng(<Object> coords)`	Ожидает простой объект вида `{lat: Number, lng: Number}` или `{lat: Number, lng: Number, alt: Number}` вместо него.

Методы

Метод	Возвращает	Описание
`equals(<LatLng> otherLatLng, <Number> maxMargin?)`	`Boolean`	Возвращает `true`, если заданная точка `LatLng` находится в той же позиции (в пределах небольшой погрешности). Погрешность можно переопределить, установив `maxMargin` на небольшое значение.
`toString()`	`String`	Возвращает строковое представление точки (для отладки).
`distanceTo(<LatLng> otherLatLng)`	`Number`	Возвращает расстояние (в метрах) до заданной `LatLng` точки, вычисленное с использованием Сферического закона косинусов.
`wrap()`	`LatLng`	Возвращает новый объект `LatLng` с долготой, обернутой так, чтобы она всегда находилась в диапазоне от -180 до +180 градусов.
`toBounds(<Number> sizeInMeters)`	`LatLngBounds`	Возвращает новый объект `LatLngBounds`, в котором каждая граница находится на расстоянии `sizeInMeters/2` метров от `LatLng` точки.

Свойства

Свойство	Тип	Описание
`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 не наследуется от объекта Leaflet Class, что означает, что новые классы не могут наследоваться от него, и новые методы не могут быть добавлены к нему с помощью функции include.

Создание

Фабрика	Описание
`L.latLngBounds(<LatLng> corner1, <LatLng> corner2)`	Создает объект `LatLngBounds`, определяя две диагонально противоположные вершины прямоугольника.
`L.latLngBounds(<LatLng[]> latlngs)`	Создает объект `LatLngBounds`, определяемый географическими точками, которые он содержит. Очень полезно для масштабирования карты до соответствия определенному набору местоположений с помощью `fitBounds`.

Методы

Метод	Возвращает	Описание
`extend(<LatLng> latlng)`	`this`	Расширить область, чтобы она содержала заданную точку
`extend(<LatLngBounds> otherBounds)`	`this`	Расширить область, чтобы она содержала заданную область
`pad(<Number> bufferRatio)`	`LatLngBounds`	Возвращает область, созданную путём расширения или сужения текущей области на заданный коэффициент в каждом направлении. Например, коэффициент 0,5 расширит область на 50% в каждом направлении. Отрицательные значения сузят область.
`getCenter()`	`LatLng`	Возвращает центральную точку области.
`getSouthWest()`	`LatLng`	Возвращает юго-западную точку области.
`getNorthEast()`	`LatLng`	Возвращает северо-восточную точку области.
`getNorthWest()`	`LatLng`	Возвращает северо-западную точку области.
`getSouthEast()`	`LatLng`	Возвращает юго-восточную точку области.
`getWest()`	`Number`	Возвращает западную долготу области.
`getSouth()`	`Number`	Возвращает южную широту области.
`getEast()`	`Number`	Возвращает восточную долготу области.
`getNorth()`	`Number`	Возвращает северную широту области.
`contains(<LatLngBounds> otherBounds)`	`Boolean`	Возвращает `true` , если прямоугольник содержит заданный.
`contains(<LatLng> latlng)`	`Boolean`	Возвращает `true` , если прямоугольник содержит заданную точку.
`intersects(<LatLngBounds> otherBounds)`	`Boolean`	Возвращает `true` , если прямоугольник пересекается с заданной областью. Две области пересекаются, если у них есть хотя бы одна общая точка.
`overlaps(<LatLngBounds> otherBounds)`	`Boolean`	Возвращает `true` , если прямоугольник перекрывается с заданной областью. Две области перекрываются, если их пересечение представляет собой область.
`toBBoxString()`	`String`	Возвращает строку с координатами рамки в формате 'southwest_lng,southwest_lat,northeast_lng,northeast_lat'. Полезно для отправки запросов веб-сервисам, возвращающим геоданные.
`equals(<LatLngBounds> otherBounds, <Number> maxMargin?)`	`Boolean`	Возвращает `true` , если прямоугольник эквивалентен (в пределах небольшой погрешности) заданной области. Погрешность можно настроить, задав `maxMargin` небольшое значение.
`isValid()`	`Boolean`	Возвращает `true` , если область должным образом инициализирована.

Точка

Представляет точку с координатами 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(<Number> x, <Number> y, <Boolean> round?)`	Создаёт объект Point с заданными координатами `x` и `y`. Если необязательный `round` равен true, округляет значения `x` и `y`.
`L.point(<Number[]> coords)`	Ожидает массив в формате `[x, y]`.
`L.point(<Object> coords)`	Ожидает простой объект в формате `{x: Number, y: Number}`.

Методы

Метод	Возвращает	Описание
`clone()`	`Point`	Возвращает копию текущей точки.
`add(<Point> otherPoint)`	`Point`	Возвращает результат сложения текущей и заданной точек.
`subtract(<Point> otherPoint)`	`Point`	Возвращает результат вычитания заданной точки из текущей.
`divideBy(<Number> num)`	`Point`	Возвращает результат деления текущей точки на заданное число.
`multiplyBy(<Number> num)`	`Point`	Возвращает результат умножения текущей точки на заданное число.
`scaleBy(<Point> scale)`	`Point`	Умножает каждую координату текущей точки на каждую координату `scale`. В терминах линейной алгебры, умножает точку на матрицу масштабирования, определённую `scale`.
`unscaleBy(<Point> scale)`	`Point`	Обратное преобразование `scaleBy`. Делит каждую координату текущей точки на каждую координату `scale`.
`round()`	`Point`	Возвращает копию текущей точки с округленными координатами.
`floor()`	`Point`	Возвращает копию текущей точки с округленными вниз координатами.
`ceil()`	`Point`	Возвращает копию текущей точки с округленными вверх координатами.
`trunc()`	`Point`	Возвращает копию текущей точки с усеченными координатами (округление к нулю).
`distanceTo(<Point> otherPoint)`	`Number`	Возвращает евклидово расстояние между текущей и заданной точками.
`equals(<Point> otherPoint)`	`Boolean`	Возвращает `true`, если у заданной точки те же координаты.
`contains(<Point> otherPoint)`	`Boolean`	Возвращает `true`, если обе координаты заданной точки меньше соответствующих координат текущей точки (по модулю).
`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(<Point> corner1, <Point> corner2)`	Создаёт объект Bounds из двух пар координат углов.
`L.bounds(<Point[]> points)`	Создаёт объект Bounds из заданного массива точек.

Методы

Метод	Возвращает	Описание
`extend(<Point> point)`	`this`	Расширяет область, чтобы она содержала заданную точку.
`getCenter(<Boolean> round?)`	`Point`	Возвращает центральную точку области.
`getBottomLeft()`	`Point`	Возвращает нижнюю левую точку области.
`getTopRight()`	`Point`	Возвращает верхнюю правую точку области.
`getTopLeft()`	`Point`	Возвращает верхнюю левую точку области (т.е. `this.min`).
`getBottomRight()`	`Point`	Возвращает нижнюю правую точку области (т.е. `this.max`).
`getSize()`	`Point`	Возвращает размер заданной области.
`contains(<Bounds> otherBounds)`	`Boolean`	Возвращает `true`, если прямоугольник содержит заданный.
`contains(<Point> point)`	`Boolean`	Возвращает `true`, если прямоугольник содержит заданную точку.
`intersects(<Bounds> otherBounds)`	`Boolean`	Возвращает `true`, если прямоугольник пересекается с заданной областью. Две области пересекаются, если у них есть хотя бы одна общая точка.
`overlaps(<Bounds> otherBounds)`	`Boolean`	Возвращает `true`, если прямоугольник перекрывается с заданной областью. Две области перекрываются, если их пересечение является областью.

Свойства

Свойство	Тип	Описание
`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(<Icon options> options)`	Создаёт экземпляр значка с заданными параметрами.

Параметры

Опция	Тип	По умолчанию	Описание
`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`	`''`	Настраиваемое имя класса, которое будет присвоено изображениям значка и тени. По умолчанию пусто.

Методы

Метод	Возвращает	Описание
`createIcon(<HTMLElement> oldIcon?)`	`HTMLElement`	Вызывается внутри, когда значок должен быть показан, возвращает элемент HTML `<img>` с стилями, соответствующими опциям.
`createShadow(<HTMLElement> oldIcon?)`	`HTMLElement`	Аналогично `createIcon`, но для тени под ним.

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 options> options)`	Создаёт экземпляр `DivIcon` с заданными опциями.

Опции

Опция	Тип	По умолчанию	Описание
`html`	`String\|HTMLElement`	`''`	Пользовательский HTML-код для вставки в элемент div, по умолчанию пусто. В качестве альтернативы, экземпляр `HTMLElement`.
`bgPos`	`Point`	`[0, 0]`	Необязательная относительная позиция фона в пикселях

Наследственные параметры от Icon

Параметр	Тип	Значение по умолчанию	Описание
`iconUrl`	`String`	`null`	(обязательно) URL изображения значка (абсолютный или относительный к пути вашего скрипта).
`iconRetinaUrl`	`String`	`null`	URL изображения значка в разрешении Retina (абсолютный или относительный к пути вашего скрипта). Используется для устройств с экранами 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`	`''`	Пользовательское имя класса, которое будет присвоено как изображению значка, так и изображению тени. По умолчанию пустое.

Методы

Наследственные методы от Icon

Метод	Возвращает	Описание
`createIcon(<HTMLElement> oldIcon?)`	`HTMLElement`	Вызывается внутри, когда значок должен быть показан, возвращает `<img>` HTML-элемент, стилизованный в соответствии с параметрами.
`createShadow(<HTMLElement> oldIcon?)`	`HTMLElement`	Аналогично `createIcon`, но для тени под ним.

Control.Zoom

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

Создание

Фабрика	Описание
`L.control.zoom(<Control.Zoom options> options)`	Создает панель масштабирования

Параметры

Параметр	Тип	Значение по умолчанию	Описание
`zoomInText`	`String`	`'+'`	Текст на кнопке "увеличение масштаба".
`zoomInTitle`	`String`	`'Zoom in'`	Заголовок на кнопке "увеличение масштаба".
`zoomOutText`	`String`	`'&#x2212`	Текст на кнопке "уменьшение масштаба".
`zoomOutTitle`	`String`	`'Zoom out'`	Заголовок на кнопке "уменьшение масштаба".

Наследственные параметры от Control

Параметр	Тип	Значение по умолчанию	Описание
`position`	`String`	`'topright'`	Положение элемента управления (один из углов карты). Возможные значения `'topleft'`, `'topright'`, `'bottomleft'` или `'bottomright'`

Методы

Наследственные методы от Control

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

Управление атрибутами

Элемент управления атрибутами позволяет отображать данные атрибуции в небольшом текстовом поле на карте. Он добавляется на карту по умолчанию, если не задан параметр attributionControl со значением false, и автоматически извлекает тексты атрибуции из слоёв с помощью метода getAttribution. Наследует от Control.

Создание

Фабрика	Описание
`L.control.attribution(<Control.Attribution options> options)`	Создаёт элемент управления атрибутами.

Параметры

Параметр	Тип	Значение по умолчанию	Описание
`prefix`	`String`	`'Leaflet'`	HTML-текст, отображаемый перед атрибуциями. Передайте `false`, чтобы отключить.

Параметры, унаследованные от Управления

Параметр	Тип	Значение по умолчанию	Описание
`position`	`String`	`'topright'`	Положение элемента управления (один из углов карты). Возможные значения: `'topleft'`, `'topright'`, `'bottomleft'` или `'bottomright'`

Методы

Метод	Возвращает	Описание
`setPrefix(<String> prefix)`	`this`	Устанавливает текст перед атрибуциями.
`addAttribution(<String> text)`	`this`	Добавляет текст атрибуции (например, `'Vector data © Mapbox'`).
`removeAttribution(<String> text)`	`this`	Удаляет текст атрибуции.

Методы, унаследованные от Управления

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

Управление слоями

Элемент управления слоями позволяет пользователям переключаться между различными базовыми слоями и включать/отключать наложения (подробнее в примере). Наследует от 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(<Object> baselayers?, <Object> overlays?, <Control.Layers options> options?) Создаёт элемент управления слоями с заданными слоями. Базовые слои будут переключаться с помощью радиокнопок, а наложения — с помощью флажков. Обратите внимание, что все базовые слои должны быть переданы в объекте baseLayers, но только один должен быть добавлен на карту при инициализации карты.

Параметры

Параметр	Тип	Значение по умолчанию	Описание
`collapsed`	`Boolean`	`true`	Если `true`, управление будет свернуто в значок и развернуто при наведении курсора или касании.
`autoZIndex`	`Boolean`	`true`	Если `true`, управление будет назначать z-индексы в порядке возрастания всем слоям, чтобы порядок сохранялся при включении/выключении слоев.
`hideSingleBase`	`Boolean`	`false`	Если `true`, базовые слои в управлении будут скрыты, если их только один.
`sortLayers`	`Boolean`	`false`	Необходимо ли сортировать слои. Когда `false`, слои сохранят порядок, в котором они были добавлены в управление.
`sortFunction`	`Function`	`*`	Функция сравнения для сортировки слоев, которая будет использована при `sortLayers`, равном `true`. Функция получает экземпляры `L.Layer` и их имена, как в `sortFunction(layerA, layerB, nameA, nameB)`. По умолчанию она сортирует слои по имени в алфавитном порядке.

Параметры, унаследованные от Control

Параметр	Тип	Значение по умолчанию	Описание
`position`	`String`	`'topright'`	Положение управления (один из углов карты). Возможные значения: `'topleft'`, `'topright'`, `'bottomleft'` или `'bottomright'`

Методы

Метод	Возвращаемое значение	Описание
`addBaseLayer(<Layer> layer, <String> name)`	`this`	Добавляет базовый слой (элемент радиокнопки) с заданным именем в управление.
`addOverlay(<Layer> layer, <String> name)`	`this`	Добавляет наложение (элемент флажка) с заданным именем в управление.
`removeLayer(<Layer> layer)`	`this`	Удаляет заданный слой из управления.
`expand()`	`this`	Развернуть контейнер управления, если он свернут.
`collapse()`	`this`	Свернуть контейнер управления, если он развернут.

Методы, унаследованные от Control

Метод	Возвращаемое значение	Описание
`getPosition()`	`string`	Возвращает положение управления.
`setPosition(<string> position)`	`this`	Устанавливает положение управления.
`getContainer()`	`HTMLElement`	Возвращает HTMLElement, содержащий управление.
`addTo(<Map> map)`	`this`	Добавляет управление на заданную карту.
`remove()`	`this`	Удаляет управление с карты, на которой оно активное.

Control.Scale

Простой инструмент масштабирования, отображающий масштаб текущего центра экрана в метрической (м/км) и имперской (ми/футах) системах. Расширяет Control.

Пример использования

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

Создание

Фабрика	Описание
`L.control.scale(<Control.Scale options> options?)`	Создает инструмент масштабирования с заданными параметрами.

Параметры

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

Наследуемые опции от Control

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

Методы

Наследуемые методы от Control

Метод	Возвращаемое значение	Описание
`getPosition()`	`string`	Возвращает положение элемента управления.
`setPosition(<string> position)`	`this`	Устанавливает положение элемента управления.
`getContainer()`	`HTMLElement`	Возвращает HTMLElement, содержащий элемент управления.
`addTo(<Map> map)`	`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 (в частности, IE10).
`pointer`	`Boolean`	`true` для всех браузеров, поддерживающих события pointer events.
`touch`	`Boolean`	`true` для всех браузеров, поддерживающих события touch. Это не обязательно означает, что браузер работает на компьютере с сенсорным экраном, а лишь то, что браузер способен понимать события touch.
`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.

Util

Различные служебные функции, используемые Leaflet внутри.

Функции

Функция	Возвращает	Описание
`extend(<Object> dest, <Object> src?)`	`Object`	Объединяет свойства объекта `src` (или нескольких объектов) в объект `dest` и возвращает последний. Имеет сокращение `L.extend`.
`create(<Object> proto, <Object> properties?)`	`Object`	Полифил совместимости для Object.create
`bind(<Function> fn, …)`	`Function`	Возвращает новую функцию, привязанную к переданным аргументам, как Function.prototype.bind. Имеет сокращение `L.bind()`.
`stamp(<Object> obj)`	`Number`	Возвращает уникальный идентификатор объекта, присваивая его, если он отсутствует.
`throttle(<Function> fn, <Number> time, <Object> context)`	`Function`	Возвращает функцию, которая выполняет функцию `fn` с заданным контекстом `context` (так что ключевое слово `this` ссылается на `context` внутри кода `fn`). Функция `fn` будет вызываться не более одного раза за заданное количество `time`. Аргументы, получаемые привязанной функцией, будут любыми аргументами, переданными при привязке функции, за которыми следуют любые аргументы, переданные при вызове привязанной функции. Имеет сокращение `L.throttle`.
`wrapNum(<Number> num, <Number[]> range, <Boolean> includeMax?)`	`Number`	Возвращает число `num` по модулю `range` таким образом, чтобы оно находилось в диапазоне от `range[0]` до `range[1]`. Возвращаемое значение всегда будет меньше `range[1]`, если `includeMax` не установлено в `true`.
`falseFn()`	`Function`	Возвращает функцию, которая всегда возвращает `false`.
`formatNum(<Number> num, <Number> digits?)`	`Number`	Возвращает число `num`, округлённое до `digits` десятичных знаков, или до 6 по умолчанию.
`trim(<String> str)`	`String`	Полифил совместимости для String.prototype.trim
`splitWords(<String> str)`	`String[]`	Удаляет пробелы и разбивает строку на слова, возвращая массив частей.
`setOptions(<Object> obj, <Object> options)`	`Object`	Объединяет заданные свойства в опции объекта `options` объекта `obj`, возвращая результирующие опции. Смотрите `Class options`. Имеет сокращение `L.setOptions`.
`getParamString(<Object> obj, <String> existingUrl?, <Boolean> uppercase?)`	`String`	Преобразует объект в строку параметров URL, например, `{a: "foo", b: "bar"}` преобразуется в `'?a=foo&b=bar'`. Если `existingUrl` установлено, параметры будут добавлены в конец. Если `uppercase` равно `true`, имена параметров будут приведены к верхнему регистру (например, `'?A=foo&B=bar'`).
`template(<String> str, <Object> data)`	`String`	Простая система шаблонов, принимает строку шаблона вида `'Hello {a}, {b}'` и объект данных, как `{a: 'foo', b: 'bar'}`, возвращает вычисленную строку `('Hello foo, bar')`. Вы также можете указать функции вместо строк для значений данных — они будут вычислены, передавая `data` в качестве аргумента.
`isArray(obj)`	`Boolean`	Полифил совместимости для Array.isArray
`indexOf(<Array> array, <Object> el)`	`Number`	Полифил совместимости для Array.prototype.indexOf
`requestAnimFrame(<Function> fn, <Object> context?, <Boolean> immediate?)`	`Number`	Планирует выполнение `fn` при перерисовке браузера. `fn` привязывается к `context`, если задано. Если `immediate` установлено, `fn` вызывается немедленно, если браузер не поддерживает `window.requestAnimationFrame`, в противном случае задержка. Возвращает идентификатор запроса, который может быть использован для отмены запроса.
`cancelAnimFrame(<Number> id)`	`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(<Number> a, <Number> b, <Number> c, <Number> d)`	Создает объект Transformation с заданными коэффициентами.
`L.transformation(<Array> coefficients)`	Ожидает массив коэффициентов в форме `[a: Number, b: Number, c: Number, d: Number]`.

Методы

Метод	Возвращает	Описание
`transform(<Point> point, <Number> scale?)`	`Point`	Возвращает преобразованную точку, необязательно умноженную на заданный масштаб. Принимает только экземпляры `L.Point`, а не массивы.
`untransform(<Point> point, <Number> scale?)`	`Point`	Возвращает обратное преобразование заданной точки, необязательно поделенное на заданный масштаб. Принимает только экземпляры `L.Point`, а не массивы.

LineUtil

Различные служебные функции для обработки точек полилиний, используемые Leaflet для повышения скорости работы с полилиниями.

Функции

Функция	Возвращает	Описание
`simplify(<Point[]> points, <Number> tolerance)`	`Point[]`	Драматически уменьшает количество точек в полилинии, сохраняя ее форму, и возвращает новый массив упрощенных точек, используя алгоритм Douglas-Peucker. Используется для существенного повышения производительности при обработке/отображении полилиний Leaflet на каждом уровне масштабирования, а также для уменьшения визуального шума. tolerance влияет на степень упрощения (меньшее значение означает более высокое качество, но медленнее и с большим количеством точек). Также выпущен как отдельная микробиблиотека Simplify.js.
`pointToSegmentDistance(<Point> p, <Point> p1, <Point> p2)`	`Number`	Возвращает расстояние между точкой `p` и отрезком `p1` до `p2`.
`closestPointOnSegment(<Point> p, <Point> p1, <Point> p2)`	`Number`	Возвращает ближайшую точку от точки `p` к отрезку `p1` до `p2`.
`clipSegment(<Point> a, <Point> b, <Bounds> bounds, <Boolean> useLastCode?, <Boolean> round?)`	`Point[]\|Boolean`	Обрезает отрезок a to b прямоугольными границами с помощью алгоритма Cohen-Sutherland (непосредственно изменяя точки отрезка!). Используется Leaflet для отображения только точек полилинии, которые находятся на экране или рядом, повышая производительность.
`isFlat(<LatLng[]> latlngs)`	`Boolean`	Возвращает true, если `latlngs` является плоским массивом, false - вложенным.

PolyUtil

Различные служебные функции для геометрий многоугольников.

Функции

Функция	Возвращает	Описание
`clipPolygon(<Point[]> points, <Bounds> bounds, <Boolean> round?)`	`Point[]`	Обрезает геометрию многоугольника, определённую заданными `points` по заданным границам (используя алгоритм Sutherland-Hodgman). Используется Leaflet для отображения только точек многоугольника, которые находятся на экране или рядом, повышая производительность. Обратите внимание, что для обрезки точек многоугольника нужен другой алгоритм, чем для полилиний, поэтому для этого есть отдельный метод.

DomEvent

Служебные функции для работы с событиями DOM, используемые Leaflet внутри.

Функции

Функция	Возвращает	Описание
`on(<HTMLElement> el, <String> types, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-обработчик (`fn`) к определённому типу события DOM элемента `el`. Можно указать контекст обработчика (объект, к которому будет относиться ключевое слово `this`). Также можно передать несколько типов через пробел (например, `'click dblclick'`).
`on(<HTMLElement> el, <Object> eventMap, <Object> context?)`	`this`	Добавляет набор пар "тип/обработчик", например `{click: onClick, mousemove: onMouseMove}`
`off(<HTMLElement> el, <String> types, <Function> fn, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-обработчик. Обратите внимание, что если вы передали пользовательский контекст в on, вы должны передать тот же контекст в `off` для удаления обработчика.
`off(<HTMLElement> el, <Object> eventMap, <Object> context?)`	`this`	Удаляет набор пар "тип/обработчик", например `{click: onClick, mousemove: onMouseMove}`
`stopPropagation(<DOMEvent> ev)`	`this`	Останавливает распространение события к родительским элементам. Используется внутри функций-обработчиков: L.DomEvent.on(div, 'click', function (ev) { L.DomEvent.stopPropagation(ev); });
`disableScrollPropagation(<HTMLElement> el)`	`this`	Добавляет `stopPropagation` к событиям элемента `'wheel'` (плюс варианты браузеров).
`disableClickPropagation(<HTMLElement> el)`	`this`	Добавляет `stopPropagation` к событиям элемента `'click'`, `'doubleclick'`, `'mousedown'` и `'touchstart'` (плюс варианты браузеров).
`preventDefault(<DOMEvent> ev)`	`this`	Препятствует выполнению стандартного действия события DOM `ev` (например, переходу по ссылке в href тега a или выполнению POST запроса с перезагрузкой страницы при отправке `<form>`). Используется внутри функций-обработчиков.
`stop(<DOMEvent> ev)`	`this`	Выполняет `stopPropagation` и `preventDefault` одновременно.
`getMousePosition(<DOMEvent> ev, <HTMLElement> container?)`	`Point`	Получает нормализованное положение курсора мыши из события DOM относительно `container` (без учёта границы) или всей страницы, если не указано иное.
`getWheelDelta(<DOMEvent> ev)`	`Number`	Получает нормализованное значение прокрутки колесика мыши из события колесика DOM в вертикальных пикселях (отрицательное значение при прокрутке вниз). События от указательных устройств без точной прокрутки отображаются по наилучшему предположению в 60 пикселях.
`addListener(…)`	`this`	Псевдоним к `L.DomEvent.on`
`removeListener(…)`	`this`	Псевдоним к `L.DomEvent.off`

DomUtil

Функции-утилиты для работы с деревом DOM, используемые Leaflet внутри.

Большинство функций, ожидающих или возвращающих HTMLElement , также работают с элементами SVG. Разница только в том, что классы относятся к классам CSS в HTML и классам SVG в SVG.

Функции

Функция	Возвращает	Описание
`get(<String\|HTMLElement> id)`	`HTMLElement`	Возвращает элемент по его идентификатору DOM или сам элемент, если он был передан напрямую.
`getStyle(<HTMLElement> el, <String> styleAttrib)`	`String`	Возвращает значение определенного атрибута стиля элемента, включая вычисленные значения или значения, заданные через CSS.
`create(<String> tagName, <String> className?, <HTMLElement> container?)`	`HTMLElement`	Создаёт HTML-элемент с `tagName`, устанавливает его класс на `className`, и необязательно добавляет его в элемент `container`.
`remove(<HTMLElement> el)`		Удаляет `el` из его родительского элемента.
`empty(<HTMLElement> el)`		Удаляет все дочерние элементы `el` из `el`.
`toFront(<HTMLElement> el)`		Делает `el` последним дочерним элементом его родителя, чтобы он отображался перед другими дочерними элементами.
`toBack(<HTMLElement> el)`		Делает `el` первым дочерним элементом его родителя, чтобы он отображался за другими дочерними элементами.
`hasClass(<HTMLElement> el, <String> name)`	`Boolean`	Возвращает `true`, если атрибут класса элемента содержит `name`.
`addClass(<HTMLElement> el, <String> name)`		Добавляет `name` к атрибуту класса элемента.
`removeClass(<HTMLElement> el, <String> name)`		Удаляет `name` из атрибута класса элемента.
`setClass(<HTMLElement> el, <String> name)`		Устанавливает класс элемента.
`getClass(<HTMLElement> el)`	`String`	Возвращает класс элемента.
`setOpacity(<HTMLElement> el, <Number> opacity)`		Устанавливает непрозрачность элемента (включая поддержку старого IE). `opacity` должно быть числом от `0` до `1`.
`testProp(<String[]> props)`	`String\|false`	Проходит по массиву имён стилей и возвращает первое имя, которое является допустимым именем стиля для элемента. Если такое имя не найдено, возвращает false. Полезно для стилей с префиксами вендоров, таких как `transform`.
`setTransform(<HTMLElement> el, <Point> offset, <Number> scale?)`		Сбрасывает 3D CSS-трансформацию `el` так, чтобы она была сдвинута на `offset` пикселей и необязательно масштабирована на `scale`. Не имеет эффекта, если браузер не поддерживает 3D CSS-трансформации.
`setPosition(<HTMLElement> el, <Point> position)`		Устанавливает положение `el` в координаты, указанные в `position`, используя CSS translate или позиционирование top/left в зависимости от браузера (внутренне используется Leaflet для позиционирования его слоёв).
`getPosition(<HTMLElement> el)`	`Point`	Возвращает координаты элемента, ранее позиционированного с помощью setPosition.
`disableTextSelection()`		Запрещает пользователю генерировать события `selectstart` DOM, обычно генерируемые, когда пользователь перетаскивает мышкой по странице с текстом. Внутренне используется Leaflet для переопределения поведения любой интеракции клик-перетащить на карте. Воздействует на взаимодействия с перетаскиванием на всей странице.
`enableTextSelection()`		Отменяет действие предыдущей `L.DomUtil.disableTextSelection`.
`disableImageDrag()`		Как `L.DomUtil.disableTextSelection`, но для событий `dragstart` DOM, обычно генерируемых, когда пользователь перетаскивает изображение.
`enableImageDrag()`		Отменяет действие предыдущей `L.DomUtil.disableImageDrag`.
`preventOutline(<HTMLElement> el)`		Делает рамку элемента `el` невидимой. Внутренне используется Leaflet для предотвращения отображения рамки фокусируемых элементов, когда пользователь выполняет взаимодействие перетаскивания на них.
`restoreOutline()`		Отменяет действие предыдущей `L.DomUtil.preventOutline`.
`getSizedParentNode(<HTMLElement> el)`	`HTMLElement`	Находит ближайшего родительского узла, размер (ширина и высота) которого не равен null.

getScale(<HTMLElement> el) Object Вычисляет масштаб CSS, применённый к элементу. Возвращает объект с x и y членами в качестве горизонтального и вертикального масштаба соответственно, и boundingClientRect в качестве результата getBoundingClientRect().

Свойства

Свойство	Тип	Описание
`TRANSFORM`	`String`	Имя стилей преобразования с префиксом вендора (например, `'webkitTransform'` для WebKit).
`TRANSITION`	`String`	Имя стилей перехода с префиксом вендора.
`TRANSITION_END`	`String`	Имя события transitionend с префиксом вендора.

PosAnimation

Используется внутри для анимаций перемещения, используя CSS3 Переходы для современных браузеров и таймер для отката в IE6-9.

Пример использования

var fx = new L.PosAnimation();
fx.run(el, [300, 500], 0.5);

Конструктор

Конструктор	Описание
`L.PosAnimation()`	Создаёт объект `PosAnimation`.

События

Событие	Данные	Описание
`start`	`Event`	Срабатывает при запуске анимации
`step`	`Event`	Срабатывает непрерывно во время анимации.
`end`	`Event`	Срабатывает по завершении анимации.

Методы

Метод	Возвращает	Описание
`run(<HTMLElement> el, <Point> newPos, <Number> duration?, <Number> easeLinearity?)`		Запускает анимацию заданного элемента в новое положение, необязательно устанавливая длительность в секундах (`0.25` по умолчанию) и коэффициент линейности сглаживания (третий аргумент кривой Безье, `0.5` по умолчанию).
`stop()`		Останавливает анимацию (если она в данный момент выполняется).

Наследуемые методы от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет обработчик событий (`fn`) для определенного типа события объекта. Вы можете необязательно указать контекст обработчика (объект, к которому будет относиться ключевое слово this). Вы также можете передать несколько типов, разделённых пробелами (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар "тип/обработчик", например, `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленный обработчик событий. Если функция не указана, все обработчики этого конкретного события будут удалены из объекта. Обратите внимание, что если вы передали пользовательский контекст в `on`, вы должны передать тот же контекст в `off` для удаления обработчика.
`off(<Object> eventMap)`	`this`	Удаляет набор пар "тип/обработчик".
`off()`	`this`	Удаляет все обработчики всех событий объекта. Это включает неявно прикреплённые события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — первый аргумент функции обработчика будет содержать его свойства. Событие может необязательно быть распространено на родительские элементы.
`listens(<String> type)`	`Boolean`	Возвращает `true` если для определённого типа события есть прикреплённые обработчики.
`once(…)`	`this`	Ведёт себя как `on(…)`, за исключением того, что обработчик будет вызван только один раз, а затем удалён.
`addEventParent(<Evented> obj)`	`this`	Добавляет родительский элемент события - `Evented`, который будет получать распространяемые события
`removeEventParent(<Evented> obj)`	`this`	Удаляет родительский элемент события, так что он перестанет получать распространяемые события
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

Перетаскиваемый

Класс для создания перетаскиваемых элементов DOM (включая поддержку касаний). Используется внутри для перетаскивания карт и маркеров. Работает только для элементов, которые были размещены с помощью L.DomUtil.setPosition.

Пример использования

var draggable = new L.Draggable(elementToDrag);
draggable.enable();

Конструктор

Конструктор	Описание
`L.Draggable(<HTMLElement> el, <HTMLElement> dragHandle?, <Boolean> preventOutline?, <Draggable options> options?)`	Создаёт объект `Draggable` для перемещения `el` при начале перетаскивания элемента `dragHandle` (по умолчанию равен `el` самому себе).

Параметры

Параметр	Тип	Значение по умолчанию	Описание
`clickTolerance`	`Number`	`3`	Максимальное количество пикселей, на которое пользователь может сдвинуть указатель мыши во время щелчка, чтобы щелчок был принят как действительный (в отличие от перетаскивания мышью).

События

Событие	Данные	Описание
`down`	`Event`	Срабатывает при начале перетаскивания.
`dragstart`	`Event`	Срабатывает при старте перетаскивания.
`predrag`	`Event`	Срабатывает непрерывно во время перетаскивания перед каждым соответствующим обновлением позиции элемента.
`drag`	`Event`	Срабатывает непрерывно во время перетаскивания.
`dragend`	`DragEndEvent`	Срабатывает при окончании перетаскивания.

Методы

Метод	Возвращает	Описание
`enable()`		Включает возможность перетаскивания.
`disable()`		Отключает возможность перетаскивания.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-слушатель (`fn`) к определенному типу события объекта. Вы можете указать контекст слушателя (объект, к которому будет относиться ключевое слово this). Вы также можете передать несколько типов через пробел (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар тип/слушатель, например, `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-слушатель. Если функция не указана, удаляются все слушатели данного события в объекте. Обратите внимание, что если вы передали пользовательский контекст в `on`, вы должны передать тот же контекст в `off` для удаления слушателя.
`off(<Object> eventMap)`	`this`	Удаляет набор пар тип/слушатель.
`off()`	`this`	Удаляет всех слушателей всех событий в объекте. Включая неявно прикрепленные события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — свойства этого объекта будут доступны в качестве первого аргумента функции-слушателя. Событие может быть необязательно распространено на родительские элементы.
`listens(<String> type)`	`Boolean`	Возвращает `true` , если для данного типа события есть какие-либо прикреплённые слушатели.
`once(…)`	`this`	Ведёт себя как `on(…)`, за исключением того, что слушатель будет вызван только один раз, а затем удален.
`addEventParent(<Evented> obj)`	`this`	Добавляет родительский элемент события - `Evented`, который будет получать распространяемые события.
`removeEventParent(<Evented> obj)`	`this`	Удаляет родительский элемент события, чтобы он перестал получать распространяемые события.
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

Класс

L.Class обеспечивает возможности объектно-ориентированного программирования в Leaflet и используется для создания почти всех классов Leaflet, описанных здесь.

Помимо реализации простой модели наследования, он вводит несколько специальных свойств для удобной организации кода — options, includes и statics.

Пример использования

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
});

Это создаст класс, который унаследует все методы и свойства родительского класса (через правильную цепочку прототипов), добавив или переопределив те, которые вы передаёте в extend. Он также правильно отреагирует на instanceof:

var a = new MyChildClass();
a instanceof MyChildClass; // true
a instanceof MyClass; // true

Вы можете вызывать родительские методы (включая конструктор) из соответствующих дочерних, (как вы делаете с вызовами super в других языках), обращаясь к прототипу родительского класса и используя call или apply JavaScript:

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(<Object> props)`	`Function`	Расширяет текущий класс, задавая свойства, которые нужно включить. Возвращает функцию JavaScript, которая является конструктором класса (для вызова с `new`)
`include(<Object> properties)`	`this`	Включает миксин в текущий класс.
`mergeOptions(<Object> options)`	`this`	Объединяет `options` в значения по умолчанию класса.
`addInitHook(<Function> fn)`	`this`	Добавляет обработчик конструктора в класс.

Evented

Набор методов, используемых совместно классами, основанными на событиях (например, Map и Marker). Обычно события позволяют выполнить определённую функцию, когда что-то происходит с объектом (например, пользователь нажимает на карту, вызывая событие 'click').

Пример использования

map.on('click', function(e) {
	alert(e.latlng);
} );

Leaflet обрабатывает обработчики событий по ссылке, поэтому если вы хотите добавить обработчик и затем удалить его, определите его как функцию:

function onClick(e) { ... }

map.on('click', onClick);
map.off('click', onClick);

Методы

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-обработчик (`fn`) к определенному типу события объекта. Можно указать контекст обработчика (объект, к которому будет относиться ключевое слово this). Также можно передать несколько типов через пробел (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар тип/обработчик, например, `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-обработчик. Если функция не указана, удаляются все обработчики этого события для объекта. Обратите внимание, если вы передали пользовательский контекст для `on`, вы должны передать тот же контекст для `off` для удаления обработчика.
`off(<Object> eventMap)`	`this`	Удаляет набор пар тип/обработчик.
`off()`	`this`	Удаляет все обработчики всех событий объекта. Это включает неявные присоединённые события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Можно дополнительно передать объект данных — свойства этого объекта будут доступны в качестве первого аргумента функции-обработчика. Событие может быть проброшено родителям.
`listens(<String> type)`	`Boolean`	Возвращает `true` если для определённого типа события есть какие-либо присоединённые обработчики.
`once(…)`	`this`	Ведёт себя как `on(…)`, за исключением того, что обработчик будет вызван только один раз и затем удалён.
`addEventParent(<Evented> obj)`	`this`	Добавляет родительское событие - `Evented`, которое будет получать распространяемые события.
`removeEventParent(<Evented> obj)`	`this`	Удаляет родительское событие, поэтому оно перестанет получать распространяемые события.
`addEventListener(…)`	`this`	Псевдоним к `on(…)`
`removeEventListener(…)`	`this`	Псевдоним к `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним к `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним к `once(…)`
`fireEvent(…)`	`this`	Псевдоним к `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним к `listens(…)`

Слой

Набор методов из базового класса 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(<Map\|LayerGroup> map)`	`this`	Добавляет слой на указанную карту или группу слоев.
`remove()`	`this`	Удаляет слой с карты, на которой он активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с указанной карты.
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из указанной `LayerGroup`
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий указанный на карте слой. Если `name` опущено, возвращает слой для этого слоя.
`getAttribution()`	`String`	Используется `attribution control`, возвращает опцию атрибуции.

Расширяющие методы

Каждый слой должен расширяться от L.Layer и (пере-)реализовывать следующие методы.

Метод	Возвращает	Описание
`onAdd(<Map> map)`	`this`	Должно содержать код, который создаёт DOM-элементы для слоя, добавляет их в `map panes`, куда они должны принадлежать, и устанавливает слушатели на соответствующие события карты. Вызывается при `map.addLayer(layer)`.
`onRemove(<Map> map)`	`this`	Должно содержать весь код очистки, который удаляет элементы слоя из DOM и удаляет слушатели, ранее добавленные в `onAdd`. Вызывается при `map.removeLayer(layer)`.
`getEvents()`	`Object`	Этот необязательный метод должен возвращать объект, подобный `{ viewreset: this._reset }`, для `addEventListener`. Обработчики событий в этом объекте будут автоматически добавляться и удаляться с картой вместе с вашим слоем.
`getAttribution()`	`String`	Этот необязательный метод должен возвращать строку, содержащую HTML, который отображается на `Attribution control`, когда слой виден.
`beforeAdd(<Map> map)`	`this`	Необязательный метод. Вызывается при `map.addLayer(layer)`, перед добавлением слоя на карту, перед инициализацией событий, без ожидания, пока карта будет готова к использованию. Используется только для ранней инициализации.

Все слои имеют набор методов, удобных для привязки всплывающих окон.

var layer = L.Polygon(latlngs).bindPopup('Hi There!').addTo(map);
layer.openPopup();
layer.closePopup();

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

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Привязывает всплывающее окно к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающее окно, ранее привязанное с помощью `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает привязанное всплывающее окно в указанной `latlng` или в по умолчанию якорной точке всплывающего окна, если `latlng` не передан.
`closePopup()`	`this`	Закрывает всплывающее окно, привязанное к этому слою, если оно открыто.
`togglePopup()`	`this`	Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true`, если всплывающее окно, привязанное к этому слою, в настоящее время открыто.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающего окна, привязанного к этому слою.
`getPopup()`	`Popup`	Возвращает всплывающее окно, привязанное к этому слою.

Все слои обладают набором методов, удобных для привязки всплывающих подсказок к ним.

var layer = L.Polygon(latlngs).bindTooltip('Hi There!').addTo(map);
layer.openTooltip();
layer.closeTooltip();

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Привязывает всплывающую подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет всплывающую подсказку, ранее привязанную с помощью `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает привязанную всплывающую подсказку в указанной `latlng` или в по умолчанию якорной точке всплывающей подсказки, если `latlng` не передан.
`closeTooltip()`	`this`	Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от ее текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true` , если всплывающая подсказка, привязанная к этому слою, в настоящее время открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.
`getTooltip()`	`Tooltip`	Возвращает всплывающую подсказку, привязанную к этому слою.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-слушатель (`fn`) к определённому типу события объекта. Вы можете указать контекст слушателя (объект, к которому будет относиться ключевое слово this). Также вы можете указать несколько типов через пробел (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар тип/слушатель, например, `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-слушатель. Если функция не указана, удаляются все слушатели данного события для объекта. Обратите внимание, что если вы передали пользовательский контекст в `on`, вы должны передать тот же контекст в `off`, чтобы удалить слушателя.
`off(<Object> eventMap)`	`this`	Удаляет набор пар тип/слушатель.
`off()`	`this`	Удаляет всех слушателей всех событий объекта. Это включает неявно прикреплённые события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Вы можете необязательно указать объект данных — свойства этого объекта будут доступны как первый аргумент функции-слушателя. Событие может быть необязательно распространено родительским элементам.
`listens(<String> type)`	`Boolean`	Возвращает `true` если для определённого типа события есть какие-либо прикреплённые слушатели.
`once(…)`	`this`	Ведёт себя как `on(…)`, за исключением того, что слушатель будет вызван только один раз, а затем удалён.
`addEventParent(<Evented> obj)`	`this`	Добавляет родительский элемент события — `Evented`, который будет получать распространяемые события.
`removeEventParent(<Evented> obj)`	`this`	Удаляет родительский элемент события, чтобы он перестал получать распространяемые события.
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

Интерактивный слой

Некоторые Layer могут быть интерактивными — при взаимодействии пользователя с таким слоем можно обрабатывать события мыши, такие как click и mouseover. Используйте методы обработки событий, чтобы обработать эти события.

Параметры

Параметр	Тип	Значение по умолчанию	Описание
`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`	Срабатывает при закрытии подсказки, связанной с этим слоем.

Методы

Методы, унаследованные от Слой

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой на заданную карту или группу слоёв.
`remove()`	`this`	Удаляет слой с карты, на которой он активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с заданной карты.
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из заданной `LayerGroup`
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий именованный отсек на карте. Если `name` опущено, возвращает отсек для этого слоя.
`getAttribution()`	`String`	Используется `attribution control`, возвращает параметр подписи.

Методы всплывающих окон, унаследованные от Слой

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Привязывает всплывающее окно к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающее окно, ранее привязанное с помощью `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает привязанное всплывающее окно в указанной `latlng` или в стандартной точке привязки всплывающего окна, если `latlng` не передан.
`closePopup()`	`this`	Закрывает всплывающее окно, привязанное к этому слою, если оно открыто.
`togglePopup()`	`this`	Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true`, если всплывающее окно, привязанное к этому слою, в настоящее время открыто.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающего окна, привязанного к этому слою.
`getPopup()`	`Popup`	Возвращает всплывающее окно, привязанное к этому слою.

Методы, унаследованные от Слой

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Привязывает подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function` он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет подсказку, ранее привязанную с помощью `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает привязанную подсказку в указанной `latlng` или в стандартной точке привязки подсказки, если `latlng` не передан.
`closeTooltip()`	`this`	Закрывает подсказку, привязанную к этому слою, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от её текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true`, если подсказка, привязанная к этому слою, в настоящее время открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое подсказки, привязанной к этому слою.
`getTooltip()`	`Tooltip`	Возвращает подсказку, привязанную к этому слою.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-слушатель (`fn`) к определённому типу события объекта. Можно указать контекст слушателя (объект, к которому будет указывать ключевое слово this). Также можно передать несколько типов, разделённых пробелом (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар тип/слушатель, например, `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-слушатель. Если функция не указана, удаляет всех слушателей данного события из объекта. Обратите внимание, если вы передали пользовательский контекст для `on`, вы должны передать тот же контекст для `off` для удаления слушателя.
`off(<Object> eventMap)`	`this`	Удаляет набор пар тип/слушатель.
`off()`	`this`	Удаляет всех слушателей всех событий объекта. Это включает неявные привязанные события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Можно указать объект данных — свойства этого объекта будут первым аргументом функции-слушателя. Событие может быть распространено к родительским событиям.
`listens(<String> type)`	`Boolean`	Возвращает `true` , если определённый тип события имеет присоединённых слушателей.
`once(…)`	`this`	Ведёт себя как `on(…)`, за исключением того, что слушатель будет вызван только один раз и затем удалён.
`addEventParent(<Evented> obj)`	`this`	Добавляет родительское событие — `Evented`, которое будет получать распространяемые события.
`removeEventParent(<Evented> obj)`	`this`	Удаляет родительское событие, поэтому оно перестанет получать распространяемые события.
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

Управление

L.Control — базовый класс для реализации элементов управления картой. Обрабатывает позиционирование. Все остальные элементы управления наследуются от этого класса.

Параметры

Параметр	Тип	Значение по умолчанию	Описание
`position`	`String`	`'topright'`	Позиция элемента управления (один из углов карты). Возможные значения: `'topleft'`, `'topright'`, `'bottomleft'` или `'bottomright'`

Методы

Классы, расширяющие L.Control, унаследуют следующие методы:

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

Методы расширения

Каждый элемент управления должен наследоваться от L.Control и (пере)реализовывать следующие методы.

Метод	Возвращает	Описание
`onAdd(<Map> map)`	`HTMLElement`	Должен вернуть DOM-элемент контейнера для элемента управления и добавить слушатели на соответствующие события карты. Вызывается при `control.addTo(map)`.
`onRemove(<Map> map)`		Необязательный метод. Должен содержать весь код очистки, удаляющий слушатели, ранее добавленные в `onAdd`. Вызывается при `control.remove()`.

Обработчик

Абстрактный класс для обработчиков взаимодействия с картой

Методы

Метод	Возвращает	Описание
`enable()`	`this`	Включает обработчик
`disable()`	`this`	Отключает обработчик
`enabled()`	`Boolean`	Возвращает `true` если обработчик включен

Методы расширения

Классы, наследуемые от Handler, должны реализовать следующие два метода:

Метод	Возвращает	Описание
`addHooks()`		Вызывается при включении обработчика, должен добавить обработчики событий.
`removeHooks()`		Вызывается при отключении обработчика, должен удалить ранее добавленные обработчики событий.

Функции

Существует статическая функция, которую можно вызвать без создания экземпляра L.Handler:

Функция	Возвращает	Описание
`addTo(<Map> map, <String> name)`	`this`	Добавляет новый обработчик на заданную карту с заданным именем.

Проекция

Объект с методами для проектирования географических координат мира на плоскую поверхность (и обратно). См. Проекцию карты.

Методы

Метод Возвращает Описание

project(<LatLng> latlng)

Point

Проектирует географические координаты в 2D-точку. Принимает только экземпляры L.LatLng, а не массивы.

unproject(<Point> point)

LatLng

Обратная функция project. Проектирует 2D-точку в географическое местоположение. Принимает только экземпляры L.Point, а не массивы.

Обратите внимание, что экземпляры проекции не наследуются от объекта Leaflet Class и не могут быть созданы. Также новые классы не могут наследоваться от них, и методы не могут быть добавлены к ним с помощью функции include.

Свойства

Свойство	Тип	Описание
`bounds`	`Bounds`	Пределы (указанные в единицах CRS), в которых проекция действительна

Определённые проекции

Leaflet поставляется с набором заранее определённых проекций:

Проекция	Описание
`L.Projection.LonLat`	Прямоугольная или Plate Carrée проекция — самая простая проекция, чаще всего используемая специалистами по ГИС. Прямо отображает `x` как долготу и `y` как широту. Также подходит для плоских миров, например, игровых карт. Используется CRS `EPSG:4326` и `Simple`.
`L.Projection.Mercator`	Эллиптическая проекция Меркатора — более сложная, чем сферическая Меркатора. Предполагает, что Земля является эллипсоидом. Используется CRS EPSG:3395.
`L.Projection.SphericalMercator`	Сферическая проекция Меркатора — наиболее распространённая проекция для онлайн-карт, используемая почти всеми бесплатными и коммерческими поставщиками тайлов. Предполагает, что Земля является сферой. Используется CRS `EPSG:3857`.

CRS

Методы

Метод	Возвращает	Описание
`latLngToPoint(<LatLng> latlng, <Number> zoom)`	`Point`	Проектирует географические координаты в пиксельные координаты для заданного масштаба.
`pointToLatLng(<Point> point, <Number> zoom)`	`LatLng`	Обратная функция к `latLngToPoint`. Проектирует пиксельные координаты на заданном масштабе в географические координаты.
`project(<LatLng> latlng)`	`Point`	Проектирует географические координаты в координаты в единицах, принятых для этого CRS (например, метры для EPSG:3857, для передачи в службы WMS).
`unproject(<Point> point)`	`LatLng`	При заданных спроектированных координатах возвращает соответствующие LatLng. Обратная функция к `project`.
`scale(<Number> zoom)`	`Number`	Возвращает масштаб, используемый при преобразовании спроектированных координат в пиксельные координаты для определенного масштаба. Например, возвращает `256 * 2^zoom` для CRS, основанных на Меркаторе.
`zoom(<Number> scale)`	`Number`	Обратная функция к `scale()`, возвращает уровень масштаба, соответствующий коэффициенту масштаба `scale`.
`getProjectedBounds(<Number> zoom)`	`Bounds`	Возвращает пределы проекции, отмасштабированные и преобразованные для предоставленного `zoom`.
`distance(<LatLng> latlng1, <LatLng> latlng2)`	`Number`	Возвращает расстояние между двумя географическими координатами.
`wrapLatLng(<LatLng> latlng)`	`LatLng`	Возвращает `LatLng`, где широта и долгота были обернуты в соответствии с `wrapLat` и `wrapLng` свойствами CRS, если они находятся вне границ CRS.
`wrapLatLngBounds(<LatLngBounds> bounds)`	`LatLngBounds`	Возвращает `LatLngBounds` с теми же размерами, что и заданный, гарантируя, что его центр находится в пределах границ CRS. Принимает только фактические экземпляры `L.LatLngBounds`, а не массивы.

Свойства

Свойство	Тип	Описание
`code`	`String`	Стандартное кодовое имя CRS, передаваемое в службы WMS (например, `'EPSG:3857'`).
`wrapLng`	`Number[]`	Массив из двух чисел, определяющий, обёртывается ли ось долготы (горизонтальная) вокруг заданного диапазона и как. По умолчанию `[-180, 180]` в большинстве географических CRS. Если `undefined`, ось долготы не обёртывается.
`wrapLat`	`Number[]`	Как `wrapLng`, но для оси широты (вертикальной).
`infinite`	`Boolean`	Если true, координатное пространство будет неограниченным (бесконечным по обеим осям).

Определённые CRS

CRS	Описание
`L.CRS.EPSG3395`	Редко используется некоторыми коммерческими поставщиками тайлов. Использует эллиптическую проекцию Меркатора.
`L.CRS.EPSG3857`	Наиболее распространённый CRS для онлайн-карт, используемый почти всеми бесплатными и коммерческими поставщиками тайлов. Использует сферическую проекцию Меркатора. Устанавливается по умолчанию в опции карты `crs`.
`L.CRS.EPSG4326`	Распространённый CRS среди энтузиастов ГИС. Использует простую проекцию равнопрямоугольную. Leaflet 1.0.x соответствует схеме координат TMS для EPSG:4326, что является изменением поведения по сравнению с 0.7.x. Если вы используете `TileLayer` с этим CRS, убедитесь, что есть две плитки размером 256x256 пикселей, покрывающие всю Землю на уровне масштаба ноль, и что начало координат плитки находится в (-180,+90) или (-180,-90) для `TileLayer` с параметром `tms` установленным.
`L.CRS.Earth`	Служит основой для CRS, которые являются глобальными, охватывая всю Землю. Может быть использован только как основа для других CRS и не может быть использован напрямую, так как у него нет `code`, `projection` или `transformation`. `distance()` возвращает значение в метрах.
`L.CRS.Simple`	Простой CRS, который отображает долготу и широту в `x` и `y` напрямую. Может использоваться для карт плоских поверхностей (например, карт игр). Обратите внимание, что ось `y` всё равно должна быть инвертирована (сверху вниз). `distance()` возвращает просто евклидово расстояние.
`L.CRS.Base`	Объект, определяющий системы координат для проектирования географических точек в пиксельные (экранные) координаты и обратно (и в координаты в других единицах для WMS сервисов). См. систему пространственных ссылок. Leaflet по умолчанию определяет наиболее распространённые CRS. Если вы хотите использовать CRS, не определённый по умолчанию, ознакомьтесь с плагином Proj4Leaflet. Обратите внимание, что экземпляры CRS не наследуются от объекта Leaflet's `Class` и не могут быть созданы. Также новые классы не могут наследовать от них, и методы не могут быть добавлены к ним с помощью функции `include`.

Рендеринг

Базовый класс для реализации рендеров векторных данных (SVG, Canvas). Обрабатывает контейнер DOM рендера, его границы и анимацию масштабирования.

A Renderer работает как неявная группа слоёв для всех Path - сам рендер может быть добавлен или удален на карту. Все пути используют рендер, который может быть неявным (карта сама определит тип рендера и использует его автоматически) или явным (с использованием опции renderer пути).

Не используйте этот класс напрямую, используйте SVG и Canvas вместо него.

Параметры

Параметр	Тип	Значение по умолчанию	Описание
`padding`	`Number`	`0.1`	Насколько расширить область обрезки вокруг отображения карты (относительно её размера), например, 0,1 будет 10% от размера отображения карты в каждом направлении
`tolerance`	`Number`	`0`	Насколько расширить зону толерантности клика вокруг пути/объекта на карте

Параметры, унаследованные от Слой

Параметр	Тип	Значение по умолчанию	Описание
`pane`	`String`	`'overlayPane'`	По умолчанию слой будет добавлен в слой наложения карты. Переопределение этого параметра заставит слой разместиться на другом слое по умолчанию.
`attribution`	`String`	`null`	Строка, отображаемая в панели атрибуции, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридическим обязательством перед правообладателями и поставщиками тайлов.

События

Событие	Данные	Описание
`update`	`Event`	Срабатывает, когда рендер обновляет свои границы, центр и масштаб, например, когда карта переместилась

События, унаследованные от Слой

Событие	Данные	Описание
`add`	`Event`	Вызывается после добавления слоя на карту
`remove`	`Event`	Вызывается после удаления слоя с карты

События всплывающих окон, унаследованные от Слой

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Вызывается при открытии всплывающего окна, связанного с этим слоем
`popupclose`	`PopupEvent`	Вызывается при закрытии всплывающего окна, связанного с этим слоем

События подсказок, унаследованные от Слой

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Вызывается при открытии подсказки, связанной с этим слоем.
`tooltipclose`	`TooltipEvent`	Вызывается при закрытии подсказки, связанной с этим слоем.

Методы

Методы, унаследованные от Слой

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой на заданную карту или группу слоев.
`remove()`	`this`	Удаляет слой с карты, на которой он сейчас активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с заданной карты.
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из заданной `LayerGroup`
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий именованный pane на карте. Если `name` опущено, возвращает pane для этого слоя.
`getAttribution()`	`String`	Используется `attribution control`, возвращает опцию атрибуции.

Методы всплывающих окон, унаследованные от Слой

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Связывает всплывающее окно со слоем с переданным `content` и настраивает необходимые обработчики событий. Если передается `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающее окно, ранее связанное с `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает связанное всплывающее окно в указанном `latlng` или по умолчанию в якорной точке всплывающего окна, если `latlng` не передан.
`closePopup()`	`this`	Закрывает связанное всплывающее окно, если оно открыто.
`togglePopup()`	`this`	Открывает или закрывает всплывающее окно, связанное с этим слоем, в зависимости от его текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true`, если всплывающее окно, связанное с этим слоем, в настоящее время открыто.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающего окна, связанного с этим слоем.
`getPopup()`	`Popup`	Возвращает всплывающее окно, связанное с этим слоем.

Методы подсказок, унаследованные от Слой

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Привязывает всплывающую подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет всплывающую подсказку, ранее привязанную с помощью `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает привязанную всплывающую подсказку в указанной `latlng` или в стандартном якоре всплывающей подсказки, если `latlng` не передан.
`closeTooltip()`	`this`	Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от ее текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true`, если всплывающая подсказка, привязанная к этому слою, в настоящее время открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.
`getTooltip()`	`Tooltip`	Возвращает всплывающую подсказку, привязанную к этому слою.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-слушатель (`fn`) к определенному типу события объекта. Вы можете необязательно указать контекст слушателя (объект, к которому будет относиться ключевое слово this). Вы также можете передать несколько типов, разделенных пробелами (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар "тип/слушатель", например, `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-слушатель. Если функция не указана, она удалит всех слушателей этого конкретного события из объекта. Обратите внимание, что если вы передали пользовательский контекст для `on`, вы должны передать тот же контекст в `off`, чтобы удалить слушателя.
`off(<Object> eventMap)`	`this`	Удаляет набор пар "тип/слушатель".
`off()`	`this`	Удаляет всех слушателей всех событий в объекте. Это включает неявные присоединенные события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — первый аргумент функции-слушателя будет содержать его свойства. Событие необязательно может быть передано родительским объектам событий.
`listens(<String> type)`	`Boolean`	Возвращает `true`, если для определенного типа события есть прикрепленные слушатели.
`once(…)`	`this`	Ведёт себя как `on(…)`, за исключением того, что слушатель будет вызван только один раз и затем удалён.
`addEventParent(<Evented> obj)`	`this`	Добавляет родительский объект события - `Evented`, который будет получать передаваемые события.
`removeEventParent(<Evented> obj)`	`this`	Удаляет родительский объект события, поэтому он перестанет получать передаваемые события.
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

Объекты событий

Всякий раз, когда класс, наследуемый от 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.

Наследуемые свойства из Event

Свойство	Тип	Описание
`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.

Наследуемые свойства из Event

Свойство	Тип	Описание
`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`	Время получения позиции.

Наследуемые свойства из Event

Свойство	Тип	Описание
`type`	`String`	Тип события (например, `'click'`).
`target`	`Object`	Объект, сгенерировавший событие. Для распространяемых событий — последний объект в цепочке распространения, сгенерировавший событие.
`sourceTarget`	`Object`	Объект, который изначально сгенерировал событие. Для неспрастволяемых событий, это будет то же, что и `target`.
`propagatedFrom`	`Object`	Для распространяемых событий, последний объект, который распространил событие к его родительскому объекту события.
`layer`	`Object`	Устаревшее. То же, что и `propagatedFrom`.

ErrorEvent

Свойство	Тип	Описание
`message`	`String`	Сообщение об ошибке.
`code`	`Number`	Код ошибки (если применимо).

Наследуемые свойства от Event

Свойство	Тип	Описание
`type`	`String`	Тип события (например, `'click'`).
`target`	`Object`	Объект, сгенерировавший событие. Для распространяемых событий — последний объект в цепочке распространения, сгенерировавший событие.
`sourceTarget`	`Object`	Объект, который изначально сгенерировал событие. Для неспрастволяемых событий, это будет то же, что и `target`.
`propagatedFrom`	`Object`	Для распространяемых событий, последний объект, который распространил событие к его родительскому объекту события.
`layer`	`Object`	Устаревшее. То же, что и `propagatedFrom`.

LayerEvent

Свойство	Тип	Описание
`layer`	`Layer`	Слои, которые были добавлены или удалены.

Наследуемые свойства от Event

Свойство	Тип	Описание
`type`	`String`	Тип события (например, `'click'`).
`target`	`Object`	Объект, сгенерировавший событие. Для распространяемых событий — последний объект в цепочке распространения, сгенерировавший событие.
`sourceTarget`	`Object`	Объект, который изначально сгенерировал событие. Для неспрастволяемых событий, это будет то же, что и `target`.
`propagatedFrom`	`Object`	Для распространяемых событий, последний объект, который распространил событие к его родительскому объекту события.

LayersControlEvent

Свойство	Тип	Описание
`layer`	`Layer`	Слои, которые были добавлены или удалены.
`name`	`String`	Имя слоя, который был добавлен или удален.

Наследуемые свойства от Event

Свойство	Тип	Описание
`type`	`String`	Тип события (например, `'click'`).
`target`	`Object`	Объект, сгенерировавший событие. Для распространяемых событий — последний объект в цепочке распространения, сгенерировавший событие.
`sourceTarget`	`Object`	Объект, который изначально сгенерировал событие. Для неспрастволяемых событий, это будет то же, что и `target`.
`propagatedFrom`	`Object`	Для распространяемых событий, последний объект, который распространил событие к его родительскому объекту события.

TileEvent

Свойство	Тип	Описание
`tile`	`HTMLElement`	Элемент тайла (изображение).
`coords`	`Point`	Объект Point с координатами тайла: `x`, `y`, и `z` (уровень масштабирования).

Наследованные свойства от Event

Свойство	Тип	Описание
`type`	`String`	Тип события (например, `'click'`).
`target`	`Object`	Объект, сгенерировавший событие. Для прокинутых событий – последний объект в цепочке распространения, который сгенерировал событие.
`sourceTarget`	`Object`	Объект, первоначально сгенерировавший событие. Для непрокинутых событий – это будет то же, что и `target`.
`propagatedFrom`	`Object`	Для прокинутых событий – последний объект, который распространил событие к его родительскому объекту события.
`layer`	`Object`	Устаревшее. То же самое, что и `propagatedFrom`.

TileErrorEvent

Свойство	Тип	Описание
`tile`	`HTMLElement`	Элемент тайла (изображение).
`coords`	`Point`	Объект Point с координатами тайла: `x`, `y`, и `z` (уровень масштабирования).
`error`	`*`	Ошибка, переданная в обратный вызов тайла `done()`.

Наследованные свойства от Event

Свойство	Тип	Описание
`type`	`String`	Тип события (например, `'click'`).
`target`	`Object`	Объект, сгенерировавший событие. Для прокинутых событий – последний объект в цепочке распространения, который сгенерировал событие.
`sourceTarget`	`Object`	Объект, первоначально сгенерировавший событие. Для непрокинутых событий – это будет то же, что и `target`.
`propagatedFrom`	`Object`	Для прокинутых событий – последний объект, который распространил событие к его родительскому объекту события.
`layer`	`Object`	Устаревшее. То же самое, что и `propagatedFrom`.

ResizeEvent

Свойство	Тип	Описание
`oldSize`	`Point`	Размер до события изменения размера.
`newSize`	`Point`	Новый размер после события изменения размера.

Наследованные свойства от Event

Свойство	Тип	Описание
`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 геообъекта (если указан).

Наследуемые свойства из Event

Свойство	Тип	Описание
`type`	`String`	Тип события (например, `'click'`).
`target`	`Object`	Объект, который сгенерировал событие. Для проксированных событий — последний объект в цепочке распространения, сгенерировавший событие.
`sourceTarget`	`Object`	Объект, который изначально сгенерировал событие. Для непроксированных событий он совпадает с `target`.
`propagatedFrom`	`Object`	Для проксированных событий — последний объект, который распространил событие к его родительскому объекту.

PopupEvent

Свойство	Тип	Описание
`popup`	`Popup`	Открытый или закрытый всплывающий элемент.

Наследуемые свойства из Event

Свойство	Тип	Описание
`type`	`String`	Тип события (например, `'click'`).
`target`	`Object`	Объект, который сгенерировал событие. Для проксированных событий — последний объект в цепочке распространения, сгенерировавший событие.
`sourceTarget`	`Object`	Объект, который изначально сгенерировал событие. Для непроксированных событий он совпадает с `target`.
`propagatedFrom`	`Object`	Для проксированных событий — последний объект, который распространил событие к его родительскому объекту.
`layer`	`Object`	Устарело. То же самое, что `propagatedFrom`.

TooltipEvent

Свойство	Тип	Описание
`tooltip`	`Tooltip`	Открытый или закрытый подсказывающий элемент.

Наследуемые свойства из Event

Свойство	Тип	Описание
`type`	`String`	Тип события (например, `'click'`).
`target`	`Object`	Объект, который сгенерировал событие. Для проксированных событий — последний объект в цепочке распространения, сгенерировавший событие.
`sourceTarget`	`Object`	Объект, который изначально сгенерировал событие. Для непроксированных событий он совпадает с `target`.
`propagatedFrom`	`Object`	Для проксированных событий — последний объект, который распространил событие к его родительскому объекту.
`layer`	`Object`	Устарело. То же самое, что `propagatedFrom`.

DragEndEvent

Свойство	Тип	Описание
`distance`	`Number`	Расстояние в пикселях, на которое был перемещен элемент.

Наследуемые свойства из Event

Свойство	Тип	Описание
`type`	`String`	Тип события (например, `'click'`).
`target`	`Object`	Объект, сгенерировавший событие. Для распространяемых событий — последний объект в цепочке распространения, сгенерировавший событие.
`sourceTarget`	`Object`	Объект, который изначально сгенерировал событие. Для неспраространяемых событий — совпадает с `target`.
`propagatedFrom`	`Object`	Для распространяемых событий — последний объект, который распространил событие к своему родительскому объекту события.
`layer`	`Object`	Устарело. То же, что и `propagatedFrom`.

ZoomAnimEvent

Свойство	Тип	Описание
`center`	`LatLng`	Текущий центр карты
`zoom`	`Number`	Текущий уровень масштаба карты
`noUpdate`	`Boolean`	Нужно ли слоям обновлять содержимое из-за этого события

Наследуемые свойства от Event

Свойство	Тип	Описание
`type`	`String`	Тип события (например, `'click'`).
`target`	`Object`	Объект, сгенерировавший событие. Для распространяемых событий — последний объект в цепочке распространения, сгенерировавший событие.
`sourceTarget`	`Object`	Объект, который изначально сгенерировал событие. Для неспраространяемых событий — совпадает с `target`.
`propagatedFrom`	`Object`	Для распространяемых событий — последний объект, который распространил событие к своему родительскому объекту события.
`layer`	`Object`	Устарело. То же, что и `propagatedFrom`.

DivOverlay

Базовая модель для L.Popup и L.Tooltip. Наследуйте от нее для создания пользовательских всплывающих окон.

Параметры

Параметр	Тип	Значение по умолчанию	Описание
`offset`	`Point`	`Point(0, 7)`	Смещение позиции всплывающего окна. Полезно для управления якорем всплывающего окна при открытии на некоторых наложениях.
`className`	`String`	`''`	Настраиваемое имя класса CSS для назначения всплывающему окну.
`pane`	`String`	`'popupPane'`	`Map pane` куда будет добавлено всплывающее окно.

Наследуемые параметры от Layer

Параметр	Тип	Значение по умолчанию	Описание
`attribution`	`String`	`null`	Строка, отображаемая в элементе управления атрибутами, например, «© OpenStreetMap contributors». Описывает данные слоя и часто является правовой обязанностью перед правообладателями и поставщиками плиток.

События

Наследуемые события от Layer

Событие	Данные	Описание
`add`	`Event`	Срабатывает после добавления слоя на карту
`remove`	`Event`	Срабатывает после удаления слоя с карты

События всплывающего окна, унаследованные от Layer

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Срабатывает при открытии всплывающего окна, привязанного к этому слою
`popupclose`	`PopupEvent`	Срабатывает при закрытии всплывающего окна, привязанного к этому слою

События всплывающей подсказки, унаследованные от Layer

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Срабатывает при открытии всплывающей подсказки, привязанной к этому слою.
`tooltipclose`	`TooltipEvent`	Срабатывает при закрытии всплывающей подсказки, привязанной к этому слою.

Методы

Методы, унаследованные от Слой

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой на заданную карту или группу слоев.
`remove()`	`this`	Удаляет слой с карты, на которой он в настоящее время активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с указанной карты.
`removeFrom(<LayerGroup> group)`	`this`	Удаляет слой из заданной `LayerGroup`
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий именованный слой на карте. Если `name` опущено, возвращает слой для этого слоя.
`getAttribution()`	`String`	Используется `attribution control`, возвращает опцию атрибуции.

Методы всплывающей подсказки, унаследованные от Слой

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Привязывает всплывающую подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающую подсказку, ранее привязанную с помощью `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает привязанную всплывающую подсказку в указанной `latlng` или в якорной точке всплывающей подсказки по умолчанию, если `latlng` не передан.
`closePopup()`	`this`	Закрывает привязанную к этому слою всплывающую подсказку, если она открыта.
`togglePopup()`	`this`	Открывает или закрывает привязанную к этому слою всплывающую подсказку в зависимости от ее текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true`, если всплывающая подсказка, привязанная к этому слою, в настоящее время открыта.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.
`getPopup()`	`Popup`	Возвращает всплывающую подсказку, привязанную к этому слою.

Методы всплывающих подсказок, унаследованные от Слой

Метод	Возвращает	Описание
`bindTooltip(<String\|HTMLElement\|Function\|Tooltip> content, <Tooltip options> options?)`	`this`	Привязывает всплывающую подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен вернуть `String` или `HTMLElement`.
`unbindTooltip()`	`this`	Удаляет всплывающую подсказку, ранее привязанную с `bindTooltip`.
`openTooltip(<LatLng> latlng?)`	`this`	Открывает привязанную всплывающую подсказку в указанной `latlng` или в стандартном якоре подсказки, если `latlng` не передан.
`closeTooltip()`	`this`	Закрывает всплывающую подсказку, привязанную к этому слою, если она открыта.
`toggleTooltip()`	`this`	Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от её текущего состояния.
`isTooltipOpen()`	`boolean`	Возвращает `true`, если всплывающая подсказка, привязанная к этому слою, в настоящее время открыта.
`setTooltipContent(<String\|HTMLElement\|Tooltip> content)`	`this`	Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.
`getTooltip()`	`Tooltip`	Возвращает всплывающую подсказку, привязанную к этому слою.

Методы, унаследованные от Evented

Метод	Возвращает	Описание
`on(<String> type, <Function> fn, <Object> context?)`	`this`	Добавляет функцию-слушатель (`fn`) к определенному типу события объекта. Вы можете указать контекст слушателя (объект, к которому будет относиться ключевое слово this). Также можно передать несколько типов, разделённых пробелами (например, `'click dblclick'`).
`on(<Object> eventMap)`	`this`	Добавляет набор пар тип/слушатель, например: `{click: onClick, mousemove: onMouseMove}`
`off(<String> type, <Function> fn?, <Object> context?)`	`this`	Удаляет ранее добавленную функцию-слушатель. Если функция не указана, будут удалены все слушатели этого события для объекта. Обратите внимание, что если вы передали пользовательский контекст для `on`, вы должны передать тот же контекст для `off` для удаления слушателя.
`off(<Object> eventMap)`	`this`	Удаляет набор пар тип/слушатель.
`off()`	`this`	Удаляет всех слушателей всех событий объекта. Включая неявно присоединённые события.
`fire(<String> type, <Object> data?, <Boolean> propagate?)`	`this`	Срабатывает событие указанного типа. Вы можете дополнительно передать объект данных — первый аргумент функции-слушателя будет содержать его свойства. Событие может быть дополнительно распространено на родительские события.
`listens(<String> type)`	`Boolean`	Возвращает `true`, если для определённого типа события присоединены какие-либо слушатели.
`once(…)`	`this`	Ведёт себя как `on(…)`, за исключением того, что слушатель будет срабатывать один раз и затем удаляться.
`addEventParent(<Evented> obj)`	`this`	Добавляет родительское событие — `Evented`, которое будет получать распространяемые события
`removeEventParent(<Evented> obj)`	`this`	Удаляет родительское событие, поэтому оно перестанет получать распространяемые события
`addEventListener(…)`	`this`	Псевдоним для `on(…)`
`removeEventListener(…)`	`this`	Псевдоним для `off(…)`
`clearAllEventListeners(…)`	`this`	Псевдоним для `off()`
`addOneTimeEventListener(…)`	`this`	Псевдоним для `once(…)`
`fireEvent(…)`	`this`	Псевдоним для `fire(…)`
`hasEventListeners(…)`	`Boolean`	Псевдоним для `listens(…)`

Глобальные переключатели

Глобальные переключатели созданы для редких случаев и обычно заставляют Leaflet не обнаруживать определённую функцию браузера, даже если она есть. Вам нужно установить переключатель как глобальную переменную в true перед включением Leaflet на странице, например:

<script>L_NO_TOUCH = true;</script>
<script src="leaflet.js"></script>

Переключатель	Описание
`L_NO_TOUCH`	Заставляет Leaflet не использовать события касания, даже если они обнаружены.
`L_DISABLE_3D`	Заставляет Leaflet не использовать ускоренные 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–2019 Vladimir Agafonkin
© 2010–2011, CloudMade
Maps © OpenStreetMap contributors.
https://leafletjs.com/reference-1.7.1.html

Leaflet API справочник

Карта

Пример использования

Создание

Параметры

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

Параметры взаимодействия

Параметры состояния карты

Параметры анимации

Параметры инерции при панорамировании

Параметры навигации с клавиатуры

Параметры скроллинга мыши

Опции взаимодействия с сенсорным экраном

События

События слоя

События изменения состояния карты

События всплывающих окон

События всплывающих подсказок

События геолокации

События взаимодействия

Другие события

Методы

Методы для слоев и элементов управления

Методы для изменения состояния карты

Методы геолокации

Другие методы

Методы для получения состояния карты

Методы преобразования

Свойства

Управление

Обработчики

Панели карты

Опции определения местоположения

Опции масштабирования

Опции перемещения

Опции масштабирования/перемещения

Опции FitBounds

Маркер

Пример использования

Создание

Опции

Опции перетаскиваемого маркера

Другие методы

Свойства

Обработчики взаимодействия

Поп-ап

Пример использования

Создание

Параметры

События

Методы

Подсказка

Пример использования

Создание

Параметры

События

Методы

Слой плиток

Пример использования

Шаблон URL

Создание

Методы расширения

Параметры

События

Методы

Расширяемые методы

TileLayer.WMS

Пример использования

Создание

Параметры

События

Методы

ImageOverlay

Пример использования

Создание

Параметры

Методы

VideoOverlay

Пример использования

Создание