cone.maps 1.1.0
Maps integration into cone using leaflet.js.
License: Simplified BSD
Requires Python: >=3.10
Keywords: cone, node, pyramid, web

.. image:: https://img.shields.io/pypi/v/cone.maps.svg
    :target: https://pypi.python.org/pypi/cone.maps
    :alt: Latest PyPI version

.. image:: https://img.shields.io/pypi/dm/cone.maps.svg
    :target: https://pypi.python.org/pypi/cone.maps
    :alt: Number of PyPI downloads

.. image:: https://github.com/conestack/cone.maps/actions/workflows/test.yml/badge.svg
    :target: https://github.com/conestack/cone.maps/actions/workflows/test.yml
    :alt: Test cone.maps


This package provides maps integration in to cone.app.

* As maps library, `Leaflet JS <https://leafletjs.com/>`_ (v1.7.1) is included.

* For avoiding 1px gap between tiles,
  `Leaflet.TileLayer.NoGap <https://github.com/Leaflet/Leaflet.TileLayer.NoGap>`_
  `(ab4f107) <https://github.com/Leaflet/Leaflet.TileLayer.NoGap/commit/ab4f107fecb80e12ffbdc4ebbedf5f85b8da7173>`_ is included.

* For geocoding,
  `leaflet-geosearch <https://smeijer.github.io/leaflet-geosearch>`_
  (3.5.0) is included.

* For grouping of map markers,
  `Leaflet.markercluster <https://github.com/Leaflet/Leaflet.markercluster>`_
  (1.5.3) is included.

* For making geometries editable in Leaflet,
  `Leaflet.Editable <https://github.com/Leaflet/Leaflet.Editable>`_
  (1.2.0) is included.

* For adding dragging capability to Leaflet paths,
  `Path.Drag.js <https://github.com/Leaflet/Path.Drag.js>`_
  (0.0.6) is included.

* For defining active map area, e.g. if parts of a map is used as background,
  `Leaflet-active-area <https://github.com/Mappy/Leaflet-active-area>`_
  (1.2.0) is included.

* For general CRS projection support,
  `proj4js <https://github.com/proj4js/proj4js>`_ (2.7.5) and
  `Proj4Leaflet <https://github.com/kartena/Proj4Leaflet>`_ (1.0.2)
  are included


Map Widget
----------

A map widget tile is included which provides OOTB default map behavior and
can be used as starting point for complex custom maps.

.. code-block:: python

    from cone.maps.browser.map import MapTile
    from cone.tile import tile
    from myplugin import MyModel

    @tile(name='map', interface=MyModel)
    class MyMap(MapTile):
        """See ``cone.maps.browser.map`` for available tile options.
        """

Not that ``cone.maps`` defines by default no height for maps. This must be
done explicitely using CSS, or via custom JS map class.


Resources
---------

The following ``cone.maps`` related application configuration options are
available :

- **cone.maps.public**: Flag whether browser resources are delivered for
  unauthenticated users. Defaults to `false`.

- **cone.maps.nogap**: Flag whether to include ``Leaflet.TileLayer.NoGap``
  plugin. Defaults to `false`.

- **cone.maps.geosearch**: Flag whether to include ``leaflet-geosearch``
  plugin. Defaults to `false`.

- **cone.maps.markercluster**: Flag whether to include ``Leaflet.markercluster``
  plugin. Defaults to `false`.

- **cone.maps.editable**: Flag whether to include ``Leaflet.Editable`` plugin.
  Defaults to `false`.

- **cone.maps.pathdrag**: Flag whether to include ``Path.Drag.js`` plugin.
  Defaults to `false`.

- **cone.maps.activearea**: Flag whether to include ``Leaflet-active-area``
  plugin. Defaults to `false`.

- **cone.maps.proj4**: Flag whether to include ``proj4js`` and ``Proj4Leaflet``
  plugins. Defaults to `false`.


Contributors
============

- Robert Niederreiter


TODO
====

- Default map marker rendering (from DOM elem data directly and from
  JSON endpoint)

- Default map markercluster rendering (from DOM elem data directly and from
  JSON endpoint)

- Geosearch on default map.

- Activearea config on default map.


Changes
=======

1.1.0 (2026-02-03)
------------------

- Refactor package layout to use ``pyproject.toml`` and implicit namespace packages.
  [rnix]

- Setup Makefile.
  [lenadax]

- Run tests with pytest.
  [lenadax]

- Add ``Path.Drag.js`` to resources.
  [rnix]

- Add ``Leaflet.Editable`` to resources.
  [rnix]

- Map settings are defined via ``MapTile.map_settings`` property.
  [rnix]

- Map settings gets rendered as single data attribute.
  [rnix]

- Add ``MapTile.map_bounds`` property.
  [rnix]

- Fix control layers creation in ``Map.create_controls``.
  [rnix]

- Implement map markers from JSON source.
  [rnix]

- Implement static map markers.
  [rnix]


0.1 (2021-11-21)
----------------

- Initial release.
  [rnix]


License
=======

Copyright (c) 2021-2025, Cone Contributors
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this
  list of conditions and the following disclaimer in the documentation and/or
  other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.