GeoDjango formulär API

GeoDjango tillhandahåller några specialiserade formulärfält och widgets för att visuellt visa och redigera geolokaliserade data på en karta. Som standard använder de OpenLayers-drivna kartor, med ett grundläggande WMS-lager som tillhandahålls av NASA.

Fältargument

Förutom de vanliga formulärfältsargumenten, tar GeoDjango formulärfält följande valfria argument.

srid

Field.srid

Detta är den SRID-kod som fältvärdet ska omvandlas till. Om SRID för kartwidgeten t.ex. skiljer sig från den SRID som används mer allmänt i programmet eller databasen, konverterar fältet automatiskt inmatningsvärden till den SRID:en.

geom_typ

Field.geom_type

Du bör i allmänhet inte behöva ställa in eller ändra det attributet som bör ställas in beroende på fältklassen. Det matchar OpenGIS standardgeometrinamn.

max_geom_collections

Field.max_geom_collections

Det maximala antalet geometrisamlingar som fältet accepterar innan det vägrar att tolka indata och utlöser ValidationError. Detta skyddar mot krascher i det underliggande GEOS-biblioteket vid tolkning av djupt nästlad GEOMETRYCOLLECTION-indata. Standardvärdet är 198.

Gränsen tillämpas olika beroende på indataformatet: för well-known text (WKT) begränsar den nästlings*djupet*, medan den för well-known binary (WKB och hex-kodad WKB) begränsar det totala antalet geometrisamlingar (både bredd och djup). Följaktligen kan samma värde acceptera en bred, grund samling som WKT men avvisa den som WKB. För GeoJSON tillämpas gränsen inte alls eftersom GDAL i stället tolkar den indatatypen.

Öka detta värde (eller sätt det till None) endast om du måste acceptera geometrier som legitimt är djupt nästlade, eftersom det minskar skyddet mot allvarliga fel.

Klasser för formulärfält

GeometryField

class GeometryField[source]

PointField

class PointField[source]

LineStringField

class LineStringField[source]

PolygonField

class PolygonField[source]

MultiPointField

class MultiPointField[source]

MultiLineStringField

class MultiLineStringField[source]

MultiPolygonField

class MultiPolygonField[source]

GeometryCollectionField

class GeometryCollectionField[source]

Widgets för formulär

GeoDjango-formulärwidgets gör att du kan visa och redigera geografiska data på en visuell karta. Observera att ingen av de för närvarande tillgängliga widgetarna stöder 3D-geometrier, därför kommer geometriska fält att använda en Textarea-widget för sådana data.

Widget-attribut

GeoDjango widgets är mallbaserade, så deras attribut skiljer sig mest från andra Django widget-attribut.

BaseGeometryWidget.base_layer

New in Django 6.0.

En sträng som anger identifieraren för det standardbaslager som ska användas av motsvarande JavaScript-kartwidget. Den skickas som en del av widgetalternativen vid rendering, vilket låter MapWidget avgöra vilken kartbricksleverantör eller vilket baslager som ska initieras (standardvärdet är None).

BaseGeometryWidget.geom_type

OpenGIS geometrityp, som vanligtvis anges av formulärfältet.

BaseGeometryWidget.map_srid

SRID-kod som används av kartan (standard är 4326).

BaseGeometryWidget.display_raw

Booleskt värde som anger om en textarea som visar den serialiserade representationen av den aktuella geometrin är synlig, främst för felsökningsändamål (standard är False).

BaseGeometryWidget.supports_3d

Anger om widgeten stöder redigering av 3D-data (standard är False).

BaseGeometryWidget.template_name

Den mall som används för att rendera kartwidgeten.

Du kan skicka widgetattribut på samma sätt som för alla andra Django-widgetar. Till exempel:

from django.contrib.gis import forms


class MyGeoForm(forms.Form):
    point = forms.PointField(widget=forms.OSMWidget(attrs={"display_raw": True}))

Widget-klasser

BaseGeometryWidget

class BaseGeometryWidget[source]

Detta är en abstrakt baswidget som innehåller den logik som underklasser behöver. Du kan inte använda denna widget direkt för ett geometrifält. Observera att återgivningen av GeoDjango-widgetar bygger på ett baslagernamn som identifieras av klassattributet base_layer.

OpenLayersWidget

class OpenLayersWidget[source]

Detta är standardwidgeten som används av alla GeoDjango-formulärfält. Attribut är:

base_layer

New in Django 6.0.

nasaWorldview

template_name

gis/openlayers.html.

map_srid

3857

OpenLayersWidget och OSMWidget inkluderar filerna ol.js och ol.css som finns på innehållsleveransnätverket cdn.jsdelivr.net. Filerna kan åsidosättas genom att skapa en underklass till widgeten och ange egenskaperna js och css för den inre klassen Media (se Tillgångar som en statisk definition).

Externa resurser med CSP

När ContentSecurityPolicyMiddleware är aktiverad blockeras standardresurserna från OpenLayers CDN (ol.js och ol.css) om de inte uttryckligen tillåts. Detta kan hanteras på ett av två sätt: servera resurser lokalt genom att skapa en underklass till widgeten och tillhandahålla lokala kopior av JavaScript- och CSS-filerna, eller tillåt CDN:en i CSP-policyn.

Till exempel, för att tillåta standardbaslagret NASA Worldview (ersätt x.y.z med den faktiska versionen):

from django.utils.csp import CSP

SECURE_CSP = {
    "default-src": [CSP.SELF],
    "script-src": [CSP.SELF, "https://cdn.jsdelivr.net/npm/ol@x.y.z/dist/ol.js"],
    "style-src": [CSP.SELF, "https://cdn.jsdelivr.net/npm/ol@x.y.z/ol.css"],
    "img-src": [CSP.SELF, "https://*.earthdata.nasa.gov"],
}

OSMWidget

class OSMWidget[source]

Den här widgeten är specialiserad från OpenLayersWidget och använder ett OpenStreetMap-baslager för att visa geografiska objekt. Attributen är:

base_layer

New in Django 6.0.

osm

default_lat

default_lon

Standardvärdet för centrets latitud och longitud är 47 respektive 5, vilket är en plats i östra Frankrike.

default_zoom

Standardzoomen för kartan är 12.

Anmärkningen i OpenLayersWidget om att använda externa resurser gäller även här. Se också detta FAQ-svar om https-åtkomst till kartplattor.

OpenStreetMap-kartplattor med CSP

Den här widgeten använder OpenStreetMap-kartplattor i stället för NASA Worldview. Om Content Security Policy är aktiverad måste både OpenLayers CDN-resurserna (vilket krävs av OpenLayersWidget) och OpenStreetMap-kartplattsservrarna tillåtas:

from django.utils.csp import CSP

SECURE_CSP = {
    # other directives
    "img-src": [CSP.SELF, "https://tile.openstreetmap.org"],
}

Changed in Django 6.0:

OSMWidget använder inte längre en anpassad mall. Följaktligen togs mallen gis/openlayers-osm.html bort.

Anpassa baslagret som används i OpenLayers-baserade widgetar

New in Django 6.0.

Om du vill anpassa baslagret som visas i OpenLayers-baserade geometriwidgetar definierar du en ny lagerskapare i en anpassad JavaScript-fil. Till exempel:

path-to-file.js

 MapWidget.layerBuilder.custom_layer_name = function () {
     // Return an OpenLayers layer instance.
     return new ol.layer.Tile({source: new ol.source.<ChosenSource>()});
 };

Underklassa sedan en standardwidget för geometri och sätt base_layer:

from django.contrib.gis.forms.widgets import OpenLayersWidget


class YourCustomWidget(OpenLayersWidget):
    base_layer = "custom_layer_name"

    class Media:
        js = ["path-to-file.js"]