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

Параметры

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

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

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

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

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

Параметры инерционного перемещения

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

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

Параметр	Тип	Значение по умолчанию	Описание
`crs`	`CRS`	`L.CRS.EPSG3857`	Используемая система координат. Не изменяйте это, если не уверены, что это означает.
`center`	`LatLng`	`undefined`	Начальный географический центр карты
`zoom`	`Number`	`undefined`	Начальный уровень масштабирования карты
`minZoom`	`Number`	`*`	Минимальный уровень масштабирования карты. Если не указано, и на карте есть хотя бы один `GridLayer` или `TileLayer`, будет использовано наименьшее из их `minZoom` значений.
`maxZoom`	`Number`	`*`	Максимальный уровень масштабирования карты. Если не указано, и на карте есть хотя бы один `GridLayer` или `TileLayer`, будет использовано наибольшее из их `maxZoom` значений.
`layers`	`Layer[]`	`[]`	Массив слоев, которые будут добавлены на карту изначально
`maxBounds`	`LatLngBounds`	`null`	При установке этого параметра карта ограничивает представление заданными географическими границами, возвращая пользователя назад, если пользователь пытается переместить представление за пределы представления. Для динамической установки ограничения используйте метод `setMaxBounds`.
`renderer`	`Renderer`	`*`	Метод по умолчанию для отрисовки векторных слоев на карте. `L.SVG` или `L.Canvas` по умолчанию, в зависимости от поддержки браузера.

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

Опция	Тип	Значение по умолчанию	Описание
`zoomAnimation`	`Boolean`	`true`	Включить ли анимацию изменения масштаба карты. По умолчанию включена во всех браузерах, поддерживающих CSS3 Transitions, кроме Android.
`zoomAnimationThreshold`	`Number`	`4`	Анимация масштабирования не будет выполнена, если разница в масштабе превысит это значение.
`fadeAnimation`	`Boolean`	`true`	Включить ли анимацию плавного появления тайлов. По умолчанию включена во всех браузерах, поддерживающих CSS3 Transitions, кроме Android.
`markerZoomAnimation`	`Boolean`	`true`	Анимировать ли масштабирование маркеров вместе с анимацией изменения масштаба карты. Если отключено, маркеры исчезнут на время анимации. По умолчанию включена во всех браузерах, поддерживающих CSS3 Transitions, кроме Android.
`transform3DLimit`	`Number`	`2^23`	Определяет максимальный размер трансформации CSS-перевода. Значение по умолчанию не следует изменять, если браузер некорректно позиционирует слои после большого `panBy`.

События

События слоёв

Событие	Данные	Описание
`baselayerchange`	`LayersControlEvent`	Fired when the base layer is changed through the layer control.
`overlayadd`	`LayersControlEvent`	Fired when an overlay is selected through the layer control.
`overlayremove`	`LayersControlEvent`	Fired when an overlay is deselected through the layer control.
`layeradd`	`LayerEvent`	Fired when a new layer is added to the map.
`layerremove`	`LayerEvent`	Fired when some layer is removed from the map

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

Событие	Данные	Описание
`zoomlevelschange`	`Event`	Fired when the number of zoomlevels on the map is changed due to adding or removing a layer.
`resize`	`ResizeEvent`	Fired when the map is resized.
`unload`	`Event`	Fired when the map is destroyed with remove method.
`viewreset`	`Event`	Fired when the map needs to redraw its content (this usually happens on map zoom or load). Very useful for creating custom overlays.
`load`	`Event`	Fired when the map is initialized (when its center and zoom are set for the first time).
`zoomstart`	`Event`	Fired when the map zoom is about to change (e.g. before zoom animation).
`movestart`	`Event`	Fired when the view of the map starts changing (e.g. user starts dragging the map).
`zoom`	`Event`	Fired repeatedly during any change in zoom level, including zoom and fly animations.
`move`	`Event`	Fired repeatedly during any movement of the map, including pan and fly animations.
`zoomend`	`Event`	Fired when the map has changed, after any animations.
`moveend`	`Event`	Fired when the center of the map stops changing (e.g. user stopped dragging the map).

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup is opened in the map
`popupclose`	`PopupEvent`	Fired when a popup in the map is closed
`autopanstart`	`Event`	Fired when the map starts autopanning when opening a popup.

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip is opened in the map.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip in the map is closed.

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

Событие	Данные	Описание
`locationerror`	`ErrorEvent`	Fired when geolocation (using the `locate` method) failed.
`locationfound`	`LocationEvent`	Fired when geolocation (using the `locate` method) went successfully.

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

Событие	Данные	Описание
`click`	`MouseEvent`	Fired when the user clicks (or taps) the map.
`dblclick`	`MouseEvent`	Fired when the user double-clicks (or double-taps) the map.
`mousedown`	`MouseEvent`	Fired when the user pushes the mouse button on the map.
`mouseup`	`MouseEvent`	Fired when the user releases the mouse button on the map.
`mouseover`	`MouseEvent`	Fired when the mouse enters the map.
`mouseout`	`MouseEvent`	Fired when the mouse leaves the map.
`mousemove`	`MouseEvent`	Fired while the mouse moves over the map.
`contextmenu`	`MouseEvent`	Fired when the user pushes the right mouse button on the map, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).
`keypress`	`KeyboardEvent`	Fired when the user presses a key from the keyboard while the map is focused.
`preclick`	`MouseEvent`	Fired before mouse click on the map (sometimes useful when you want something to happen on click before any existing click handlers start running).

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

Событие	Данные	Описание
`zoomanim`	`ZoomAnimEvent`	Fired on every frame of a zoom animation

Методы

Метод	Возвращает	Описание
`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(<Bounds> bounds)`	`this`	Ограничивает вид карты заданными границами (см. параметр maxBounds).
`setMinZoom(<Number> zoom)`	`this`	Устанавливает минимальное значение для доступных уровней масштабирования (см. параметр minZoom).
`setMaxZoom(<Number> zoom)`	`this`	Устанавливает максимальное значение для доступных уровней масштабирования (см. параметр maxZoom).
`panInsideBounds(<LatLngBounds> bounds, <Pan options> options?)`	`this`	Перемещает карту к ближайшему виду, который попадает в заданные границы (если это не так уже), контролируя анимацию с использованием соответствующих опций (если таковые имеются).
`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` в соответствии с проекцией системы координат карты, затем масштабирует ее в соответствии с `zoom` и преобразованием системы координат `Transformation`. Результатом является пиксельная координата, относительная к началу системы координат.
`unproject(<Point> point, <Number> zoom)`	`LatLng`	Обратная функция `project`.
`layerPointToLatLng(<Point> point)`	`LatLng`	При заданной пиксельной координате, относительной к начальной пиксельной координате, возвращает соответствующую географическую координату (для текущего уровня масштаба).
`latLngToLayerPoint(<LatLng> latlng)`	`Point`	При заданной географической координате, возвращает соответствующую пиксельную координату, относительную к начальной пиксельной координате.
`wrapLatLng(<LatLng> latlng)`	`LatLng`	Возвращает `LatLng`, где `lat` и `lng` были обернуты в соответствии со свойствами `wrapLat` и `wrapLng` системы координат карты, если они выходят за пределы границ системы координат. По умолчанию это означает, что долгота обернута вокруг меридиана, поэтому ее значение находится в диапазоне от -180 до +180 градусов.
`wrapLatLngBounds(<LatLngBounds> bounds)`	`LatLngBounds`	Возвращает `LatLngBounds` того же размера, что и заданный, гарантируя, что его центр находится в пределах границ системы координат. По умолчанию это означает, что центральная долгота обернута вокруг меридиана, поэтому ее значение находится в диапазоне от -180 до +180 градусов, и большая часть границ перекрывает границы системы координат.
`distance(<LatLng> latlng1, <LatLng> latlng2)`	`Number`	Возвращает расстояние между двумя географическими координатами в соответствии с системой координат карты. По умолчанию расстояние измеряется в метрах.
`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`	The default zoom control (only available if the `zoomControl` option was `true` when creating the map).

Обработчики

Свойство	Тип	Описание
`boxZoom`	`Handler`	Box (shift-drag with mouse) zoom handler.
`doubleClickZoom`	`Handler`	Double click zoom handler.
`dragging`	`Handler`	Map dragging handler (by both mouse and touch).
`keyboard`	`Handler`	Keyboard navigation handler.
`scrollWheelZoom`	`Handler`	Scroll wheel zoom handler.
`tap`	`Handler`	Mobile touch hacks (quick tap and touch hold) handler.
`touchZoom`	`Handler`	Touch zoom handler.

Плани Map

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

План	Тип	Z-индекс	Описание
`mapPane`	`HTMLElement`	`'auto'`	План, содержащий все другие планы карты
`tilePane`	`HTMLElement`	`200`	План для `GridLayer` и `TileLayer`
`overlayPane`	`HTMLElement`	`400`	План для векторов (`Path`, таких как `Polyline` и `Polygon`), `ImageOverlay` и `VideoOverlay`
`shadowPane`	`HTMLElement`	`500`	План для теней наложения (например, тени `Marker`)
`markerPane`	`HTMLElement`	`600`	План для `Icon` маркеров `Marker`
`tooltipPane`	`HTMLElement`	`650`	План для `Tooltip`.
`popupPane`	`HTMLElement`	`700`	План для `Popup`.

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

Некоторые методы геолокации для Map принимают параметр options. Это обычный объект JavaScript с перечисленными необязательными компонентами:

Опция	Тип	По умолчанию	Описание
`watch`	`Boolean`	`false`	Если `true`, начинает непрерывное отслеживание изменений местоположения (вместо однократного обнаружения) с использованием метода W3C `watchPosition` . Позже вы можете прекратить отслеживание с помощью метода `map.stopLocate()` .
`setView`	`Boolean`	`false`	Если `true`, автоматически устанавливает представление карты на местоположение пользователя с учетом точности обнаружения или на представление мира, если геолокация не удалась.
`maxZoom`	`Number`	`Infinity`	Максимальный масштаб для автоматической установки представления при использовании опции `setView` .
`timeout`	`Number`	`10000`	Количество миллисекунд, которые нужно подождать для получения ответа от геолокации, прежде чем будет вызвано событие `locationerror` .
`maximumAge`	`Number`	`0`	Максимальный срок хранения данных о местоположении. Если прошло меньше этого значения миллисекунд с момента последнего ответа геолокации, `locate` вернет кэшированное местоположение.
`enableHighAccuracy`	`Boolean`	`false`	Включает высокую точность, см. описание в спецификации W3C.

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

Некоторые из методов Map, которые изменяют уровень масштаба, принимают параметр options . Это обычный объект JavaScript с указанными ниже необязательными компонентами:

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

Опции панорамирования

Некоторые из методов Map, которые изменяют центр карты, принимают параметр options . Это обычный объект JavaScript с указанными ниже необязательными компонентами:

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

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

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

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

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

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

Опции 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?)`	Создает объект Marker на основе географической точки и, необязательно, объекта опций.

Опции

Опция	Тип	По умолчанию	Описание
`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` куда будет добавлена иконка маркера.
`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`	Строка, отображаемая в блоке атрибуции, описывающая данные слоя, например, "© Mapbox".

События

В дополнение к общим методам слоев типа addTo() и remove() и методам всплывающих окон типа bindPopup() вы также можете использовать следующие методы:

Событие	Данные	Описание
`move`	`Event`	Fired when the marker is moved via `setLatLng` or by dragging. Old and new coordinates are included in event arguments as `oldLatLng`, `latlng`.

События перетаскивания

Событие	Данные	Описание
`dragstart`	`Event`	Fired when the user starts dragging the marker.
`movestart`	`Event`	Fired when the marker starts moving (because of dragging).
`drag`	`Event`	Fired repeatedly while the user drags the marker.
`dragend`	`DragEndEvent`	Fired when the user stops dragging the marker.
`moveend`	`Event`	Fired when the marker stops moving (because of dragging).

События мыши, унаследованные от Интерактивного слоя

Событие	Данные	Описание
`click`	`MouseEvent`	Fired when the user clicks (or taps) the layer.
`dblclick`	`MouseEvent`	Fired when the user double-clicks (or double-taps) the layer.
`mousedown`	`MouseEvent`	Fired when the user pushes the mouse button on the layer.
`mouseup`	`MouseEvent`	Fired when the user releases the mouse button pushed on the layer.
`mouseover`	`MouseEvent`	Fired when the mouse enters the layer.
`mouseout`	`MouseEvent`	Fired when the mouse leaves the layer.
`contextmenu`	`MouseEvent`	Fired when the user right-clicks on the layer, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).

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

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

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

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

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

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Методы

Метод	Возвращаемое значение	Описание
`toGeoJSON()`	`Object`	Возвращает представление метки в формате `GeoJSON` (как объект GeoJSON `Point` Feature).
`getLatLng()`	`LatLng`	Возвращает текущее географическое положение метки.
`setLatLng(<LatLng> latlng)`	`this`	Изменяет положение метки на заданную точку.
`setZIndexOffset(<Number> offset)`	`this`	Изменяет смещение zIndex метки.
`setIcon(<Icon> icon)`	`this`	Изменяет значок метки.
`setOpacity(<Number> opacity)`	`this`	Изменяет непрозрачность метки.

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

Метод	Возвращаемое значение	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой на заданную карту или группу слоев.
`remove()`	`this`	Удаляет слой с карты, на которой он сейчас активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с указанной карты.
`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 dragging handler (by both mouse and touch). Only valid when the marker is on the map (Otherwise set `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` куда будет добавлен попап.

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

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

События

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

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

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

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

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

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Метод	Возвращает	Описание
`getLatLng()`	`LatLng`	Возвращает географическую точку всплывающей подсказки.
`setLatLng(<LatLng> latlng)`	`this`	Устанавливает географическую точку, где откроется всплывающая подсказка.
`getContent()`	`String\|HTMLElement`	Возвращает содержимое всплывающей подсказки.
`setContent(<String\|HTMLElement\|Function> htmlContent)`	`this`	Устанавливает HTML-содержимое всплывающей подсказки. Если передана функция, то исходный слой будет передан в функцию. Функция должна вернуть `String` или `HTMLElement`, которые будут использованы во всплывающей подсказке.
`getElement()`	`String\|HTMLElement`	Псевдоним для getContent()
`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`	Удаляет слой с заданной карты
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий именованное окно на карте. Если `name` опущено, возвращает окно для этого слоя.
`getAttribution()`	`String`	Используется `attribution control`, возвращает опцию атрибуции.

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

Метод	Возвращает	Описание
`bindPopup(<String\|HTMLElement\|Function\|Popup> content, <Popup options> options?)`	`this`	Привязывает всплывающую подсказку к слою с переданным `content` и настраивает необходимые обработчики событий. Если передана функция, она получит слой в качестве первого аргумента и должна вернуть `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` и настраивает необходимые обработчики событий. Если передана функция, она получит слой в качестве первого аргумента и должна вернуть `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`	Строка, отображаемая в элементе управления атрибутами, описывающая данные слоя, например, «© Mapbox».

События

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

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

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

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

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

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Методы

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

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

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

Метод	Возвращает	Описание
`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(…)`

TileLayer

Используется для загрузки и отображения слоёв тайлов на карте. Расширяет GridLayer.

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

L.tileLayer('https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png?{foo}', {foo: 'bar'}).addTo(map);

Шаблон URL

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

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

{s} обозначает один из доступных поддоменов (используется последовательно для помощи с параллельными запросами браузера на ограничение домена; значения поддомена указываются в параметрах; a, b или c по умолчанию, могут быть опущены), {z} — уровень масштабирования, {x} и {y} — координаты тайла. {r} может использоваться для добавления "&commat;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)`	Загружать новые тайлы только после окончания перемещения. `true` по умолчанию в мобильных браузерах, чтобы избежать большого количества запросов и обеспечить плавное перемещение. `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 будет отображаться только один раз на низких уровнях масштабирования. Не оказывает никакого влияния, когда система координат карты не заворачивается. Может использоваться в сочетании с `bounds` для предотвращения запросов тайлов за пределами ограничений системы координат.
`pane`	`String`	`'tilePane'`	`Map pane` в который будет добавлен слой сетки.
`className`	`String`	`''`	Пользовательское имя класса для назначения слою тайлов. По умолчанию пусто.
`keepBuffer`	`Number`	`2`	При перемещении карты сохранять это количество строк и столбцов тайлов перед их разгрузкой.

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

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

События

Наследованные события от GridLayer

Событие	Данные	Описание
`loading`	`Event`	Fired when the grid layer starts loading tiles.
`tileunload`	`TileEvent`	Fired when a tile is removed (e.g. when a tile goes off the screen).
`tileloadstart`	`TileEvent`	Fired when a tile is requested and starts loading.
`tileerror`	`TileErrorEvent`	Fired when there is an error loading a tile.
`tileload`	`TileEvent`	Fired when a tile loads.
`load`	`Event`	Fired when the grid layer loaded all visible tiles.

Наследованные события от Layer

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

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

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

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

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Методы

Метод	Возвращаемое значение	Описание
`setUrl(<String> url, <Boolean> noRedraw?)`	`this`	Обновляет шаблон URL слоя и перерисовывает его (если `noRedraw` установлено в `true`).
`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`	Удаляет слой с указанной карты.
`getPane(<String> name?)`	`HTMLElement`	Возвращает элемент `HTMLElement`, представляющий именованный элемент области на карте. Если `name` опущено, возвращает область для этого слоя.
`getAttribution()`	`String`	Используется методом `attribution control`, возвращает параметр attribution.

Методы всплывающих окон, унаследованные от 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, по умолчанию соответствует системе координат карты. Не меняйте это, если вы не уверены, что это значит.
`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` и пользователь находится на дисплее с сетчаткой, он запросит четыре плитки вдвое меньшего размера и с большим уровнем масштабирования вместо одной, чтобы использовать высокое разрешение.
`crossOrigin`	`Boolean\|String`	`false`	Указывает, будет ли добавлен атрибут crossOrigin к плиткам. Если указана строка, для всех плиток будет установлен атрибут crossOrigin со значением указанной строки. Это необходимо, если вы хотите получить доступ к данным пикселей плиток. Обратитесь к Настройкам CORS для допустимых значений строк.

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

Опция	Тип	По умолчанию	Описание
`tileSize`	`Number\|Point`	`256`	Ширина и высота тайлов в сетке. Используйте число, если ширина и высота равны, или `L.point(width, height)` в противном случае.
`opacity`	`Number`	`1.0`	Непрозрачность тайлов. Может использоваться в функции `createTile()`.
`updateWhenIdle`	`Boolean`	`(depends)`	Загружать новые тайлы только по завершении перемещения. `true` по умолчанию в мобильных браузерах, чтобы избежать слишком многих запросов и сохранить плавную навигацию. `false` в противном случае, чтобы отобразить новые тайлы во время перемещения, так как легко переместиться за пределы параметра `keepBuffer` в браузерах на десктопах.
`updateWhenZooming`	`Boolean`	`true`	По умолчанию, плавная анимация масштабирования (во время масштабирования с помощью касания или `flyTo()`) будет обновлять слои сетки на каждом целочисленном уровне масштабирования. Установка этого параметра в `false` обновит слой сетки только по завершении плавной анимации.
`updateInterval`	`Number`	`200`	Тайлы не будут обновляться чаще, чем один раз каждые `updateInterval` миллисекунд при перемещении.
`zIndex`	`Number`	`1`	Явное значение zIndex слоя тайлов.
`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`	Строка, отображаемая в элементе управления атрибуцией, описывающая данные слоя, например, "© Mapbox".

События

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

Событие	Данные	Описание
`loading`	`Event`	Fired when the grid layer starts loading tiles.
`tileunload`	`TileEvent`	Fired when a tile is removed (e.g. when a tile goes off the screen).
`tileloadstart`	`TileEvent`	Fired when a tile is requested and starts loading.
`tileerror`	`TileErrorEvent`	Fired when there is an error loading a tile.
`tileload`	`TileEvent`	Fired when a tile loads.
`load`	`Event`	Fired when the grid layer loaded all visible tiles.

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

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

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

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

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

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Методы

Метод	Возвращает	Описание
`setParams(<Object> params, <Boolean> noRedraw?)`	`this`	Объединяет объект с новыми параметрами и повторно запрашивает тайлы на текущем экране (если `noRedraw` не было установлено в true).

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

Метод	Возвращает	Описание
`setUrl(<String> url, <Boolean> noRedraw?)`	`this`	Обновляет шаблон URL слоя и перерисовывает его (если `noRedraw` не установлено в `true`).
`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()`.

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

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

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

Метод	Возвращает	Описание
`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(…)`

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`	Строка, которая будет отображаться в контроле атрибуции, описывает данные слоя, например, «© Mapbox».

События

Событие	Данные	Описание
`load`	`Event`	Fired when the ImageOverlay layer has loaded its image
`error`	`Event`	Fired when the ImageOverlay layer fails to load its image

События мыши, унаследованные от Интерактивный слой

Событие	Данные	Описание
`click`	`MouseEvent`	Fired when the user clicks (or taps) the layer.
`dblclick`	`MouseEvent`	Fired when the user double-clicks (or double-taps) the layer.
`mousedown`	`MouseEvent`	Fired when the user pushes the mouse button on the layer.
`mouseup`	`MouseEvent`	Fired when the user releases the mouse button pushed on the layer.
`mouseover`	`MouseEvent`	Fired when the mouse enters the layer.
`mouseout`	`MouseEvent`	Fired when the mouse leaves the layer.
`contextmenu`	`MouseEvent`	Fired when the user right-clicks on the layer, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).

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

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

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

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

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

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Методы

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

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

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

Методы всплывающей подсказки, унаследованные от 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(…)`

END_OF_DOCUMENT_MARKER

VideoOverlay

Используется для загрузки и отображения видеоплеера поверх определённых границ карты. Расширяет ImageOverlay. Видео-оверлей использует элемент <video> HTML5.

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

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`	Повторять видео с начала при воспроизведении.

Параметры, унаследованные от 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`	Строка, отображаемая в блоке авторских прав, описывающая данные слоя, например, "© Mapbox".

События

Событие	Данные	Описание
`load`	`Event`	Fired when the video has finished loading the first frame

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

Событие	Данные	Описание
`error`	`Event`	Fired when the ImageOverlay layer fails to load its image

События мыши, унаследованные от Интерактивного слоя

Событие	Данные	Описание
`click`	`MouseEvent`	Fired when the user clicks (or taps) the layer.
`dblclick`	`MouseEvent`	Fired when the user double-clicks (or double-taps) the layer.
`mousedown`	`MouseEvent`	Fired when the user pushes the mouse button on the layer.
`mouseup`	`MouseEvent`	Fired when the user releases the mouse button pushed on the layer.
`mouseover`	`MouseEvent`	Fired when the mouse enters the layer.
`mouseout`	`MouseEvent`	Fired when the mouse leaves the layer.
`contextmenu`	`MouseEvent`	Fired when the user right-clicks on the layer, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).

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

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

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

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

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

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Методы

Метод	Возвращает	Описание
`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

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

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой на заданную карту или группу слоёв.
`remove()`	`this`	Удаляет слой с карты, на которой он в данный момент активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с указанной карты
`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.

Параметры

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

События

События мыши, унаследованные от Интерактивного слоя

Событие	Данные	Описание
`click`	`MouseEvent`	Fired when the user clicks (or taps) the layer.
`dblclick`	`MouseEvent`	Fired when the user double-clicks (or double-taps) the layer.
`mousedown`	`MouseEvent`	Fired when the user pushes the mouse button on the layer.
`mouseup`	`MouseEvent`	Fired when the user releases the mouse button pushed on the layer.
`mouseover`	`MouseEvent`	Fired when the mouse enters the layer.
`mouseout`	`MouseEvent`	Fired when the mouse leaves the layer.
`contextmenu`	`MouseEvent`	Fired when the user right-clicks on the layer, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).

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

Event	Data	Description
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

Popup events inherited from Layer

Event	Data	Description
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

Tooltip events inherited from Layer

Event	Data	Description
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Methods

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

Methods inherited from Layer

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

Popup methods inherited from Layer

Method	Returns	Description
`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`	Возвращает привязанное к этому слою всплывающее окно.

Tooltip methods inherited from Layer

Method	Returns	Description
`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`	Возвращает привязанную к этому слою подсказку.

Methods inherited from Evented

Method	Returns	Description
`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`	Отключить обрезку полилинии.

Options inherited from 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`	Строка, отображаемая в контроле атрибуции, описывающая данные слоя, например, "© Mapbox".

События

События мыши, унаследованные от Интерактивного слоя

Событие	Данные	Описание
`click`	`MouseEvent`	Fired when the user clicks (or taps) the layer.
`dblclick`	`MouseEvent`	Fired when the user double-clicks (or double-taps) the layer.
`mousedown`	`MouseEvent`	Fired when the user pushes the mouse button on the layer.
`mouseup`	`MouseEvent`	Fired when the user releases the mouse button pushed on the layer.
`mouseover`	`MouseEvent`	Fired when the mouse enters the layer.
`mouseout`	`MouseEvent`	Fired when the mouse leaves the layer.
`contextmenu`	`MouseEvent`	Fired when the user right-clicks on the layer, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).

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

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

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

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

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

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Методы

Метод	Возвращает	Описание
`toGeoJSON()`	`Object`	Возвращает представление полилинии в формате `GeoJSON` (как объект GeoJSON `LineString` или `MultiLineString` Feature).
`getLatLngs()`	`LatLng[]`	Возвращает массив точек пути или вложенные массивы точек в случае мульти-полилинии.
`setLatLngs(<LatLng[]> latlngs)`	`this`	Заменяет все точки в полилинии заданным массивом географических точек.
`isEmpty()`	`Boolean`	Возвращает `true` если у полилинии нет LatLng.
`closestLayerPoint(<Point> p)`	`Point`	Возвращает точку, ближайшую к `p` на полилинии.
`getCenter()`	`LatLng`	Возвращает центр (центроид) полилинии.
`getBounds()`	`LatLngBounds`	Возвращает `LatLngBounds` пути.
`addLatLng(<LatLng> latlng)`	`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`	Удаляет слой с заданной карты.
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий именованный слой на карте. Если `name` опущено, возвращает слой для данного слоя.
`getAttribution()`	`String`	Используется контролем атрибуции, возвращает опцию атрибуции.

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

Метод	Возвращает	Описание
`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`	Строка, отображаемая в элементе управления атрибуцией, описывающая данные слоя, например, "© Mapbox".

События

События мыши, унаследованные от Интерактивного слоя

Событие	Данные	Описание
`click`	`MouseEvent`	Fired when the user clicks (or taps) the layer.
`dblclick`	`MouseEvent`	Fired when the user double-clicks (or double-taps) the layer.
`mousedown`	`MouseEvent`	Fired when the user pushes the mouse button on the layer.
`mouseup`	`MouseEvent`	Fired when the user releases the mouse button pushed on the layer.
`mouseover`	`MouseEvent`	Fired when the mouse enters the layer.
`mouseout`	`MouseEvent`	Fired when the mouse leaves the layer.
`contextmenu`	`MouseEvent`	Fired when the user right-clicks on the layer, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).

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

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

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

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

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

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Методы

Метод	Возвращаемое значение	Описание
`toGeoJSON()`	`Object`	Возвращает представление многоугольника в формате `GeoJSON` (как GeoJSON `Polygon` или `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)`	`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`	Удаляет слой с указанной карты.
`getPane(<String> name?)`	`HTMLElement`	Возвращает `HTMLElement`, представляющий указанный слой на карте. Если `name` опущено, возвращает слой для этого слоя.
`getAttribution()`	`String`	Используется элементом управления атрибуцией, возвращает опцию атрибуции.

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

Метод	Возвращает	Описание
`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(…)`

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

Класс для рисования прямоугольных наложений на карте. Расширяет 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`	Строка, отображаемая в блоке авторских прав, описывает данные слоя, например, "© Mapbox".

События

События мыши, унаследованные от Интерактивного слоя

Событие	Данные	Описание
`click`	`MouseEvent`	Fired when the user clicks (or taps) the layer.
`dblclick`	`MouseEvent`	Fired when the user double-clicks (or double-taps) the layer.
`mousedown`	`MouseEvent`	Fired when the user pushes the mouse button on the layer.
`mouseup`	`MouseEvent`	Fired when the user releases the mouse button pushed on the layer.
`mouseover`	`MouseEvent`	Fired when the mouse enters the layer.
`mouseout`	`MouseEvent`	Fired when the mouse leaves the layer.
`contextmenu`	`MouseEvent`	Fired when the user right-clicks on the layer, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).

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

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

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

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

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

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Методы

Метод	Возвращаемое значение	Описание
`setBounds(<LatLngBounds> latLngBounds)`	`this`	Перерисовывает прямоугольник с переданными границами.

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

Метод	Возвращаемое значение	Описание
`toGeoJSON()`	`Object`	Возвращает представление многоугольника в формате `GeoJSON` (как GeoJSON `Polygon` или `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)`	`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`	Удаляет слой с заданной карты.
`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(…)`

Circle

Класс для рисования круговых наложений на карте. Расширяет 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`		Радиус круга в метрах.

Параметры, унаследованные от 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`	Строка, отображаемая в элементе управления атрибутами, описывающая данные слоя, например, "© Mapbox".

События

События мыши, унаследованные от Интерактивного слоя

Событие	Данные	Описание
`click`	`MouseEvent`	Fired when the user clicks (or taps) the layer.
`dblclick`	`MouseEvent`	Fired when the user double-clicks (or double-taps) the layer.
`mousedown`	`MouseEvent`	Fired when the user pushes the mouse button on the layer.
`mouseup`	`MouseEvent`	Fired when the user releases the mouse button pushed on the layer.
`mouseover`	`MouseEvent`	Fired when the mouse enters the layer.
`mouseout`	`MouseEvent`	Fired when the mouse leaves the layer.
`contextmenu`	`MouseEvent`	Fired when the user right-clicks on the layer, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).

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

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

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

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

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

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Методы

Метод	Возвращает	Описание
`setRadius(<Number> radius)`	`this`	Устанавливает радиус окружности. Единицы измерения — метры.
`getRadius()`	`Number`	Возвращает текущий радиус окружности. Единицы измерения — метры.
`getBounds()`	`LatLngBounds`	Возвращает `LatLngBounds` траектории.

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

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

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

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

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

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

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

Метод	Возвращает	Описание
`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`	Строка, отображаемая в контроле атрибуции, описывающая данные слоя, например, «© Mapbox».

События

События мыши, унаследованные от Интерактивного слоя

Событие	Данные	Описание
`click`	`MouseEvent`	Fired when the user clicks (or taps) the layer.
`dblclick`	`MouseEvent`	Fired when the user double-clicks (or double-taps) the layer.
`mousedown`	`MouseEvent`	Fired when the user pushes the mouse button on the layer.
`mouseup`	`MouseEvent`	Fired when the user releases the mouse button pushed on the layer.
`mouseover`	`MouseEvent`	Fired when the mouse enters the layer.
`mouseout`	`MouseEvent`	Fired when the mouse leaves the layer.
`contextmenu`	`MouseEvent`	Fired when the user right-clicks on the layer, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).

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

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

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

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

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

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Методы circlemarker

Метод	Возвращает	Описание
`toGeoJSON()`	`Object`	Возвращает представление маркера круга в формате `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`	Удаляет слой с заданной карты.
`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

Позволяет отображать векторные слои с помощью SVG. Наследует Renderer. Из-за технических ограничений, SVG не доступен во всех веб-браузерах, в частности, в Android 2.x и 3.x. Хотя SVG недоступен в IE7 и IE8, эти браузеры поддерживают VML (ныне устаревшая технология), и рендерер SVG в этом случае будет использовать VML. Хотя SVG недоступен в IE7 и IE8, эти браузеры поддерживают VML, и рендерер SVG в этом случае будет использовать VML. VML был устаревшим в 2012 году, что означает, что функциональность VML существует только для обратной совместимости со старыми версиями Internet Explorer.

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

Использовать SVG по умолчанию для всех путей на карте:

var map = L.map('map', {
    renderer: L.svg()
});

Использовать рендерер SVG с дополнительным отступом для определенных векторных геометрий:

var map = L.map('map');
var myRenderer = L.svg({ padding: 0.5 });
var line = L.polyline( coordinates, { renderer: myRenderer } );
var circle = L.circle( center, { renderer: myRenderer } );

Создание

Фабрика	Описание
`L.svg(<Renderer options> options?)`	Создает рендерер SVG с заданными параметрами.

Параметры

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

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

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

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

События

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

Событие	Данные	Описание
`update`	`Event`	Fired when the renderer updates its bounds, center and zoom, for example when its map has moved

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

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

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

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

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

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Методы

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

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой к заданной карте или группе слоёв.
`remove()`	`this`	Удаляет слой с карты, на которой он в данный момент активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с заданной карты.
`getAttribution()`	`String`	Возвращает `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.SVG:

Функция	Возвращает	Описание
`create(<String> name)`	`SVGElement`	Возвращает экземпляр SVGElement, соответствующий переданному имени класса. Например, использование 'line' вернёт экземпляр SVGLineElement.
`pointsToPath(<Point[]> rings, <Boolean> closed)`	`String`	Генерирует строку SVG path для нескольких контуров, где каждый контур преобразуется в инструкции "M..L..L..".

Canvas

Позволяет отображать векторные слои с помощью <canvas>. Наследует Renderer. Из-за технических ограничений, Canvas недоступен во всех веб-браузерах, особенно в IE8, и перекрывающиеся геометрии могут не отображаться должным образом в некоторых крайних случаях.

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

Использование Canvas по умолчанию для всех путей на карте:

var map = L.map('map', {
    renderer: L.canvas()
});

Использование 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?)`	Создаёт Canvas рендерер с заданными опциями.

Опции

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

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

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

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

События

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

Событие	Данные	Описание
`update`	`Event`	Fired when the renderer updates its bounds, center and zoom, for example when its map has moved

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

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

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

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

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

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Методы

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

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой к заданной карте или группе слоев.
`remove()`	`this`	Удаляет слой с карты, на которой он сейчас активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с заданной карты
`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.

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

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

Создание

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

Параметры

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

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

События

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

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

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

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

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

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Методы

Метод	Возвращает	Описание
`toGeoJSON()`	`Object`	Возвращает представление группы слоёв в формате `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`	Удаляет слой с заданной карты
`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(…)`

FeatureGroup

Расширенный LayerGroup, который упрощает выполнение одних и тех же действий со всеми слоями-членами:

bindPopup связывает всплывающее окно со всеми слоями сразу (аналогично bindTooltip)
События передаются в FeatureGroup, поэтому, если у группы есть обработчик событий, она будет обрабатывать события любого из слоев. Это включает события мыши и пользовательские события.
Имеет события layeradd и layerremove

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

L.featureGroup([marker1, marker2, polyline])
    .bindPopup('Hello world!')
    .on('click', function() { alert('Clicked on a member of the group!'); })
    .addTo(map);

Создание

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

Параметры

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

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

События

Событие	Данные	Описание
`layeradd`	`LayerEvent`	Fired when a layer is added to this `FeatureGroup`
`layerremove`	`LayerEvent`	Fired when a layer is removed from this `FeatureGroup`

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

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

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

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

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

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Методы

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

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

Метод	Возвращает	Описание
`toGeoJSON()`	`Object`	Возвращает представление группы слоёв в формате `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`	Удаляет слой с заданной карты.
`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(…)`

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

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

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

События

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

Событие	Данные	Описание
`layeradd`	`LayerEvent`	Fired when a layer is added to this `FeatureGroup`
`layerremove`	`LayerEvent`	Fired when a layer is removed from this `FeatureGroup`

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

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

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

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

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

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Методы

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

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

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

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

Метод	Возвращает	Описание
`toGeoJSON()`	`Object`	Возвращает представление группы слоев в формате `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`	Удаляет слой со заданной карты.
`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)`	Загружать новые тайлы только при завершении панорамирования. По умолчанию `true` в мобильных браузерах, чтобы избежать слишком большого количества запросов и обеспечить плавную навигацию. `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`, чтобы предотвратить запрос тайлов за пределами границ системы координат.
`pane`	`String`	`'tilePane'`	`Map pane` где будет добавлен слой сетки.
`className`	`String`	`''`	Пользовательское имя класса для назначения слою тайлов. По умолчанию пустое.
`keepBuffer`	`Number`	`2`	При панорамировании карты сохраняйте это количество строк и столбцов тайлов перед их разгрузкой.

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

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

События

Событие	Данные	Описание
`loading`	`Event`	Fired when the grid layer starts loading tiles.
`tileunload`	`TileEvent`	Fired when a tile is removed (e.g. when a tile goes off the screen).
`tileloadstart`	`TileEvent`	Fired when a tile is requested and starts loading.
`tileerror`	`TileErrorEvent`	Fired when there is an error loading a tile.
`tileload`	`TileEvent`	Fired when a tile loads.
`load`	`Event`	Fired when the grid layer loaded all visible tiles.

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

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

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

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

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

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Методы

Метод	Возвращает	Описание
`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` коллбэк, он должен быть вызван, когда тайл завершит загрузку и отрисовку.

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

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой к заданной карте или группе слоёв.
`remove()`	`this`	Удаляет слой с карты, на которой он сейчас активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с заданной карты.
`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(…)`

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`	Latitude in degrees
`lng`	`Number`	Longitude in degrees
`alt`	`Number`	Altitude in meters (optional)

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's 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(<Bounds> otherBounds)`	`Boolean`	Возвращает `true` если прямоугольник перекрывает заданные границы. Две границы перекрываются, если их пересечение является областью.
`toBBoxString()`	`String`	Возвращает строку с координатами bounding box в формате '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 не наследуется от объекта Leaflet's Class, что означает, что новые классы не могут наследоваться от него, и новые методы не могут быть добавлены к нему с помощью функции 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`	The `x` coordinate of the point
`y`	`Number`	The `y` coordinate of the point

Прямоугольная область

Представляет прямоугольную область в пиксельных координатах.

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

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`	The top left corner of the rectangle.
`max`	`Point`	The bottom right corner of the rectangle.

Значок

Представляет значок для использования при создании маркера.

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

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 и shadow.

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

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`	`''`	Пользовательский HTML-код для размещения внутри элемента div, по умолчанию пустой.
`bgPos`	`Point`	`[0, 0]`	Необязательная относительная позиция фона в пикселях

Опции унаследованы от Значка

Опция	Тип	По умолчанию	Описание
`iconUrl`	`String`	`null`	(обязательно) URL изображения значка (абсолютный или относительный к пути вашего скрипта).
`iconRetinaUrl`	`String`	`null`	URL изображения значка высокого разрешения (абсолютный или относительный к пути вашего скрипта). Используется для устройств с дисплеями Retina.
`iconSize`	`Point`	`null`	Размер изображения значка в пикселях.
`iconAnchor`	`Point`	`null`	Координаты "кончика" значка (относительно его левого верхнего угла). Значок будет выровнен так, чтобы эта точка находилась в географическом месте маркера. По умолчанию центрируется, если задан размер, также может быть задан в CSS с отрицательными отступами.
`popupAnchor`	`Point`	`[0, 0]`	Координаты точки, из которой будут открываться всплывающие окна, относительно якоря значка.
`tooltipAnchor`	`Point`	`[0, 0]`	Координаты точки, из которой будут открываться всплывающие подсказки, относительно якоря значка.
`shadowUrl`	`String`	`null`	URL изображения тени значка. Если не указано, изображение тени не будет создано.
`shadowRetinaUrl`	`String`	`null`
`shadowSize`	`Point`	`null`	Размер изображения тени в пикселях.
`shadowAnchor`	`Point`	`null`	Координаты "кончика" тени (относительно её левого верхнего угла) (то же, что и iconAnchor, если не указано иначе).
`className`	`String`	`''`	Пользовательское имя класса, которое будет назначено как значку, так и изображению тени. По умолчанию пустое.

Методы

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

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

Control.Attribution

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

Создание

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

Опции

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

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

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

Методы

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

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

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

Control.Layers

Инструмент управления слоями позволяет пользователям переключаться между различными базовыми слоями и включать/выключать наложения (см. подробный пример здесь). Расширяет Control.

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

var baseLayers = {
    "Mapbox": mapbox,
    "OpenStreetMap": osm
};
var overlays = {
    "Marker": marker,
    "Roads": roadsLayer
};
L.control.layers(baseLayers, overlays).addTo(map);

Параметры baseLayers и overlays являются объектами-литералами с именами слоёв в качестве ключей и объектами Layer в качестве значений:

{
    "<someName1>": layer1,
    "<someName2>": layer2
}

Имена слоёв могут содержать HTML, что позволяет добавлять дополнительный стиль к элементам:

{"<img src='my-layer-icon' /> <span class='my-layer-item'>My Layer</span>": myLayer}

Создание

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

L.control.layers(<Object> baselayers?, <Object> overlays?, <Control.Layers options> options?) Создаёт инструмент управления слоями с заданными слоями. Базовые слои будут переключаться с помощью радиокнопок, а наложения — с помощью флажков. Обратите внимание, что все базовые слои должны быть переданы в объекте base layers, но только один должен быть добавлен на карту во время инициализации карты.

Опции

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

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

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

Методы

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

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

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

Управление.Масштаб

Простое управление масштабом, отображающее масштаб текущего центра экрана в метрических (м/км) и имперских (ми/футов) системах. Расширяет 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`).

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

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

Методы

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

Метод	Возвращает	Описание
`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` for all Internet Explorer versions (not Edge).
`ielt9`	`Boolean`	`true` for Internet Explorer versions less than 9.
`edge`	`Boolean`	`true` for the Edge web browser.
`webkit`	`Boolean`	`true` for webkit-based browsers like Chrome and Safari (including mobile versions).
`android`	`Boolean`	`true` for any browser running on an Android platform.
`android23`	`Boolean`	`true` for browsers running on Android 2 or Android 3.
`androidStock`	`Boolean`	`true` for the Android stock browser (i.e. not Chrome)
`opera`	`Boolean`	`true` for the Opera browser
`chrome`	`Boolean`	`true` for the Chrome browser.
`gecko`	`Boolean`	`true` for gecko-based browsers like Firefox.
`safari`	`Boolean`	`true` for the Safari browser.
`opera12`	`Boolean`	`true` for the Opera browser supporting CSS transforms (version 12 or later).
`win`	`Boolean`	`true` when the browser is running in a Windows platform
`ie3d`	`Boolean`	`true` for all Internet Explorer versions supporting CSS transforms.
`webkit3d`	`Boolean`	`true` for webkit-based browsers supporting CSS transforms.
`gecko3d`	`Boolean`	`true` for gecko-based browsers supporting CSS transforms.
`any3d`	`Boolean`	`true` for all browsers supporting CSS transforms.
`mobile`	`Boolean`	`true` for all browsers running in a mobile device.
`mobileWebkit`	`Boolean`	`true` for all webkit-based browsers in a mobile device.
`mobileWebkit3d`	`Boolean`	`true` for all webkit-based browsers in a mobile device supporting CSS transforms.
`msPointer`	`Boolean`	`true` for browsers implementing the Microsoft touch events model (notably IE10).
`pointer`	`Boolean`	`true` for all browsers supporting pointer events.
`touch`	`Boolean`	`true` for all browsers supporting touch events. This does not necessarily mean that the browser is running in a computer with a touchscreen, it only means that the browser is capable of understanding touch events.
`mobileOpera`	`Boolean`	`true` for the Opera browser in a mobile device.
`mobileGecko`	`Boolean`	`true` for gecko-based browsers running in a mobile device.
`retina`	`Boolean`	`true` for browsers on a high-resolution "retina" screen or on any screen when browser's display zoom is more than 100%.
`canvas`	`Boolean`	`true` when the browser supports `<canvas>`.
`svg`	`Boolean`	`true` when the browser supports SVG.
`vml`	`Boolean`	`true` if the browser supports VML.

Утилиты

Различные вспомогательные функции, используемые 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` при перерисовке браузера. `context` привязан к `fn` при задании. Если `immediate` установлено, `fn` вызывается немедленно, если браузер не поддерживает `window.requestAnimationFrame`, иначе он откладывается. Возвращает идентификатор запроса, который может использоваться для отмены запроса.
`cancelAnimFrame(<Number> id)`	`undefined`	Отменяет предыдущий `requestAnimFrame`. См. также window.cancelAnimationFrame.

Свойства

Свойство	Тип	Описание
`lastId`	`Number`	Last unique ID used by `stamp()`
`emptyImageUrl`	`String`	Data URI string containing a base64-encoded empty GIF image. Used as a hack to free memory from unused images on WebKit-powered mobile devices (by setting image `src` to this string).

Преобразование

Представляет аффинное преобразование: набор коэффициентов 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 до 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`) к элементу `el` для определенного типа события DOM. Можно указать контекст обработчика (объект, к которому будет относиться ключевое слово `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` к событиям `'mousewheel'` элемента (плюс варианты браузера).
`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`	Возвращает элемент по его ID в 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-сдвиг или позиционирование по 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`	Vendor-prefixed transform style name (e.g. `'webkitTransform'` for WebKit).
`TRANSITION`	`String`	Vendor-prefixed transition style name.
`TRANSITION_END`	`String`	Vendor-prefixed transitionend event name.

PosAnimation

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

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

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

Конструктор

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

События

Событие	Данные	Описание
`start`	`Event`	Fired when the animation starts
`step`	`Event`	Fired continuously during the animation.
`end`	`Event`	Fired when the animation ends.

Методы

Метод	Возвращает	Описание
`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`	Fired when a drag is about to start.
`dragstart`	`Event`	Fired when a drag starts
`predrag`	`Event`	Fired continuously during dragging before each corresponding update of the element's position.
`drag`	`Event`	Fired continuously during dragging.
`dragend`	`DragEndEvent`	Fired when the drag ends.

Методы

Метод	Возвращает	Описание
`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 в других языках), обращаясь к прототипу родительского класса и используя JavaScript's call или apply:

var MyChildClass = MyClass.extend({
    initialize: function () {
        MyClass.prototype.initialize.call(this, "Yo");
    },
    greet: function (name) {
        MyClass.prototype.greet.call(this, 'bro ' + name + '!');
    }
});
var a = new MyChildClass();
a.greet('Jason'); // alerts "Yo, bro Jason!"

Параметры

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

var MyClass = L.Class.extend({
    options: {
        myOption1: 'foo',
        myOption2: 'bar'
    }
});
var MyChildClass = MyClass.extend({
    options: {
        myOption1: 'baz',
        myOption3: 5
    }
});
var a = new MyChildClass();
a.options.myOption1; // 'baz'
a.options.myOption2; // 'bar'
a.options.myOption3; // 5

Также есть L.Util.setOptions, метод для удобного объединения параметров, переданных конструктору, с значениями по умолчанию, определёнными в классе:

var MyClass = L.Class.extend({
    options: {
        foo: 'bar',
        bla: 5
    },
    initialize: function (options) {
        L.Util.setOptions(this, options);
        ...
    }
});
var a = new MyClass({bla: 10});
a.options; // {foo: 'bar', bla: 10}

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

Включения

includes — специальное свойство класса, которое объединяет все указанные объекты в класс (такие объекты называются миксинами).

 var MyMixin = {
    foo: function () { ... },
    bar: 5
};
var MyClass = L.Class.extend({
    includes: MyMixin
});
var a = new MyClass();
a.foo();

END_OF_DOCUMENT_MARKER

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

Событийная модель

Набор методов, общих для классов, работающих с событиями (например, 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`	Строка, отображаемая в элементе управления атрибуцией, описывающая данные слоя, например, "© Mapbox".

События

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Методы

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

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

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

Каждый слой должен наследоваться от 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, который отображается в элементе управления атрибуцией, когда слой видимый.
`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`	Строка, отображаемая в контроле атрибуции, описывающая данные слоя, например, "© Mapbox".

События

События мыши

Событие	Данные	Описание
`click`	`MouseEvent`	Fired when the user clicks (or taps) the layer.
`dblclick`	`MouseEvent`	Fired when the user double-clicks (or double-taps) the layer.
`mousedown`	`MouseEvent`	Fired when the user pushes the mouse button on the layer.
`mouseup`	`MouseEvent`	Fired when the user releases the mouse button pushed on the layer.
`mouseover`	`MouseEvent`	Fired when the mouse enters the layer.
`mouseout`	`MouseEvent`	Fired when the mouse leaves the layer.
`contextmenu`	`MouseEvent`	Fired when the user right-clicks on the layer, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).

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

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

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

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

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

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Методы

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

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой на заданную карту или группу слоев.
`remove()`	`this`	Удаляет слой с карты, на которой он в настоящее время активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с заданной карты.
`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`	The bounds (specified in CRS units) where the projection is valid

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

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

Проекция	Описание
`L.Projection.LonLat`	Прямоугольная, или проекция Плана Карре — самая простая проекция, в основном используемая энтузиастами ГИС. Прямо отображает `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`	Standard code name of the CRS passed into WMS services (e.g. `'EPSG:3857'`)
`wrapLng`	`Number[]`	An array of two numbers defining whether the longitude (horizontal) coordinate axis wraps around a given range and how. Defaults to `[-180, 180]` in most geographical CRSs. If `undefined`, the longitude axis does not wrap around.
`wrapLat`	`Number[]`	Like `wrapLng`, but for the latitude (vertical) axis.
`infinite`	`Boolean`	If true, the coordinate space will be unbounded (infinite in both axes)

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

CRS	Описание
`L.CRS.Earth`	Служит основой для CRS, которые являются глобальными и покрывают Землю. Может использоваться только как основа для других CRS и не может использоваться напрямую, так как у него нет `code`, `projection` или `transformation`. `distance()` возвращает метры.
`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.Base`	Объект, определяющий системы координат для проектирования географических точек в пиксельные (экранные) координаты и обратно (и в другие единицы для служб WMS). Смотрите пространственную систему координат. Leaflet определяет наиболее распространённые CRS по умолчанию. Если вы хотите использовать CRS, не определённый по умолчанию, обратите внимание на плагин Proj4Leaflet. Обратите внимание, что экземпляры CRS не наследуют от объекта Leaflet `Class` и не могут быть созданы. Кроме того, новые классы не могут наследоваться от них, и методы не могут быть добавлены к ним с помощью функции `include`.
`L.CRS.Simple`	Простой CRS, который отображает долготу и широту в `x` и `y` напрямую. Может использоваться для карт плоских поверхностей (например, игровых карт). Обратите внимание, что ось `y` всё ещё должна быть инвертирована (от нижней к верхней части). `distance()` возвращает просто евклидово расстояние.

Рендерер

Базовый класс для реализаций векторного рендеринга (SVG, Canvas). Обрабатывает контейнер DOM рендера, его границы и анимацию масштабирования. Renderer работает как неявная группа слоёв для всех Path — сам рендерер может быть добавлен или удалён в карту. Все пути используют рендерер, который может быть неявным (карта сама определит тип рендера и использует его автоматически) или явным (с помощью параметра renderer пути). Не используйте этот класс напрямую, используйте SVG и Canvas вместо него.

Параметры

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

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

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

События

Событие	Данные	Описание
`update`	`Event`	Fired when the renderer updates its bounds, center and zoom, for example when its map has moved

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

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

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

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

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

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Методы

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

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой на указанную карту или группу слоёв.
`remove()`	`this`	Удаляет слой с карты, на которой он в данный момент активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с заданной карты.
`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(…)`.

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

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

map.on('click', function(ev) {
    alert(ev.latlng); // ev is an event object (MouseEvent in this case)
});

Доступная информация зависит от типа события:

Событие

Базовый объект события. Все остальные объекты событий также содержат эти свойства.

Свойство	Тип	Описание
`type`	`String`	The event type (e.g. `'click'`).
`target`	`Object`	The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
`sourceTarget`	`Object`	The object that originally fired the event. For non-propagated events, this will be the same as the `target`.
`propagatedFrom`	`Object`	For propagated events, the last object that propagated the event to its event parent.
`layer`	`Object`	Deprecated. The same as `propagatedFrom`.

KeyboardEvent

Свойство	Тип	Описание
`originalEvent`	`DOMEvent`	The original DOM `KeyboardEvent` that triggered this Leaflet event.

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

Свойство	Тип	Описание
`type`	`String`	The event type (e.g. `'click'`).
`target`	`Object`	The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
`sourceTarget`	`Object`	The object that originally fired the event. For non-propagated events, this will be the same as the `target`.
`propagatedFrom`	`Object`	For propagated events, the last object that propagated the event to its event parent.
`layer`	`Object`	Deprecated. The same as `propagatedFrom`.

Элемент мыши (MouseEvent)

Свойство	Тип	Описание
`latlng`	`LatLng`	The geographical point where the mouse event occured.
`layerPoint`	`Point`	Pixel coordinates of the point where the mouse event occured relative to the map layer.
`containerPoint`	`Point`	Pixel coordinates of the point where the mouse event occured relative to the map сontainer.
`originalEvent`	`DOMEvent`	The original DOM `MouseEvent` or DOM `TouchEvent` that triggered this Leaflet event.

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

Свойство	Тип	Описание
`type`	`String`	The event type (e.g. `'click'`).
`target`	`Object`	The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
`sourceTarget`	`Object`	The object that originally fired the event. For non-propagated events, this will be the same as the `target`.
`propagatedFrom`	`Object`	For propagated events, the last object that propagated the event to its event parent.
`layer`	`Object`	Deprecated. The same as `propagatedFrom`.

Событие местоположения (LocationEvent)

Свойство	Тип	Описание
`latlng`	`LatLng`	Detected geographical location of the user.
`bounds`	`LatLngBounds`	Geographical bounds of the area user is located in (with respect to the accuracy of location).
`accuracy`	`Number`	Accuracy of location in meters.
`altitude`	`Number`	Height of the position above the WGS84 ellipsoid in meters.
`altitudeAccuracy`	`Number`	Accuracy of altitude in meters.
`heading`	`Number`	The direction of travel in degrees counting clockwise from true North.
`speed`	`Number`	Current velocity in meters per second.
`timestamp`	`Number`	The time when the position was acquired.

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

Свойство	Тип	Описание
`type`	`String`	The event type (e.g. `'click'`).
`target`	`Object`	The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
`sourceTarget`	`Object`	The object that originally fired the event. For non-propagated events, this will be the same as the `target`.
`propagatedFrom`	`Object`	For propagated events, the last object that propagated the event to its event parent.
`layer`	`Object`	Deprecated. The same as `propagatedFrom`.

Событие ошибки (ErrorEvent)

Свойство	Тип	Описание
`message`	`String`	Error message.
`code`	`Number`	Error code (if applicable).

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

Свойство	Тип	Описание
`type`	`String`	The event type (e.g. `'click'`).
`target`	`Object`	The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
`sourceTarget`	`Object`	The object that originally fired the event. For non-propagated events, this will be the same as the `target`.
`propagatedFrom`	`Object`	For propagated events, the last object that propagated the event to its event parent.
`layer`	`Object`	Deprecated. The same as `propagatedFrom`.

Событие слоя (LayerEvent)

Свойство	Тип	Описание
`layer`	`Layer`	The layer that was added or removed.

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

Свойство	Тип	Описание
`type`	`String`	The event type (e.g. `'click'`).
`target`	`Object`	The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
`sourceTarget`	`Object`	The object that originally fired the event. For non-propagated events, this will be the same as the `target`.
`propagatedFrom`	`Object`	For propagated events, the last object that propagated the event to its event parent.

Событие управления слоями (LayersControlEvent)

Свойство	Тип	Описание
`layer`	`Layer`	The layer that was added or removed.
`name`	`String`	The name of the layer that was added or removed.

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

Свойство	Тип	Описание
`type`	`String`	The event type (e.g. `'click'`).
`target`	`Object`	The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
`sourceTarget`	`Object`	The object that originally fired the event. For non-propagated events, this will be the same as the `target`.
`propagatedFrom`	`Object`	For propagated events, the last object that propagated the event to its event parent.

Событие плитки (TileEvent)

Свойство	Тип	Описание
`tile`	`HTMLElement`	The tile element (image).
`coords`	`Point`	Point object with the tile's `x`, `y`, and `z` (zoom level) coordinates.

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

Свойство	Тип	Описание
`type`	`String`	The event type (e.g. `'click'`).
`target`	`Object`	The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
`sourceTarget`	`Object`	The object that originally fired the event. For non-propagated events, this will be the same as the `target`.
`propagatedFrom`	`Object`	For propagated events, the last object that propagated the event to its event parent.
`layer`	`Object`	Deprecated. The same as `propagatedFrom`.

Событие ошибки плитки (TileErrorEvent)

Свойство	Тип	Описание
`tile`	`HTMLElement`	The tile element (image).
`coords`	`Point`	Point object with the tile's `x`, `y`, and `z` (zoom level) coordinates.
`error`	`*`	Error passed to the tile's `done()` callback.

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

Свойство	Тип	Описание
`type`	`String`	The event type (e.g. `'click'`).
`target`	`Object`	The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
`sourceTarget`	`Object`	The object that originally fired the event. For non-propagated events, this will be the same as the `target`.
`propagatedFrom`	`Object`	For propagated events, the last object that propagated the event to its event parent.
`layer`	`Object`	Deprecated. The same as `propagatedFrom`.

Событие изменения размера (ResizeEvent)

Свойство	Тип	Описание
`oldSize`	`Point`	The old size before resize event.
`newSize`	`Point`	The new size after the resize event.

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

Свойство	Тип	Описание
`type`	`String`	The event type (e.g. `'click'`).
`target`	`Object`	The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
`sourceTarget`	`Object`	The object that originally fired the event. For non-propagated events, this will be the same as the `target`.
`propagatedFrom`	`Object`	For propagated events, the last object that propagated the event to its event parent.
`layer`	`Object`	Deprecated. The same as `propagatedFrom`.

Событие GeoJSON (GeoJSONEvent)

Свойство	Тип	Описание
`layer`	`Layer`	The layer for the GeoJSON feature that is being added to the map.
`properties`	`Object`	GeoJSON properties of the feature.
`geometryType`	`String`	GeoJSON geometry type of the feature.
`id`	`String`	GeoJSON ID of the feature (if present).

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

Свойство	Тип	Описание
`type`	`String`	The event type (e.g. `'click'`).
`target`	`Object`	The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
`sourceTarget`	`Object`	The object that originally fired the event. For non-propagated events, this will be the same as the `target`.
`propagatedFrom`	`Object`	For propagated events, the last object that propagated the event to its event parent.

Событие всплывающей подсказки (PopupEvent)

Свойство	Тип	Описание
`popup`	`Popup`	The popup that was opened or closed.

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

Свойство	Тип	Описание
`type`	`String`	The event type (e.g. `'click'`).
`target`	`Object`	The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
`sourceTarget`	`Object`	The object that originally fired the event. For non-propagated events, this will be the same as the `target`.
`propagatedFrom`	`Object`	For propagated events, the last object that propagated the event to its event parent.
`layer`	`Object`	Deprecated. The same as `propagatedFrom`.

Событие всплывающей подсказки (TooltipEvent)

Свойство	Тип	Описание
`tooltip`	`Tooltip`	The tooltip that was opened or closed.

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

Свойство	Тип	Описание
`type`	`String`	The event type (e.g. `'click'`).
`target`	`Object`	The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
`sourceTarget`	`Object`	The object that originally fired the event. For non-propagated events, this will be the same as the `target`.
`propagatedFrom`	`Object`	For propagated events, the last object that propagated the event to its event parent.
`layer`	`Object`	Deprecated. The same as `propagatedFrom`.

Событие окончания перетаскивания (DragEndEvent)

Свойство	Тип	Описание
`distance`	`Number`	The distance in pixels the draggable element was moved by.

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

Свойство	Тип	Описание
`type`	`String`	The event type (e.g. `'click'`).
`target`	`Object`	The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
`sourceTarget`	`Object`	The object that originally fired the event. For non-propagated events, this will be the same as the `target`.
`propagatedFrom`	`Object`	For propagated events, the last object that propagated the event to its event parent.
`layer`	`Object`	Deprecated. The same as `propagatedFrom`.

Событие анимации масштабирования (ZoomAnimEvent)

Свойство	Тип	Описание
`center`	`LatLng`	The current center of the map
`zoom`	`Number`	The current zoom level of the map
`noUpdate`	`Boolean`	Whether layers should update their contents due to this event

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

Свойство	Тип	Описание
`type`	`String`	The event type (e.g. `'click'`).
`target`	`Object`	The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
`sourceTarget`	`Object`	The object that originally fired the event. For non-propagated events, this will be the same as the `target`.
`propagatedFrom`	`Object`	For propagated events, the last object that propagated the event to its event parent.
`layer`	`Object`	Deprecated. The same as `propagatedFrom`.

DivOverlay

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

Параметры (Options)

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

Наследованные опции от Слой

Опция	Тип	По умолчанию	Описание
`attribution`	`String`	`null`	Строка, отображаемая в элементе атрибуции, описывающая данные слоя, например, "© Mapbox".

События

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

Событие	Данные	Описание
`add`	`Event`	Fired after the layer is added to a map
`remove`	`Event`	Fired after the layer is removed from a map

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

Событие	Данные	Описание
`popupopen`	`PopupEvent`	Fired when a popup bound to this layer is opened
`popupclose`	`PopupEvent`	Fired when a popup bound to this layer is closed

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

Событие	Данные	Описание
`tooltipopen`	`TooltipEvent`	Fired when a tooltip bound to this layer is opened.
`tooltipclose`	`TooltipEvent`	Fired when a tooltip bound to this layer is closed.

Методы

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

Метод	Возвращает	Описание
`addTo(<Map\|LayerGroup> map)`	`this`	Добавляет слой в указанную карту или группу слоев.
`remove()`	`this`	Удаляет слой с карты, на которой он в данный момент активен.
`removeFrom(<Map> map)`	`this`	Удаляет слой с указанной карты.
`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–2018 Vladimir Agafonkin
© 2010–2011, CloudMade
Maps © OpenStreetMap contributors.
https://leafletjs.com/reference-1.3.4.html

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

Карта

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

Создание

Параметры

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

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

Параметры инерционного перемещения

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

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

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

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

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

События

События слоёв

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

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

События подсказок

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

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

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

Методы

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

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

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

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

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

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

Свойства

Управление

Обработчики

Плани Map

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

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

Опции панорамирования

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

Опции FitBounds

Маркер

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

Создание

Опции

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

События

События перетаскивания

Методы

Свойства

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

Попап

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

Создание

Параметры

События

Методы

Подсказка

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

Создание

Параметры

События

Методы

TileLayer

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

Шаблон URL

Создание

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

Параметры

События

Методы

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

TileLayer.WMS

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

Создание

Настройки

События

Методы

ImageOverlay

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

Создание

Параметры

События

Методы