Spec-Zone.ru › Leaflet 1.4

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

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

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

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

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

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

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

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

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

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

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

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

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

События (map-event)

События слоев (map-layer-events)

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

События изменения состояния карты (map-map-state-change-events)

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

События всплывающих окон (map-popup-events)

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

События подсказок (map-tooltip-events)

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

События определения местоположения (map-location-events)

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

События взаимодействия (map-interaction-events)

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

Другие методы (map-other-methods)

Событие Данные Описание
zoomanim ZoomAnimEvent Fired at least once per zoom animation. For continuous zoom, like pinch zooming, fired once per frame during zoom.

Методы (map-method)

Метод Возвращаемое значение Описание
getRenderer(<Path> layer) Renderer

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

Методы для слоев и элементов управления (map-methods-for-layers-and-controls)

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

Закрывает подсказку, переданную в качестве параметра.

Методы для изменения состояния карты (map-methods-for-modifying-map-state)

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

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-слушатель (fn) к определённому типу события объекта. Вы можете указать контекст слушателя (объект, к которому будет относиться this). Также можно передать несколько типов через пробел (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар тип/слушатель, например, {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

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

off(<Object> eventMap) this

Удаляет набор пар тип/слушатель.

off() this

Удаляет всех слушателей всех событий объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Срабатывает событие заданного типа. Вы можете необязательно предоставить объект данных — первое аргумент функции-слушателя будет содержать его свойства. Событие необязательно может быть распространено к родительским событиям.

listens(<String> type) Boolean

Возвращает true если для определённого типа события есть какие-либо слушатели.

once(…) this

Ведёт себя как on(…), за исключением того, что слушатель будет срабатывать только один раз, а затем будет удалён.

addEventParent(<Evented> obj) this

Добавляет родительское событие — Evented, который будет получать распространяемые события

removeEventParent(<Evented> obj) this

Удаляет родительское событие, так что оно перестанет получать распространяемые события

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

Свойства

Управление

Свойство Тип Описание
zoomControl Control.Zoom The default zoom control (only available if the zoomControl option was true when creating the map).

Обработчики

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

Планы карты

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

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

Некоторые из методов Map, которые изменяют уровень масштаба, принимают параметр options. Это обычный javascript-объект со следующими необязательными компонентами:
Вариант Тип Значение по умолчанию Описание
animate Boolean Если не указано, анимация масштабирования произойдёт, если точка масштабирования находится внутри текущего представления. Если true, карта попытается выполнить анимацию масштабирования, не зависимо от того, где находится точка масштабирования. Установка false заставит её всегда полностью переустановить представление без анимации.

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

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

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

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

Параметры FitBounds

Вариант Тип Значение по умолчанию Описание
paddingTopLeft Point [0, 0] Устанавливает количество отступа в верхнем левом углу контейнера карты, которое не должно учитываться при установке представления для соответствия границам. Полезно, если у вас есть наложения управления на карте, такие как боковая панель, и вы не хотите, чтобы они скрывали объекты, к которым вы приближаетесь.
paddingBottomRight Point [0, 0] То же самое для нижнего правого угла карты.
padding Point [0, 0] Эквивалентно установке верхнего левого и нижнего правого отступов одинакового значения.
maxZoom Number null Максимальный возможный масштаб для использования.
Вариант Тип Значение по умолчанию Описание
animate Boolean Если не указано, анимация масштабирования произойдёт, если точка масштабирования находится внутри текущего представления. Если true, карта попытается выполнить анимацию масштабирования, не зависимо от того, где находится точка масштабирования. Установка false заставит её всегда полностью переустановить представление без анимации.
Вариант Тип Значение по умолчанию Описание
duration Number 0.25 Продолжительность анимированного перемещения в секундах.
easeLinearity Number 0.25 Коэффициент кривизны сглаживания анимации перемещения (третий параметр кривой Безье). 1.0 означает линейную анимацию, а чем меньше это число, тем более изогнутой будет кривая.
noMoveStart Boolean false Если true, перемещение не будет вызывать событие movestart при старте (используется внутренне для инерции перемещения).

Маркер

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

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

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

Создание

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

Параметры

Вариант Тип Значение по умолчанию Описание
icon Icon * Объект значка для отображения маркера. См. документацию по значкам для получения информации о настройке значка маркера. Если не указано, используется общий объект L.Icon.Default.
keyboard Boolean true Можно ли переключаться на маркер с клавиатуры и нажимать Enter для клика.
title String '' Текст всплывающей подсказки браузера, появляющейся при наведении на маркер (по умолчанию подсказки нет).
alt String '' Текст для атрибута alt изображения значка (полезно для обеспечения доступности).
zIndexOffset Number 0 По умолчанию zIndex изображения маркера устанавливается автоматически в зависимости от его широты. Используйте этот параметр, если хотите разместить маркер поверх всех остальных (или ниже), указав высокое значение, например 1000 (или высокое отрицательное значение, соответственно).
opacity Number 1.0 Непрозрачность маркера.
riseOnHover Boolean false Если true, маркер окажется поверх других, когда вы наведёте на него курсор.
riseOffset Number 250 Смещение z-индекса, используемое для функции riseOnHover.
pane String 'markerPane' Map pane куда будет добавлен значок маркера.
bubblingMouseEvents Boolean false Когда true, событие мыши на этом маркере вызовет то же самое событие на карте (если не используется L.DomEvent.stopPropagation).

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

Параметр Тип Значение по умолчанию Описание
draggable Boolean false Определяет, можно ли перетаскивать метку с помощью мыши/тачскрина.
autoPan Boolean false Определяет, нужно ли перемещать карту при перетаскивании метки близко к её краю.
autoPanPadding Point Point(50, 50) Расстояние (в пикселях слева/справа и сверху/снизу) от края карты, при котором начнется перемещение карты.
autoPanSpeed Number 10 Количество пикселей, на которое должна сместиться карта.
Параметр Тип Значение по умолчанию Описание
interactive Boolean true Если false, слой не будет генерировать события мыши и будет действовать как часть базовой карты.
Параметр Тип Значение по умолчанию Описание
attribution String null Строка, отображаемая в контроле атрибуции, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является обязательством перед правообладателями и поставщиками тайлов.

События

В дополнение к общим методам слоя, таким как addTo() и remove() и методам всплывающей подсказки, таким как bindPopup(), вы также можете использовать следующие методы:
Событие Данные Описание
move Event Fired when the marker is moved via setLatLng or by dragging. Old and new coordinates are included in event arguments as oldLatLng, latlng.

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

Событие Данные Описание
dragstart Event Fired when the user starts dragging the marker.
movestart Event Fired when the marker starts moving (because of dragging).
drag Event Fired repeatedly while the user drags the marker.
dragend DragEndEvent Fired when the user stops dragging the marker.
moveend Event Fired when the marker stops moving (because of dragging).
Событие Данные Описание
click MouseEvent Fired when the user clicks (or taps) the layer.
dblclick MouseEvent Fired when the user double-clicks (or double-taps) the layer.
mousedown MouseEvent Fired when the user pushes the mouse button on the layer.
mouseup MouseEvent Fired when the user releases the mouse button pushed on the layer.
mouseover MouseEvent Fired when the mouse enters the layer.
mouseout MouseEvent Fired when the mouse leaves the layer.
contextmenu MouseEvent Fired when the user right-clicks on the layer, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).
Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
Событие Данные Описание
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы

Метод Возвращаемое значение Описание
toGeoJSON(<Number> precision) Object

Возвращает представление метки в формате GeoJSON (как объект GeoJSON Point Feature).

getLatLng() LatLng

Возвращает текущее географическое положение метки.

setLatLng(<LatLng> latlng) this

Изменяет положение метки на указанную точку.

setZIndexOffset(<Number> offset) this

Изменяет смещение zIndex метки.

setIcon(<Icon> icon) this

Изменяет значок метки.

setOpacity(<Number> opacity) this

Изменяет прозрачность метки.

Метод Возвращаемое значение Описание
addTo(<Map|LayerGroup> map) this

Добавляет слой на заданную карту или группу слоёв.

remove() this

Удаляет слой с карты, на которой он сейчас активен.

removeFrom(<Map> map) this

Удаляет слой с заданной карты.

getPane(<String> name?) HTMLElement

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

getAttribution() String

Используется attribution control, возвращает параметр атрибуции.

Метод Возвращаемое значение Описание
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?) this

Связывает всплывающую подсказку со слоем с переданной content и настраивает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindPopup() this

Удаляет всплывающую подсказку, ранее привязанную с помощью bindPopup.

openPopup(<LatLng> latlng?) this

Открывает привязанную всплывающую подсказку в указанном latlng или в стандартном якоре всплывающей подсказки, если latlng не передан.

closePopup() this

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

togglePopup() this

Открывает или закрывает привязанную к этому слою всплывающую подсказку в зависимости от её текущего состояния.

isPopupOpen() boolean

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

setPopupContent(<String|HTMLElement|Popup> content) this

Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.

getPopup() Popup

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

Метод Возвращаемое значение Описание
bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

Связывает подсказку со слоем с переданной content и настраивает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindTooltip() this

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

openTooltip(<LatLng> latlng?) this

Открывает привязанную подсказку в указанной latlng или в стандартном якоре подсказки, если latlng не передан.

closeTooltip() this

Закрывает привязанную к этому слою подсказку, если она открыта.

toggleTooltip() this

Открывает или закрывает привязанную к этому слою подсказку в зависимости от её текущего состояния.

isTooltipOpen() boolean

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

setTooltipContent(<String|HTMLElement|Tooltip> content) this

Устанавливает содержимое подсказки, привязанной к этому слою.

getTooltip() Tooltip

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

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-слушатель (fn) к определенному типу события объекта. Вы можете указать контекст слушателя (объект, к которому будет относиться ключевое слово this). Также вы можете передать несколько типов через пробел (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар тип/слушатель, например, {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

Удаляет ранее добавленную функцию-слушатель. Если функция не указана, удаляются все слушатели данного события для объекта. Обратите внимание, что если вы передали пользовательский контекст в on, вы должны передать тот же контекст в off для удаления слушателя.

off(<Object> eventMap) this

Удаляет набор пар тип/слушатель.

off() this

Удаляет всех слушателей всех событий для объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Вызывает событие указанного типа. Вы можете необязательно указать объект данных — свойства этого объекта будут первым аргументом функции-слушателя. Событие может быть необязательно распространено родительским объектам.

listens(<String> type) Boolean

Возвращает true , если для определенного типа события есть прикреплённые слушатели.

once(…) this

Ведёт себя как on(…), за исключением того, что слушатель будет вызван только один раз и затем удалён.

addEventParent(<Evented> obj) this

Добавляет родителя события — Evented, который будет получать распространяемые события

removeEventParent(<Evented> obj) this

Удаляет родителя события, чтобы он перестал получать распространяемые события

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

Свойства

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

Обработчики взаимодействия — это свойства экземпляра маркера, которые позволяют управлять поведением взаимодействия во время выполнения, включая или выключая определённые функции, такие как перетаскивание (см. методы Handler). Пример:
marker.dragging.disable();
Свойство Тип Описание
dragging Handler Marker dragging handler (by both mouse and touch). Only valid when the marker is on the map (Otherwise set marker.options.draggable).

Попап

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

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

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

marker.bindPopup(popupContent).openPopup();

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

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

Создание

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

Параметры

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

События

Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
Событие Данные Описание
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы

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

Возвращает географическую точку всплывающей подсказки.

setLatLng(<LatLng> latlng) this

Устанавливает географическую точку, где будет открыта всплывающая подсказка.

getContent() String|HTMLElement

Возвращает содержимое всплывающей подсказки.

setContent(<String|HTMLElement|Function> htmlContent) this

Устанавливает HTML-содержимое всплывающей подсказки. Если передана функция, в неё будет передан исходный слой. Функция должна вернуть String или HTMLElement, которые будут использованы во всплывающей подсказке.

getElement() String|HTMLElement

Псевдоним для getContent()

update() null

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

isOpen() Boolean

Возвращает true, когда всплывающая подсказка видна на карте.

bringToFront() this

Выводит эту всплывающую подсказку вперёд других всплывающих подсказок (в том же окне карты).

bringToBack() this

Выводит эту всплывающую подсказку назад других всплывающих подсказок (в том же окне карты).

openOn(<Map> map) this

Добавляет всплывающую подсказку на карту и закрывает предыдущую. То же самое, что и map.openPopup(popup).

Метод Возвращает Описание
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 и устанавливает необходимые обработчики событий. Если передана функция, она получит слой в качестве первого аргумента и должна вернуть 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 и настраивает необходимые обработчики событий. Если передана функция, она получит слой в качестве первого аргумента и должна вернуть 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

Возвращает привязанную подсказку.

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-обработчик (fn) к определённому типу события объекта. Можно указать контекст обработчика (объект, к которому будет относиться this). Также можно передать несколько типов, разделённых пробелами (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар тип/обработчик, например, {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

Удаляет ранее добавленную функцию-обработчик. Если функция не указана, удаляются все обработчики этого события. Обратите внимание, что если вы передавали пользовательский контекст для on, вы должны передать тот же контекст в off для удаления обработчика.

off(<Object> eventMap) this

Удаляет набор пар тип/обработчик.

off() this

Удаляет все обработчики всех событий для объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Вызывает событие указанного типа. Можно необязательно указать объект данных — свойства этого объекта будут первым аргументом функции-обработчика. Событие может необязательно распространяться на родительские элементы.

listens(<String> type) Boolean

Возвращает true, если определённый тип события имеет какие-либо прикреплённые обработчики.

once(…) this

Поведение аналогично on(…), за исключением того, что обработчик будет вызван только один раз, а затем удалён.

addEventParent(<Evented> obj) this

Добавляет родительский обработчик событий — Evented, который будет получать распространяемые события.

removeEventParent(<Evented> obj) this

Удаляет родительский обработчик событий, чтобы он больше не получал распространяемые события.

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

Подсказка

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

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

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

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

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

Создание

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

Опции

Вариант Тип Значение по умолчанию Описание
pane String 'tooltipPane' Map pane где будет добавлен всплывающая подсказка.
offset Point Point(0, 0) Дополнительный смещение позиции всплывающей подсказки.
direction String 'auto' Направление открытия всплывающей подсказки. Возможные значения: right, left, top, bottom, center, auto. auto динамически переключается между right и left в зависимости от положения всплывающей подсказки на карте.
permanent Boolean false Открывать всплывающую подсказку постоянно или только при наведении курсора.
sticky Boolean false Если true, всплывающая подсказка будет следовать за курсором мыши, а не закрепляться в центре объекта.
interactive Boolean false Если true, всплывающая подсказка будет реагировать на события объекта.
opacity Number 0.9 Непрозрачность контейнера всплывающей подсказки.
Вариант Тип Значение по умолчанию Описание
className String '' Настраиваемое имя класса CSS для всплывающего окна.
Вариант Тип Значение по умолчанию Описание
attribution String null Строка, отображаемая в элементе управления подписью, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является правовой обязанностью в отношении правообладателей и поставщиков плиток.

События

Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
Событие Данные Описание
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы

Метод Возвращает Описание
addTo(<Map|LayerGroup> map) this

Добавляет слой к заданной карте или группе слоёв.

remove() this

Удаляет слой с карты, на которой он сейчас активен.

removeFrom(<Map> map) this

Удаляет слой с заданной карты.

getPane(<String> name?) HTMLElement

Возвращает HTMLElement, представляющий собой именованный элемент управления на карте. Если name опущено, возвращает элемент управления для данного слоя.

getAttribution() String

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

Метод Возвращает Описание
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?) this

Привязывает всплывающее окно к слою с переданным content и настраивает необходимые обработчики событий. Если передаётся Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindPopup() this

Удаляет всплывающее окно, ранее привязанное с помощью bindPopup.

openPopup(<LatLng> latlng?) this

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

closePopup() this

Закрывает привязанное всплывающее окно для данного слоя, если оно открыто.

togglePopup() this

Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния.

isPopupOpen() boolean

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

setPopupContent(<String|HTMLElement|Popup> content) this

Устанавливает содержимое всплывающего окна, привязанного к этому слою.

getPopup() Popup

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

Метод Возвращает Описание
bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

Привязывает всплывающую подсказку к слою с переданным content и настраивает необходимые обработчики событий. Если передаётся Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindTooltip() this

Удаляет всплывающую подсказку, ранее привязанную с помощью bindTooltip.

openTooltip(<LatLng> latlng?) this

Открывает привязанную всплывающую подсказку в указанной latlng или по умолчанию в якоре всплывающей подсказки, если latlng не передан.

closeTooltip() this

Закрывает привязанную всплывающую подсказку для данного слоя, если она открыта.

toggleTooltip() this

Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от её текущего состояния.

isTooltipOpen() boolean

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

setTooltipContent(<String|HTMLElement|Tooltip> content) this

Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.

getTooltip() Tooltip

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

END_OF_DOCUMENT_MARKER
Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-слушатель (fn) к определенному типу события объекта. Вы можете необязательно указать контекст слушателя (объект, к которому будет относиться ключевое слово this). Вы также можете передать несколько типов через пробел (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар тип/слушатель, например {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

Удаляет ранее добавленную функцию-слушатель. Если функция не указана, удалятся все слушатели этого конкретного события объекта. Обратите внимание, что если вы передали пользовательский контекст в on, вы должны передать тот же контекст в off для удаления слушателя.

off(<Object> eventMap) this

Удаляет набор пар тип/слушатель.

off() this

Удаляет всех слушателей всех событий объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — первый аргумент функции-слушателя будет содержать его свойства. Событие можно необязательно распространить на родительские события.

listens(<String> type) Boolean

Возвращает true , если для определенного типа события есть какие-либо присоединённые слушатели.

once(…) this

Ведёт себя как on(…), за исключением того, что слушатель будет вызван только один раз, а затем удалён.

addEventParent(<Evented> obj) this

Добавляет родительское событие — Evented, которое будет получать распространяемые события

removeEventParent(<Evented> obj) this

Удаляет родительское событие, поэтому оно перестанет получать распространяемые события

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

Слои плиток

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

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

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

Шаблон URL

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

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

{s} обозначает один из доступных поддоменов (используется последовательно для помощи с одновременными запросами браузера на домен; значения поддомена задаются в параметрах; a, b или c по умолчанию, могут быть опущены), {z} — уровень масштаба, {x} и {y} — координаты плиток. {r} может быть использовано для добавления "&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 и пользователь находится на экране с высокой чёткостью, он запросит четыре плитки с половиной указанного размера и большим уровнем масштаба вместо одной для использования высокого разрешения.
crossOrigin Boolean|String false Указывает, будет ли добавляться атрибут crossOrigin к плиткам. Если указана строка, у всех плиток атрибут crossOrigin будет установлен в предоставленную строку. Это необходимо, если вы хотите получить доступ к данным пикселей плитки. Обратитесь к Настройкам CORS для допустимых значений строк.
Параметр Тип Значение по умолчанию Описание
tileSize Number|Point 256 Ширина и высота плиток в сетке. Используйте число, если ширина и высота равны, или L.point(width, height) в противном случае.
opacity Number 1.0 Непрозрачность плиток. Может быть использована в функции createTile()
updateWhenIdle Boolean (depends) Загружать новые плитки только после окончания панорамирования. true по умолчанию в мобильных браузерах, чтобы избежать слишком многих запросов и обеспечить плавную навигацию. false в противном случае, чтобы отображать новые плитки *во время* панорамирования, так как легко выйти за пределы параметра keepBuffer в настольных браузерах.
updateWhenZooming Boolean true По умолчанию, плавная анимация масштабирования (во время приближения/удаления пальцем или flyTo()) будет обновлять слои сетки каждый целое уровень масштаба. Установка этого параметра в false обновит слой сетки только после окончания плавной анимации.
updateInterval Number 200 Плитки не будут обновляться более одного раза каждые updateInterval миллисекунд во время панорамирования.
zIndex Number 1 Явный z-индекс слоя плиток.
bounds LatLngBounds undefined Если установлено, плитки будут загружаться только внутри заданных LatLngBounds.
maxNativeZoom Number undefined Максимальный номер масштаба, доступный в источнике плиток. Если указан, плитки на всех уровнях масштабирования выше maxNativeZoom будут загружаться с уровня maxNativeZoom и автоматически масштабироваться.
minNativeZoom Number undefined Минимальный номер масштаба, доступный в источнике плиток. Если указан, плитки на всех уровнях масштабирования ниже minNativeZoom будут загружаться с уровня minNativeZoom и автоматически масштабироваться.
noWrap Boolean false Можно ли скручивать слой вокруг антимеридиана. Если true, слой GridLayer будет отображаться только один раз на низких уровнях масштабирования. Не имеет эффекта, когда CRS карты не скручивается вокруг. Может использоваться в сочетании с bounds для предотвращения запросов плиток за пределами ограничений CRS.
pane String 'tilePane' Map pane куда будет добавлен слой сетки.
className String '' Пользовательское имя класса для назначения слою плиток. По умолчанию пустое.
keepBuffer Number 2 При панорамировании карты сохраните столько строк и столбцов плиток, прежде чем их разгружать.
Опция Тип По умолчанию Описание
attribution String null Строка, отображаемая в элементе управления атрибутами, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридическим обязательством перед правообладателями и поставщиками тайлов.

События

Событие Данные Описание
loading Event Fired when the grid layer starts loading tiles.
tileunload TileEvent Fired when a tile is removed (e.g. when a tile goes off the screen).
tileloadstart TileEvent Fired when a tile is requested and starts loading.
tileerror TileErrorEvent Fired when there is an error loading a tile.
tileload TileEvent Fired when a tile loads.
load Event Fired when the grid layer loaded all visible tiles.
Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
Событие Данные Описание
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы

Метод Возвращает Описание
setUrl(<String> url, <Boolean> noRedraw?) this

Обновляет шаблон URL слоя и перерисовывает его (если noRedraw установлено в true). Если URL не изменился, слой не будет перерисован, если параметр noRedraw не установлен в false.

createTile(<Object> coords, <Function> done?) HTMLElement

Вызывается только во внутреннем режиме, переопределяет createTile() GridLayer для возврата HTML-элемента <img> с соответствующим URL изображения, заданного coords. Функция обратного вызова done вызывается, когда тайл загружен.

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

Слои, расширяющие TileLayer, могут повторно реализовать следующий метод.
Метод Возвращает Описание
getTileUrl(<Object> coords) String

Вызывается только во внутреннем режиме, возвращает URL тайла, учитывая его координаты. Классы, расширяющие TileLayer, могут переопределить эту функцию для предоставления пользовательских схем именования URL тайлов.

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

Выводит слой тайлов поверх всех других слоев тайлов.

bringToBack() this

Выводит слой тайлов под все остальные слои тайлов.

getContainer() HTMLElement

Возвращает HTML-элемент, содержащий тайлы для этого слоя.

setOpacity(<Number> opacity) this

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

setZIndex(<Number> zIndex) this

Изменяет zIndex слоя сетки.

isLoading() Boolean

Возвращает true, если какой-либо тайл в слое сетки еще не завершил загрузку.

redraw() this

Принудительно очищает все тайлы и запрашивает их заново.

getTileSize() Point

Нормализует опцию размер тайла в точку. Используется методом createTile().

Метод Возвращает Описание
addTo(<Map|LayerGroup> map) this

Добавляет слой на заданную карту или группу слоев.

remove() this

Удаляет слой с карты, на которой он сейчас активен.

removeFrom(<Map> map) this

Удаляет слой с заданной карты.

getPane(<String> name?) HTMLElement

Возвращает HTMLElement, представляющий указанный на карте слой. Если name опущен, возвращает слой для этого слоя.

getAttribution() String

Используется методом attribution control, возвращает опцию атрибуции.

Метод Возвращает Описание
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?) this

Привязывает всплывающее окно к слою с переданным content и настраивает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindPopup() this

Удаляет всплывающее окно, ранее привязанное с помощью bindPopup.

openPopup(<LatLng> latlng?) this

Открывает привязанное всплывающее окно в указанной latlng или по умолчанию, если latlng не передан.

closePopup() this

Закрывает привязанное всплывающее окно, если оно открыто.

togglePopup() this

Открывает или закрывает привязанное всплывающее окно в зависимости от его текущего состояния.

isPopupOpen() boolean

Возвращает true, если привязанное всплывающее окно открыто.

setPopupContent(<String|HTMLElement|Popup> content) this

Устанавливает содержимое привязанного всплывающего окна.

getPopup() Popup

Возвращает привязанное всплывающее окно.

Метод Возвращает Описание
bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

Привязывает подсказку к слою с переданным content и настраивает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindTooltip() this

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

openTooltip(<LatLng> latlng?) this

Открывает привязанную подсказку в указанной latlng или по умолчанию, если latlng не передан.

closeTooltip() this

Закрывает привязанную подсказку, если она открыта.

toggleTooltip() this

Открывает или закрывает привязанную подсказку в зависимости от её текущего состояния.

isTooltipOpen() boolean

Возвращает true, если привязанная подсказка открыта.

setTooltipContent(<String|HTMLElement|Tooltip> content) this

Устанавливает содержимое привязанной подсказки.

getTooltip() Tooltip

Возвращает привязанную подсказку.

Метод Возвращает Описание
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 будут в верхнем регистре.
Параметр Тип Значение по умолчанию Описание
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 для допустимых значений строки.
Опция Тип По умолчанию Описание
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, слой сетки будет отображаться только один раз при низких уровнях масштабирования. Не оказывает влияния, если система координат отображения (map CRS) не оборачивается. Может использоваться в сочетании с bounds для предотвращения запроса тайлов за пределами ограничений системы координат.
pane String 'tilePane' Map pane куда будет добавлен слой сетки.
className String '' Настраиваемое имя класса для назначения слою тайлов. По умолчанию пустое.
keepBuffer Number 2 При перемещении карты сохранять столько же строк и столбцов тайлов, прежде чем их выгружать.
Опция Тип По умолчанию Описание
attribution String null Строка, отображаемая в элементе управления атрибутами, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридической обязанностью перед правообладателями и поставщиками тайлов.

События

Событие Данные Описание
loading Event Fired when the grid layer starts loading tiles.
tileunload TileEvent Fired when a tile is removed (e.g. when a tile goes off the screen).
tileloadstart TileEvent Fired when a tile is requested and starts loading.
tileerror TileErrorEvent Fired when there is an error loading a tile.
tileload TileEvent Fired when a tile loads.
load Event Fired when the grid layer loaded all visible tiles.
Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
Событие Данные Описание
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы

Метод Возвращаемое значение Описание
setParams(<Object> params, <Boolean> noRedraw?) this

Объединяет объект с новыми параметрами и повторно запрашивает тайлы на текущем экране (если noRedraw не было установлено в значение true).

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

Метод Возвращаемое значение Описание
bringToFront() this

Выводит слой тайлов поверх всех остальных слоев тайлов.

bringToBack() this

Выводит слой тайлов под все остальные слои тайлов.

getContainer() HTMLElement

Возвращает элемент HTML, содержащий тайлы для этого слоя.

setOpacity(<Number> opacity) this

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

setZIndex(<Number> zIndex) this

Изменяет zIndex слоя сетки.

isLoading() Boolean

Возвращает true, если какой-либо тайл в слое сетки еще не завершил загрузку.

redraw() this

Принудительно очищает все тайлы и запрашивает их снова.

getTileSize() Point

Нормализует опцию tileSize в точку. Используется методом createTile().

Метод Возвращаемое значение Описание
addTo(<Map|LayerGroup> map) this

Добавляет слой на заданную карту или группу слоев.

remove() this

Удаляет слой с карты, на которой он сейчас активен.

removeFrom(<Map> map) this

Удаляет слой с данной карты.

getPane(<String> name?) HTMLElement

Возвращает HTMLElement, представляющий заданный слой на карте. Если name опущено, возвращает слой для данного слоя.

getAttribution() String

Используется методом attribution control, возвращает опцию attribution.

Метод Возвращает Описание
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?) this

Связывает всплывающее окно с слоем с переданным content и настраивает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindPopup() this

Удаляет всплывающее окно, ранее связанное с bindPopup.

openPopup(<LatLng> latlng?) this

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

closePopup() this

Закрывает всплывающее окно, привязанное к этому слою, если оно открыто.

togglePopup() this

Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния.

isPopupOpen() boolean

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

setPopupContent(<String|HTMLElement|Popup> content) this

Устанавливает содержимое всплывающего окна, связанного с этим слоем.

getPopup() Popup

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

Метод Возвращает Описание
bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

Привязывает всплывающую подсказку к слою с переданным content и настраивает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindTooltip() this

Удаляет всплывающую подсказку, ранее связанную с bindTooltip.

openTooltip(<LatLng> latlng?) this

Открывает связанную всплывающую подсказку в указанной latlng или по умолчанию в якорной точке всплывающей подсказки, если latlng не передан.

closeTooltip() this

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

toggleTooltip() this

Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от её текущего состояния.

isTooltipOpen() boolean

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

setTooltipContent(<String|HTMLElement|Tooltip> content) this

Устанавливает содержимое всплывающей подсказки, связанной с этим слоем.

getTooltip() Tooltip

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

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-обработчик (fn) к определённому типу события объекта. Вы можете необязательно указать контекст обработчика (объект, к которому будет относиться ключевое слово this). Вы также можете передать несколько типов через пробел (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар тип/обработчик, например {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

Удаляет ранее добавленную функцию-обработчик. Если функция не указана, она удалит все обработчики этого конкретного события из объекта. Обратите внимание, что если вы передали пользовательский контекст в on, вы должны передать тот же контекст в off для удаления обработчика.

off(<Object> eventMap) this

Удаляет набор пар тип/обработчик.

off() this

Удаляет все обработчики всех событий в объекте.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Вызывает событие указанного типа. Вы можете необязательно предоставить объект данных — первый аргумент функции-обработчика будет содержать его свойства. Событие необязательно может быть распространено на родительские события.

listens(<String> type) Boolean

Возвращает true , если для определенного типа события есть какие-либо обработчики.

once(…) this

Ведёт себя как on(…), за исключением того, что обработчик будет вызван только один раз, а затем удалён.

addEventParent(<Evented> obj) this

Добавляет родителя события — Evented, который получит распространяемые события

removeEventParent(<Evented> obj) this

Удаляет родителя события, так что он перестанет получать распространяемые события

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

ImageOverlay

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

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

var imageUrl = 'http://www.lib.utexas.edu/maps/historical/newark_nj_1922.jpg',
    imageBounds = [[40.712216, -74.22655], [40.773941, -74.12544]];
L.imageOverlay(imageUrl, imageBounds).addTo(map);

Создание

Фабрика Описание
L.imageOverlay(<String> imageUrl, <LatLngBounds> bounds, <ImageOverlay options> options?) Создаёт объект наложения изображения на основе URL изображения и географических границ, к которым он привязан.

Параметры

Параметр Тип Значение по умолчанию Описание
opacity Number 1.0 Непрозрачность слоя наложения изображения.
alt String '' Текст для атрибута alt изображения (полезно для доступности).
interactive Boolean false Если true, наложение изображения будет генерировать события мыши при нажатии или наведении курсора.
crossOrigin Boolean|String false Добавлять ли атрибут crossOrigin к изображению. Если предоставлена строка, атрибут crossOrigin изображения будет установлен в предоставленную строку. Это необходимо, если вы хотите получить данные пикселей изображения. Обратитесь к Настройкам CORS для допустимых значений строк.
errorOverlayUrl String '' URL наложения изображения, которое будет показано вместо наложения изображения, не загруженного по каким-либо причинам.
zIndex Number 1 Явное значение zIndex слоя наложения.
className String '' Пользовательское имя класса, которое будет присвоено изображению. По умолчанию пустое.
Параметр Тип Значение по умолчанию Описание
bubblingMouseEvents Boolean true Если true, событие мыши на этом слое будет активировать то же самое событие на карте (если не используется L.DomEvent.stopPropagation).
Параметр Тип Значение по умолчанию Описание
pane String 'overlayPane' По умолчанию слой будет добавлен в панель наложений карты. Переопределение этого параметра по умолчанию поместит слой на другую панель.
attribution String null Строка, которая будет отображаться в элементе управления подписью, например "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридическим обязательством по отношению к правообладателям и поставщикам плиток.

События

Событие Данные Описание
load Event Fired when the ImageOverlay layer has loaded its image
error Event Fired when the ImageOverlay layer fails to load its image
END_OF_DOCUMENT_MARKER
Событие Данные Описание
click MouseEvent Fired when the user clicks (or taps) the layer.
dblclick MouseEvent Fired when the user double-clicks (or double-taps) the layer.
mousedown MouseEvent Fired when the user pushes the mouse button on the layer.
mouseup MouseEvent Fired when the user releases the mouse button pushed on the layer.
mouseover MouseEvent Fired when the mouse enters the layer.
mouseout MouseEvent Fired when the mouse leaves the layer.
contextmenu MouseEvent Fired when the user right-clicks on the layer, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).
Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
Событие Данные Описание
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы

Метод Возвращает Описание
setOpacity(<Number> opacity) this

Устанавливает непрозрачность наложения.

bringToFront() this

Выводит слой поверх всех наложений.

bringToBack() this

Выводит слой под все наложения.

setUrl(<String> url) this

Изменяет URL изображения.

setBounds(<LatLngBounds> bounds) this

Обновление границ, которые охватывает этот ImageOverlay

setZIndex(<Number> value) this

Изменяет zIndex наложения изображения.

getBounds() LatLngBounds

Получение границ, которые охватывает этот ImageOverlay

getElement() HTMLElement

Возвращает экземпляр HTMLImageElement, используемый этим наложением.

Метод Возвращает Описание
addTo(<Map|LayerGroup> map) this

Добавляет слой на заданную карту или группу слоев.

remove() this

Удаляет слой с карты, на которой он сейчас активен.

removeFrom(<Map> map) this

Удаляет слой с указанной карты

getPane(<String> name?) HTMLElement

Возвращает HTMLElement, представляющий собой именованный слой на карте. Если name опущено, возвращает слой для этого слоя.

getAttribution() String

Используется attribution control, возвращает вариант атрибуции.

Метод Возвращает Описание
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?) this

Связывает всплывающее окно со слоем с переданным content и настраивает необходимые обработчики событий. Если передано Function, оно получит слой в качестве первого аргумента и должно вернуть String или HTMLElement.

unbindPopup() this

Удаляет всплывающее окно, ранее связанное с bindPopup.

openPopup(<LatLng> latlng?) this

Открывает связанное всплывающее окно в указанной latlng или в стандартной точке привязки всплывающего окна, если latlng не передано.

closePopup() this

Закрывает связанное всплывающее окно, если оно открыто.

togglePopup() this

Открывает или закрывает связанное всплывающее окно в зависимости от его текущего состояния.

isPopupOpen() boolean

Возвращает true если связанное всплывающее окно в данный момент открыто.

setPopupContent(<String|HTMLElement|Popup> content) this

Устанавливает содержимое связанного всплывающего окна.

getPopup() Popup

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

Метод Возвращает Описание
bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

Связывает подсказку со слоем с переданным content и настраивает необходимые обработчики событий. Если передано Function, оно получит слой в качестве первого аргумента и должно вернуть String или HTMLElement.

unbindTooltip() this

Удаляет подсказку, ранее связанную с bindTooltip.

openTooltip(<LatLng> latlng?) this

Открывает связанную подсказку в указанной latlng или в стандартной точке привязки подсказки, если latlng не передано.

closeTooltip() this

Закрывает связанную подсказку, если она открыта.

toggleTooltip() this

Открывает или закрывает связанную подсказку в зависимости от её текущего состояния.

isTooltipOpen() boolean

Возвращает true если связанная подсказка в данный момент открыта.

setTooltipContent(<String|HTMLElement|Tooltip> content) this

Устанавливает содержимое связанной подсказки.

getTooltip() Tooltip

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

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-обработчик (fn) к определенному типу события объекта. Можно указать контекст обработчика (объект, к которому будет указывать ключевое слово this). Также можно передать несколько типов через пробел (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар тип/обработчик, например {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

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

off(<Object> eventMap) this

Удаляет набор пар тип/обработчик.

off() this

Удаляет все обработчики всех событий объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Вызывает событие указанного типа. Можно передать объект данных — свойства объекта будут доступны в качестве первого аргумента функции-обработчика. Событие может быть распространено на родительские элементы.

listens(<String> type) Boolean

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

once(…) this

Ведёт себя как on(…), за исключением того, что обработчик будет вызван только один раз и затем удален.

addEventParent(<Evented> obj) this

Добавляет родительский элемент события — Evented, который будет получать распространяемые события

removeEventParent(<Evented> obj) this

Удаляет родительский элемент события, так что он перестанет получать распространяемые события

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

VideoOverlay

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

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

var videoUrl = 'https://www.mapbox.com/bites/00188/patricia_nasa.webm',
    videoBounds = [[ 32, -130], [ 13, -100]];
L.videoOverlay(videoUrl, videoBounds ).addTo(map);

Создание

Фабрика Описание
L.videoOverlay(<String|Array|HTMLVideoElement> video, <LatLngBounds> bounds, <VideoOverlay options> options?) Создает объект наложения изображения по заданному URL видео (или массиву URL или даже элементу видео) и связанным географическим границам.

Параметры

Параметр Тип Значение по умолчанию Описание
autoplay Boolean true Начинать воспроизведение видео автоматически при загрузке.
loop Boolean true Видео будет повторяться с начала при воспроизведении.
Параметр Тип Значение по умолчанию Описание
opacity Number 1.0 Непрозрачность наложения изображения.
alt String '' Текст для атрибута alt изображения (полезно для доступности).
interactive Boolean false Если true, наложение изображения будет генерировать события мыши при клике или наведении.
crossOrigin Boolean|String false Добавить атрибут crossOrigin к изображению. Если строка, атрибут crossOrigin изображения будет установлен на переданную строку. Это необходимо, если вы хотите получить доступ к пиксельным данным изображения. Обратитесь к Настройки CORS для допустимых значений строк.
errorOverlayUrl String '' URL изображения-замещения, отображаемого вместо не загруженного наложения.
zIndex Number 1 Явное значение zIndex наложения.
className String '' Пользовательское имя класса для назначения изображению. По умолчанию пустое.
Параметр Тип Значение по умолчанию Описание
bubblingMouseEvents Boolean true Если true, событие мыши на этом слое вызовет то же событие на карте (если не используется L.DomEvent.stopPropagation).
Параметр Тип Значение по умолчанию Описание
pane String 'overlayPane' По умолчанию слой добавляется на панель наложения карты overlay pane. Если этот параметр переопределён, слой будет размещён на другой панели по умолчанию.
attribution String null Строка, отображаемая в блоке атрибуции, например, "© OpenStreetMap contributors". Описывает данные слоя и часто является юридической обязанностью по отношению к правообладателям и поставщикам плиток.

События

Событие Данные Описание
load Event Fired when the video has finished loading the first frame
Событие Данные Описание
error Event Fired when the ImageOverlay layer fails to load its image
Событие Данные Описание
click MouseEvent Fired when the user clicks (or taps) the layer.
dblclick MouseEvent Fired when the user double-clicks (or double-taps) the layer.
mousedown MouseEvent Fired when the user pushes the mouse button on the layer.
mouseup MouseEvent Fired when the user releases the mouse button pushed on the layer.
mouseover MouseEvent Fired when the mouse enters the layer.
mouseout MouseEvent Fired when the mouse leaves the layer.
contextmenu MouseEvent Fired when the user right-clicks on the layer, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).
Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
Событие Данные Описание
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы

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

Возвращает экземпляр HTMLVideoElement, используемый этим наложением.

Метод Возвращает Описание
setOpacity(<Number> opacity) this

Устанавливает непрозрачность наложения.

bringToFront() this

Выводит слой поверх всех других наложений.

bringToBack() this

Выводит слой под все остальные наложения.

setUrl(<String> url) this

Изменяет URL изображения.

setBounds(<LatLngBounds> bounds) this

Обновляет границы, которые охватывает данное наложение изображения.

setZIndex(<Number> value) this

Изменяет zIndex наложения изображения.

getBounds() LatLngBounds

Получить границы, которые охватывает это наложение изображения.

Метод Возвращает Описание
addTo(<Map|LayerGroup> map) this

Добавляет слой к заданной карте или группе слоёв.

remove() this

Удаляет слой с карты, на которой он сейчас активен.

removeFrom(<Map> map) this

Удаляет слой с заданной карты.

getPane(<String> name?) HTMLElement

Возвращает HTMLElement, представляющее именованный слой на карте. Если name опущено, возвращает слой для данного слоя.

getAttribution() String

Используется attribution control, возвращает опцию атрибуции.

Метод Возвращает Описание
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?) this

Привязывает всплывающее окно к слою с переданным content и настраивает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindPopup() this

Удаляет всплывающее окно, ранее привязанное с помощью bindPopup.

openPopup(<LatLng> latlng?) this

Открывает привязанное всплывающее окно в указанной latlng или по умолчанию, если latlng не указан.

closePopup() this

Закрывает всплывающее окно, привязанное к этому слою, если оно открыто.

togglePopup() this

Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния.

isPopupOpen() boolean

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

setPopupContent(<String|HTMLElement|Popup> content) this

Устанавливает содержимое всплывающего окна, привязанного к этому слою.

getPopup() Popup

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

Метод Возвращает Описание
bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

Привязывает подсказку к слою с переданным content и настраивает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindTooltip() this

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

openTooltip(<LatLng> latlng?) this

Открывает привязанную подсказку в указанной latlng или по умолчанию, если latlng не указан.

closeTooltip() this

Закрывает подсказку, привязанную к этому слою, если она открыта.

toggleTooltip() this

Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от её текущего состояния.

isTooltipOpen() boolean

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

setTooltipContent(<String|HTMLElement|Tooltip> content) this

Устанавливает содержимое подсказки, привязанной к этому слою.

getTooltip() Tooltip

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

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-слушатель (fn) к определённому типу события объекта. Можно указать контекст слушателя (объект, к которому будет относиться this). Также можно передать несколько типов через пробел (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар тип/слушатель, например, {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

Удаляет ранее добавленную функцию-слушателя. Если функция не указана, удаляются все слушатели данного типа события от объекта. Обратите внимание, что если вы передали пользовательский контекст в on, вы должны передать тот же контекст в off для удаления слушателя.

off(<Object> eventMap) this

Удаляет набор пар тип/слушатель.

off() this

Удаляет всех слушателей всех событий объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Вызывает событие указанного типа. Можно дополнительно передать объект данных — свойства этого объекта будут содержаться в первом аргументе функции-слушателя. Событие можно дополнительно распространить на родительские события.

listens(<String> type) Boolean

Возвращает true, если для определённого типа события есть прикреплённые слушатели.

once(…) this

Ведёт себя как on(…), за исключением того, что слушатель будет вызван один раз, а затем удалён.

addEventParent(<Evented> obj) this

Добавляет родительский обработчик событий — Evented, который получит распространяемые события.

removeEventParent(<Evented> obj) this

Удаляет родительский обработчик событий, поэтому он перестанет получать распространяемые события.

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

Путь

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

Опции

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

События

Событие Данные Описание
click MouseEvent Fired when the user clicks (or taps) the layer.
dblclick MouseEvent Fired when the user double-clicks (or double-taps) the layer.
mousedown MouseEvent Fired when the user pushes the mouse button on the layer.
mouseup MouseEvent Fired when the user releases the mouse button pushed on the layer.
mouseover MouseEvent Fired when the mouse enters the layer.
mouseout MouseEvent Fired when the mouse leaves the layer.
contextmenu MouseEvent Fired when the user right-clicks on the layer, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).
Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
Событие Данные Описание
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы

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

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

setStyle(<Path options> style) this

Изменяет внешний вид пути на основе опций в объекте Path options.

bringToFront() this

Выводит слой на передний план всех слоев пути.

bringToBack() this

Выводит слой на задний план всех слоев пути.

Метод Возвращает Описание
addTo(<Map|LayerGroup> map) this

Добавляет слой к заданной карте или группе слоев.

remove() this

Удаляет слой с карты, на которой он сейчас активен.

removeFrom(<Map> map) this

Удаляет слой с заданной карты.

getPane(<String> name?) HTMLElement

Возвращает HTMLElement, представляющий указанный слой на карте. Если name опущено, возвращает слой для данного слоя.

getAttribution() String

Используется для attribution control, возвращает опцию атрибуции.

Метод Возвращает Описание
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?) this

Связывает всплывающее окно со слоем с переданным content, и настраивает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindPopup() this

Удаляет всплывающее окно, ранее привязанное с помощью bindPopup.

openPopup(<LatLng> latlng?) this

Открывает привязанное всплывающее окно в заданной latlng или в стандартном якоре всплывающего окна, если переданный latlng отсутствует.

closePopup() this

Закрывает привязанное к этому слою всплывающее окно, если оно открыто.

togglePopup() this

Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния.

isPopupOpen() boolean

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

setPopupContent(<String|HTMLElement|Popup> content) this

Устанавливает содержимое всплывающего окна, привязанного к этому слою.

getPopup() Popup

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

Метод Возвращает Описание
bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

Привязывает всплывающую подсказку к слою с переданным content и настраивает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindTooltip() this

Удаляет ранее привязанную всплывающую подсказку с bindTooltip.

openTooltip(<LatLng> latlng?) this

Открывает привязанную всплывающую подсказку в указанной latlng или по умолчанию в якорной точке всплывающей подсказки, если latlng не передан.

closeTooltip() this

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

toggleTooltip() this

Открывает или закрывает привязанную к этому слою всплывающую подсказку в зависимости от её текущего состояния.

isTooltipOpen() boolean

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

setTooltipContent(<String|HTMLElement|Tooltip> content) this

Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.

getTooltip() Tooltip

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

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-обработчик (fn) к определенному типу события объекта. Вы можете указать контекст обработчика (объект, на который будет указывать ключевое слово this). Также вы можете передать несколько типов через пробел (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар тип/обработчик, например, {click: onClick, mousemove: onMouseMove}.

off(<String> type, <Function> fn?, <Object> context?) this

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

off(<Object> eventMap) this

Удаляет набор пар тип/обработчик.

off() this

Удаляет все обработчики всех событий объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Вызывает событие указанного типа. Вы можете дополнительно передать объект данных — свойства этого объекта будут первым аргументом функции-обработчика. Событие может быть дополнительно передано родительским объектам.

listens(<String> type) Boolean

Возвращает true, если для определенного типа события есть какие-либо прикрепленные обработчики.

once(…) this

Ведёт себя как on(…), за исключением того, что обработчик будет вызван только один раз, а затем удалён.

addEventParent(<Evented> obj) this

Добавляет родительский обработчик событий — объект Evented, который будет получать передаваемые события.

removeEventParent(<Evented> obj) this

Удаляет родительский обработчик событий, чтобы он перестал получать передаваемые события.

addEventListener(…) this

Псевдоним для on(…).

removeEventListener(…) this

Псевдоним для off(…).

clearAllEventListeners(…) this

Псевдоним для off().

addOneTimeEventListener(…) this

Псевдоним для once(…).

fireEvent(…) this

Псевдоним для fire(…).

hasEventListeners(…) Boolean

Псевдоним для listens(…).

Ломаная линия

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

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

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

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

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

Создание

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

Опции

Опция Тип Значение по умолчанию Описание
smoothFactor Number 1.0 Степень упрощения полилинии на каждом уровне масштабирования. Большее значение означает лучшую производительность и более плавный вид, а меньшее значение — более точное отображение.
noClip Boolean false Отключить обрезку полилиний.
Опция Тип Значение по умолчанию Описание
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 Fired when the user clicks (or taps) the layer.
dblclick MouseEvent Fired when the user double-clicks (or double-taps) the layer.
mousedown MouseEvent Fired when the user pushes the mouse button on the layer.
mouseup MouseEvent Fired when the user releases the mouse button pushed on the layer.
mouseover MouseEvent Fired when the mouse enters the layer.
mouseout MouseEvent Fired when the mouse leaves the layer.
contextmenu MouseEvent Fired when the user right-clicks on the layer, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).
Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
Событие Данные Описание
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы полилинии

Метод Возвращает Описание
toGeoJSON(<Number> precision) Object

Возвращает представление полилинии в формате GeoJSON (как объект GeoJSON LineString или MultiLineString Feature).

getLatLngs() LatLng[]

Возвращает массив точек в пути или вложенные массивы точек в случае многолинейной полилинии.

setLatLngs(<LatLng[]> latlngs) this

Заменяет все точки в полилинии заданным массивом географических точек.

isEmpty() Boolean

Возвращает true если у полилинии нет точек LatLng.

closestLayerPoint(<Point> p) Point

Возвращает точку, ближайшую к p на полилинии.

getCenter() LatLng

Возвращает центр (центроид) полилинии.

getBounds() LatLngBounds

Возвращает LatLngBounds пути.

addLatLng(<LatLng> latlng) this

Добавляет заданную точку в полилинию. По умолчанию добавляет к первому кольцу полилинии в случае многолинейной полилинии, но это можно переопределить, передав определенное кольцо в качестве массива LatLng (к которому вы можете ранее получить доступ с помощью getLatLngs).

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

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

setStyle(<Path options> style) this

Изменяет внешний вид пути на основе опций в объекте Path options.

bringToFront() this

Выводит слой на верхний уровень всех слоев пути.

bringToBack() this

Выводит слой на нижний уровень всех слоев пути.

Метод Возвращает Описание
addTo(<Map|LayerGroup> map) this

Добавляет слой к заданной карте или группе слоев.

remove() this

Удаляет слой с карты, на которой он сейчас активен.

removeFrom(<Map> map) this

Удаляет слой с заданной карты

getPane(<String> name?) HTMLElement

Возвращает HTMLElement, представляющий указанную панель на карте. Если name опущено, возвращает панель для этого слоя.

getAttribution() String

Используется для attribution control, возвращает опцию атрибуции.

Метод Возвращает Описание
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?) this

Привязывает всплывающее окно к слою с переданным content и устанавливает необходимые обработчики событий. Если передается Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindPopup() this

Удаляет привязанное всплывающее окно с помощью bindPopup.

openPopup(<LatLng> latlng?) this

Открывает привязанное всплывающее окно в указанной latlng или в стандартной точке привязки всплывающего окна, если latlng не передан.

closePopup() this

Закрывает привязанное всплывающее окно, если оно открыто.

togglePopup() this

Открывает или закрывает привязанное всплывающее окно в зависимости от его текущего состояния.

isPopupOpen() boolean

Возвращает true если привязанное всплывающее окно в настоящее время открыто.

setPopupContent(<String|HTMLElement|Popup> content) this

Устанавливает содержимое всплывающего окна, привязанного к этому слою.

getPopup() Popup

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

Метод Возвращает Описание
bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

Привязывает подсказку к слою с переданным content и настраивает необходимые обработчики событий. Если передается Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindTooltip() this

Удаляет привязанную подсказку с помощью bindTooltip.

openTooltip(<LatLng> latlng?) this

Открывает привязанную подсказку в указанной latlng или в стандартной точке привязки подсказки, если latlng не передан.

closeTooltip() this

Закрывает привязанную подсказку, если она открыта.

toggleTooltip() this

Открывает или закрывает привязанную подсказку в зависимости от ее текущего состояния.

isTooltipOpen() boolean

Возвращает true если привязанная подсказка в настоящее время открыта.

setTooltipContent(<String|HTMLElement|Tooltip> content) this

Устанавливает содержимое подсказки, привязанной к этому слою.

getTooltip() Tooltip

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

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-обработчик (fn) к определенному типу события объекта. Вы можете необязательно указать контекст обработчика (объект, к которому будет относиться ключевое слово this). Вы также можете передать несколько типов через пробел (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар тип/обработчик, например {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

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

off(<Object> eventMap) this

Удаляет набор пар тип/обработчик.

off() this

Удаляет всех обработчиков всех событий объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Вызывает событие указанного типа. Вы можете необязательно указать объект данных — первый аргумент функции-обработчика будет содержать его свойства. Событие необязательно может быть распространено на родительские события.

listens(<String> type) Boolean

Возвращает true если для определенного типа события есть какие-либо присоединенные обработчики.

once(…) this

Ведёт себя как on(…), за исключением того, что обработчик будет вызван один раз и затем удалён.

addEventParent(<Evented> obj) this

Добавляет родительское событие — Evented, которое будет получать распространяемые события

removeEventParent(<Evented> obj) this

Удаляет родительское событие, поэтому оно перестанет получать распространяемые события

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

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

Класс для отрисовки полигональных наложений на карте. Расширяет Polyline. Обратите внимание, что точки, которые вы передаёте при создании многоугольника, не должны иметь дополнительной последней точки, равной первой — лучше отфильтровать такие точки.

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

// create a red polygon from an array of LatLng points
var latlngs = [[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]];
var polygon = L.polygon(latlngs, {color: 'red'}).addTo(map);
// zoom the map to the polygon
map.fitBounds(polygon.getBounds());

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

var latlngs = [
  [[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]], // outer ring
  [[37.29, -108.58],[40.71, -108.58],[40.71, -102.50],[37.29, -102.50]] // hole
];

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

var latlngs = [
  [ // first polygon
    [[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]], // outer ring
    [[37.29, -108.58],[40.71, -108.58],[40.71, -102.50],[37.29, -102.50]] // hole
  ],
  [ // second polygon
    [[41, -111.03],[45, -111.04],[45, -104.05],[41, -104.05]]
  ]
];

Создание

Фабрика Описание
L.polygon(<LatLng[]> latlngs, <Polyline options> options?)

Параметры

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

События

Событие Данные Описание
click MouseEvent Fired when the user clicks (or taps) the layer.
dblclick MouseEvent Fired when the user double-clicks (or double-taps) the layer.
mousedown MouseEvent Fired when the user pushes the mouse button on the layer.
mouseup MouseEvent Fired when the user releases the mouse button pushed on the layer.
mouseover MouseEvent Fired when the mouse enters the layer.
mouseout MouseEvent Fired when the mouse leaves the layer.
contextmenu MouseEvent Fired when the user right-clicks on the layer, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).
Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
END_OF_DOCUMENT_MARKER
Событие Данные Описание
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы

Метод Возвращает Описание
toGeoJSON(<Number> precision) Object

Возвращает представление многоугольника в формате GeoJSON (как GeoJSON Polygon или MultiPolygon Feature).

Метод Возвращает Описание
getLatLngs() LatLng[]

Возвращает массив точек в пути или вложенные массивы точек в случае многократной полилинии.

setLatLngs(<LatLng[]> latlngs) this

Заменяет все точки полилинии заданным массивом географических точек.

isEmpty() Boolean

Возвращает true, если у полилинии нет LatLng.

closestLayerPoint(<Point> p) Point

Возвращает точку, ближайшую к p на полилинии.

getCenter() LatLng

Возвращает центр (центроид) полилинии.

getBounds() LatLngBounds

Возвращает LatLngBounds пути.

addLatLng(<LatLng> latlng) this

Добавляет заданную точку к полилинии. По умолчанию, добавляет к первому кольцу полилинии в случае многократной полилинии, но может быть переопределено путем передачи определённого кольца как массив LatLng (который можно получить с помощью getLatLngs).

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

Перерисовывает слой. Иногда полезно после изменения координат, используемых путём.

setStyle(<Path options> style) this

Изменяет внешний вид пути на основе опций в объекте Path options.

bringToFront() this

Выводит слой поверх всех слоев пути.

bringToBack() this

Выводит слой под все слои пути.

Метод Возвращает Описание
addTo(<Map|LayerGroup> map) this

Добавляет слой на заданную карту или группу слоёв.

remove() this

Удаляет слой с карты, на которой он сейчас активен.

removeFrom(<Map> map) this

Удаляет слой с заданной карты

getPane(<String> name?) HTMLElement

Возвращает HTMLElement, представляющий именованный слой на карте. Если name опущено, возвращает слой для этого слоя.

getAttribution() String

Используется attribution control, возвращает параметр атрибуции.

Метод Возвращает Описание
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?) this

Связывает всплывающую подсказку со слоем с переданным content и устанавливает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindPopup() this

Удаляет всплывающую подсказку, ранее привязанную с помощью bindPopup.

openPopup(<LatLng> latlng?) this

Открывает привязанную всплывающую подсказку в указанной latlng или по умолчанию, если не передан latlng.

closePopup() this

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

togglePopup() this

Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от текущего состояния.

isPopupOpen() boolean

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

setPopupContent(<String|HTMLElement|Popup> content) this

Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.

getPopup() Popup

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

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

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

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-обработчик (fn) для определённого типа события объекта. Можно указать контекст обработчика (объект, к которому будет относиться this). Также можно передать несколько типов, разделённых пробелами (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар тип/обработчик, например {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

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

off(<Object> eventMap) this

Удаляет набор пар тип/обработчик.

off() this

Удаляет всех обработчиков для всех событий объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Вызывает событие указанного типа. Можно передать объект данных — свойства объекта будут содержаться в первом аргументе функции-обработчика. Событие может быть передано родительским элементам.

listens(<String> type) Boolean

Возвращает true если для определённого типа события есть какие-либо обработчики.

once(…) this

Поведение аналогично on(…), за исключением того, что обработчик будет вызван один раз и затем удалён.

addEventParent(<Evented> obj) this

Добавляет родительский элемент события - Evented, который будет получать передаваемые события

removeEventParent(<Evented> obj) this

Удаляет родительский элемент события, чтобы он перестал получать передаваемые события

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

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

Класс для рисования прямоугольных наложений на карте. Расширяет Polygon.

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

// define rectangle geographical bounds
var bounds = [[54.559322, -5.767822], [56.1210604, -3.021240]];
// create an orange rectangle
L.rectangle(bounds, {color: "#ff7800", weight: 1}).addTo(map);
// zoom the map to the rectangle bounds
map.fitBounds(bounds);

Создание

Фабрика Описание
L.rectangle(<LatLngBounds> latLngBounds, <Polyline options> options?)

Параметры

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

События

Событие Данные Описание
click MouseEvent Fired when the user clicks (or taps) the layer.
dblclick MouseEvent Fired when the user double-clicks (or double-taps) the layer.
mousedown MouseEvent Fired when the user pushes the mouse button on the layer.
mouseup MouseEvent Fired when the user releases the mouse button pushed on the layer.
mouseover MouseEvent Fired when the mouse enters the layer.
mouseout MouseEvent Fired when the mouse leaves the layer.
contextmenu MouseEvent Fired when the user right-clicks on the layer, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).
Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
Событие Данные Описание
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы прямоугольника

Метод Возвращает Описание
setBounds(<LatLngBounds> latLngBounds) this

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

Метод Возвращает Описание
toGeoJSON(<Number> precision) Object

Возвращает представление многоугольника в формате GeoJSON (как GeoJSON Polygon или MultiPolygon Feature).

Метод Возвращает Описание
getLatLngs() LatLng[]

Возвращает массив точек пути или вложенные массивы точек в случае многолинейной полилинии.

setLatLngs(<LatLng[]> latlngs) this

Заменяет все точки полилинии заданным массивом географических точек.

isEmpty() Boolean

Возвращает true, если у полилинии нет точек LatLng.

closestLayerPoint(<Point> p) Point

Возвращает точку, ближайшую к p на полилинии.

getCenter() LatLng

Возвращает центр (центроид) полилинии.

getBounds() LatLngBounds

Возвращает LatLngBounds пути.

addLatLng(<LatLng> latlng) this

Добавляет заданную точку в полилинию. По умолчанию добавляет к первому кольцу полилинии в случае многолинейной полилинии, но можно переопределить, передав определенное кольцо в виде массива LatLng (к которому вы можете получить доступ с помощью getLatLngs).

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

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

setStyle(<Path options> style) this

Изменяет внешний вид пути на основе опций в объекте Path options.

bringToFront() this

Выводит слой поверх всех слоев пути.

bringToBack() this

Выводит слой под все слои пути.

Метод Возвращает Описание
addTo(<Map|LayerGroup> map) this

Добавляет слой на заданную карту или группу слоев.

remove() this

Удаляет слой с карты, на которой он сейчас активен.

removeFrom(<Map> map) this

Удаляет слой с заданной карты

getPane(<String> name?) HTMLElement

Возвращает HTMLElement, представляющий именованный слой на карте. Если name опущено, возвращает слой для данного слоя.

getAttribution() String

Используется attribution control, возвращает опцию атрибуции.

Метод Возвращает Описание
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?) this

Связывает всплывающую подсказку со слоем с переданным content и настраивает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindPopup() this

Удаляет всплывающую подсказку, ранее связанную с bindPopup.

openPopup(<LatLng> latlng?) this

Открывает привязанную всплывающую подсказку в указанной latlng или по умолчанию, если latlng не передан.

closePopup() this

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

togglePopup() this

Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от текущего состояния.

isPopupOpen() boolean

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

setPopupContent(<String|HTMLElement|Popup> content) this

Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.

getPopup() Popup

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

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

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

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-слушатель (fn) к определённому типу события объекта. Вы можете указать контекст слушателя (объект, к которому будет относиться ключевое слово this). Также можно передать несколько типов, разделённых пробелами (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар тип/слушатель, например {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

Удаляет ранее добавленную функцию-слушатель. Если функция не указана, будут удалены все слушатели этого конкретного события от объекта. Обратите внимание, что если вы передали пользовательский контекст для on, вы должны передать тот же контекст для off, чтобы удалить слушателя.

off(<Object> eventMap) this

Удаляет набор пар тип/слушатель.

off() this

Удаляет всех слушателей всех событий объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Вызывает событие указанного типа. Вы можете дополнительно указать объект данных — первое аргумент функции-слушателя будет содержать его свойства. Событие может быть необязательно распространено на родительские события.

listens(<String> type) Boolean

Возвращает true если для определённого типа события есть присоединённые слушатели.

once(…) this

Ведёт себя как on(…), за исключением того, что слушатель будет вызван только один раз и затем удалён.

addEventParent(<Evented> obj) this

Добавляет родительское событие — Evented, которое будет получать распространяемые события.

removeEventParent(<Evented> obj) this

Удаляет родительское событие, чтобы оно перестало получать распространяемые события.

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

Круг

Класс для рисования круговых наложений на карте. Расширяет CircleMarker. Представляет собой приближение и начинает отклоняться от реального круга ближе к полюсам (из-за искажений проекции).

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

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

Создание

Фабрика Описание
L.circle(<LatLng> latlng, <Circle options> options?) Создаёт объект круга на основе географической точки и объекта опций, содержащего радиус круга.
L.circle(<LatLng> latlng, <Number> radius, <Circle options> options?) Устаревший способ создания круга, для совместимости с кодом 0.7.x. Не использовать в новых приложениях или плагинах.

Параметры

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

События

Событие Данные Описание
click MouseEvent Fired when the user clicks (or taps) the layer.
dblclick MouseEvent Fired when the user double-clicks (or double-taps) the layer.
mousedown MouseEvent Fired when the user pushes the mouse button on the layer.
mouseup MouseEvent Fired when the user releases the mouse button pushed on the layer.
mouseover MouseEvent Fired when the mouse enters the layer.
mouseout MouseEvent Fired when the mouse leaves the layer.
contextmenu MouseEvent Fired when the user right-clicks on the layer, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).
Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
Событие Данные Описание
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы

Метод Возвращает Описание
setRadius(<Number> radius) this

Устанавливает радиус окружности. Единицы измерения - метры.

getRadius() Number

Возвращает текущий радиус окружности. Единицы измерения - метры.

getBounds() LatLngBounds

Возвращает LatLngBounds пути.

Метод Возвращает Описание
toGeoJSON(<Number> precision) Object

Возвращает представление маркера окружности в формате GeoJSON (как объект GeoJSON Point Feature).

setLatLng(<LatLng> latLng) this

Устанавливает позицию маркера окружности в новом месте.

getLatLng() LatLng

Возвращает текущее географическое положение маркера окружности.

Метод Возвращает Описание
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, возвращает опцию атрибуции.

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

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

... (rest of the translated HTML) ...

CircleMarker

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

Создание

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

Опции

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

События

Событие Данные Описание
click MouseEvent Fired when the user clicks (or taps) the layer.
dblclick MouseEvent Fired when the user double-clicks (or double-taps) the layer.
mousedown MouseEvent Fired when the user pushes the mouse button on the layer.
mouseup MouseEvent Fired when the user releases the mouse button pushed on the layer.
mouseover MouseEvent Fired when the mouse enters the layer.
mouseout MouseEvent Fired when the mouse leaves the layer.
contextmenu MouseEvent Fired when the user right-clicks on the layer, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).
Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
Событие Данные Описание
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы

Метод Возвращает Описание
toGeoJSON(<Number> precision) Object

Возвращает GeoJSON представление маркера круга (как GeoJSON Point Feature).

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

Используется элементом управления подписей, возвращает опцию подписи.

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

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

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-обработчик (fn) к определенному типу события объекта. Можно указать контекст обработчика (объект, к которому будет относиться this). Также можно передать несколько типов через пробел (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар тип/обработчик, например {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

Удаляет ранее добавленную функцию-обработчик. Если функция не указана, удалит все обработчики этого события для объекта. Обратите внимание, что если вы передали пользовательский контекст в on, вы должны передать тот же контекст в off, чтобы удалить обработчик.

off(<Object> eventMap) this

Удаляет набор пар тип/обработчик.

off() this

Удаляет все обработчики всех событий объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Вызывает событие указанного типа. Можно передать объект данных — свойства этого объекта будут первым аргументом функции-обработчика. Событие может быть передано родительским элементам.

listens(<String> type) Boolean

Возвращает true если для определенного типа события есть какие-либо обработчики.

once(…) this

Ведёт себя как on(…), за исключением того, что обработчик будет вызван один раз и затем удален.

addEventParent(<Evented> obj) this

Добавляет родительский элемент события — Evented, который будет получать передаваемые события.

removeEventParent(<Evented> obj) this

Удаляет родительский элемент события, чтобы он перестал получать передаваемые события.

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

SVG

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

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

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

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

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

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

Создание

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

Параметры

Параметр Тип Значение по умолчанию Описание
padding Number 0.1 Насколько расширяется область обрезки вокруг представления карты (относительно её размера), например, 0,1 будет составлять 10% представления карты в каждом направлении
tolerance Number 0 Насколько расширяется толерантность щелчка вокруг пути/объекта на карте
Параметр Тип Значение по умолчанию Описание
pane String 'overlayPane' По умолчанию слой будет добавлен на слой наложения карты. Переопределение этого параметра заставит слой помещаться на другой слой по умолчанию.
attribution String null Строка, отображаемая в элементе подписи, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридической обязанностью перед правообладателями и поставщиками плиток.

События

Событие Данные Описание
update Event Fired when the renderer updates its bounds, center and zoom, for example when its map has moved
Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
Событие Данные Описание
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы

Метод Возвращает Описание
addTo(<Map|LayerGroup> map) this

Добавляет слой на заданную карту или группу слоёв.

remove() this

Удаляет слой с карты, на которой он в настоящее время активен.

removeFrom(<Map> map) this

Удаляет слой с заданной карты.

getPane(<String> name?) HTMLElement

Возвращает HTMLElement, представляющий собой указанный на карте слой. Если name опущено, возвращает слой для этого слоя.

getAttribution() String

Используется attribution control, возвращает опцию атрибуции.

Метод Возвращает Описание
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?) this

Привязывает всплывающее окно к слою с переданным content и настраивает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindPopup() this

Удаляет всплывающее окно, ранее привязанное с помощью bindPopup.

openPopup(<LatLng> latlng?) this

Открывает привязанное всплывающее окно в указанной latlng или по умолчанию, если latlng не передан.

closePopup() this

Закрывает всплывающее окно, привязанное к этому слою, если оно открыто.

togglePopup() this

Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния.

isPopupOpen() boolean

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

setPopupContent(<String|HTMLElement|Popup> content) this

Устанавливает содержимое всплывающего окна, привязанного к этому слою.

getPopup() Popup

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

Метод Возвращает Описание
bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

Привязывает подсказку к слою с переданным content и настраивает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindTooltip() this

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

openTooltip(<LatLng> latlng?) this

Открывает привязанную подсказку в указанной latlng или по умолчанию, если latlng не передан.

closeTooltip() this

Закрывает подсказку, привязанную к этому слою, если она открыта.

toggleTooltip() this

Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от её текущего состояния.

isTooltipOpen() boolean

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

setTooltipContent(<String|HTMLElement|Tooltip> content) this

Устанавливает содержимое подсказки, привязанной к этому слою.

getTooltip() Tooltip

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

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-обработчик (fn) к определённому типу события объекта. Можно указать контекст обработчика (объект, на который будет указывать ключевое слово this). Также можно передать несколько типов через пробел (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар тип/обработчик, например, {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

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

off(<Object> eventMap) this

Удаляет набор пар тип/обработчик.

off() this

Удаляет всех обработчиков всех событий объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Вызывает событие указанного типа. Можно необязательно предоставить объект данных — первый аргумент функции-обработчика будет содержать его свойства. Событие можно необязательно распространить на родительские события.

listens(<String> type) Boolean

Возвращает true, если для определенного типа события есть какие-либо присоединенные обработчики.

once(…) this

Ведёт себя как on(…), за исключением того, что обработчик будет вызван один раз, а затем удалён.

addEventParent(<Evented> obj) this

Добавляет родителя события - Evented, который будет получать распространяемые события.

removeEventParent(<Evented> obj) this

Удаляет родителя события, так что он перестанет получать распространяемые события.

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

Функции

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

Canvas

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

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

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

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

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

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

Создание

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

Параметры

Параметр Тип Значение по умолчанию Описание
padding Number 0.1 Насколько расширить область обрезки вокруг области просмотра карты (относительно её размера), например, 0,1 будет составлять 10% области просмотра карты в каждом направлении.
tolerance Number 0 Насколько расширить толерантность щелчка вокруг пути/объекта на карте.
Параметр Тип Значение по умолчанию Описание
pane String 'overlayPane' По умолчанию слой будет добавлен на слой overlay pane карты. Переопределение этого параметра приведет к размещению слоя на другом слое по умолчанию.
attribution String null Строка, отображаемая в элементе атрибуции, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является обязательством перед правообладателями и поставщиками тайлов.

События

Событие Данные Описание
update Event Fired when the renderer updates its bounds, center and zoom, for example when its map has moved
END_OF_DOCUMENT_MARKER
Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
Событие Данные Описание
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы

Метод Возвращает Описание
addTo(<Map|LayerGroup> map) this

Добавляет слой на заданную карту или группу слоёв.

remove() this

Удаляет слой с карты, на которой он в данный момент активен.

removeFrom(<Map> map) this

Удаляет слой со заданной карты.

getPane(<String> name?) HTMLElement

Возвращает HTMLElement, представляющий собой именованный слой на карте. Если name опущено, возвращает слой для этого слоя.

getAttribution() String

Используется attribution control, возвращает параметр авторских прав.

Метод Возвращает Описание
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?) this

Связывает всплывающую подсказку со слоем с переданной content и настраивает необходимые обработчики событий. Если передано Function, оно получит слой в качестве первого аргумента и должно вернуть String или HTMLElement.

unbindPopup() this

Удаляет всплывающую подсказку, ранее связанную с bindPopup.

openPopup(<LatLng> latlng?) this

Открывает привязанную всплывающую подсказку в указанной latlng или по умолчанию, если latlng не указано.

closePopup() this

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

togglePopup() this

Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от текущего состояния.

isPopupOpen() boolean

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

setPopupContent(<String|HTMLElement|Popup> content) this

Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.

getPopup() Popup

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

Метод Возвращает Описание
bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

Привязывает всплывающую подсказку к слою с переданной content и настраивает необходимые обработчики событий. Если передано Function, оно получит слой в качестве первого аргумента и должно вернуть String или HTMLElement.

unbindTooltip() this

Удаляет всплывающую подсказку, ранее связанную с bindTooltip.

openTooltip(<LatLng> latlng?) this

Открывает привязанную всплывающую подсказку в указанной latlng или по умолчанию, если latlng не указано.

closeTooltip() this

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

toggleTooltip() this

Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от текущего состояния.

isTooltipOpen() boolean

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

setTooltipContent(<String|HTMLElement|Tooltip> content) this

Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.

getTooltip() Tooltip

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

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-обработчик (fn) к определённому типу события объекта. Можно необязательно указать контекст обработчика (объект, к которому будет относиться this). Можно также передать несколько типов через пробел (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар тип/обработчик, например, {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

Удаляет ранее добавленную функцию-обработчик. Если функция не указана, удаляются все обработчики данного события от объекта. Обратите внимание, если вы передали контекст в on, вы должны передать тот же контекст в off для удаления обработчика.

off(<Object> eventMap) this

Удаляет набор пар тип/обработчик.

off() this

Удаляет все обработчики всех событий объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Вызывает событие указанного типа. Можно необязательно указать объект данных — первый аргумент функции-обработчика будет содержать его свойства. Событие необязательно может быть распространено на родительские события.

listens(<String> type) Boolean

Возвращает true если для определённого типа события есть какие-либо обработчики.

once(…) this

Ведёт себя как on(…), за исключением того, что обработчик будет вызван только один раз, а затем удалён.

addEventParent(<Evented> obj) this

Добавляет родителя события - Evented, который будет получать распространяемые события.

removeEventParent(<Evented> obj) this

Удаляет родителя события, чтобы он перестал получать распространяемые события.

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

LayerGroup

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

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

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

Создание

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

Параметры

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

События

Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
Event Data Description
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы

Метод Возвращает Описание
toGeoJSON(<Number> precision) Object

Возвращает представление группы слоёв в формате GeoJSON (в виде GeoJSON FeatureCollection, GeometryCollection, или MultiPoint).

addLayer(<Layer> layer) this

Добавляет указанный слой в группу.

removeLayer(<Layer> layer) this

Удаляет указанный слой из группы.

removeLayer(<Number> id) this

Удаляет слой с заданным внутренним идентификатором из группы.

hasLayer(<Layer> layer) Boolean

Возвращает true, если указанный слой добавлен в группу.

hasLayer(<Number> id) Boolean

Возвращает true, если указанный внутренний идентификатор добавлен в группу.

clearLayers() this

Удаляет все слои из группы.

invoke(<String> methodName, …) this

Вызывает methodName для каждого слоя в группе, передавая дополнительные параметры. Не имеет эффекта, если содержащиеся слои не реализуют methodName.

eachLayer(<Function> fn, <Object> context?) this

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

group.eachLayer(function (layer) {
    layer.bindPopup('Hello');
});
getLayer(<Number> id) Layer

Возвращает слой с заданным внутренним идентификатором.

getLayers() Layer[]

Возвращает массив всех добавленных в группу слоёв.

setZIndex(<Number> zIndex) this

Вызывает setZIndex для каждого слоя в группе, передавая значение z-индекса.

getLayerId(<Layer> layer) Number

Возвращает внутренний идентификатор слоя.

Метод Возвращает Описание
addTo(<Map|LayerGroup> map) this

Добавляет слой на заданную карту или в группу слоёв.

remove() this

Удаляет слой с текущей карты.

removeFrom(<Map> map) this

Удаляет слой с заданной карты.

getPane(<String> name?) HTMLElement

Возвращает HTMLElement, представляющий собой указанный слой на карте. Если name опущено, возвращает слой для текущего слоя.

getAttribution() String

Используется attribution control, возвращает параметр атрибуции.

Метод Возвращает Описание
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?) this

Привязывает всплывающую подсказку к слою с переданным content, и настраивает необходимые обработчики событий. Если передается Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindPopup() this

Удаляет ранее привязанную всплывающую подсказку с помощью bindPopup.

openPopup(<LatLng> latlng?) this

Открывает привязанную всплывающую подсказку в указанной latlng или по умолчанию, если latlng не указан.

closePopup() this

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

togglePopup() this

Открывает или закрывает привязанную всплывающую подсказку в зависимости от её текущего состояния.

isPopupOpen() boolean

Возвращает true, если всплывающая подсказка для данного слоя открыта.

setPopupContent(<String|HTMLElement|Popup> content) this

Устанавливает содержимое всплывающей подсказки для данного слоя.

getPopup() Popup

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

Метод Возвращает Описание
bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

Привязывает подсказку к слою с переданным content, и настраивает необходимые обработчики событий. Если передается Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindTooltip() this

Удаляет ранее привязанную подсказку с помощью bindTooltip.

openTooltip(<LatLng> latlng?) this

Открывает привязанную подсказку в указанной latlng или по умолчанию, если latlng не указан.

closeTooltip() this

Закрывает привязанную подсказку, если она открыта.

toggleTooltip() this

Открывает или закрывает привязанную подсказку в зависимости от её текущего состояния.

isTooltipOpen() boolean

Возвращает true, если подсказка для данного слоя открыта.

setTooltipContent(<String|HTMLElement|Tooltip> content) this

Устанавливает содержимое подсказки для данного слоя.

getTooltip() Tooltip

Возвращает привязанную подсказку для данного слоя.

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-обработчик (fn) на конкретный тип события объекта. Необязательно указать контекст обработчика (объект, к которому будет относиться ключевое слово this). Можно также передать несколько типов через пробел (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар тип/обработчик, например {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

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

off(<Object> eventMap) this

Удаляет набор пар тип/обработчик.

off() this

Удаляет все обработчики всех событий объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

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

listens(<String> type) Boolean

Возвращает true, если для конкретного типа события есть какие-либо обработчики.

once(…) this

Ведёт себя как on(…), за исключением того, что обработчик будет срабатывать только один раз, а затем удаляться.

addEventParent(<Evented> obj) this

Добавляет родительский объект события — Evented, который будет получать распространяемые события.

removeEventParent(<Evented> obj) this

Удаляет родительский объект события, чтобы он больше не получал распространяемые события.

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

Группа объектов

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

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

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

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

Создание

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

Параметры

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

События

Событие Данные Описание
layeradd LayerEvent Fired when a layer is added to this FeatureGroup
layerremove LayerEvent Fired when a layer is removed from this FeatureGroup
Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
Событие Данные Описание
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы

Метод Возвращаемое значение Описание
setStyle(<Path options> style) this

Устанавливает заданные параметры стиля для каждого слоя группы, у которого есть метод setStyle.

bringToFront() this

Выводит группу слоёв вперёд всех остальных.

bringToBack() this

Выводит группу слоёв назад, за все остальные.

getBounds() LatLngBounds

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

Метод Возвращаемое значение Описание
toGeoJSON(<Number> precision) Object

Возвращает представление группы слоёв в формате GeoJSON (как GeoJSON FeatureCollection, GeometryCollection, или MultiPoint).

addLayer(<Layer> layer) this

Добавляет заданный слой в группу.

removeLayer(<Layer> layer) this

Удаляет заданный слой из группы.

removeLayer(<Number> id) this

Удаляет слой с заданным внутренним идентификатором из группы.

hasLayer(<Layer> layer) Boolean

Возвращает true, если заданный слой в данный момент добавлен в группу.

hasLayer(<Number> id) Boolean

Возвращает true, если заданный внутренний идентификатор в данный момент добавлен в группу.

clearLayers() this

Удаляет все слои из группы.

invoke(<String> methodName, …) this

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

eachLayer(<Function> fn, <Object> context?) this

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

group.eachLayer(function (layer) {
    layer.bindPopup('Hello');
});
getLayer(<Number> id) Layer

Возвращает слой с заданным внутренним идентификатором.

getLayers() Layer[]

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

setZIndex(<Number> zIndex) this

Вызывает setZIndex на каждом слое, содержащемся в этой группе, передавая значение z-индекса.

getLayerId(<Layer> layer) Number

Возвращает внутренний идентификатор слоя.

Метод Возвращаемое значение Описание
addTo(<Map|LayerGroup> map) this

Добавляет слой к заданной карте или группе слоёв.

remove() this

Удаляет слой с карты, на которой он в данный момент активен.

removeFrom(<Map> map) this

Удаляет слой с данной карты.

getPane(<String> name?) HTMLElement

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

getAttribution() String

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

Метод Возвращаемое значение Описание
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?) this

Связывает всплывающее окно со слоем с переданным content и настраивает необходимые обработчики событий. Если передано Function, оно получит слой в качестве первого аргумента и должно вернуть String или HTMLElement.

unbindPopup() this

Удаляет всплывающее окно, ранее привязанное с помощью bindPopup.

openPopup(<LatLng> latlng?) this

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

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 не передано.

closeTooltip() this

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

toggleTooltip() this

Открывает или закрывает всплывающую подсказку, привязанную к этому слою, в зависимости от её текущего состояния.

isTooltipOpen() boolean

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

setTooltipContent(<String|HTMLElement|Tooltip> content) this

Устанавливает содержимое всплывающей подсказки, привязанной к этому слою.

getTooltip() Tooltip

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

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-слушатель (fn) к определённому типу события объекта. Вы можете указать контекст слушателя (объект, к которому будет относиться this). Вы также можете передать несколько типов через пробел (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар тип/слушатель, например {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

Удаляет ранее добавленную функцию-слушатель. Если функция не указана, будут удалены все слушатели данного события для объекта. Обратите внимание, что если вы передали пользовательский контекст для on, вы должны передать тот же контекст для off для удаления слушателя.

off(<Object> eventMap) this

Удаляет набор пар тип/слушатель.

off() this

Удаляет всех слушателей всех событий объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Вызывает событие указанного типа. Вы можете дополнительно указать объект данных — свойства этого объекта будут первым аргументом функции слушателя. Событие может быть дополнительно распространено на родительские события.

listens(<String> type) Boolean

Возвращает true, если для определенного типа события есть какие-либо присоединенные слушатели.

once(…) this

Ведёт себя как on(…), за исключением того, что слушатель будет вызван только один раз, а затем удалён.

addEventParent(<Evented> obj) this

Добавляет родителя события — Evented, который будет получать распространяемые события

removeEventParent(<Evented> obj) this

Удаляет родителя события, так что он перестанет получать распространяемые события

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

GeoJSON

Представляет собой объект GeoJSON или массив объектов GeoJSON. Позволяет парсить данные GeoJSON и отображать их на карте. Расширяет FeatureGroup.

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

L.geoJSON(data, {
    style: function (feature) {
        return {color: feature.properties.color};
    }
}).bindPopup(function (layer) {
    return layer.feature.properties.description;
}).addTo(map);

Создание

Фабрика Описание
L.geoJSON(<Object> geojson?, <GeoJSON options> options?) Создаёт слой GeoJSON. Дополнительно принимает объект в формате GeoJSON для отображения на карте (можно добавить позже методом addData ) и объект options.

Параметры

Параметр Тип Значение по умолчанию Описание
pointToLayer Function * Функция, определяющая, как точки GeoJSON преобразуются в слои Leaflet. Вызывается при добавлении данных, принимая в качестве аргументов объект GeoJSON и его LatLng. По умолчанию создаёт стандартный маркер:
function(geoJsonPoint, latlng) {
    return L.marker(latlng);
}
style Function * Функция, определяющая стиль для линий и полигонов GeoJSON, вызывается при добавлении данных. Значение по умолчанию — не переопределять стандартные стили:
function (geoJsonFeature) {
    return {}
}
onEachFeature Function * Функция, которая вызывается один раз для каждого созданного Feature, после его создания и стилизации. Полезно для добавления событий и всплывающих окон к элементам. По умолчанию ничего не делает:
function (feature, layer) {}
filter Function * Функция, определяющая, будет ли элемент включён или нет. По умолчанию — включать все элементы:
function (geoJsonFeature) {
    return true;
}

Примечание: динамическое изменение параметра filter повлияет только на новые добавленные данные. Это не повлияет на уже включённые элементы.

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

События

Событие Данные Описание
layeradd LayerEvent Fired when a layer is added to this FeatureGroup
layerremove LayerEvent Fired when a layer is removed from this FeatureGroup
Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
Событие Данные Описание
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы

Метод Возвращает Описание
addData(data) this

Добавляет объект GeoJSON в слой.

resetStyle(layer) this

Сбрасывает стиль заданного векторного слоя к исходному стилю GeoJSON, полезно для сброса стиля после событий наведения.

setStyle(style) this

Изменяет стили векторных слоёв GeoJSON с помощью заданной функции стиля.

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

Перемещает группу слоёв наверх всех остальных слоёв

bringToBack() this

Перемещает группу слоёв в самый низ всех остальных слоёв

getBounds() LatLngBounds

Возвращает LatLngBounds группы элементов (созданный на основе границ и координат её дочерних элементов).

Метод Возвращает Описание
toGeoJSON(<Number> precision) Object

Возвращает представление группы слоёв в формате GeoJSON (как GeoJSON FeatureCollection, GeometryCollection, или MultiPoint).

addLayer(<Layer> layer) this

Добавляет указанный слой в группу.

removeLayer(<Layer> layer) this

Удаляет указанный слой из группы.

removeLayer(<Number> id) this

Удаляет слой с заданным внутренним ID из группы.

hasLayer(<Layer> layer) Boolean

Возвращает true, если заданный слой в данный момент добавлен в группу.

hasLayer(<Number> id) Boolean

Возвращает true, если заданный внутренний ID в данный момент добавлен в группу.

clearLayers() this

Удаляет все слои из группы.

invoke(<String> methodName, …) this

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

eachLayer(<Function> fn, <Object> context?) this

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

group.eachLayer(function (layer) {
    layer.bindPopup('Hello');
});
getLayer(<Number> id) Layer

Возвращает слой с заданным внутренним ID.

getLayers() Layer[]

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

setZIndex(<Number> zIndex) this

Вызывает setZIndex на каждом слое, содержащемся в этой группе, передавая z-индекс.

getLayerId(<Layer> layer) Number

Возвращает внутренний ID для слоя

Метод Возвращает Описание
addTo(<Map|LayerGroup> map) this

Добавляет слой к указанной карте или группе слоёв.

remove() this

Удаляет слой с активной карты.

removeFrom(<Map> map) this

Удаляет слой с заданной карты.

getPane(<String> name?) HTMLElement

Возвращает HTMLElement, представляющий собой именованный слой на карте. Если name опущен, возвращает слой для этого слоя.

getAttribution() String

Используется attribution control, возвращает опцию подписи.

Метод Возвращает Описание
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?) this

Привязывает всплывающее окно к слою с переданным content и настраивает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindPopup() this

Удаляет всплывающее окно, ранее привязанное с помощью bindPopup.

openPopup(<LatLng> latlng?) this

Открывает привязанное всплывающее окно в указанной latlng или по умолчанию, если latlng не передан.

closePopup() this

Закрывает привязанное всплывающее окно, если оно открыто.

togglePopup() this

Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния.

isPopupOpen() boolean

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

setPopupContent(<String|HTMLElement|Popup> content) this

Устанавливает содержимое всплывающего окна, привязанного к этому слою.

getPopup() Popup

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

Метод Возвращает Описание
bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

Привязывает подсказку к слою с переданным content и настраивает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindTooltip() this

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

openTooltip(<LatLng> latlng?) this

Открывает привязанную подсказку в указанной latlng или по умолчанию, если latlng не передан.

closeTooltip() this

Закрывает подсказку, привязанную к этому слою, если она открыта.

toggleTooltip() this

Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от её текущего состояния.

isTooltipOpen() boolean

Возвращает true, если привязанная подсказка в данный момент открыта.

setTooltipContent(<String|HTMLElement|Tooltip> content) this

Устанавливает содержимое подсказки, привязанной к этому слою.

getTooltip() Tooltip

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

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-обработчик (fn) к определённому типу события объекта. Необязательно указать контекст обработчика (объект, на который будет указывать this). Также можно передать несколько типов через пробел (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар "тип/обработчик", например {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

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

off(<Object> eventMap) this

Удаляет набор пар "тип/обработчик".

off() this

Удаляет всех обработчиков всех событий объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Вызывает событие указанного типа. Необязательно передать объект данных — первый аргумент функции-обработчика будет содержать его свойства. Событие может быть необязательно распространено на родительские события.

listens(<String> type) Boolean

Возвращает true, если для определённого типа события есть какие-либо обработчики.

once(…) this

Ведёт себя как on(…), за исключением того, что обработчик будет вызван только один раз, а затем удалён.

addEventParent(<Evented> obj) this

Добавляет родительский объект события - Evented, который будет получать распространяемые события.

removeEventParent(<Evented> obj) this

Удаляет родительский объект события, так что он перестанет получать распространяемые события.

addEventListener(…) this

Псевдоним к on(…)

removeEventListener(…) this

Псевдоним к off(…)

clearAllEventListeners(…) this

Псевдоним к off()

addOneTimeEventListener(…) this

Псевдоним к once(…)

fireEvent(…) this

Псевдоним к fire(…)

hasEventListeners(…) Boolean

Псевдоним к listens(…)

Функции

Существует несколько статических функций, которые можно вызывать без создания экземпляра L.GeoJSON:
Функция Возвращает Описание
geometryToLayer(<Object> featureData, <GeoJSON options> options?) Layer Создаёт Layer из заданного GeoJSON объекта. Можно использовать пользовательские функции pointToLayer и/или coordsToLatLng, если они заданы в качестве опций.
coordsToLatLng(<Array> coords) LatLng Создаёт объект LatLng из массива из 2 чисел (долгота, широта) или 3 чисел (долгота, широта, высота), используемых в GeoJSON для точек.
coordsToLatLngs(<Array> coords, <Number> levelsDeep?, <Function> coordsToLatLng?) Array Создаёт многомерный массив объектов LatLng из массива координат GeoJSON. levelsDeep задаёт уровень вложенности (0 — массив точек, 1 — массив массивов точек и т. д., по умолчанию 0). Можно использовать пользовательскую функцию coordsToLatLng.
latLngToCoords(<LatLng> latlng, <Number> precision?) Array Обратная функция к coordsToLatLng
latLngsToCoords(<Array> latlngs, <Number> levelsDeep?, <Boolean> closed?) Array Обратная функция к coordsToLatLngs closed определяет, нужно ли добавлять первую точку в конец массива для закрытия объекта, используется только когда levelsDeep равно 0. По умолчанию False.
asFeature(<Object> geojson) Object Нормализует геометрии/объекты GeoJSON в объекты GeoJSON.

GridLayer

Общий класс для работы с разбиением на плитки сетки HTML-элементов. Это базовый класс для всех слоёв плиток и заменяет TileLayer.Canvas. GridLayer можно расширить для создания сетки разбиений на плитки HTML-элементов, таких как <canvas>, <img> или <div>. GridLayer будет обрабатывать создание и анимацию этих DOM-элементов за вас.

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

Синхронное использование

Для создания пользовательского слоя расширьте GridLayer и реализуйте метод createTile(), которому будет передан объект Point с координатами x, y, и z (уровень масштабирования) для отрисовки вашей плитки.

var CanvasLayer = L.GridLayer.extend({
    createTile: function(coords){
        // create a <canvas> element for drawing
        var tile = L.DomUtil.create('canvas', 'leaflet-tile');
        // setup tile width and height according to the options
        var size = this.getTileSize();
        tile.width = size.x;
        tile.height = size.y;
        // get a canvas context and draw something on it using coords.x, coords.y and coords.z
        var ctx = tile.getContext('2d');
        // return the tile so it can be rendered on screen
        return tile;
    }
});

Асинхронное использование

Создание плиток также может быть асинхронным, это полезно при использовании сторонней библиотеки отрисовки. После завершения отрисовки плитки она может быть передана в обратный вызов done().

var CanvasLayer = L.GridLayer.extend({
    createTile: function(coords, done){
        var error;
        // create a <canvas> element for drawing
        var tile = L.DomUtil.create('canvas', 'leaflet-tile');
        // setup tile width and height according to the options
        var size = this.getTileSize();
        tile.width = size.x;
        tile.height = size.y;
        // draw something asynchronously and pass the tile to the done() callback
        setTimeout(function() {
            done(error, tile);
        }, 1000);
        return tile;
    }
});

Создание

Фабрика Описание
L.gridLayer(<GridLayer options> options?) Создаёт новый экземпляр GridLayer с заданными параметрами.

Параметры

Параметр Тип Значение по умолчанию Описание
tileSize Number|Point 256 Ширина и высота плиток в сетке. Используйте число, если ширина и высота равны, или L.point(width, height) в противном случае.
opacity Number 1.0 Непрозрачность плиток. Может быть использована в функции createTile().
updateWhenIdle Boolean (depends) Загружать новые плитки только после окончания панорамирования. По умолчанию true в мобильных браузерах, чтобы избежать слишком многих запросов и сохранить плавную навигацию. false в противном случае, чтобы отображать новые плитки *во время* панорамирования, так как легко выйти за пределы параметра keepBuffer в настольных браузерах.
updateWhenZooming Boolean true По умолчанию плавная анимация масштабирования (во время масштабирования с помощью сенсорного управления или flyTo()) будет обновлять слои плиток через каждые целые уровни масштабирования. Установка этого параметра в false обновит слой плиток только по окончании плавной анимации.
updateInterval Number 200 Плитки не будут обновляться чаще, чем раз в updateInterval миллисекунд при панорамировании.
zIndex Number 1 Явный zIndex слоя плиток.
bounds LatLngBounds undefined Если задано, плитки будут загружаться только внутри заданных LatLngBounds.
minZoom Number 0 Минимальный уровень масштабирования, до которого будет отображаться этот слой (включительно).
maxZoom Number undefined Максимальный уровень масштабирования, до которого будет отображаться этот слой (включительно).
maxNativeZoom Number undefined Максимальное значение масштабирования, доступное для источника плиток. Если задано, плитки на всех уровнях масштабирования, больших, чем maxNativeZoom, будут загружаться с уровня maxNativeZoom и автоматически масштабироваться.
minNativeZoom Number undefined Минимальное значение масштабирования, доступное для источника плиток. Если задано, плитки на всех уровнях масштабирования, меньших, чем minNativeZoom, будут загружаться с уровня minNativeZoom и автоматически масштабироваться.
noWrap Boolean false Включает ли слой обёртку вокруг антимеридиана. Если true, GridLayer будет отображаться только один раз при низких уровнях масштабирования. Не оказывает влияния, если система координат карты не имеет обёртки. Может использоваться в сочетании с bounds, чтобы предотвратить запрос плиток за пределами ограничений системы координат.
pane String 'tilePane' Map pane куда будет добавлен слой плиток.
className String '' Пользовательское имя класса для присвоения слою плиток. По умолчанию пустое.
keepBuffer Number 2 При панорамировании карты сохраняйте столько строк и столбцов плиток, прежде чем их выгрузить.
Параметр Тип Значение по умолчанию Описание
attribution String null Строка, отображаемая в элементе управления атрибутами, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является юридическим обязательством перед держателями авторских прав и поставщиками плиток.

События

Событие Данные Описание
loading Event Fired when the grid layer starts loading tiles.
tileunload TileEvent Fired when a tile is removed (e.g. when a tile goes off the screen).
tileloadstart TileEvent Fired when a tile is requested and starts loading.
tileerror TileErrorEvent Fired when there is an error loading a tile.
tileload TileEvent Fired when a tile loads.
load Event Fired when the grid layer loaded all visible tiles.
Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
Событие Данные Описание
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы

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

Переводит слой плиток вперёд всех слоёв плиток.

bringToBack() this

Переводит слой плиток назад всех слоёв плиток.

getContainer() HTMLElement

Возвращает HTML-элемент, содержащий плитки для данного слоя.

setOpacity(<Number> opacity) this

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

setZIndex(<Number> zIndex) this

Изменяет zIndex слоя плиток.

isLoading() Boolean

Возвращает true если какая-либо плитка в слое плиток ещё не загружена.

redraw() this

Принудительно очищает все плитки и запрашивает их заново.

getTileSize() Point

Нормализует параметр tileSize в точку. Используется методом createTile().

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

Слои, расширяющие GridLayer, должны переопределить следующие методы.
Метод Возвращает Описание
createTile(<Object> coords, <Function> done?) HTMLElement

Вызывается только во внутреннем режиме, должен быть переопределён классами, расширяющими GridLayer. Возвращает HTMLElement соответствующий заданному coords. Если указан коллбэк done, он должен быть вызван, когда тайл завершит загрузку и отрисовку.

Метод Возвращает Описание
addTo(<Map|LayerGroup> map) this

Добавляет слой на заданную карту или группу слоёв.

remove() this

Удаляет слой с карты, на которой он активен в данный момент.

removeFrom(<Map> map) this

Удаляет слой с заданной карты.

getPane(<String> name?) HTMLElement

Возвращает HTMLElement, представляющий собой указанный на карте плейн. Если name опущен, возвращает плейн для этого слоя.

getAttribution() String

Используется attribution control, возвращает опцию атрибуции.

Метод Возвращает Описание
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?) this

Связывает всплывающее окно с слоем, используя переданный content и устанавливает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindPopup() this

Удаляет привязанное всплывающее окно, ранее связанное с bindPopup.

openPopup(<LatLng> latlng?) this

Открывает привязанное всплывающее окно в указанной latlng или по умолчанию, если latlng не передан.

closePopup() this

Закрывает привязанное к этому слою всплывающее окно, если оно открыто.

togglePopup() this

Открывает или закрывает привязанное к этому слою всплывающее окно в зависимости от его текущего состояния.

isPopupOpen() boolean

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

setPopupContent(<String|HTMLElement|Popup> content) this

Устанавливает содержимое всплывающего окна, привязанного к этому слою.

getPopup() Popup

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

Метод Возвращает Описание
bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

Связывает подсказку со слоем, используя переданный content и настраивает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindTooltip() this

Удаляет привязанную подсказку, ранее связанную с bindTooltip.

openTooltip(<LatLng> latlng?) this

Открывает привязанную подсказку в указанной latlng или по умолчанию, если latlng не передан.

closeTooltip() this

Закрывает подсказку, привязанную к этому слою, если она открыта.

toggleTooltip() this

Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от её текущего состояния.

isTooltipOpen() boolean

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

setTooltipContent(<String|HTMLElement|Tooltip> content) this

Устанавливает содержимое подсказки, привязанной к этому слою.

getTooltip() Tooltip

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

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-обработчик (fn) к определённому типу события объекта. Можно необязательно указать контекст обработчика (объект, к которому будет относиться ключевое слово this). Также можно передать несколько типов через пробел (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар тип/обработчик, например {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

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

off(<Object> eventMap) this

Удаляет набор пар тип/обработчик.

off() this

Удаляет всех обработчиков всех событий объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Вызывает событие указанного типа. Можно необязательно предоставить объект данных — первый аргумент функции-обработчика будет содержать его свойства. Событие может необязательно распространяться на родительские события.

listens(<String> type) Boolean

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

once(…) this

Ведёт себя как on(…), за исключением того, что обработчик будет вызван только один раз, а затем удален.

addEventParent(<Evented> obj) this

Добавляет родительское событие — Evented, которое будет получать распространяемые события.

removeEventParent(<Evented> obj) this

Удаляет родительское событие, чтобы оно прекратило получать распространяемые события.

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

LatLng

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

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

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

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

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

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

Создание

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

Методы

Метод Возвращает Описание
equals(<LatLng> otherLatLng, <Number> maxMargin?) Boolean

Возвращает true, если заданная точка LatLng находится в той же позиции (в пределах небольшой погрешности). Погрешность можно переопределить, задав maxMargin небольшим числом.

toString() String

Возвращает строковое представление точки (для отладки).

distanceTo(<LatLng> otherLatLng) Number

Возвращает расстояние (в метрах) до заданной точки LatLng, рассчитанное с использованием сферического закона косинусов.

wrap() LatLng

Возвращает новый объект LatLng с долготой, обернутой так, чтобы она всегда была в пределах от -180 до +180 градусов.

toBounds(<Number> sizeInMeters) LatLngBounds

Возвращает новый объект LatLngBounds, в котором каждый предел находится на расстоянии sizeInMeters/2 метров от точки LatLng.

Свойства

Свойство Тип Описание
lat Number Latitude in degrees
lng Number Longitude in degrees
alt Number Altitude in meters (optional)

LatLngBounds

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

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

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

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

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

Внимание: если область пересекает антимеридиан (часто путают с линией перемены дат), вы должны указать углы вне диапазона долгот [-180, 180]. Обратите внимание, что LatLngBounds не наследуется от объекта Leaflet's Class, что означает, что новые классы не могут наследоваться от него, и новые методы не могут быть добавлены к нему с помощью функции include.

Создание

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

Методы

Метод Возвращает Описание
extend(<LatLng> latlng) this

Расширить границы, чтобы они содержали данную точку

extend(<LatLngBounds> otherBounds) this

Расширить границы, чтобы они содержали заданные границы

pad(<Number> bufferRatio) LatLngBounds

Возвращает границы, созданные путём расширения или сужения текущих границ на заданное отношение в каждом направлении. Например, отношение 0,5 расширяет границы на 50% в каждом направлении. Отрицательные значения сужают границы.

getCenter() LatLng

Возвращает центральную точку границ.

getSouthWest() LatLng

Возвращает юго-западную точку границ.

getNorthEast() LatLng

Возвращает северо-восточную точку границ.

getNorthWest() LatLng

Возвращает северо-западную точку границ.

getSouthEast() LatLng

Возвращает юго-восточную точку границ.

getWest() Number

Возвращает западную долготу границ

getSouth() Number

Возвращает южную широту границ

getEast() Number

Возвращает восточную долготу границ

getNorth() Number

Возвращает северную широту границ

contains(<LatLngBounds> otherBounds) Boolean

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

contains(<LatLng> latlng) Boolean

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

intersects(<LatLngBounds> otherBounds) Boolean

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

overlaps(<Bounds> otherBounds) Boolean

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

toBBoxString() String

Возвращает строку с координатами рамки в формате 'southwest_lng,southwest_lat,northeast_lng,northeast_lat'. Полезно для отправки запросов в веб-сервисы, возвращающие геоданные.

equals(<LatLngBounds> otherBounds, <Number> maxMargin?) Boolean

Возвращает true если прямоугольник эквивалентен (в пределах небольшой погрешности) заданным границам. Погрешность можно переопределить, задав maxMargin небольшим числом.

isValid() Boolean

Возвращает true если границы инициализированы правильно.

Точка

Представляет точку с координатами x и y в пикселях.

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

var point = L.point(200, 300);

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

map.panBy([200, 300]);
map.panBy(L.point(200, 300));

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

Создание

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

Методы

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

Возвращает копию текущей точки.

add(<Point> otherPoint) Point

Возвращает результат сложения текущей и заданной точек.

subtract(<Point> otherPoint) Point

Возвращает результат вычитания заданной точки из текущей.

divideBy(<Number> num) Point

Возвращает результат деления текущей точки на заданное число.

multiplyBy(<Number> num) Point

Возвращает результат умножения текущей точки на заданное число.

scaleBy(<Point> scale) Point

Умножает каждую координату текущей точки на каждую координату scale. В терминах линейной алгебры умножает точку на матрицу масштабирования, определённую scale.

unscaleBy(<Point> scale) Point

Обратное к scaleBy. Делит каждую координату текущей точки на каждую координату scale.

round() Point

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

floor() Point

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

ceil() Point

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

trunc() Point

Возвращает копию текущей точки с усечёнными координатами (округление к нулю).

distanceTo(<Point> otherPoint) Number

Возвращает евклидово расстояние между текущей и заданной точками.

equals(<Point> otherPoint) Boolean

Возвращает true если заданная точка имеет те же координаты.

contains(<Point> otherPoint) Boolean

Возвращает true если обе координаты заданной точки меньше соответствующих координат текущей точки (по абсолютной величине).

toString() String

Возвращает строковое представление точки для целей отладки.

Свойства

Свойство Тип Описание
x Number The x coordinate of the point
y Number The y coordinate of the point

Границы

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

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

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

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

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

Обратите внимание, что Bounds не наследуется от объекта 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 The top left corner of the rectangle.
max Point The bottom right corner of the rectangle.

Значок

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

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

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

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

Создание

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

Параметры

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

Методы

Метод Возвращает Описание
createIcon(<HTMLElement> oldIcon?) HTMLElement

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

createShadow(<HTMLElement> oldIcon?) HTMLElement

Как createIcon, но для тени под ним.

Icon.Default

Тривиальный подкласс Icon, представляющий значок, который используется в Marker по умолчанию, если не указан другой. Ссылается на изображение синего маркера, распространяемого с выпусками Leaflet. Чтобы настроить значок по умолчанию, просто измените свойства L.Icon.Default.prototype.options (который является набором Icon options). Если вы хотите полностью заменить значок по умолчанию, переопределите L.Marker.prototype.options.icon собственным значком.
Параметр Тип Значение по умолчанию Описание
imagePath String Icon.Default попытается автоматически определить расположение изображений синего значка. Если вы размещаете эти изображения нестандартным образом, установите этот параметр, чтобы указать правильный путь.

DivIcon

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

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

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

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

Создание

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

Параметры

Параметр Тип Значение по умолчанию Описание
html String '' Пользовательский HTML-код для размещения внутри элемента div, по умолчанию пустой.
bgPos Point [0, 0] Необязательное относительное положение фона в пикселях
Опция Тип По умолчанию Описание
iconUrl String null (обязательно) URL изображения значка (абсолютный или относительный к пути вашего скрипта).
iconRetinaUrl String null URL изображения значка в разрешении Retina (абсолютный или относительный к пути вашего скрипта). Используется для устройств с экранами 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, но для тени под ним.

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' Заголовок на кнопке "уменьшить".
Опция Тип По умолчанию Описание
position String 'topright' Положение панели управления (один из углов карты). Возможные значения — 'topleft', 'topright', 'bottomleft' или 'bottomright'

Методы

Метод Возвращает Описание
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 для отключения.
Опция Тип По умолчанию Описание
position String 'topright' Положение панели управления (один из углов карты). Возможные значения — 'topleft', 'topright', 'bottomleft' или 'bottomright'

Методы

Метод Возвращает Описание
setPrefix(<String> prefix) this

Устанавливает текст перед атрибуциями.

addAttribution(<String> text) this

Добавляет текст атрибуции (например, 'Vector data &copy; Mapbox').

removeAttribution(<String> text) this

Удаляет текст атрибуции.

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

Опции

Опция Тип По умолчанию Описание
collapsed Boolean true Если true, управление будет свернуто в значок и развернуто при наведении или касании мыши.
autoZIndex Boolean true Если true, управление присвоит zIndexes в порядке возрастания всем своим слоям, так что порядок сохранится при переключении слоев.
hideSingleBase Boolean false Если true, базовые слои в управлении будут скрыты, когда их будет только один.
sortLayers Boolean false Сортировать ли слои. Когда false, слои сохранят порядок, в котором они были добавлены в управление.
sortFunction Function * Функция сравнения, которая будет использоваться для сортировки слоев, когда sortLayers равна true. Функция получает оба экземпляра L.Layer и их имена, как в sortFunction(layerA, layerB, nameA, nameB). По умолчанию слои сортируются по алфавиту по их имени.
Опция Тип По умолчанию Описание
position String 'topright' Положение управления (один из углов карты). Возможные значения — 'topleft', 'topright', 'bottomleft' или 'bottomright'

Методы

Метод Возвращает Описание
addBaseLayer(<Layer> layer, <String> name) this

Добавляет базовый слой (элемент радиокнопки) с заданным именем в управление.

addOverlay(<Layer> layer, <String> name) this

Добавляет наложение (элемент флажка) с заданным именем в управление.

removeLayer(<Layer> layer) this

Удаляет заданный слой из управления.

expand() this

Развернуть контейнер управления, если он свернут.

collapse() this

Свернуть контейнер управления, если он развернут.

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

Возвращает положение управления.

setPosition(<string> position) this

Устанавливает положение управления.

getContainer() HTMLElement

Возвращает HTMLElement, содержащий управление.

addTo(<Map> map) this

Добавляет управление на заданную карту.

remove() this

Удаляет управление с карты, на которой оно сейчас активное.

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

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

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

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

Создание

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

Параметры

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

Методы

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

Возвращает положение управления.

setPosition(<string> position) this

Устанавливает положение управления.

getContainer() HTMLElement

Возвращает HTMLElement, содержащий управление.

addTo(<Map> map) this

Добавляет управление на заданную карту.

remove() this

Удаляет управление с карты, на которой оно сейчас активное.

Браузер

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

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

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

Свойства

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

Утилиты

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

Функции

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

Свойства

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

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

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

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

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

Создание

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

Методы

Метод Возвращает Описание
transform(<Point> point, <Number> scale?) Point

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

untransform(<Point> point, <Number> scale?) Point

Возвращает обратное преобразование заданной точки, необязательно делённое на заданный масштаб. Принимает только объекты L.Point, а не массивы.

LineUtil

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

Функции

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

PolyUtil

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

Функции

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

DomEvent

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

Функции

Функция Возвращает Описание
on(<HTMLElement> el, <String> types, <Function> fn, <Object> context?) this Добавляет функцию-обработчик (fn) к определённому типу события 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 Получает нормализованное значение дельты прокрутки мыши из события 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() Запрещает пользователю генерировать события selectstart DOM, которые обычно генерируются, когда пользователь перетаскивает мышь по странице с текстом. Внутренне используется Leaflet для переопределения поведения любого взаимодействия "клика-перетаскивания" на карте. Влияет на взаимодействия перетаскивания на всей странице.
enableTextSelection() Отменяет действия предыдущего L.DomUtil.disableTextSelection.
disableImageDrag() Как L.DomUtil.disableTextSelection, но для событий dragstart DOM, которые обычно генерируются при перетаскивании пользователем изображения.
enableImageDrag() Отменяет действия предыдущего L.DomUtil.disableImageDrag.
preventOutline(<HTMLElement> el) Делает контур элемента el невидимым. Внутренне используется Leaflet для предотвращения отображения контура фокусируемых элементов, когда пользователь выполняет взаимодействие перетаскивания на них.
restoreOutline() Отменяет действия предыдущего L.DomUtil.preventOutline.
getSizedParentNode(<HTMLElement> el) HTMLElement Находит ближайшего родительского узла, размер (ширина и высота) которого не равен null.
getScale(<HTMLElement> el) Object Вычисляет текущее CSS масштабирование, применённое к элементу. Возвращает объект с x и y членами в качестве горизонтального и вертикального масштабирования соответственно, и boundingClientRect в качестве результата getBoundingClientRect().

Свойства

Свойство Тип Описание
TRANSFORM String Vendor-prefixed transform style name (e.g. 'webkitTransform' for WebKit).
TRANSITION String Vendor-prefixed transition style name.
TRANSITION_END String Vendor-prefixed transitionend event name.

PosAnimation

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

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

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

Конструктор

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

События

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

Методы

Метод Возвращает Описание
run(<HTMLElement> el, <Point> newPos, <Number> duration?, <Number> easeLinearity?)

Запустить анимацию данного элемента в новую позицию, необязательно задавая длительность в секундах (0.25 по умолчанию) и линейность ускорения (3-й аргумент кривой кубического безиера, 0.5 по умолчанию).

stop()

Остановить анимацию (если она выполняется).

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-обработчик (fn) к определённому типу события объекта. Вы можете указать контекст обработчика (объект, на который будет указывать ключевое слово this). Вы также можете передать несколько типов через пробел (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар "тип/обработчик", например {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

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

off(<Object> eventMap) this

Удаляет набор пар "тип/обработчик".

off() this

Удаляет все обработчики всех событий для объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Вызывает событие указанного типа. Вы можете необязательно передать объект данных — свойства объекта будут содержаться в первом аргументе функции-обработчика. Событие может быть распространено на родительские события.

listens(<String> type) Boolean

Возвращает true если для определённого типа события есть обработчики.

once(…) this

Ведёт себя как on(…), за исключением того, что обработчик будет вызван только один раз, а затем удалён.

addEventParent(<Evented> obj) this

Добавляет родителя события — Evented, который будет получать распространяемые события

removeEventParent(<Evented> obj) this

Удаляет родителя события, так что он перестанет получать распространяемые события

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

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

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

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

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

Конструктор

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

Параметры

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

События

Событие Данные Описание
down Event Fired when a drag is about to start.
dragstart Event Fired when a drag starts
predrag Event Fired continuously during dragging before each corresponding update of the element's position.
drag Event Fired continuously during dragging.
dragend DragEndEvent Fired when the drag ends.

Методы

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

Включает возможность перетаскивания

disable()

Отключает возможность перетаскивания

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-обработчик (fn) к определённому типу события объекта. Вы можете указать контекст обработчика (объект, на который будет указывать ключевое слово this). Вы также можете передать несколько типов через пробел (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар "тип/обработчик", например {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

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

off(<Object> eventMap) this

Удаляет набор пар "тип/обработчик".

off() this

Удаляет все обработчики всех событий для объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Вызывает событие указанного типа. Вы можете необязательно передать объект данных — свойства объекта будут содержаться в первом аргументе функции-обработчика. Событие может быть распространено на родительские события.

listens(<String> type) Boolean

Возвращает true если для определённого типа события есть обработчики.

once(…) this

Ведёт себя как on(…), за исключением того, что обработчик будет вызван только один раз, а затем удалён.

addEventParent(<Evented> obj) this

Добавляет родителя события — Evented, который будет получать распространяемые события

removeEventParent(<Evented> obj) this

Удаляет родителя события, так что он перестанет получать распространяемые события

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

Класс

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

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

Включения

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

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

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

MyClass.include(MyMixin);

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

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

Методы инициализации конструктора

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

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

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

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

Функции

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

Событийный

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

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

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

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

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

Методы

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

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

on(<Object> eventMap) this

Добавляет набор пар тип/обработчик, например, {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

Удаляет ранее добавленную функцию-обработчик. Если функция не указана, удалятся все обработчики этого события от объекта. Обратите внимание, что если вы передали пользовательский контекст в on, вы должны передать тот же контекст в off для удаления обработчика.

off(<Object> eventMap) this

Удаляет набор пар тип/обработчик.

off() this

Удаляет все обработчики всех событий объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Вызывает событие указанного типа. Вы можете необязательно указать объект данных — первое аргумент функции-обработчика будет содержать его свойства. Событие может быть необязательно распространено на родительские события.

listens(<String> type) Boolean

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

once(…) this

Ведёт себя как on(…), за исключением того, что обработчик будет вызван один раз, а затем удален.

addEventParent(<Evented> obj) this

Добавляет родительский обработчик событий — Evented, который будет получать распространяемые события

removeEventParent(<Evented> obj) this

Удаляет родительский обработчик событий, так что он перестанет получать распространяемые события

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

Слой

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

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

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

Параметры

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

События

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

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

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

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

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

Методы

Классы, расширяющие L.Layer, унаследуют следующие методы:
Метод Возвращает Описание
addTo(<Map|LayerGroup> map) this

Добавляет слой на заданную карту или группу слоев.

remove() this

Удаляет слой с карты, на которой он сейчас активен.

removeFrom(<Map> map) this

Удаляет слой с указанной карты

getPane(<String> name?) HTMLElement

Возвращает HTMLElement, представляющую панель с заданным именем на карте. Если name опущено, возвращает панель для этого слоя.

getAttribution() String

Используется классом 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

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

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-обработчик (fn) к определенному типу события объекта. Вы можете необязательно указать контекст обработчика (объект, к которому будет относиться ключевое слово this). Вы также можете передать несколько типов через пробел (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар тип/обработчик, например, {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

Удаляет ранее добавленную функцию-обработчик. Если функция не указана, удаляет все обработчики этого конкретного события из объекта. Обратите внимание, что если вы передали пользовательский контекст в on, вы должны передать тот же контекст в off для удаления обработчика.

off(<Object> eventMap) this

Удаляет набор пар тип/обработчик.

off() this

Удаляет все обработчики всех событий в объекте.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Срабатывает событие указанного типа. Вы можете необязательно указать объект данных — первый аргумент функции-обработчика будет содержать его свойства. Событие необязательно может быть распространено на родительские элементы.

listens(<String> type) Boolean

Возвращает true , если для определенного типа события прикреплены какие-либо обработчики.

once(…) this

Ведет себя как on(…), за исключением того, что обработчик будет вызван только один раз, а затем удален.

addEventParent(<Evented> obj) this

Добавляет родительский элемент события — Evented, который будет получать распространяемые события.

removeEventParent(<Evented> obj) this

Удаляет родительский элемент события, чтобы он больше не получал распространяемые события.

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

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

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

Параметры

Параметр Тип Значение по умолчанию Описание
interactive Boolean true Если false, слой не будет генерировать события мыши и будет действовать как часть основного слоя карты.
bubblingMouseEvents Boolean true Когда true, событие мыши на этом слое вызовет то же самое событие на карте (если не используется L.DomEvent.stopPropagation).
Параметр Тип Значение по умолчанию Описание
pane String 'overlayPane' По умолчанию слой будет добавлен на слой наложения карты. Переопределение этого параметра приведет к тому, что слой по умолчанию будет размещен на другом слое.
attribution String null Строка, отображаемая в элементе атрибуции, например, «© OpenStreetMap contributors». Она описывает данные слоя и часто является правовой обязанностью по отношению к правообладателям и поставщикам плиток.

События

События мыши

Событие Данные Описание
click MouseEvent Fired when the user clicks (or taps) the layer.
dblclick MouseEvent Fired when the user double-clicks (or double-taps) the layer.
mousedown MouseEvent Fired when the user pushes the mouse button on the layer.
mouseup MouseEvent Fired when the user releases the mouse button pushed on the layer.
mouseover MouseEvent Fired when the mouse enters the layer.
mouseout MouseEvent Fired when the mouse leaves the layer.
contextmenu MouseEvent Fired when the user right-clicks on the layer, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).
Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
Событие Данные Описание
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы

Метод Возвращает Описание
addTo(<Map|LayerGroup> map) this

Добавляет слой на заданную карту или группу слоёв.

remove() this

Удаляет слой с карты, на которой он в настоящее время активен.

removeFrom(<Map> map) this

Удаляет слой с заданной карты.

getPane(<String> name?) HTMLElement

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

getAttribution() String

Используется attribution control, возвращает параметр авторских прав.

Метод Возвращает Описание
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?) this

Привязывает всплывающее окно к слою с переданным content, и настраивает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindPopup() this

Удаляет всплывающее окно, ранее привязанное с помощью bindPopup.

openPopup(<LatLng> latlng?) this

Открывает привязанное всплывающее окно в указанной latlng или в стандартной точке якоря всплывающего окна, если latlng не указан.

closePopup() this

Закрывает всплывающее окно, привязанное к этому слою, если оно открыто.

togglePopup() this

Открывает или закрывает всплывающее окно, привязанное к этому слою, в зависимости от его текущего состояния.

isPopupOpen() boolean

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

setPopupContent(<String|HTMLElement|Popup> content) this

Устанавливает содержимое всплывающего окна, привязанного к этому слою.

getPopup() Popup

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

Метод Возвращает Описание
bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

Привязывает подсказку к слою с переданным content, и настраивает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindTooltip() this

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

openTooltip(<LatLng> latlng?) this

Открывает привязанную подсказку в указанной latlng или в стандартной точке якоря подсказки, если latlng не указан.

closeTooltip() this

Закрывает подсказку, привязанную к этому слою, если она открыта.

toggleTooltip() this

Открывает или закрывает подсказку, привязанную к этому слою, в зависимости от её текущего состояния.

isTooltipOpen() boolean

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

setTooltipContent(<String|HTMLElement|Tooltip> content) this

Устанавливает содержимое подсказки, привязанной к этому слою.

getTooltip() Tooltip

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

Метод Возвращает Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет функцию-обработчик (fn) к определенному типу события объекта. Можно необязательно указать контекст обработчика (объект, к которому будет относиться ключевое слово this). Также можно указать несколько типов через пробел (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар тип/обработчик, например, {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

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

off(<Object> eventMap) this

Удаляет набор пар тип/обработчик.

off() this

Удаляет всех обработчиков всех событий для объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Вызывает событие указанного типа. Можно необязательно указать объект данных — свойства объекта будут первым аргументом функции-обработчика. Событие необязательно может быть распространено на родительские события.

listens(<String> type) Boolean

Возвращает true если для конкретного типа события привязаны какие-либо обработчики.

once(…) this

Ведёт себя как on(…), за исключением того, что обработчик будет вызван только один раз, а затем удалён.

addEventParent(<Evented> obj) this

Добавляет родителя события — Evented, который будет получать распространяемые события.

removeEventParent(<Evented> obj) this

Удаляет родителя события, поэтому он больше не будет получать распространяемые события.

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

Контроль

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

Параметры

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

Методы

Классы, расширяющие L.Control, унаследуют следующие методы:
Метод Возвращает Описание
getPosition() string

Возвращает позицию элемента управления.

setPosition(<string> position) this

Устанавливает позицию элемента управления.

getContainer() HTMLElement

Возвращает элемент HTMLElement, содержащий элемент управления.

addTo(<Map> map) this

Добавляет элемент управления на заданную карту.

remove() this

Удаляет элемент управления с карты, на которой он в настоящее время активен.

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

Каждый элемент управления должен расширять L.Control и (пере-)реализовывать следующие методы.
Метод Возвращает Описание
onAdd(<Map> map) HTMLElement

Должен вернуть контейнерный элемент DOM для элемента управления и добавить обработчики на соответствующие события карты. Вызывается при control.addTo(map).

onRemove(<Map> map)

Необязательный метод. Должен содержать весь код очистки, который удаляет обработчики, ранее добавленные в onAdd. Вызывается при control.remove().

Обработчик

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

Методы

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

Включает обработчик

disable() this

Отключает обработчик

enabled() Boolean

Возвращает true , если обработчик включен

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

Классы, наследующие от Handler, должны реализовать следующие два метода:
Метод Возвращает Описание
addHooks()

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

removeHooks()

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

Функции

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

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

Проекция

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

Методы

Метод Возвращает Описание
project(<LatLng> latlng) Point

Проектирует географические координаты в 2D точку. Принимает только объекты L.LatLng, а не массивы.

unproject(<Point> point) LatLng

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

Свойства

Свойство Тип Описание
bounds Bounds The bounds (specified in CRS units) where the projection is valid

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

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

CRS

Методы

Метод Возвращает Описание
latLngToPoint(<LatLng> latlng, <Number> zoom) Point

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

pointToLatLng(<Point> point, <Number> zoom) LatLng

Обратная функция latLngToPoint. Проектирует пиксельные координаты в заданном масштабе в географические координаты.

project(<LatLng> latlng) Point

Проектирует географические координаты в координаты, используемые для данного CRS (например, метры для EPSG:3857, для передачи их в службы WMS).

unproject(<Point> point) LatLng

Принимая проецированные координаты, возвращает соответствующий LatLng. Обратная функция project.

scale(<Number> zoom) Number

Возвращает масштаб, используемый при преобразовании проецированных координат в пиксельные координаты для определенного масштаба. Например, он возвращает 256 * 2^zoom для CRS, основанных на Меркаторе.

zoom(<Number> scale) Number

Обратная функция scale(), возвращает уровень масштабирования, соответствующий коэффициенту масштаба scale.

getProjectedBounds(<Number> zoom) Bounds

Возвращает рамки проекции, отмасштабированные и преобразованные для предоставленного zoom.

distance(<LatLng> latlng1, <LatLng> latlng2) Number

Возвращает расстояние между двумя географическими координатами.

wrapLatLng(<LatLng> latlng) LatLng

Возвращает LatLng, где широта и долгота были обернуты в соответствии со свойствами wrapLat и wrapLng CRS, если они находятся за пределами границ CRS.

wrapLatLngBounds(<LatLngBounds> bounds) LatLngBounds

Возвращает LatLngBounds с таким же размером, как и заданный, гарантируя, что его центр находится внутри границ CRS. Принимает только объекты L.LatLngBounds, а не массивы.

Свойства

Свойство Тип Описание
code String Standard code name of the CRS passed into WMS services (e.g. 'EPSG:3857')
wrapLng Number[] An array of two numbers defining whether the longitude (horizontal) coordinate axis wraps around a given range and how. Defaults to [-180, 180] in most geographical CRSs. If undefined, the longitude axis does not wrap around.
wrapLat Number[] Like wrapLng, but for the latitude (vertical) axis.
infinite Boolean If true, the coordinate space will be unbounded (infinite in both axes)

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

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

Рендерер

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

Параметры

Параметр Тип Значение по умолчанию Описание
padding Number 0.1 Насколько следует расширить область обрезки вокруг представления карты (относительно ее размера), например, 0,1 составит 10% от представления карты в каждом направлении
tolerance Number 0 Насколько следует расширить толерантность клика вокруг пути/объекта на карте
Опция Тип По умолчанию Описание
pane String 'overlayPane' По умолчанию слой будет добавлен в панель наложения карты. Переопределение этой опции приведет к размещению слоя по умолчанию на другой панели.
attribution String null Строка, отображаемая в блоке атрибуции, например, "© OpenStreetMap contributors". Она описывает данные слоя и часто является обязательством перед правообладателями и поставщиками плиток.

События

Событие Данные Описание
update Event Fired when the renderer updates its bounds, center and zoom, for example when its map has moved
Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
Событие Данные Описание
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы

Метод Возвращаемое значение Описание
addTo(<Map|LayerGroup> map) this

Добавляет слой на заданную карту или группу слоёв.

remove() this

Удаляет слой с карты, на которой он в настоящее время активен.

removeFrom(<Map> map) this

Удаляет слой с заданной карты.

getPane(<String> name?) HTMLElement

Возвращает HTMLElement, представляющую заданную панель на карте. Если name опущена, возвращает панель для данного слоя.

getAttribution() String

Используется классом attribution control, возвращает опцию атрибуции.

Метод Возвращаемое значение Описание
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?) this

Привязывает всплывающее окно к слою с переданным content и настраивает необходимые обработчики событий. Если передана функция Function, она получит слой в качестве первого аргумента и должна вернуть String или HTMLElement.

unbindPopup() this

Удаляет всплывающее окно, ранее привязанное с помощью bindPopup.

openPopup(<LatLng> latlng?) this

Открывает привязанное всплывающее окно в указанной latlng или в стандартной точке якоря всплывающего окна, если latlng не передано.

closePopup() this

Закрывает привязанное к этому слою всплывающее окно, если оно открыто.

togglePopup() this

Открывает или закрывает привязанное к этому слою всплывающее окно в зависимости от его текущего состояния.

isPopupOpen() boolean

Возвращает true если привязанное к этому слою всплывающее окно открыто в данный момент.

setPopupContent(<String|HTMLElement|Popup> content) this

Устанавливает содержимое всплывающего окна, привязанного к этому слою.

getPopup() Popup

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

Метод Возвращаемое значение Описание
bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

Привязывает подсказку к слою с переданным content и настраивает необходимые обработчики событий. Если передана функция Function, она получит слой в качестве первого аргумента и должна вернуть String или HTMLElement.

unbindTooltip() this

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

openTooltip(<LatLng> latlng?) this

Открывает привязанную подсказку в указанной latlng или в стандартной точке якоря подсказки, если latlng не передано.

closeTooltip() this

Закрывает привязанную к этому слою подсказку, если она открыта.

toggleTooltip() this

Открывает или закрывает привязанную к этому слою подсказку в зависимости от её текущего состояния.

isTooltipOpen() boolean

Возвращает true если привязанная к этому слою подсказка открыта в данный момент.

setTooltipContent(<String|HTMLElement|Tooltip> content) this

Устанавливает содержимое подсказки, привязанной к этому слою.

getTooltip() Tooltip

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

Метод Возвращаемое значение Описание
on(<String> type, <Function> fn, <Object> context?) this

Добавляет обработчик функции (fn) к определенному типу события объекта. Можно необязательно указать контекст обработчика (объект, к которому будет относиться ключевое слово this). Можно также передать несколько типов через пробел (например, 'click dblclick').

on(<Object> eventMap) this

Добавляет набор пар тип/обработчик, например, {click: onClick, mousemove: onMouseMove}

off(<String> type, <Function> fn?, <Object> context?) this

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

off(<Object> eventMap) this

Удаляет набор пар тип/обработчик.

off() this

Удаляет всех обработчиков всех событий объекта.

fire(<String> type, <Object> data?, <Boolean> propagate?) this

Вызывает событие указанного типа. Можно необязательно передать объект данных — первый аргумент функции-обработчика будет содержать его свойства. Событие необязательно может быть распространено к родительским событиям.

listens(<String> type) Boolean

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

once(…) this

Поведение как on(…), за исключением того, что обработчик будет вызван только один раз и затем удален.

addEventParent(<Evented> obj) this

Добавляет родительское событие — Evented, которое будет получать распространяемые события.

removeEventParent(<Evented> obj) this

Удаляет родительское событие, так что оно перестанет получать распространяемые события.

addEventListener(…) this

Псевдоним для on(…)

removeEventListener(…) this

Псевдоним для off(…)

clearAllEventListeners(…) this

Псевдоним для off()

addOneTimeEventListener(…) this

Псевдоним для once(…)

fireEvent(…) this

Псевдоним для fire(…)

hasEventListeners(…) Boolean

Псевдоним для listens(…)

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

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

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

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

Событие

Базовый объект события. Все остальные объекты событий также содержат эти свойства.
Свойство Тип Описание
type String The event type (e.g. 'click').
target Object The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
sourceTarget Object The object that originally fired the event. For non-propagated events, this will be the same as the target.
propagatedFrom Object For propagated events, the last object that propagated the event to its event parent.
layer Object Deprecated. The same as propagatedFrom.

KeyboardEvent

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

MouseEvent

Свойство Тип Описание
latlng LatLng The geographical point where the mouse event occured.
layerPoint Point Pixel coordinates of the point where the mouse event occured relative to the map layer.
containerPoint Point Pixel coordinates of the point where the mouse event occured relative to the map сontainer.
originalEvent DOMEvent The original DOM MouseEvent or DOM TouchEvent that triggered this Leaflet event.
Свойство Тип Описание
type String The event type (e.g. 'click').
target Object The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
sourceTarget Object The object that originally fired the event. For non-propagated events, this will be the same as the target.
propagatedFrom Object For propagated events, the last object that propagated the event to its event parent.
layer Object Deprecated. The same as propagatedFrom.

LocationEvent

Свойство Тип Описание
latlng LatLng Detected geographical location of the user.
bounds LatLngBounds Geographical bounds of the area user is located in (with respect to the accuracy of location).
accuracy Number Accuracy of location in meters.
altitude Number Height of the position above the WGS84 ellipsoid in meters.
altitudeAccuracy Number Accuracy of altitude in meters.
heading Number The direction of travel in degrees counting clockwise from true North.
speed Number Current velocity in meters per second.
timestamp Number The time when the position was acquired.
Свойство Тип Описание
type String The event type (e.g. 'click').
target Object The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
sourceTarget Object The object that originally fired the event. For non-propagated events, this will be the same as the target.
propagatedFrom Object For propagated events, the last object that propagated the event to its event parent.
layer Object Deprecated. The same as propagatedFrom.

ErrorEvent

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

LayerEvent

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

LayersControlEvent

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

TileEvent

Свойство Тип Описание
tile HTMLElement The tile element (image).
coords Point Point object with the tile's x, y, and z (zoom level) coordinates.
Свойство Тип Описание
type String The event type (e.g. 'click').
target Object The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
sourceTarget Object The object that originally fired the event. For non-propagated events, this will be the same as the target.
propagatedFrom Object For propagated events, the last object that propagated the event to its event parent.
layer Object Deprecated. The same as propagatedFrom.

TileErrorEvent

Свойство Тип Описание
tile HTMLElement The tile element (image).
coords Point Point object with the tile's x, y, and z (zoom level) coordinates.
error * Error passed to the tile's done() callback.
Свойство Тип Описание
type String The event type (e.g. 'click').
target Object The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
sourceTarget Object The object that originally fired the event. For non-propagated events, this will be the same as the target.
propagatedFrom Object For propagated events, the last object that propagated the event to its event parent.
layer Object Deprecated. The same as propagatedFrom.

ResizeEvent

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

GeoJSONEvent

Свойство Тип Описание
layer Layer The layer for the GeoJSON feature that is being added to the map.
properties Object GeoJSON properties of the feature.
geometryType String GeoJSON geometry type of the feature.
id String GeoJSON ID of the feature (if present).
Свойство Тип Описание
type String The event type (e.g. 'click').
target Object The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
sourceTarget Object The object that originally fired the event. For non-propagated events, this will be the same as the target.
propagatedFrom Object For propagated events, the last object that propagated the event to its event parent.

PopupEvent

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

TooltipEvent

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

DragEndEvent

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

ZoomAnimEvent

Свойство Тип Описание
center LatLng The current center of the map
zoom Number The current zoom level of the map
noUpdate Boolean Whether layers should update their contents due to this event
Свойство Тип Описание
type String The event type (e.g. 'click').
target Object The object that fired the event. For propagated events, the last object in the propagation chain that fired the event.
sourceTarget Object The object that originally fired the event. For non-propagated events, this will be the same as the target.
propagatedFrom Object For propagated events, the last object that propagated the event to its event parent.
layer Object Deprecated. The same as propagatedFrom.

DivOverlay

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

Параметры

Вариант Тип Значение по умолчанию Описание
offset Point Point(0, 7) Смещение позиции всплывающего окна. Полезно для управления якорем всплывающего окна при открытии на некоторых перекрытиях.
className String '' Настраиваемое имя класса CSS для назначения всплывающему окну.
pane String 'popupPane' Map pane куда будет добавлено всплывающее окно.
Вариант Тип Значение по умолчанию Описание
attribution String null Строка, отображаемая в элементе подписи, например, «© OpenStreetMap contributors». Она описывает данные слоя и часто является обязательством перед правообладателями и поставщиками тайлов.

События

Событие Данные Описание
add Event Fired after the layer is added to a map
remove Event Fired after the layer is removed from a map
Событие Данные Описание
popupopen PopupEvent Fired when a popup bound to this layer is opened
popupclose PopupEvent Fired when a popup bound to this layer is closed
Событие Данные Описание
tooltipopen TooltipEvent Fired when a tooltip bound to this layer is opened.
tooltipclose TooltipEvent Fired when a tooltip bound to this layer is closed.

Методы

Метод Возвращаемое значение Описание
addTo(<Map|LayerGroup> map) this

Добавляет слой на указанную карту или группу слоёв.

remove() this

Удаляет слой с карты, на которой он в данный момент активен.

removeFrom(<Map> map) this

Удаляет слой с заданной карты.

getPane(<String> name?) HTMLElement

Возвращает HTMLElement, представляющий собой именованный элемент на панели карты. Если name опущено, возвращается элемент панели для данного слоя.

getAttribution() String

Используется модулем attribution control, возвращает опцию подписи attribution.

Метод Возвращаемое значение Описание
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?) this

Привязывает всплывающее окно к слою с переданным content и настраивает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindPopup() this

Удаляет всплывающее окно, ранее привязанное с помощью bindPopup.

openPopup(<LatLng> latlng?) this

Открывает привязанное всплывающее окно в указанной latlng или по умолчанию, если latlng не передан.

closePopup() this

Закрывает привязанное к слою всплывающее окно, если оно открыто.

togglePopup() this

Открывает или закрывает привязанное к слою всплывающее окно в зависимости от его текущего состояния.

isPopupOpen() boolean

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

setPopupContent(<String|HTMLElement|Popup> content) this

Устанавливает содержимое всплывающего окна, привязанного к этому слою.

getPopup() Popup

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

Метод Возвращаемое значение Описание
bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?) this

Привязывает подсказку к слою с переданным content и настраивает необходимые обработчики событий. Если передан Function, он получит слой в качестве первого аргумента и должен вернуть String или HTMLElement.

unbindTooltip() this

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

openTooltip(<LatLng> latlng?) this

Открывает привязанную подсказку в указанной latlng или по умолчанию, если latlng не передан.

closeTooltip() this

Закрывает привязанную к слою подсказку, если она открыта.

toggleTooltip() this

Открывает или закрывает привязанную к слою подсказку в зависимости от её текущего состояния.

isTooltipOpen() boolean

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

setTooltipContent(<String|HTMLElement|Tooltip> content) this

Устанавливает содержимое подсказки, привязанной к этому слою.

getTooltip() Tooltip

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

Метод Возвращаемое значение Описание
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 не использовать события touch, даже если они обнаружены.
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.4.0.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API