Skip to content

Latest commit

 

History

History
151 lines (112 loc) · 5.25 KB

README.md

File metadata and controls

151 lines (112 loc) · 5.25 KB
Raw

Leaflet

Integration with a recent version of the Leaflet JS mapping library, a modern, lightweight Open-Source library for interactive maps.

The Leaflet module features:

  • Field formatter for the Geofield to render geospatial data as maps (main module)
  • Views integration that plots data on a map (using the sub module Leaflet Views)
  • Animated marker clustering functionality using the Leaflet MarkerCluster library (in a sub module)
  • A lot more attractive map styles from a variety of providers (in another sub module)
  • A demo block for all those map styles (in its own sub module)
  • Lightweight and easy to use API for defining maps and displaying data on a map

Coming from Drupal 7?

The formerly extra contrib projects Leaflet Markercluster and Leaflet More Maps now both ship with this module. And so do the required Javascript libraries. This makes the Leaflet module your "one-stop shop" for mapping in Backdrop.

Example map

Installation

Related modules

The Leaflet Widget utilizes this module's library to input values like markers or geometries into Geofields in a user-friendly way.

If you need a legacy version of the leaflet library: Leaflet library ships with version 1.2.0. Note that the library module is no dependency of this module, as this one ships with the most recent version of Leaflet.

Issues

Bugs and feature requests should be reported in the Issue Queue.

Views integration

To render a map using Views, enable the module leaflet_views.

You need to add at least one geofield to the Fields list, and select the Leaflet Map style in Format.

In the settings of the style, select the geofield as the Data Source and select a field for Title and Description (which will be rendered in the popup).

As a more powerful alternative, you can use node view modes to be rendered in the popup. In the Description field, select <entire node> and then select a View mode.

For a tutorial, please read this (relatively old) blog post https://marzeelabs.org/blog/2012-09-24-building-maps-in-drupal-using-leaflet-views

API Usage (for developers)

Building a map is as simple as calling a single method, leaflet_build_map(), which takes 3 parameters.

$map (array) An associative array defining a map. See hook_leaflet_map_info(). The module defines a default map with a OpenStreet Maps base layer.

$features (array) This is the tricky part. This is an associative array of all the features you want to plot on the map. A feature can be a point, linestring, polygon, multilinestring, multipolygon, or json object. Additionally, features can be grouped into layer groups so they can be controlled together, https://leafletjs.com/reference.html#layergroup. A feature will look something like:

$features = array(
  array(
    'type' => 'point',
    'lat' => 12.32,
    'lon' => 123.45,
    'icon' => array(
      'iconUrl' => 'sites/default/files/mymarker.png'
    ),
    'popup' => l($node->title, 'node/' . $node->nid),
    'leaflet_id' => 'some unique ID'
  ),
  array(
    'type' => 'linestring',
    'points' => array(
      0 => array('lat' => 13.24, 'lon' => 123.2),
      1 => array('lat' => 13.24, 'lon' => 123.2),
      2 => array('lat' => 13.24, 'lon' => 123.2),
      3 => array('lat' => 13.24, 'lon' => 123.2),
      4 => array('lat' => 13.24, 'lon' => 123.2),
    ),
    'popup' => l($node->title, 'node/' . $node->nid),
    'leaflet_id' => 'some unique ID'
  ),
  array(
    'type' => 'json',
    'json' => [JSON OBJECT],
    'properties' = array(
      'style' => [style settings],
      'leaflet_id' => 'some unique ID'
    )
  )
);

$height (string) Height of the map expressed in pixels. Append 'px'. Default: '400px'.

Current Maintainers

Credits

This module wouldn't be possible without the fabulous Leaflet Javascript library, see their LICENSE file for details.

The also bundled Leaflet.markercluster library by the same team uses MIT License

This module also ships with several Leaflet plugins, see the README.md file in the libraries/leaflet_plugins directory for details.

The default map style provided by the main module is "OSM Mapnik", which relies on OpenStreetMap data.

License

This project is GPL v2 software. See the LICENSE.txt file in this directory for complete text.