cone.maps 0.2__py3-none-any.whl

cone/maps/__init__.py

@@ -0,0 +1,64 @@
+from cone.app import cfg
+from cone.app import main_hook
+from cone.maps.browser import static_resources
+import logging
+
+
+logger = logging.getLogger('cone.maps')
+
+
+@main_hook
+def initialize_maps(config, global_config, settings):
+    # application startup initialization
+
+    # ignore yafowil leaflet dependencies if cone.maps is installed
+    cfg.yafowil.js_skip.add('yafowil.widget.location.dependencies')
+    cfg.yafowil.css_skip.add('yafowil.widget.location.dependencies')
+
+    # resources
+    if settings.get('cone.maps.public', 'false') == 'true':
+        css_res = cfg.css.public
+        js_res = cfg.js.public
+    else:
+        css_res = cfg.css.protected
+        js_res = cfg.js.protected
+
+    # leaflet core
+    css_res.append('maps-static/leaflet/leaflet.css')
+    js_res.append('maps-static/leaflet/leaflet.js')
+
+    # Leaflet.TileLayer.NoGap
+    if settings.get('cone.maps.nogap', 'false') == 'true':
+        js_res.append('maps-static/leaflet-nogap/L.TileLayer.NoGap.js')
+
+    # leaflet-geosearch
+    if settings.get('cone.maps.geosearch', 'false') == 'true':
+        css_res.append('maps-static/leaflet-geosearch/geosearch.css')
+        js_res.append('maps-static/leaflet-geosearch/geosearch.umd.js')
+
+    # Leaflet.markercluster
+    if settings.get('cone.maps.markercluster', 'false') == 'true':
+        css_res.append('maps-static/leaflet-markercluster/MarkerCluster.css')
+        css_res.append('maps-static/leaflet-markercluster/MarkerCluster.Default.css')
+        js_res.append('maps-static/leaflet-markercluster/leaflet.markercluster.js')
+
+    # Leaflet-active-area
+    if settings.get('cone.maps.activearea', 'false') == 'true':
+        js_res.append('maps-static/leaflet-activearea/leaflet.activearea.js')
+
+    # proj4js and Proj4Leaflet
+    if settings.get('cone.maps.proj4', 'false') == 'true':
+        js_res.append('maps-static/proj4js/proj4.js')
+        js_res.append('maps-static/leaflet-proj4/proj4leaflet.js')
+
+    # cone maps
+    js_res.append('maps-static/cone.maps.js')
+
+    # add translation
+    config.add_translation_dirs('cone.maps:locale/')
+
+    # static resources
+    config.add_view(static_resources, name='maps-static')
+
+    # scan browser package
+    config.scan('cone.maps.browser')

cone/maps/browser/__init__.py

@@ -0,0 +1,4 @@
+from pyramid.static import static_view
+
+
+static_resources = static_view('static', use_subpath=True)

cone/maps/browser/map.py

@@ -0,0 +1,139 @@
+from cone.tile import Tile
+import json
+
+
+class MapTile(Tile):
+    """Tile rendering a leaflet map.
+
+    Reference: https://leafletjs.com/reference.html
+    """
+
+    map_factory = 'cone_maps.Map'
+    """Factory used for map creation in Javascript.
+
+    The definded factory must accept the map related DOM element as argument
+    and is responsible to initialize the leaflet map.
+
+    It points to a class or function and does property lookup on window with
+    '.' as delimiter, e.g:
+
+        'cone_maps.Map'
+
+    corresponds to:
+
+        cone_maps: {
+            Map: {}
+        }
+
+    If JS map factory needs to be customized, this is usually done by subclassing
+    'cone_maps.Map':
+
+        my_namespace = {};
+
+        my_namespace.Map = class extends cone_maps.Map {
+            constructor(elem) {
+                elem.height(800);
+                super(elem);
+            }
+        }
+    """
+
+    map_id = 'map'
+    """HTML id of the map.
+    """
+
+    map_css = 'cone-map'
+    """CSS class of the map element.
+
+    The default JS map implementation searches for
+    for all `div` elements with `cone-map` CSS class set and initializes map
+    instances for them.
+
+    If it's desired to completly customize map instancing on client side, this
+    property must be changed.
+    """
+
+    map_options = {}
+    """Map options passed to the leaflet map constructor.
+
+    See: https://leafletjs.com/reference.html#map-l-map
+    """
+
+    map_control_options = {}
+    """Layers control options passed to the leaflet layers control constructor.
+
+    See: https://leafletjs.com/reference.html#control-layers
+    """
+
+    map_layers = [{
+        # general layer options
+        'factory': 'tile_layer',   # layer factory
+        'category': 'base',        # base|overlay
+        'display': True,           # initial display
+        'title': 'OpenStreetMap',  # layer title
+        # factory specific layer options
+        'urlTemplate': '//{s}.tile.openstreetmap.org/{z}/{x}/{y}.png',
+        'options': {
+            'attribution': 'OSM map data © <a href="http://openstreetmap.org">OSM</a>',
+            'minZoom': 2,
+            'maxZoom': 18
+        }
+    }]
+    """List of map layer definitions.
+
+    See: https://leafletjs.com/reference.html
+    """
+
+    map_center = [47.2688805, 11.3929127]
+    """The default (initial) center of the map as lat/lng.
+    """
+
+    map_zoom = 8
+    """The default (initial) zoom level of the map
+    """
+
+    map_markers = []
+    """List of map markers to display.
+    """
+
+    map_markers_source = None
+    """JSON endpoint to fetch markers from.
+    """
+
+    map_marker_groups = []
+    """List of map marker groups to display.
+    """
+
+    map_marker_groups_source = None
+    """JSON endpoint to fetch marker groups from.
+    """
+
+    def render(self):
+        return (
+            u'<div class="{css}"'
+            u'     id="{id}"'
+            u'     data-map-factory="{factory}"'
+            u'     data-map-options=\'{options}\''
+            u'     data-map-control-options=\'{control_options}\''
+            u'     data-map-layers=\'{layers}\''
+            u'     data-map-center=\'{center}\''
+            u'     data-map-zoom="{zoom}"'
+            u'     data-map-markers=\'{markers}\''
+            u'     data-map-markers-source="{markers_source}"'
+            u'     data-map-groups=\'{marker_groups}\''
+            u'     data-map-groups-source="{marker_groups_source}" >'
+            u'</div>'
+        ).format(
+            css=self.map_css,
+            id=self.map_id,
+            factory=self.map_factory,
+            options=json.dumps(self.map_options),
+            control_options=json.dumps(self.map_control_options),
+            layers=json.dumps(self.map_layers),
+            center=json.dumps(self.map_center),
+            zoom=self.map_zoom,
+            markers=self.map_markers,
+            markers_source=self.map_markers_source,
+            marker_groups=self.map_marker_groups,
+            marker_groups_source=self.map_marker_groups_source,
+        )

cone/maps/browser/static/cone.maps.js

@@ -0,0 +1,109 @@
+(function (exports, $) {
+    'use strict';
+
+    function lookup_factory(name) {
+        let ob = window;
+        for (let part of name.split('.')) {
+            ob = ob[part];
+            if (ob === undefined) {
+                throw "Cannot locate map factory: " + name;
+            }
+        }
+        return ob;
+    }
+    let layer_factories = {};
+    layer_factories.tile_layer = function(inst, cfg) {
+        inst.layer_created(new L.TileLayer(cfg.urlTemplate, cfg.options), cfg);
+    };
+    layer_factories.geo_json = function(inst, cfg) {
+        $.getJSON(cfg.dataUrl, function(data) {
+            inst.layer_created(new L.GeoJSON(data, cfg.options), cfg);
+        });
+    };
+    class Map {
+        static initialize(context) {
+            $('div.cone-map', context).each(function() {
+                let elem = $(this);
+                let factory = lookup_factory(elem.data('map-factory'));
+                new factory(elem);
+            });
+        }
+        constructor(elem) {
+            this.elem = elem;
+            this.id = elem.attr('id');
+            this.layers = elem.data('map-layers');
+            this.default_center = elem.data('map-center');
+            this.default_zoom = elem.data('map-zoom');
+            this.map_options = elem.data('map-options');
+            this.control_options = elem.data('map-control-options');
+            this.markers = elem.data('data-map-markers');
+            this.markers_source = elem.data('data-map-markers-source');
+            this.marker_groups = elem.data('data-map-groups');
+            this.marker_groups_source = elem.data('data-map-groups-source');
+            this.create();
+            elem.data('map-instance', this);
+        }
+        create() {
+            this.create_map();
+            this.create_controls();
+            this.create_layers();
+        }
+        create_map() {
+            this.map = new L.Map(this.id, this.map_options);
+            this.map.setView(this.default_center, this.default_zoom);
+        }
+        create_controls() {
+            let base_maps = [],
+                overlay_maps = [];
+            this.map_layers = new L.control.Layers(
+                base_maps,
+                overlay_maps,
+                this.control_options
+            );
+            this.map_layers.addTo(this.map);
+        }
+        create_layers() {
+            for (let l of this.layers) {
+                layer_factories[l.factory](this, l);
+            }
+        }
+        layer_created(layer, cfg) {
+            cfg.layer = layer;
+            if (cfg.display === undefined || cfg.display) {
+                this.add_layer(layer);
+            }
+            if (cfg.category === 'base') {
+                this.map_layers.addBaseLayer(layer, cfg.title);
+            } else if (cfg.category === 'overlay') {
+                this.map_layers.addOverlay(layer, cfg.title);
+            }
+        }
+        add_layer(layer) {
+            this.map.addLayer(layer);
+        }
+        remove_layer(layer) {
+            this.map.removeLayer(layer);
+        }
+    }
+
+    $(function() {
+        if (window.ts !== undefined) {
+            ts.ajax.register(Map.initialize, true);
+        } else {
+            bdajax.register(Map.initialize, true);
+        }
+    });
+
+    exports.Map = Map;
+    exports.layer_factories = layer_factories;
+    exports.lookup_factory = lookup_factory;
+
+    Object.defineProperty(exports, '__esModule', { value: true });
+
+
+    window.cone_maps = exports;
+
+
+    return exports;
+
+})({}, jQuery);

cone/maps/browser/static/cone.maps.min.js

@@ -0,0 +1 @@
+!function(a,t){"use strict";function e(a){let t=window;for(let e of a.split("."))if(t=t[e],void 0===t)throw"Cannot locate map factory: "+a;return t}let r={tile_layer:function(a,t){a.layer_created(new L.TileLayer(t.urlTemplate,t.options),t)},geo_json:function(a,e){t.getJSON(e.dataUrl,(function(t){a.layer_created(new L.GeoJSON(t,e.options),e)}))}};class i{static initialize(a){t("div.cone-map",a).each((function(){let a=t(this);new(e(a.data("map-factory")))(a)}))}constructor(a){this.elem=a,this.id=a.attr("id"),this.layers=a.data("map-layers"),this.default_center=a.data("map-center"),this.default_zoom=a.data("map-zoom"),this.map_options=a.data("map-options"),this.control_options=a.data("map-control-options"),this.markers=a.data("data-map-markers"),this.markers_source=a.data("data-map-markers-source"),this.marker_groups=a.data("data-map-groups"),this.marker_groups_source=a.data("data-map-groups-source"),this.create(),a.data("map-instance",this)}create(){this.create_map(),this.create_controls(),this.create_layers()}create_map(){this.map=new L.Map(this.id,this.map_options),this.map.setView(this.default_center,this.default_zoom)}create_controls(){this.map_layers=new L.control.Layers([],[],this.control_options),this.map_layers.addTo(this.map)}create_layers(){for(let a of this.layers)r[a.factory](this,a)}layer_created(a,t){t.layer=a,(void 0===t.display||t.display)&&this.add_layer(a),"base"===t.category?this.map_layers.addBaseLayer(a,t.title):"overlay"===t.category&&this.map_layers.addOverlay(a,t.title)}add_layer(a){this.map.addLayer(a)}remove_layer(a){this.map.removeLayer(a)}}t((function(){void 0!==window.ts?ts.ajax.register(i.initialize,!0):bdajax.register(i.initialize,!0)})),a.Map=i,a.layer_factories=r,a.lookup_factory=e,Object.defineProperty(a,"__esModule",{value:!0}),window.cone_maps=a}({},jQuery);