django-extended-ol 0.1.0__py3-none-any.whl

django_extended_ol/admin.py

@@ -0,0 +1,6 @@
+from django.contrib.gis.admin import GISModelAdmin
+from .forms.widgets import WMTSWidget
+
+
+class WMTSGISModelAdmin(GISModelAdmin):
+    gis_widget = WMTSWidget

django_extended_ol/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class OlwidgetConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "django_extended_ol"
+    label = "olwidget"

django_extended_ol/forms/widgets.py

@@ -0,0 +1,39 @@
+from django.contrib.gis.forms.widgets import OpenLayersWidget
+from django.conf import settings
+
+
+class WMTSWidget(OpenLayersWidget):
+    template_name = "gis/openlayers-wmts.html"
+    map_srid = settings.OLWIDGET["globals"].get("srid", 4326)
+    extent = settings.OLWIDGET["globals"]["extent"]
+    center_from_extent = [
+            (extent[0] + extent[2]) / 2,
+            (extent[1] + extent[3]) / 2,
+        ]
+    print(center_from_extent)
+    widget_options = {
+        "wmts_layer_name": settings.OLWIDGET["wmts"].get("layer_name"),
+        "wmts_style": settings.OLWIDGET["wmts"]["style"],
+        "wmts_matrix_set": settings.OLWIDGET["wmts"]["matrix_set"],
+        "wmts_attributions": settings.OLWIDGET["wmts"].get("attributions", None),
+        "wmts_url_template": settings.OLWIDGET["wmts"]["url_template"],
+        "wmts_request_encoding": settings.OLWIDGET["wmts"].get("request_encoding", 'KVP'),
+        "wmts_format": settings.OLWIDGET["wmts"].get("format", None),
+        "default_map_center": settings.OLWIDGET["globals"].get("default_center", center_from_extent),
+        "default_resolution": settings.OLWIDGET["globals"].get("default_resolution", 8),
+        "extent": extent,
+        "resolutions" : settings.OLWIDGET["globals"]["resolutions"]
+    }
+
+    class Media(OpenLayersWidget.Media):
+        js = OpenLayersWidget.Media.js + (
+            "olwidget/js/WMTSWidget.js",
+        )
+
+    def __init__(self, attrs=None):
+        super().__init__()
+        # Give widget_options to the template
+        for key in self.widget_options.keys():
+            self.attrs[key] = self.widget_options[key]
+        if attrs:
+            self.attrs.update(attrs)

django_extended_ol/static/olwidget/js/WMTSWidget.js

@@ -0,0 +1,27 @@
+/* global ol */
+'use strict';
+
+class WMTSWidget extends MapWidget {
+    createMap() {
+        this.map_extent = this.options.extent;
+        this.projection = new ol.proj.Projection({
+            code: `EPSG:${this.options.map_srid}`,
+            extent: this.map_extent,
+        });
+        return new ol.Map({
+            target: this.options.map_id,
+            layers: [this.options.base_layer],
+            view: new ol.View({
+                center: this.options.default_center,
+                resolution: this.options.default_resolution,
+                projection: this.projection,
+                resolutions: this.options.resolutions,
+                constrainResolution: true
+            })
+        });
+    }
+
+    defaultCenter() {
+        return this.options.default_center;
+    }
+}

django_extended_ol/templates/gis/openlayers-wmts.html

@@ -0,0 +1,59 @@
+<!--
+  This is a copy from django/contrib/gis/templates/gis/openlayers.html 
+  The call to OlMapWidget() is not in a block so the base html template cannot be extended
+-->
+{% load i18n l10n %}
+
+<div id="{{ id }}_div_map" class="dj_map_wrapper">
+    <div id="{{ id }}_map" class="dj_map"></div>
+    {% if not disabled %}<span class="clear_features"><a href="">{% translate "Delete all Features" %}</a></span>{% endif %}
+    {% if display_raw %}<p>{% translate "Debugging window (serialized value)" %}</p>{% endif %}
+    <textarea id="{{ id }}" class="vSerializedField required" cols="150" rows="10" name="{{ name }}"
+              {% if not display_raw %} hidden{% endif %}>{{ serialized }}</textarea>
+    <script>
+      {% block options %}var options = {
+        geom_name: '{{ geom_type }}',
+        id: '{{ id }}',
+        map_id: '{{ id }}_map',
+        map_srid: {{ map_srid|unlocalize }},
+        name: '{{ name }}',
+        extent: {{ extent|safe }},
+        default_center: {{ default_map_center|safe }},
+        resolutions: {{ resolutions|safe }},
+        default_resolution: {{ default_resolution|unlocalize }}
+      };
+      {% endblock %}
+
+{% block base_layer %}
+
+const matrixIds = [];
+for (let i = 0; i < options.resolutions.length; i += 1) {
+  matrixIds.push(i);
+}
+
+const tileGrid = new ol.tilegrid.WMTS({
+  origin: [options.extent[0], options.extent[3]],
+  resolutions: options.resolutions,
+  matrixIds
+});
+
+const WMTSOptions = {
+  layer: '{{ wmts_layer_name }}',
+  style: '{{ wmts_style }}',
+  matrixSet: '{{ wmts_matrix_set }}',
+  crossOrigin: 'anonymous',
+  attributions: '{{ wmts_attributions|safe }}',
+  url: '{{ wmts_url_template }}',
+  tileGrid: tileGrid,
+  requestEncoding: '{{ wmts_request_encoding }}',
+  format: '{{ wmts_format }}'
+}
+
+options.base_layer = new ol.layer.Tile({
+  source: new ol.source.WMTS(WMTSOptions),
+});
+{% endblock %}
+
+var {{ module }} = new WMTSWidget(options);
+</script>
+</div>

django_extended_ol-0.1.0.dist-info/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Canton de Neuchâtel - SITN
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. 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.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+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.

django_extended_ol-0.1.0.dist-info/METADATA

@@ -0,0 +1,84 @@
+Metadata-Version: 2.1
+Name: django-extended-ol
+Version: 0.1.0
+Summary: An openlayers widget for Django with extended capabilities
+Author-email: SITN <sitn@ne.ch>
+Project-URL: Homepage, https://github.com/sitn/django-extended-ol
+Project-URL: Issues, https://github.com/sitn/django-extended-ol/issues
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django >=5.0
+
+# django-extended-ol
+
+django-extended-ol is a Django app that extends the basic OpenLayers Widget.
+
+* Custom WMTS base_layer with fixed resolutions
+
+## Quick start
+
+1. Add "olwidget" to your INSTALLED_APPS setting like this:
+
+```python
+INSTALLED_APPS = [
+    ...,
+    "olwidget",
+]
+```
+
+2. Configure olwidget in your settings.py, here's an example:
+
+```python
+OLWIDGET = {
+    "globals": {
+        "srid": 2056,
+        "default_center": [2551470, 1211190], # optional
+        "default_resolution": 18, # optional
+        "extent": [2420000, 1030000, 2900000, 1360000],
+        "resolutions": [250, 100, 50, 20, 10, 5, 2.5, 2, 1.5, 1, 0.5, 0.25, 0.125, 0.0625]
+    },
+    "wmts": {
+        "layer_name": 'plan_cadastral',
+        "style": 'default',
+        "matrix_set": 'EPSG2056',
+        "attributions": '<a target="new" href="https://sitn.ne.ch/web/conditions_utilisation/contrat_SITN_MO.htm'
+            + '">© SITN</a>', # optional
+        "url_template": 'https://sitn.ne.ch/mapproxy95/wmts/1.0.0/{layer}/{style}/{TileMatrixSet}/{TileMatrix}/{TileRow}/{TileCol}.png',
+        "request_encoding": 'REST', # optional
+        "format": 'image/png' # optional
+    }
+}
+```
+
+3. You can now use WMTSWidget in your gis forms:
+
+```python
+gis_widget = WMTSWidget
+```
+
+4. You can also use it in your admin.py:
+
+```python
+    from django.contrib.gis import admin
+    from .models import YourGeomModel
+    from olwidget.admin import WMTSGISModelAdmin
+
+    admin.site.register(YourGeomModel, WMTSGISModelAdmin)
+```
+
+5. Start the development server and visit the admin.

django_extended_ol-0.1.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+django_extended_ol/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_extended_ol/admin.py,sha256=tE7_DtllUHuNSEpsKLkfUdLpSX7uhjZa-Q5y2UH7h7A,165
+django_extended_ol/apps.py,sha256=hw3h5JXhThL1TSDfWa2wxwBTWvCHuaEHWb8axT_QP88,188
+django_extended_ol/forms/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+django_extended_ol/forms/widgets.py,sha256=uVSj4TuJLGV-Fn8-AJsj00nrxZXSwwHqBI5IC2lErHc,1712
+django_extended_ol/static/olwidget/js/WMTSWidget.js,sha256=6fGzhd8wx20Oll_64fu7ZPfs9MZwj74vQYZ7hnanfxE,796
+django_extended_ol/templates/gis/openlayers-wmts.html,sha256=4MhZr_ldK_w7t2sswmHjTekX_P_js9SsXHW_0ESBSPw,1926
+django_extended_ol-0.1.0.dist-info/LICENSE,sha256=0uvSPKfP0VUrQ1XqeXD62tYc54cfQqt21YI9lWW9hq8,1564
+django_extended_ol-0.1.0.dist-info/METADATA,sha256=aXRMb31ksRmTegqtGBm0I1HQHSn-_szdC8rvpDHT3WY,2721
+django_extended_ol-0.1.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+django_extended_ol-0.1.0.dist-info/top_level.txt,sha256=rX8AqitfQu0etd6PoOeNxcRl5fsus-YOs932PGUjDIs,19
+django_extended_ol-0.1.0.dist-info/RECORD,,

django_extended_ol-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.1.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

django_extended_ol-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+django_extended_ol