Ссылка на API Leaflet

Карта

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

Опции

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

Опции управления

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

Опции взаимодействия

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

Опции состояния карты

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

Опции анимации

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

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

Опция	Тип	Значение по умолчанию	Описание
`inertia`	`Boolean`	`*`	Если включено, панорамирование карты будет иметь эффект инерции, при котором карта набирает импульс во время перетаскивания и продолжает двигаться в том же направлении в течение некоторого времени. Особенно приятно на сенсорных устройствах. Включено по умолчанию, если не работает на старых устройствах Android.
`inertiaDeceleration`	`Number`	`3000`	Скорость, с которой замедляется инерционное движение, в пикселях/секунд².
`inertiaMaxSpeed`	`Number`	`Infinity`	Максимальная скорость инерционного движения, в пикселях/секунду.
`easeLinearity`	`Number`	`0.2`
`worldCopyJump`	`Boolean`	`false`	С включенной этой опцией карта отслеживает, когда вы панорамируете на другую «копию» мира, и плавно переходит к оригинальной, так что все наложения, такие как маркеры и векторные слои, остаются видимыми.
`maxBoundsViscosity`	`Number`	`0.0`	Если установлен `maxBounds`, эта опция будет управлять тем, насколько жесткими являются границы при перетаскивании карты. Значение по умолчанию `0.0` позволяет пользователю перетаскивать за пределы границ на нормальной скорости, более высокие значения будут замедлять перетаскивание карты за пределы границ, а `1.0` делает границы полностью жесткими, не позволяя пользователю перетаскивать за пределы границ.

Опция	Тип	Значение по умолчанию	Описание
`keyboard`	`Boolean`	`true`	Делает карту фокусируемой и позволяет пользователям перемещаться по карте с помощью стрелок клавиатуры и клавиш `+`/`-`.
`keyboardPanDelta`	`Number`	`80`	Количество пикселей для панорамирования при нажатии клавиши со стрелкой.

Опции прокрутки колесом мыши

Опция	Тип	Значение по умолчанию	Описание
`scrollWheelZoom`	`Boolean\|String`	`true`	Можно ли масштабировать карту с помощью колесика мыши. Если передано значение `'center'`, масштабирование будет производиться до центра вида независимо от того, где находилась мышь.
`wheelDebounceTime`	`Number`	`40`	Ограничивает скорость, с которой может срабатывать колесо (в миллисекундах). По умолчанию пользователь не может масштабировать с помощью колесика чаще, чем один раз в 40 мс.
`wheelPxPerZoomLevel`	`Number`	`60`	Сколько пикселей прокрутки (как сообщается L.DomEvent.getWheelDelta) означают изменение одного полного уровня масштабирования. Меньшие значения сделают масштабирование колесом быстрее (и наоборот).

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

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

События

События слоя

Event	Data	Description
`baselayerchange`	`LayersControlEvent`	Срабатывает, когда базовый слой изменяется через управление слоями.
`overlayadd`	`LayersControlEvent`	Срабатывает, когда оверлей выбирается через управление слоями.
`overlayremove`	`LayersControlEvent`	Срабатывает, когда оверлей отключается через управление слоями.
`layeradd`	`LayerEvent`	Срабатывает, когда новый слой добавляется на карту.
`layerremove`	`LayerEvent`	Срабатывает, когда слой удаляется с карты.

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

Event	Data	Description
`zoomlevelschange`	`Event`	Срабатывает, когда количество уровней масштабирования на карте изменяется из-за добавления или удаления слоя.
`resize`	`ResizeEvent`	Срабатывает, когда карта изменяет размер.
`unload`	`Event`	Срабатывает, когда карта уничтожается с помощью метода remove.
`viewreset`	`Event`	Срабатывает, когда карте необходимо перерисовать своё содержимое (обычно это происходит при масштабировании или загрузке карты). Очень полезно для создания пользовательских оверлеев.
`load`	`Event`	Срабатывает, когда карта инициализируется (когда её центр и масштаб устанавливаются в первый раз).
`zoomstart`	`Event`	Срабатывает, когда масштаб карты вот-вот изменится (например, перед анимацией масштабирования).
`movestart`	`Event`	Срабатывает, когда вид карты начинает изменяться (например, пользователь начинает перетаскивать карту).
`zoom`	`Event`	Срабатывает многократно во время любого изменения уровня масштабирования, включая анимации масштабирования и полёта.
`move`	`Event`	Срабатывает многократно во время любого перемещения карты, включая анимации панорамирования и полёта.
`zoomend`	`Event`	Срабатывает, когда карта изменилась, после любых анимаций.
`moveend`	`Event`	Срабатывает, когда центр карты перестаёт изменяться (например, пользователь перестал перетаскивать карту).

Event	Data	Description
`popupopen`	`PopupEvent`	Срабатывает, когда всплывающее окно открывается на карте.
`popupclose`	`PopupEvent`	Срабатывает, когда всплывающее окно на карте закрывается.
`autopanstart`	`Event`	Срабатывает, когда карта начинает автоматическое панорамирование при открытии всплывающего окна.

Event	Data	Description
`tooltipopen`	`TooltipEvent`	Срабатывает, когда подсказка открывается на карте.
`tooltipclose`	`TooltipEvent`	Срабатывает, когда подсказка на карте закрывается.

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

Event	Data	Description
`locationerror`	`ErrorEvent`	Срабатывает, когда определение местоположения (с помощью метода `locate`) завершилось неудачей.
`locationfound`	`LocationEvent`	Срабатывает, когда определение местоположения (с помощью метода `locate`) прошло успешно.

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

Event	Data	Description
`click`	`MouseEvent`	Срабатывает, когда пользователь кликает (или касается) карту.
`dblclick`	`MouseEvent`	Срабатывает, когда пользователь дважды кликает (или дважды касается) карту.
`mousedown`	`MouseEvent`	Срабатывает, когда пользователь нажимает кнопку мыши на карте.
`mouseup`	`MouseEvent`	Срабатывает, когда пользователь отпускает кнопку мыши на карте.
`mouseover`	`MouseEvent`	Срабатывает, когда курсор мыши заходит на карту.
`mouseout`	`MouseEvent`	Срабатывает, когда курсор мыши выходит с карты.
`mousemove`	`MouseEvent`	Срабатывает, когда курсор мыши движется по карте.
`contextmenu`	`MouseEvent`	Срабатывает, когда пользователь нажимает правую кнопку мыши на карте, предотвращает отображение контекстного меню браузера по умолчанию, если есть обработчики для этого события. Также срабатывает на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется долгим нажатием).
`keypress`	`KeyboardEvent`	Срабатывает, когда пользователь нажимает клавишу на клавиатуре, которая создаёт символьное значение, пока карта находится в фокусе.
`keydown`	`KeyboardEvent`	Срабатывает, когда пользователь нажимает клавишу на клавиатуре, пока карта находится в фокусе. В отличие от события `keypress`, событие `keydown` срабатывает для клавиш, которые создают символьное значение, и для клавиш, которые не создают символьное значение.
`keyup`	`KeyboardEvent`	Срабатывает, когда пользователь отпускает клавишу на клавиатуре, пока карта находится в фокусе.
`preclick`	`MouseEvent`	Срабатывает перед щелчком мыши на карте (иногда полезно, когда вы хотите, чтобы что-то произошло при щелчке, прежде чем начнут работать существующие обработчики щелчков).

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

Event	Data	Description
`zoomanim`	`ZoomAnimEvent`	Срабатывает как минимум один раз для каждой анимации масштабирования. Для непрерывного масштабирования, например, масштабирования с помощью жеста «щипок», срабатывает один раз за кадр во время масштабирования.

Методы

Method	Returns	Description
`getRenderer(<Path> layer)`	`Renderer`	Возвращает экземпляр `Renderer`, который должен использоваться для отрисовки данного `Path`. Он гарантирует, что параметры `renderer` карты и путей будут соблюдены, и что средства отрисовки существуют на карте.

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

Method	Returns	Description
`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`	Перемещает карту к ближайшему виду, который будет находиться внутри заданных границ (если он еще не находится там), управляя анимацией с помощью указанных параметров, если таковые имеются.
`panInside(<LatLng> latlng, <options> options?)`	`this`	Перемещает карту на минимальное расстояние, чтобы сделать видимым `latlng`. Используйте параметры `padding`, `paddingTopLeft` и `paddingTopRight`, чтобы подогнать отображение к более ограниченным границам, как `fitBounds`. Если `latlng` уже находится внутри (опционально дополненных) границ отображения, карта перемещаться не будет.
`invalidateSize(<Zoom/pan options> options)`	`this`	Проверяет, изменился ли размер контейнера карты, и обновляет карту, если это так — вызовите его после того, как вы динамически изменили размер карты, также анимируя панорамирование по умолчанию. Если `options.pan` равно `false`, панорамирование происходить не будет. Если `options.debounceMoveend` равно `true`, это отложит событие `moveend`, чтобы оно не происходило часто, даже если метод вызывается много раз подряд.
`invalidateSize(<Boolean> animate)`	`this`	Проверяет, изменился ли размер контейнера карты, и обновляет карту, если это так — вызовите его после того, как вы динамически изменили размер карты, также анимируя панорамирование по умолчанию.
`stop()`	`this`	Останавливает текущую анимацию `panTo` или `flyTo`, если таковая имеется.

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

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

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

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

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

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

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

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

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

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

Свойства

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

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

Обработчики

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

Области карты

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

Панель	Тип	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, заданный географической точкой и необязательно объектом параметров.

Параметры

Option	Type	Default	Description
`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-index, используемое для функции `riseOnHover`.
`pane`	`String`	`'markerPane'`	`Map pane` куда будет добавлен значок маркеров. `Map pane` куда будет добавлена тень маркеров.
`bubblingMouseEvents`	`Boolean`	`false`	Когда `true`, событие мыши на этом маркере вызовет то же событие на карте (если не используется `L.DomEvent.stopPropagation`).

Параметры перемещаемого маркера

Option	Type	Default	Description
`draggable`	`Boolean`	`false`	Можно ли перетаскивать маркер мышью/сенсорным вводом или нет.
`autoPan`	`Boolean`	`false`	Перемещать ли карту при перетаскивании этого маркера около его края или нет.
`autoPanPadding`	`Point`	`Point(50, 50)`	Расстояние (в пикселях слева/справа и сверху/снизу) от края карты до начала перемещения карты.
`autoPanSpeed`	`Number`	`10`	Количество пикселей, на которое должна перемещаться карта.

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

Option	Type	Default	Description
`interactive`	`Boolean`	`true`	Если `false`, слой не будет генерировать события мыши и будет выступать как часть базовой карты.

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

Option	Type	Default	Description
`attribution`	`String`	`null`	Строка, которая будет показана в элементе управления атрибуцией, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридическим обязательством по отношению к правообладателям и поставщикам тайлов.

События

Event	Data	Description
`move`	`Event`	Генерируется, когда маркер перемещается с помощью `setLatLng` или путем перетаскивания. Старые и новые координаты включены в аргументы события как `oldLatLng`, `latlng`.

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

Event	Data	Description
`dragstart`	`Event`	Генерируется, когда пользователь начинает перетаскивать маркер.
`movestart`	`Event`	Генерируется, когда маркер начинает движение (из-за перетаскивания).
`drag`	`Event`	Генерируется многократно, пока пользователь перетаскивает маркер.
`dragend`	`DragEndEvent`	Генерируется, когда пользователь прекращает перетаскивать маркер.
`moveend`	`Event`	Генерируется, когда маркер прекращает движение (из-за перетаскивания).

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

Event	Data	Description
`click`	`MouseEvent`	Генерируется, когда пользователь щелкает (или касательно нажимает) слой.
`dblclick`	`MouseEvent`	Генерируется, когда пользователь дважды щелкает (или дважды касательно нажимает) слой.
`mousedown`	`MouseEvent`	Генерируется, когда пользователь нажимает кнопку мыши на слое.
`mouseup`	`MouseEvent`	Генерируется, когда пользователь отпускает кнопку мыши, нажатую на слое.
`mouseover`	`MouseEvent`	Генерируется, когда курсор мыши входит в слой.
`mouseout`	`MouseEvent`	Генерируется, когда курсор мыши выходит из слоя.
`contextmenu`	`MouseEvent`	Генерируется, когда пользователь щелкает правой кнопкой мыши на слое, предотвращает отображение контекстного меню браузера по умолчанию, если есть слушатели этого события. Также генерируется на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется долгим нажатием).

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

Event	Data	Description
`add`	`Event`	Генерируется после добавления слоя на карту
`remove`	`Event`	Генерируется после удаления слоя с карты

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

Event	Data	Description
`popupopen`	`PopupEvent`	Генерируется, когда открывается всплывающее окно, привязанное к этому слою
`popupclose`	`PopupEvent`	Генерируется, когда закрывается всплывающее окно, привязанное к этому слою

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

Event	Data	Description
`tooltipopen`	`TooltipEvent`	Генерируется, когда открывается подсказка, привязанная к этому слою.
`tooltipclose`	`TooltipEvent`	Генерируется, когда закрывается подсказка, привязанная к этому слою.

Методы

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

Method	Returns	Description
`getLatLng()`	`LatLng`	Возвращает текущее географическое положение маркера.
`setLatLng(<LatLng> latlng)`	`this`	Изменяет положение маркера на заданную точку.
`setZIndexOffset(<Number> offset)`	`this`	Изменяет смещение zIndex маркера.
`getIcon()`	`Icon`	Возвращает текущий значок, используемый маркером
`setIcon(<Icon> icon)`	`this`	Изменяет значок маркера.
`setOpacity(<Number> opacity)`	`this`	Изменяет непрозрачность маркера.

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

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

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

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

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

Свойства

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

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

marker.dragging.disable();

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

Используется для открытия всплывающих окон в определённых местах карты. Используйте Map.openPopup для открытия всплывающих окон, гарантируя, что одновременно открыто только одно всплывающее окно (рекомендуется для удобства использования), или используйте Map.addLayer для открытия всех, которые вы хотите.

Если вы хотите просто привязать всплывающее окно к клику маркера, а затем открыть его, это очень просто:

marker.bindPopup(popupContent).openPopup();

Наложение путей, такие как полилинии, также имеют метод bindPopup. Вот более сложный способ открыть всплывающее окно на карте:

var popup = L.popup()
    .setLatLng(latlng)
    .setContent('<p>Hello world!<br />This is a nice popup.</p>')
    .openOn(map);

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

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

Опция	Тип	Значение по умолчанию	Описание
`maxWidth`	`Number`	`300`	Максимальная ширина всплывающего окна в пикселях.
`minWidth`	`Number`	`50`	Минимальная ширина всплывающего окна в пикселях.
`maxHeight`	`Number`	`null`	Если установлено, создает прокручиваемый контейнер заданной высоты внутри всплывающего окна, если его содержимое превышает эту высоту.
`autoPan`	`Boolean`	`true`	Установите в `false`, если вы не хотите, чтобы карта выполняла анимацию панорамирования для соответствия открытому всплывающему окну.
`autoPanPaddingTopLeft`	`Point`	`null`	Поле между всплывающим окном и левым верхним углом представления карты после выполнения автопанорамирования.
`autoPanPaddingBottomRight`	`Point`	`null`	Поле между всплывающим окном и правым нижним углом представления карты после выполнения автопанорамирования.
`autoPanPadding`	`Point`	`Point(5, 5)`	Эквивалентно установке одинакового значения поля автопанорамирования для левого верхнего и правого нижнего углов.
`keepInView`	`Boolean`	`false`	Установите в `true`, если вы хотите запретить пользователям панорамировать всплывающее окно за пределы экрана, пока оно открыто.
`closeButton`	`Boolean`	`true`	Управляет наличием кнопки закрытия во всплывающем окне.
`autoClose`	`Boolean`	`true`	Установите в `false`, если вы хотите переопределить поведение по умолчанию закрытия всплывающего окна при открытии другого всплывающего окна.
`closeOnEscapeKey`	`Boolean`	`true`	Установите в `false`, если вы хотите переопределить поведение по умолчанию клавиши ESC для закрытия всплывающего окна.
`closeOnClick`	`Boolean`	`*`	Установите, если вы хотите переопределить поведение по умолчанию закрытия всплывающего окна при нажатии пользователем на карту. По умолчанию используется параметр карты `closePopupOnClick`.
`className`	`String`	`''`	Настраиваемое имя класса CSS для присвоения всплывающему окну.

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

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

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

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

События

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

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

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

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

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

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

Метод	Возвращает	Описание
`getLatLng()`	`LatLng`	Возвращает географическую точку всплывающего окна.
`setLatLng(<LatLng> latlng)`	`this`	Устанавливает географическую точку, где будет открываться всплывающее окно.
`getContent()`	`String\|HTMLElement`	Возвращает содержимое всплывающего окна.
`setContent(<String\|HTMLElement\|Function> htmlContent)`	`this`	Устанавливает HTML-содержимое всплывающего окна. Если передана функция, то исходный слой будет передан в функцию. Функция должна возвращать `String` или `HTMLElement`, которые будут использоваться во всплывающем окне.
`getElement()`	`String\|HTMLElement`	Псевдоним для 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` и настраивает необходимые обработчики событий. Если передан `Function`, он получит слой в качестве первого аргумента и должен возвращать `String` или `HTMLElement`.
`unbindPopup()`	`this`	Удаляет всплывающее окно, ранее привязанное с помощью `bindPopup`.
`openPopup(<LatLng> latlng?)`	`this`	Открывает привязанное всплывающее окно в указанном `latlng` или в якоре всплывающего окна по умолчанию, если `latlng` не передан.
`closePopup()`	`this`	Закрывает всплывающее окно, привязанное к этому слою, если оно открыто.
`togglePopup()`	`this`	Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния.
`isPopupOpen()`	`boolean`	Возвращает `true`, если всплывающее окно, привязанное к этому слою, открыто.
`setPopupContent(<String\|HTMLElement\|Popup> content)`	`this`	Устанавливает содержимое всплывающего окна, привязанного к этому слою.
`getPopup()`	`Popup`	Возвращает всплывающее окно, привязанное к этому слою.

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

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

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

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

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

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

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

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

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

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 для присвоения всплывающему окну.

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

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

События

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

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

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

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

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

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

Методы

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

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

END_OF_DOCUMENT_MARKER Методы всплывающих окон, унаследованные от 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

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

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

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

Шаблон URL

Строка следующего вида:

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

{s} означает один из доступных поддоменов (используется последовательно, чтобы помочь с параллельными запросами браузера из-за ограничения на количество доменов; значения поддоменов указаны в параметрах; a, b или c по умолчанию, могут быть опущены), {z} — уровень масштабирования, {x} и {y} — координаты плиток. {r} можно использовать для добавления "&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

Option	Type	Default	Description
`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`	При панорамировании карты сохраняйте столько строк и столбцов плиток, прежде чем выгружать их.

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

Option	Type	Default	Description
`attribution`	`String`	`null`	Строка, которая будет показана в элементе управления атрибуцией, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридическим обязательством перед правообладателями и поставщиками плиток.

События

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

Event	Data	Description
`loading`	`Event`	Генерируется, когда слой сетки начинает загружать плитки.
`tileunload`	`TileEvent`	Генерируется, когда плитка удаляется (например, когда плитка выходит за пределы экрана).
`tileloadstart`	`TileEvent`	Генерируется, когда плитка запрашивается и начинает загружаться.
`tileerror`	`TileErrorEvent`	Генерируется, когда возникает ошибка при загрузке плитки.
`tileload`	`TileEvent`	Генерируется, когда плитка загружается.
`load`	`Event`	Генерируется, когда слой сетки загрузил все видимые плитки.

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

Event	Data	Description
`add`	`Event`	Генерируется после добавления слоя на карту
`remove`	`Event`	Генерируется после удаления слоя с карты

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

Event	Data	Description
`popupopen`	`PopupEvent`	Генерируется, когда всплывающее окно, привязанное к этому слою, открывается
`popupclose`	`PopupEvent`	Генерируется, когда всплывающее окно, привязанное к этому слою, закрывается

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

Event	Data	Description
`tooltipopen`	`TooltipEvent`	Генерируется, когда подсказка, привязанная к этому слою, открывается.
`tooltipclose`	`TooltipEvent`	Генерируется, когда подсказка, привязанная к этому слою, закрывается.

Методы

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

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

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

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

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

Method	Returns	Description
`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

Method	Returns	Description
`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, по умолчанию используется CRS карты. Не изменяйте это, если вы не уверены, что это значит.
`uppercase`	`Boolean`	`false`	Если `true`, ключи параметров запроса WMS будут в верхнем регистре.

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

Option	Type	Default	Description
`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 Settings для получения допустимых значений строк.

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

Option	Type	Default	Description
`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`	При панорамировании карты сохраняйте столько строк и столбцов плиток, прежде чем выгружать их.

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

Option	Type	Default	Description
`attribution`	`String`	`null`	Строка, которая будет показана в элементе управления атрибуцией, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридическим обязательством перед правообладателями и поставщиками плиток.

События

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

Event	Data	Description
`loading`	`Event`	Вызывается, когда слой сетки начинает загружать плитки.
`tileunload`	`TileEvent`	Вызывается, когда плитка удаляется (например, когда плитка выходит за пределы экрана).
`tileloadstart`	`TileEvent`	Вызывается, когда плитка запрашивается и начинает загружаться.
`tileerror`	`TileErrorEvent`	Вызывается, когда возникает ошибка при загрузке плитки.
`tileload`	`TileEvent`	Вызывается, когда плитка загружается.
`load`	`Event`	Вызывается, когда слой сетки загрузил все видимые плитки.

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

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

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

Event	Data	Description
`popupopen`	`PopupEvent`	Вызывается при открытии всплывающего окна, привязанного к этому слою
`popupclose`	`PopupEvent`	Вызывается при закрытии всплывающего окна, привязанного к этому слою

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

Event	Data	Description
`tooltipopen`	`TooltipEvent`	Вызывается при открытии подсказки, привязанной к этому слою.
`tooltipclose`	`TooltipEvent`	Вызывается при закрытии подсказки, привязанной к этому слою.

Методы

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

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

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

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

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

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

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

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 изображения и географические границы, к которым он привязан.

Параметры

Option	Type	Default	Description
`opacity`	`Number`	`1.0`	Прозрачность наложения изображения.
`alt`	`String`	`''`	Текст для атрибута `alt` изображения (полезно для доступности).
`interactive`	`Boolean`	`false`	Если `true`, наложение изображения будет генерировать события мыши mouse events при щелчке или наведении курсора.
`crossOrigin`	`Boolean\|String`	`false`	Будет ли атрибут crossOrigin добавлен к изображению. Если указана строка, у изображения будет установлен атрибут crossOrigin со значением указанной строки. Это необходимо, если вы хотите получить доступ к пиксельным данным изображения. Обратитесь к CORS Settings для допустимых значений строк.
`errorOverlayUrl`	`String`	`''`	URL изображения-наложения, которое будет показано вместо наложения, загрузка которого не удалась.
`zIndex`	`Number`	`1`	Явное значение zIndex слоя наложения.
`className`	`String`	`''`	Пользовательское имя класса для присваивания изображению. По умолчанию пустое.

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

Option	Type	Default	Description
`bubblingMouseEvents`	`Boolean`	`true`	Когда `true`, событие мыши на этом слое вызовет то же событие на карте (если не используется `L.DomEvent.stopPropagation`).

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

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

События

Event	Data	Description
`load`	`Event`	Генерируется, когда слой ImageOverlay загрузил свое изображение
`error`	`Event`	Генерируется, когда слой ImageOverlay не может загрузить свое изображение

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

Event	Data	Description
`click`	`MouseEvent`	Генерируется, когда пользователь щелкает (или касаеется) слой.
`dblclick`	`MouseEvent`	Генерируется, когда пользователь дважды щелкает (или дважды касается) слой.
`mousedown`	`MouseEvent`	Генерируется, когда пользователь нажимает кнопку мыши на слое.
`mouseup`	`MouseEvent`	Генерируется, когда пользователь отпускает кнопку мыши, нажатую на слое.
`mouseover`	`MouseEvent`	Генерируется, когда мышь входит в слой.
`mouseout`	`MouseEvent`	Генерируется, когда мышь выходит из слоя.
`contextmenu`	`MouseEvent`	Генерируется, когда пользователь щелкает правой кнопкой мыши по слою, предотвращает отображение контекстного меню браузера по умолчанию, если для этого события есть обработчики. Также генерируется на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется долгим нажатием).

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

Event	Data	Description
`add`	`Event`	Генерируется после добавления слоя на карту
`remove`	`Event`	Генерируется после удаления слоя с карты

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

Event	Data	Description
`popupopen`	`PopupEvent`	Генерируется, когда всплывающее окно, привязанное к этому слою, открывается
`popupclose`	`PopupEvent`	Генерируется, когда всплывающее окно, привязанное к этому слою, закрывается

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

Event	Data	Description
`tooltipopen`	`TooltipEvent`	Генерируется, когда подсказка, привязанная к этому слою, открывается.
`tooltipclose`	`TooltipEvent`	Генерируется, когда подсказка, привязанная к этому слою, закрывается.

Методы

Method	Returns	Description
`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`, используемый этим наложением.

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

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

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

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

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

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

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

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

VideoOverlay

Используется для загрузки и отображения видеоплеера над определёнными границами карты. Расширяет ImageOverlay. Наложение видео использует элемент <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`	Будет ли видео циклически повторяться с начала при воспроизведении.
`keepAspectRatio`	`Boolean`	`true`	Сохраняет ли видео соотношение сторон после проекции. Актуально для поддерживаемых браузеров. Совместимость браузеров - https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit

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

Параметр	Тип	Значение по умолчанию	Описание
`opacity`	`Number`	`1.0`	Прозрачность наложения изображения.
`alt`	`String`	`''`	Текст для атрибута `alt` изображения (полезно для доступности).
`interactive`	`Boolean`	`false`	Если `true`, наложение изображения будет генерировать события мыши при нажатии или наведении курсора.
`crossOrigin`	`Boolean\|String`	`false`	Будет ли атрибут crossOrigin добавлен к изображению. Если указана строка, у изображения будет установлен атрибут crossOrigin со значением этой строки. Это необходимо, если вы хотите получить доступ к данным пикселей изображения. Обратитесь к Параметрам CORS для допустимых значений строк.
`errorOverlayUrl`	`String`	`''`	URL к изображению-наложению, которое будет показано вместо наложения, загрузка которого не удалась.
`zIndex`	`Number`	`1`	Явное значение zIndex слоя наложения.
`className`	`String`	`''`	Пользовательское имя класса для присваивания изображению. Пустое по умолчанию.

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

Параметр	Тип	Значение по умолчанию	Описание
`bubblingMouseEvents`	`Boolean`	`true`	Когда `true`, событие мыши на этом слое вызовет то же событие на карте (если не используется `L.DomEvent.stopPropagation`).

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

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

События

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

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

Событие	Данные	Описание
`error`	`Event`	Вызывается, когда слой ImageOverlay не может загрузить своё изображение

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

Событие	Данные	Описание
`click`	`MouseEvent`	Вызывается, когда пользователь щелкает (или касается) слой.
`dblclick`	`MouseEvent`	Вызывается, когда пользователь дважды щелкает (или дважды касается) слой.
`mousedown`	`MouseEvent`	Вызывается, когда пользователь нажимает кнопку мыши на слое.
`mouseup`	`MouseEvent`	Вызывается, когда пользователь отпускает кнопку мыши, нажатую на слое.
`mouseover`	`MouseEvent`	Вызывается, когда мышь входит в слой.
`mouseout`	`MouseEvent`	Вызывается, когда мышь покидает слой.
`contextmenu`	`MouseEvent`	Вызывается, когда пользователь щелкает правой кнопкой мыши на слое, предотвращает отображение контекстного меню браузера по умолчанию, если для этого события есть обработчики. Также вызывается на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется долгим нажатием).

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

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

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

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

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

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

Методы

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

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

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

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

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

SVGOverlay

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

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

var svgElement = document.createElementNS("http://www.w3.org/2000/svg", "svg");
svgElement.setAttribute('xmlns', "http://www.w3.org/2000/svg");
svgElement.setAttribute('viewBox', "0 0 200 200");
svgElement.innerHTML = '<rect width="200" height="200"/><rect x="75" y="23" width="50" height="50" style="fill:red"/><rect x="75" y="123" width="50" height="50" style="fill:#0013ff"/>';
var svgElementBounds = [ [ 32, -130 ], [ 13, -100 ] ];
L.svgOverlay(svgElement, svgElementBounds).addTo(map);

Создание

Фабрика	Описание
`L.svgOverlay(<String\|SVGElement> svg, <LatLngBounds> bounds, <SVGOverlay options> options?)`	Создаёт объект оверлея изображения, используя элемент SVG и географические границы, к которым он привязан. Для правильного масштабирования необходим атрибут viewBox в элементе SVG.

Параметры

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

Параметр	Тип	По умолчанию	Описание
`opacity`	`Number`	`1.0`	Прозрачность оверлея изображения.
`alt`	`String`	`''`	Текст для атрибута `alt` изображения (полезно для доступности).
`interactive`	`Boolean`	`false`	Если `true`, оверлей изображения будет генерировать события мыши при нажатии или наведении курсора.
`crossOrigin`	`Boolean\|String`	`false`	Будет ли добавлен атрибут crossOrigin к изображению. Если указана строка, у изображения будет установлен атрибут crossOrigin со значением указанной строки. Это необходимо, если вы хотите получить доступ к пиксельным данным изображения. Обратитесь к настройкам CORS для допустимых значений строк.
`errorOverlayUrl`	`String`	`''`	URL изображения оверлея, которое будет показано вместо оверлея, загрузка которого не удалась.
`zIndex`	`Number`	`1`	Явное значение zIndex слоя оверлея.
`className`	`String`	`''`	Пользовательское имя класса для назначения изображению. По умолчанию пустое.

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

Параметр	Тип	По умолчанию	Описание
`bubblingMouseEvents`	`Boolean`	`true`	Когда `true`, событие мыши на этом слое вызовет то же событие на карте (если не используется `L.DomEvent.stopPropagation`).

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

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

События

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

Событие	Данные	Описание
`load`	`Event`	Генерируется, когда слой ImageOverlay загрузил своё изображение
`error`	`Event`	Генерируется, когда слой ImageOverlay не смог загрузить своё изображение

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

Событие	Данные	Описание
`click`	`MouseEvent`	Генерируется, когда пользователь нажимает (или касается) слой.
`dblclick`	`MouseEvent`	Генерируется, когда пользователь дважды нажимает (или дважды касается) слой.
`mousedown`	`MouseEvent`	Генерируется, когда пользователь нажимает кнопку мыши на слое.
`mouseup`	`MouseEvent`	Генерируется, когда пользователь отпускает кнопку мыши, нажатую на слое.
`mouseover`	`MouseEvent`	Генерируется, когда мышь заходит на слой.
`mouseout`	`MouseEvent`	Генерируется, когда мышь покидает слой.
`contextmenu`	`MouseEvent`	Генерируется, когда пользователь кликает правой кнопкой мыши по слою, предотвращает отображение контекстного меню браузера по умолчанию, если есть обработчики этого события. Также генерируется на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется долгим нажатием).

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

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

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

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

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

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

Методы

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

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

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

Методы, унаследованные от 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(…)`

Path

Абстрактный класс, содержащий параметры и константы, общие для векторных оверлеев (Polygon, Polyline, Circle). Не используйте его напрямую. Расширяет Layer.

Параметры

Option	Type	Default	Description
`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-рендерера.

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

Option	Type	Default	Description
`interactive`	`Boolean`	`true`	Если `false`, слой не будет генерировать события мыши и будет действовать как часть базовой карты.

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

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

События

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

Event	Data	Description
`click`	`MouseEvent`	Генерируется, когда пользователь щелкает (или касается) слой.
`dblclick`	`MouseEvent`	Генерируется, когда пользователь дважды щелкает (или дважды касается) слой.
`mousedown`	`MouseEvent`	Генерируется, когда пользователь нажимает кнопку мыши на слое.
`mouseup`	`MouseEvent`	Генерируется, когда пользователь отпускает кнопку мыши, нажатую на слое.
`mouseover`	`MouseEvent`	Генерируется, когда курсор мыши входит в слой.
`mouseout`	`MouseEvent`	Генерируется, когда курсор мыши выходит из слоя.
`contextmenu`	`MouseEvent`	Генерируется, когда пользователь щелкает правой кнопкой мыши на слое, предотвращает отображение контекстного меню браузера по умолчанию, если есть слушатели для этого события. Также генерируется на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется долгим нажатием).

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

Event	Data	Description
`add`	`Event`	Генерируется после добавления слоя на карту
`remove`	`Event`	Генерируется после удаления слоя с карты

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

Event	Data	Description
`popupopen`	`PopupEvent`	Генерируется, когда всплывающее окно, привязанное к этому слою, открывается
`popupclose`	`PopupEvent`	Генерируется, когда всплывающее окно, привязанное к этому слою, закрывается

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

Event	Data	Description
`tooltipopen`	`TooltipEvent`	Генерируется, когда подсказка, привязанная к этому слою, открывается.
`tooltipclose`	`TooltipEvent`	Генерируется, когда подсказка, привязанная к этому слою, закрывается.

Методы

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

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

Method	Returns	Description
`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(…)`

Polyline

Класс для рисования полилиний на карте. Расширяет Path.

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

// create a red polyline from an array of LatLng points
var latlngs = [
    [45.51, -122.68],
    [37.77, -122.43],
    [34.04, -118.2]
];
var polyline = L.polyline(latlngs, {color: 'red'}).addTo(map);
// zoom the map to the polyline
map.fitBounds(polyline.getBounds());

Вы также можете передать многомерный массив для представления фигуры MultiPolyline:

// create a red polyline from an array of arrays of LatLng points
var latlngs = [
    [[45.51, -122.68],
     [37.77, -122.43],
     [34.04, -118.2]],
    [[40.78, -73.91],
     [41.83, -87.62],
     [32.76, -96.72]]
];

Создание

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

L.polyline(<LatLng[]> latlngs, <Polyline options> options?) Создает объект полилинии, используя массив географических точек и, необязательно, объект параметров. Вы можете создать объект Polyline с несколькими отдельными линиями (MultiPolyline) передав массив массивов географических точек.

Параметры

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

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

Option	Type	Default	Description
`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-рендерера.

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

Option	Type	Default	Description
`interactive`	`Boolean`	`true`	Если `false`, слой не будет генерировать события мыши и будет действовать как часть базовой карты.

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

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

События

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

Event	Data	Description
`click`	`MouseEvent`	Генерируется, когда пользователь щелкает (или касается) слой.
`dblclick`	`MouseEvent`	Генерируется, когда пользователь дважды щелкает (или дважды касается) слой.
`mousedown`	`MouseEvent`	Генерируется, когда пользователь нажимает кнопку мыши на слое.
`mouseup`	`MouseEvent`	Генерируется, когда пользователь отпускает кнопку мыши, нажатую на слое.
`mouseover`	`MouseEvent`	Генерируется, когда курсор мыши входит в слой.
`mouseout`	`MouseEvent`	Генерируется, когда курсор мыши выходит из слоя.
`contextmenu`	`MouseEvent`	Генерируется, когда пользователь щелкает правой кнопкой мыши на слое, предотвращает отображение контекстного меню браузера по умолчанию, если для этого события есть обработчики. Также генерируется на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется долгим нажатием).

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

Event	Data	Description
`add`	`Event`	Генерируется после добавления слоя на карту
`remove`	`Event`	Генерируется после удаления слоя с карты

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

Event	Data	Description
`popupopen`	`PopupEvent`	Генерируется при открытии всплывающего окна, привязанного к этому слою
`popupclose`	`PopupEvent`	Генерируется при закрытии всплывающего окна, привязанного к этому слою

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

Event	Data	Description
`tooltipopen`	`TooltipEvent`	Генерируется при открытии подсказки, привязанной к этому слою.
`tooltipclose`	`TooltipEvent`	Генерируется при закрытии подсказки, привязанной к этому слою.

Методы

Method	Returns	Description
`toGeoJSON(<Number> precision?)`	`Object`	`precision` — это количество десятичных знаков для координат. Значение по умолчанию — 6 знаков. Возвращает `GeoJSON` представление полилинии (как GeoJSON `LineString` или `MultiLineString` Feature).
`getLatLngs()`	`LatLng[]`	Возвращает массив точек пути или вложенные массивы точек в случае мультиполилинии.
`setLatLngs(<LatLng[]> latlngs)`	`this`	Заменяет все точки в полилинии заданным массивом географических точек.
`isEmpty()`	`Boolean`	Возвращает `true`, если Polyline не имеет LatLngs.
`closestLayerPoint(<Point> p)`	`Point`	Возвращает точку, ближайшую к `p` на полилинии.
`getCenter()`	`LatLng`	Возвращает центр (центроид) полилинии.
`getBounds()`	`LatLngBounds`	Возвращает `LatLngBounds` пути.
`addLatLng(<LatLng> latlng)`	`this`	Добавляет заданную точку к полилинии. По умолчанию добавляет к первому кольцу полилинии в случае мультиполилинии, но это можно переопределить, передав конкретное кольцо в виде массива LatLng (к которому вы можете получить доступ ранее с помощью `getLatLngs`).

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

Method	Returns	Description
`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`, возвращает опцию атрибуции.

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

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

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

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

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

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

Polygon

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

Кроме того, можно передать многомерный массив для представления фигуры MultiPolygon.

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?)`

Опции

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

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

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

Опция	Тип	Значение по умолчанию	Описание
`stroke`	`Boolean`	`true`	Рисовать ли обводку вдоль пути. Установите значение `false` для отключения границ многоугольников или кругов.
`color`	`String`	`'#3388ff'`	Цвет обводки
`weight`	`Number`	`3`	Ширина обводки в пикселях
`opacity`	`Number`	`1.0`	Непрозрачность обводки
`lineCap`	`String`	`'round'`	Строка, определяющая форму, используемую в конце обводки.
`lineJoin`	`String`	`'round'`	Строка, определяющая форму, используемую в углах обводки.
`dashArray`	`String`	`null`	Строка, определяющая штриховой рисунок обводки. Не работает на слоях на основе `Canvas` в некоторых старых браузерах.
`dashOffset`	`String`	`null`	Строка, определяющая расстояние в штриховом рисунке, с которого начинается штрих. Не работает на слоях на основе `Canvas` в некоторых старых браузерах.
`fill`	`Boolean`	`depends`	Заливать ли путь цветом. Установите значение `false` для отключения заливки многоугольников или кругов.
`fillColor`	`String`	`*`	Цвет заливки. По умолчанию используется значение опции `color`
`fillOpacity`	`Number`	`0.2`	Непрозрачность заливки.
`fillRule`	`String`	`'evenodd'`	Строка, определяющая как определяется внутренняя часть фигуры.
`bubblingMouseEvents`	`Boolean`	`true`	Когда `true`, событие мыши на этом пути вызовет то же событие на карте (если не используется `L.DomEvent.stopPropagation`).
`renderer`	`Renderer`		Используйте этот конкретный экземпляр `Renderer` для этого пути. Имеет приоритет над рендерером по умолчанию карты.
`className`	`String`	`null`	Настраиваемое имя класса, устанавливаемое для элемента. Только для SVG-рендерера.

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

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

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

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

События

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

Событие	Данные	Описание
`click`	`MouseEvent`	Генерируется, когда пользователь щелкает (или касает) слой.
`dblclick`	`MouseEvent`	Генерируется, когда пользователь дважды щелкает (или дважды касается) слой.
`mousedown`	`MouseEvent`	Генерируется, когда пользователь нажимает кнопку мыши на слое.
`mouseup`	`MouseEvent`	Генерируется, когда пользователь отпускает кнопку мыши, нажатую на слое.
`mouseover`	`MouseEvent`	Генерируется, когда курсор мыши входит в слой.
`mouseout`	`MouseEvent`	Генерируется, когда курсор мыши выходит из слоя.
`contextmenu`	`MouseEvent`	Генерируется, когда пользователь щелкает правой кнопкой мыши по слою, предотвращает отображение контекстного меню браузера по умолчанию, если есть обработчики для этого события. Также генерируется на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется долгим нажатием).

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

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

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

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

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

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

Методы

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

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

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

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

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

Rectangle

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

Опции

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

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

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

Option	Type	Default	Description
`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-рендерера.

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

Option	Type	Default	Description
`interactive`	`Boolean`	`true`	Если `false`, слой не будет генерировать события мыши и будет действовать как часть базовой карты.

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

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

События

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

Event	Data	Description
`click`	`MouseEvent`	Генерируется, когда пользователь щелкает (или касается) слой.
`dblclick`	`MouseEvent`	Генерируется, когда пользователь дважды щелкает (или дважды касается) слой.
`mousedown`	`MouseEvent`	Генерируется, когда пользователь нажимает кнопку мыши на слое.
`mouseup`	`MouseEvent`	Генерируется, когда пользователь отпускает кнопку мыши, нажатую на слое.
`mouseover`	`MouseEvent`	Генерируется, когда курсор мыши входит в слой.
`mouseout`	`MouseEvent`	Генерируется, когда курсор мыши выходит из слоя.
`contextmenu`	`MouseEvent`	Генерируется, когда пользователь щелкает правой кнопкой мыши на слое, предотвращает отображение контекстного меню браузера по умолчанию, если есть обработчики этого события. Также генерируется на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется долгим нажатием).

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

Event	Data	Description
`add`	`Event`	Генерируется после добавления слоя на карту
`remove`	`Event`	Генерируется после удаления слоя с карты

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

Event	Data	Description
`popupopen`	`PopupEvent`	Генерируется при открытии всплывающего окна, привязанного к этому слою
`popupclose`	`PopupEvent`	Генерируется при закрытии всплывающего окна, привязанного к этому слою

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

Event	Data	Description
`tooltipopen`	`TooltipEvent`	Генерируется при открытии подсказки, привязанной к этому слою.
`tooltipclose`	`TooltipEvent`	Генерируется при закрытии подсказки, привязанной к этому слою.

Методы

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

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

Method	Returns	Description
`toGeoJSON(<Number> precision?)`	`Object`	`precision` - это количество десятичных знаков для координат. Значение по умолчанию - 6 знаков. Возвращает представление полигона в формате `GeoJSON` (как GeoJSON `Polygon` или `MultiPolygon` Feature).

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

Method	Returns	Description
`getLatLngs()`	`LatLng[]`	Возвращает массив точек в пути или вложенные массивы точек в случае многолинии.
`setLatLngs(<LatLng[]> latlngs)`	`this`	Заменяет все точки в полилинии заданным массивом географических точек.
`isEmpty()`	`Boolean`	Возвращает `true`, если полилиния не содержит LatLngs.
`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`	Перемещает слой на самый низ всех слоев пути.

Методы, унаследованные от 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(…)`

Круг

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

События

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

Событие	Данные	Описание
`move`	`Event`	Генерируется, когда маркер перемещается с помощью `setLatLng`. Старые и новые координаты включены в аргументы события как `oldLatLng`, `latlng`.

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

Событие	Данные	Описание
`click`	`MouseEvent`	Генерируется, когда пользователь щелкает (или касаются) слой.
`dblclick`	`MouseEvent`	Генерируется, когда пользователь дважды щелкает (или дважды касаются) слой.
`mousedown`	`MouseEvent`	Генерируется, когда пользователь нажимает кнопку мыши на слое.
`mouseup`	`MouseEvent`	Генерируется, когда пользователь отпускает кнопку мыши, нажатую на слое.
`mouseover`	`MouseEvent`	Генерируется, когда курсор мыши попадает на слой.
`mouseout`	`MouseEvent`	Генерируется, когда курсор мыши покидает слой.
`contextmenu`	`MouseEvent`	Генерируется, когда пользователь щелкает правой кнопкой мыши по слою, предотвращает отображение контекстного меню браузера по умолчанию, если для этого события есть обработчики. Также генерируется на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется долгим нажатием).

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

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

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

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

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

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

Методы

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

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

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

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

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

CircleMarker

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

Создание

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

Параметры

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

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

Опция	Тип	Значение по умолчанию	Описание
`stroke`	`Boolean`	`true`	Рисовать ли обводку вдоль пути. Установите в `false` чтобы отключить границы на полигонах или кругах.
`color`	`String`	`'#3388ff'`	Цвет обводки
`weight`	`Number`	`3`	Ширина обводки в пикселях
`opacity`	`Number`	`1.0`	Прозрачность обводки
`lineCap`	`String`	`'round'`	Строка, определяющая форму, используемую в конце обводки.
`lineJoin`	`String`	`'round'`	Строка, определяющая форму, используемую в углах обводки.
`dashArray`	`String`	`null`	Строка, определяющая штриховой рисунок обводки. Не работает на слоях, использующих `Canvas`, в некоторых старых браузерах.
`dashOffset`	`String`	`null`	Строка, определяющая расстояние в штриховом рисунке, с которого начинается штрих. Не работает на слоях, использующих `Canvas`, в некоторых старых браузерах.
`fill`	`Boolean`	`depends`	Заполнять ли путь цветом. Установите в `false` чтобы отключить заливку на полигонах или кругах.
`fillColor`	`String`	`*`	Цвет заливки. По умолчанию используется значение опции `color`
`fillOpacity`	`Number`	`0.2`	Прозрачность заливки.
`fillRule`	`String`	`'evenodd'`	Строка, определяющая как определяется внутренняя часть фигуры.
`bubblingMouseEvents`	`Boolean`	`true`	Когда `true`, событие мыши на этом пути вызовет то же событие на карте (если не используется `L.DomEvent.stopPropagation`).
`renderer`	`Renderer`		Используйте этот конкретный экземпляр `Renderer` для этого пути. Имеет приоритет над рендерером по умолчанию карты.
`className`	`String`	`null`	Настраиваемое имя класса, установленное для элемента. Только для SVG-рендерера.

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

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

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

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

События

Событие	Данные	Описание
`move`	`Event`	Генерируется, когда маркер перемещается с помощью `setLatLng`. Старые и новые координаты включены в аргументы события как `oldLatLng`, `latlng`.

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

Событие	Данные	Описание
`click`	`MouseEvent`	Генерируется, когда пользователь щелкает (или касается) слой.
`dblclick`	`MouseEvent`	Генерируется, когда пользователь дважды щелкает (или дважды касается) слой.
`mousedown`	`MouseEvent`	Генерируется, когда пользователь нажимает кнопку мыши на слое.
`mouseup`	`MouseEvent`	Генерируется, когда пользователь отпускает кнопку мыши, нажатую на слое.
`mouseover`	`MouseEvent`	Генерируется, когда курсор мыши заходит на слой.
`mouseout`	`MouseEvent`	Генерируется, когда курсор мыши выходит со слоя.
`contextmenu`	`MouseEvent`	Генерируется, когда пользователь щелкает правой кнопкой мыши по слою, предотвращает отображение контекстного меню браузера по умолчанию, если есть обработчики для этого события. Также генерируется на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется долгим нажатием).

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

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

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

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

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

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

Методы

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

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

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

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

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

SVG

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

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

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

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

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

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

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

Создание

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

Параметры

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

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

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

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

События

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

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

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

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

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

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

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

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

Методы

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

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

Функции

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

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

Параметры

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

Option	Type	Default	Description
`padding`	`Number`	`0.1`	На сколько расширить область выреза вокруг представления карты (относительно её размера), например, 0.1 будет 10% от представления карты в каждом направлении
`tolerance`	`Number`	`0`	На сколько расширить допуск клика вокруг пути/объекта на карте

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

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

События

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

Event	Data	Description
`update`	`Event`	Вызывается, когда средство визуализации обновляет свои границы, центр и масштаб, например, когда карта переместилась

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

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

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

Event	Data	Description
`popupopen`	`PopupEvent`	Вызывается, когда всплывающее окно, привязанное к этому слою, открывается
`popupclose`	`PopupEvent`	Вызывается, когда всплывающее окно, привязанное к этому слою, закрывается

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

Event	Data	Description
`tooltipopen`	`TooltipEvent`	Вызывается, когда подсказка, привязанная к этому слою, открывается.
`tooltipclose`	`TooltipEvent`	Вызывается, когда подсказка, привязанная к этому слою, закрывается.

Методы

Методы, унаследованные от 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`, возвращает параметр атрибуции.

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

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

Методы, унаследованные от 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(…)`

LayerGroup

END_OF_DOCUMENT_MARKER

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

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

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

Создание

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

Параметры

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

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

События

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

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

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

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

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

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

Методы

Метод	Возвращаемое значение	Описание
`toGeoJSON(<Number> precision?)`	`Object`	`precision` — это количество десятичных знаков для координат. Значение по умолчанию — 6 знаков. Возвращает представление группы слоёв в формате `GeoJSON` (как GeoJSON `FeatureCollection`, `GeometryCollection`, или `MultiPoint`).
`addLayer(<Layer> layer)`	`this`	Добавляет заданный слой в группу.
`removeLayer(<Layer> layer)`	`this`	Удаляет заданный слой из группы.
`removeLayer(<Number> id)`	`this`	Удаляет слой с заданным внутренним 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-index.
`getLayerId(<Layer> layer)`	`Number`	Возвращает внутренний ID слоя

Методы, унаследованные от 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(…)`

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

Опции

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

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

События

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

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

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

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

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

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

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

Методы

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

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

Метод	Возвращает	Описание
`toGeoJSON(<Number> precision?)`	`Object`	`precision` — это количество десятичных знаков для координат. Значение по умолчанию — 6 знаков. Возвращает представление группы слоев в формате `GeoJSON` (как GeoJSON `FeatureCollection`, `GeometryCollection`, или `MultiPoint`).
`addLayer(<Layer> layer)`	`this`	Добавляет заданный слой в группу.
`removeLayer(<Layer> layer)`	`this`	Удаляет заданный слой из группы.
`removeLayer(<Number> id)`	`this`	Удаляет слой с заданным внутренним 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-index.
`getLayerId(<Layer> layer)`	`Number`	Возвращает внутренний ID слоя

Методы, унаследованные от 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(…)`

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`	`*`	`Function` определяющий, как точки GeoJSON порождают слои Leaflet. Внутренне вызывается при добавлении данных, передавая объект GeoJSON point feature и его `LatLng`. По умолчанию порождается стандартный `Marker`: function(geoJsonPoint, latlng) { return L.marker(latlng); }
`style`	`Function`	`*`	`Function` определяющий `Path options` для стилизации линий и полигонов GeoJSON, вызывается внутренне при добавлении данных. Значение по умолчанию — не переопределять никакие значения по умолчанию: function (geoJsonFeature) { return {} }
`onEachFeature`	`Function`	`*`	`Function`, который будет вызываться один раз для каждого созданного `Feature`, после того как он будет создан и стилизован. Полезно для добавления событий и всплывающих окон к объектам. По умолчанию ничего не делает с вновь созданными слоями: function (feature, layer) {}
`filter`	`Function`	`*`	`Function`, который будет использоваться для принятия решения о включении объекта или нет. По умолчанию включаются все объекты: function (geoJsonFeature) { return true; } Примечание: динамическое изменение параметра `filter` будет влиять только на вновь добавленные данные. Он не будет переоценивать уже включённые объекты.
`coordsToLatLng`	`Function`	`*`	`Function`, который будет использоваться для преобразования координат GeoJSON в `LatLng`. По умолчанию используется статический метод `coordsToLatLng`.
`markersInheritOptions`	`Boolean`	`false`	Наследуют ли стандартные маркеры для объектов типа "Point" параметры группы.

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

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

События

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

Event	Data	Description
`layeradd`	`LayerEvent`	Срабатывает, когда слой добавляется к этому `FeatureGroup`
`layerremove`	`LayerEvent`	Срабатывает, когда слой удаляется из этого `FeatureGroup`

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

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

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

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

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

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

Методы

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

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

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

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

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

Методы, унаследованные от 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`, возвращает параметр атрибуции.

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

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

Функции

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

Параметры

Option	Type	Default	Description
`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

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

События

Event	Data	Description
`loading`	`Event`	Генерируется, когда слой сетки начинает загружать плитки.
`tileunload`	`TileEvent`	Генерируется, когда плитка удаляется (например, когда плитка выходит за пределы экрана).
`tileloadstart`	`TileEvent`	Генерируется, когда плитка запрашивается и начинает загружаться.
`tileerror`	`TileErrorEvent`	Генерируется, когда возникает ошибка при загрузке плитки.
`tileload`	`TileEvent`	Генерируется, когда плитка загружается.
`load`	`Event`	Генерируется, когда слой сетки загрузил все видимые плитки.

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

Event	Data	Description
`add`	`Event`	Генерируется после добавления слоя на карту
`remove`	`Event`	Генерируется после удаления слоя с карты

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

Event	Data	Description
`popupopen`	`PopupEvent`	Генерируется, когда всплывающее окно, привязанное к этому слою, открывается
`popupclose`	`PopupEvent`	Генерируется, когда всплывающее окно, привязанное к этому слою, закрывается

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

Event	Data	Description
`tooltipopen`	`TooltipEvent`	Генерируется, когда подсказка, привязанная к этому слою, открывается.
`tooltipclose`	`TooltipEvent`	Генерируется, когда подсказка, привязанная к этому слою, закрывается.

Методы

Method	Returns	Description
`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, должны переопределить следующий метод.

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

Методы, унаследованные от 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`, возвращает параметр атрибуции.

Методы всплывающих окон, унаследованные от 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`	Широта в градусах
`lng`	`Number`	Долгота в градусах
`alt`	`Number`	Высота в метрах (необязательно)

LatLngBounds

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

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

var corner1 = L.latLng(40.712, -74.227),
corner2 = L.latLng(40.774, -74.125),
bounds = L.latLngBounds(corner1, corner2);

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

map.fitBounds([
    [40.712, -74.227],
    [40.774, -74.125]
]);

Внимание: если область пересекает антимеридиан (часто путают с Международной линией дат), необходимо указать углы вне диапазона долготы [-180, 180] градусов. Обратите внимание, что LatLngBounds не наследуется от объекта Class Leafet, что означает, что новые классы не могут наследовать от него, и новые методы не могут быть добавлены к нему с помощью функции 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`	Возвращает строку с координатами ограничивающей рамки в формате '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 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`	Координата `x` точки
`y`	`Number`	Координата `y` точки

Границы

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

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

var p1 = L.point(10, 10),
p2 = L.point(40, 60),
bounds = L.bounds(p1, p2);

Все методы Leaflet, которые принимают объекты Bounds, также принимают их в простом массиве (если не указано иное), поэтому пример границ выше может быть передан так:

otherBounds.intersects([[10, 10], [40, 60]]);

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

Создание

Фабрика	Описание
`L.bounds(<Point> corner1, <Point> corner2)`	Создает объект Bounds из двух пар координат углов.
`L.bounds(<Point[]> points)`	Создает объект Bounds из заданного массива точек.

Методы

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

Свойства

Свойство	Тип	Описание
`min`	`Point`	Верхний левый угол прямоугольника.
`max`	`Point`	Нижний правый угол прямоугольника.

Иконка

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

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

var myIcon = L.icon({
    iconUrl: 'my-icon.png',
    iconSize: [38, 95],
    iconAnchor: [22, 94],
    popupAnchor: [-3, -76],
    shadowUrl: 'my-icon-shadow.png',
    shadowSize: [68, 95],
    shadowAnchor: [22, 94]
});
L.marker([50.505, 30.57], {icon: myIcon}).addTo(map);

L.Icon.Default расширяет L.Icon и является синей иконкой, используемой Leaflet для маркеров по умолчанию.

Создание

Фабрика	Описание
`L.icon(<Icon options> options)`	Создает экземпляр иконки с заданными параметрами.

Параметры

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

Методы

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

Icon.Default

Тривиальный подкласс Icon, представляет иконку для использования в Marker когда иконка не указана. Указывает на синее изображение маркера, распространяемое с выпусками Leaflet. Для настройки иконки по умолчанию просто измените свойства L.Icon.Default.prototype.options (который представляет собой набор Icon options). Если вы хотите полностью заменить иконку по умолчанию, переопределите L.Marker.prototype.options.icon своей собственной иконкой.

Параметр	Тип	По умолчанию	Описание
`imagePath`	`String`		`Icon.Default` попытается автоматически определить местоположение изображений синих значков. Если вы размещаете эти изображения нестандартным способом, установите этот параметр, чтобы указать правильный путь.

DivIcon

Представляет собой облегченную иконку для маркеров, которая использует простой элемент <div> вместо изображения. Наследуется от Icon, но игнорирует параметры iconUrl и тени.

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

var myIcon = L.divIcon({className: 'my-div-icon'});
// you can set .my-div-icon styles in CSS
L.marker([50.505, 30.57], {icon: myIcon}).addTo(map);

По умолчанию он имеет класс CSS 'leaflet-div-icon' и оформлен как небольшой белый квадрат с тенью.

Создание

Фабрика	Описание
`L.divIcon(<DivIcon options> options)`	Создает экземпляр `DivIcon` с заданными параметрами.

Параметры

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

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

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

Методы

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

Метод	Возвращает	Описание
`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?) Создает элемент управления слоями с указанными слоями. Базовые слои будут переключаться с помощью переключателей, а оверлеи — с помощью флажков. Обратите внимание, что все базовые слои должны быть переданы в объект базовых слоев, но только один должен быть добавлен на карту во время создания карты.

Параметры

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

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

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

Методы

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

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

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

Control.Scale

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

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

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

Создание

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

Параметры

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

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

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

Методы

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

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

Браузер

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

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

if (L.Browser.ielt9) {
  alert('Upgrade your browser, dude!');
}

Свойства

Свойство	Тип	Описание
`ie`	`Boolean`	`true` для всех версий Internet Explorer (не Edge).
`ielt9`	`Boolean`	`true` для версий Internet Explorer младше 9.
`edge`	`Boolean`	`true` для веб-браузера Edge.
`webkit`	`Boolean`	`true` для браузеров на основе webkit, таких как Chrome и Safari (включая мобильные версии).
`android`	`Boolean`	`true` для любого браузера, работающего на платформе Android.
`android23`	`Boolean`	`true` для браузеров, работающих на Android 2 или Android 3.
`androidStock`	`Boolean`	`true` для стандартного браузера Android (т. е. не Chrome).
`opera`	`Boolean`	`true` для браузера Opera.
`chrome`	`Boolean`	`true` для браузера Chrome.
`gecko`	`Boolean`	`true` для браузеров на основе Gecko, таких как Firefox.
`safari`	`Boolean`	`true` для браузера Safari.
`opera12`	`Boolean`	`true` для браузера Opera, поддерживающего CSS-преобразования (версия 12 или более поздняя).
`win`	`Boolean`	`true` когда браузер работает на платформе Windows.
`ie3d`	`Boolean`	`true` для всех версий Internet Explorer, поддерживающих CSS-преобразования.
`webkit3d`	`Boolean`	`true` для браузеров на основе webkit, поддерживающих CSS-преобразования.
`gecko3d`	`Boolean`	`true` для браузеров на основе Gecko, поддерживающих CSS-преобразования.
`any3d`	`Boolean`	`true` для всех браузеров, поддерживающих CSS-преобразования.
`mobile`	`Boolean`	`true` для всех браузеров, работающих на мобильном устройстве.
`mobileWebkit`	`Boolean`	`true` для всех браузеров на основе webkit на мобильном устройстве.
`mobileWebkit3d`	`Boolean`	`true` для всех браузеров на основе webkit на мобильном устройстве, поддерживающих CSS-преобразования.
`msPointer`	`Boolean`	`true` для браузеров, реализующих модель событий Microsoft touch (в частности, IE10).
`pointer`	`Boolean`	`true` для всех браузеров, поддерживающих события указателя.
`touch`	`Boolean`	`true` для всех браузеров, поддерживающих сенсорные события. Это не обязательно означает, что браузер работает на компьютере с сенсорным экраном, это только означает, что браузер способен понимать сенсорные события.
`mobileOpera`	`Boolean`	`true` для браузера Opera на мобильном устройстве.
`mobileGecko`	`Boolean`	`true` для браузеров на основе Gecko, работающих на мобильном устройстве.
`retina`	`Boolean`	`true` для браузеров на высокоразрешающем экране «сетчатки» или на любом экране, когда масштаб отображения браузера больше 100%.
`passiveEvents`	`Boolean`	`true` для браузеров, поддерживающих пассивные события.
`canvas`	`Boolean`	`true` когда браузер поддерживает `<canvas>`.
`svg`	`Boolean`	`true` когда браузер поддерживает SVG.
`vml`	`Boolean`	`true` если браузер поддерживает VML.

Util

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

Функции

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

Свойства

Свойство	Тип	Описание
`lastId`	`Number`	Последний уникальный ID, используемый `stamp()`
`emptyImageUrl`	`String`	Строка данных URI, содержащая закодированное в base64 пустое изображение GIF. Используется как обходной путь для освобождения памяти от неиспользуемых изображений на мобильных устройствах с поддержкой WebKit (путем установки атрибута image `src` в эту строку).

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

Представляет аффинное преобразование: набор коэффициентов a, b, c, d для преобразования точки вида (x, y) в (a*x + b, c*y + d) и выполнения обратного преобразования. Используется Leaflet в своем коде проекций.

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

var transformation = L.transformation(2, 5, -1, 10),
    p = L.point(1, 2),
    p2 = transformation.transform(p), //  L.point(7, 8)
    p3 = transformation.untransform(p2); //  L.point(1, 2)

Создание

Фабрика	Описание
`L.transformation(<Number> a, <Number> b, <Number> c, <Number> d)`	Создает объект Transformation с заданными коэффициентами.
`L.transformation(<Array> coefficients)`	Ожидает массив коэффициентов в формате `[a: Number, b: Number, c: Number, d: Number]`.

Методы

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

LineUtil

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

Функции

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

PolyUtil

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

Функции

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

DomEvent

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

Функции

Функция	Возвращает	Описание
`on(<HTMLElement> el, <String> types, <Function> fn, <Object> context?)`	`this`	Добавляет функцию прослушивателя (`fn`) к определённому типу события DOM элемента `el`. Необязательно можно указать контекст прослушивателя (объект, на который будет указывать ключевое слово `this`). Также можно передать несколько типов, разделённых пробелами (например, `'click dblclick'`).
`on(<HTMLElement> el, <Object> eventMap, <Object> context?)`	`this`	Добавляет набор пар тип/прослушиватель, например `{click: onClick, mousemove: onMouseMove}`
`off(<HTMLElement> el, <String> types, <Function> fn, <Object> context?)`	`this`	Удаляет ранее добавленную функцию прослушивателя. Обратите внимание, что если вы передали пользовательский контекст в on, вы должны передать тот же контекст в `off` для удаления прослушивателя.
`off(<HTMLElement> el, <Object> eventMap, <Object> context?)`	`this`	Удаляет набор пар тип/прослушиватель, например `{click: onClick, mousemove: onMouseMove}`
`stopPropagation(<DOMEvent> ev)`	`this`	Остановить распространение данного события на родительские элементы. Используется внутри функций прослушивателя: L.DomEvent.on(div, 'click', function (ev) { L.DomEvent.stopPropagation(ev); });
`disableScrollPropagation(<HTMLElement> el)`	`this`	Добавляет `stopPropagation` к событиям `'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`	Получает нормализованное значение изменения колеса из события mousewheel 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 translate или позиционирование top/left в зависимости от браузера (используется Leaflet внутренне для позиционирования своих слоёв).
`getPosition(<HTMLElement> el)`	`Point`	Возвращает координаты элемента, ранее расположенного с помощью setPosition.
`disableTextSelection()`		Предотвращает создание пользователем событий DOM `selectstart`, обычно генерируемых, когда пользователь перетаскивает мышь по странице с текстом. Используется внутренне Leaflet для переопределения поведения любого взаимодействия «щелчок и перетаскивание» на карте. Влияет на перетаскивание взаимодействий на весь документ.
`enableTextSelection()`		Отменяет эффекты предыдущего `L.DomUtil.disableTextSelection`.
`disableImageDrag()`		Как `L.DomUtil.disableTextSelection`, но для событий DOM `dragstart`, обычно генерируемых, когда пользователь перетаскивает изображение.
`enableImageDrag()`		Отменяет эффекты предыдущего `L.DomUtil.disableImageDrag`.
`preventOutline(<HTMLElement> el)`		Делает контур элемента `el` невидимым. Используется внутренне Leaflet для предотвращения отображения контура фокусируемых элементов, когда пользователь выполняет перетаскивание по ним.
`restoreOutline()`		Отменяет эффекты предыдущего `L.DomUtil.preventOutline`.
`getSizedParentNode(<HTMLElement> el)`	`HTMLElement`	Находит ближайший родительский узел, размер (ширина и высота) которого не равен нулю.
`getScale(<HTMLElement> el)`	`Object`	Вычисляет масштаб CSS, в настоящее время применённый к элементу. Возвращает объект с элементами `x` и `y` как горизонтальным и вертикальным масштабами соответственно, и `boundingClientRect` как результатом `getBoundingClientRect()`.

Свойства

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

PosAnimation

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

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

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

Конструктор

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

События

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

Методы

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

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

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

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

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

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

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

Конструктор

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

Параметры

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

События

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

Методы

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

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

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

Класс

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

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

var MyClass = L.Class.extend({
initialize: function (greeter) {
    this.greeter = greeter;
    // class constructor
},
greet: function (name) {
    alert(this.greeter + ', ' + name)
    }
});
// create instance of MyClass, passing "Hello" to the constructor
var a = new MyClass("Hello");
// call greet method, alerting "Hello, World"
a.greet("World");

Фабрики классов

Вы, возможно, заметили, что объекты Leaflet создаются без использования ключевого слова new. Это достигается путем дополнения каждого класса строчным методом-фабрикой:

new L.Map('map'); // becomes:
L.map('map');

Фабрики реализованы очень просто, и вы можете сделать это для своих собственных классов:

L.map = function (id, options) {
    return new L.Map(id, options);
};

Наследование

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

var MyChildClass = MyClass.extend({
    // ... new properties and methods
});

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

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

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

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

Параметры

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

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

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

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

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

Включает

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

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

Вы также можете выполнять такие включения во время выполнения с помощью метода include:

MyClass.include(MyMixin);

statics — это просто свойство для удобства, которое вставляет указанные свойства объекта в качестве статических свойств класса, полезно для определения констант:

var MyClass = L.Class.extend({
    statics: {
        FOO: 'bar',
        BLA: 5
    }
});
MyClass.FOO; // 'bar'

Зацепки конструктора

Если вы разработчик плагинов, вам часто нужно добавлять дополнительный код инициализации в существующие классы (например, редактирование зацепок для L.Polyline). Leaflet предоставляет простой способ сделать это с помощью метода addInitHook:

MyClass.addInitHook(function () {
    // ... do something in constructor additionally
    // e.g. add event listeners, set custom properties etc.
});

Вы также можете использовать следующий ярлык, если вам нужно просто сделать один дополнительный вызов метода:

MyClass.addInitHook('methodName', arg1, arg2, …);

Функции

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

Событийное

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

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

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

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

function onClick(e) { ... }
map.on('click', onClick);
map.off('click', onClick);

Методы

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

Слой

Набор методов из базового класса Layer, которые используют все слои Leaflet. Наследует все методы, параметры и события от L.Evented.

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

var layer = L.marker(latlng).addTo(map);
layer.addTo(map);
layer.remove();

Параметры

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

События

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

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

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

Методы

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Опции

Опция	Тип	По умолчанию	Описание
`interactive`	`Boolean`	`true`	Если `false`, слой не будет генерировать события мыши и будет действовать как часть базовой карты.
`bubblingMouseEvents`	`Boolean`	`true`	Когда `true`, событие мыши на этом слое вызовет то же событие на карте (если не используется `L.DomEvent.stopPropagation`).

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

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

События

События мыши

Событие	Данные	Описание
`click`	`MouseEvent`	Срабатывает, когда пользователь кликает (или тапает) по слою.
`dblclick`	`MouseEvent`	Срабатывает, когда пользователь дважды кликает (или дважды тапает) по слою.
`mousedown`	`MouseEvent`	Срабатывает, когда пользователь нажимает кнопку мыши на слое.
`mouseup`	`MouseEvent`	Срабатывает, когда пользователь отпускает кнопку мыши, нажатую на слое.
`mouseover`	`MouseEvent`	Срабатывает, когда курсор мыши входит в слой.
`mouseout`	`MouseEvent`	Срабатывает, когда курсор мыши выходит из слоя.
`contextmenu`	`MouseEvent`	Срабатывает, когда пользователь кликает правой кнопкой мыши на слой, предотвращает отображение контекстного меню браузера по умолчанию, если есть слушатели на это событие. Также срабатывает на мобильных устройствах, когда пользователь удерживает одно касание в течение секунды (также называется долгим нажатием).

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

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

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

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

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

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

Методы

Методы, унаследованные от 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(…)`

Управление

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

Проекция

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

Методы

Метод	Возвращает	Описание
`project(<LatLng> latlng)`	`Point`	Проецирует географические координаты в 2D-точку. Принимает только фактические экземпляры `L.LatLng`, а не массивы.
`unproject(<Point> point)`	`LatLng`	Обратное `project`. Проецирует 2D-точку в географическое положение. Принимает только фактические экземпляры `L.Point`, а не массивы. Обратите внимание, что экземпляры проекции не наследуются от объекта `Class` Leafet и не могут быть созданы. Кроме того, новые классы не могут наследовать от них, и методы не могут быть добавлены к ним с помощью функции `include`.

Свойства

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

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

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

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

СК

Методы

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

Свойства

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

Определенные СК

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

Рендерер

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

Параметры

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

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

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

События

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

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

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

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

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

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

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

Методы

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

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

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

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

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

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

Событие

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

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

KeyboardEvent

Свойство	Тип	Описание
`originalEvent`	`DOMEvent`	Оригинальное событие DOM `KeyboardEvent`, которое вызвало это событие Leaflet.

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

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

MouseEvent

Свойство	Тип	Описание
`latlng`	`LatLng`	Географическая точка, где произошло событие мыши.
`layerPoint`	`Point`	Пиксельные координаты точки, где произошло событие мыши, относительно слоя карты.
`containerPoint`	`Point`	Пиксельные координаты точки, где произошло событие мыши, относительно контейнера карты.
`originalEvent`	`DOMEvent`	Оригинальное событие DOM `MouseEvent` или DOM `TouchEvent`, которое вызвало это событие Leaflet.

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

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

LocationEvent

Свойство	Тип	Описание
`latlng`	`LatLng`	Обнаруженное географическое местоположение пользователя.
`bounds`	`LatLngBounds`	Географические границы области, в которой находится пользователь (с учетом точности местоположения).
`accuracy`	`Number`	Точность местоположения в метрах.
`altitude`	`Number`	Высота позиции над эллипсоидом WGS84 в метрах.
`altitudeAccuracy`	`Number`	Точность высоты в метрах.
`heading`	`Number`	Направление движения в градусах по часовой стрелке от истинного севера.
`speed`	`Number`	Текущая скорость в метрах в секунду.
`timestamp`	`Number`	Время получения позиции.

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

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

ErrorEvent

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

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

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

LayerEvent

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

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

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

LayersControlEvent

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

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

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

TileEvent

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

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

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

TileErrorEvent

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

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

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

ResizeEvent

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

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

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

GeoJSONEvent

Свойство	Тип	Описание
`layer`	`Layer`	Слой для объекта GeoJSON, который добавляется на карту.
`properties`	`Object`	Свойства GeoJSON объекта.
`geometryType`	`String`	Тип геометрии GeoJSON объекта.
`id`	`String`	Идентификатор GeoJSON объекта (если есть).

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

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

PopupEvent

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

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

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

TooltipEvent

Свойство	Тип	Описание
`tooltip`	`Tooltip`	Подсказка, которая была открыта или закрыта.

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

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

DragEndEvent

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

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

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

ZoomAnimEvent

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

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

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

DivOverlay

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

Параметры

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

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

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

События

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

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

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

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

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

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

Методы

Методы, унаследованные от 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(…)`

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

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

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

Переключатель	Описание
`L_NO_TOUCH`	Заставляет Leaflet не использовать сенсорные события, даже если он их обнаруживает.
`L_DISABLE_3D`	Заставляет Leaflet не использовать аппаратное ускорение CSS 3D-преобразований для позиционирования (что может вызывать сбои в некоторых редких средах), даже если они поддерживаются.

noConflict

Этот метод восстанавливает глобальную переменную L к исходному значению, которое она имела до включения Leaflet, и возвращает настоящее пространство имён Leaflet, чтобы вы могли поместить его в другое место, например:

<script src='libs/l.js'>
<!-- L points to some other library -->
<script src='leaflet.js'>
<!-- you include Leaflet, it replaces the L variable to Leaflet namespace -->
<script>
var Leaflet = L.noConflict();
// now L points to that other library again, and you can use Leaflet.Map etc.
</script>

версия

Константа, представляющая используемую версию Leaflet.

L.version; // contains "1.0.0" (or whatever version is currently in use)

© 2010–2019 Vladimir Agafonkin
© 2010–2011, CloudMade
Maps © OpenStreetMap contributors.
https://leafletjs.com/reference-1.6.0.html

Ссылка на API Leaflet

Карта

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

Создание

Опции

Опции управления

Опции взаимодействия

Опции состояния карты

Опции анимации

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

Опции навигации с клавиатуры

Опции прокрутки колесом мыши

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

События

События слоя

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

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

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

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

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

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

Методы

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

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

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

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

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

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

Свойства

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

Обработчики

Области карты

Параметры геолокации

Параметры масштабирования

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

Параметры масштабирования/панорамирования

Параметры FitBounds

Маркер

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

Создание

Параметры

Параметры перемещаемого маркера

События

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

Методы

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

Свойства

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

Всплывающее окно

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

Создание

Параметры

События

Методы

Всплывающая подсказка

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

Создание

Параметры

События

Методы

TileLayer

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

Шаблон URL

Создание

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

Параметры

События

Методы

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

TileLayer.WMS

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

Создание

Опции

События

Методы

ImageOverlay

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

Создание

Параметры

События