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.

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.

A string that specifies the identifier for the default base map layer to be used by the corresponding JavaScript map widget. It is passed as part of the widget options when rendering, allowing the MapWidget to determine which map tile provider or base layer to initialize (default is 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]

This is an abstract base widget containing the logic needed by subclasses. You cannot directly use this widget for a geometry field. Note that the rendering of GeoDjango widgets is based on a base layer name, identified by the base_layer class attribute.

OpenLayersWidget

class OpenLayersWidget[source]

This is the default widget used by all GeoDjango form fields. Attributes are:

base_layer

New in Django 6.0.

nasaWorldview

template_name

gis/openlayers.html.

map_srid

3857

OpenLayersWidget and OSMWidget include the ol.js and ol.css files hosted on the cdn.jsdelivr.net content-delivery network. These files can be overridden by subclassing the widget and setting the js and css properties of the inner Media class (see Tillgångar som en statisk definition).

External assets with CSP

When ContentSecurityPolicyMiddleware is enabled, the default OpenLayers CDN assets (ol.js and ol.css) will be blocked unless explicitly allowed. This can be addressed in one of two ways: serve assets locally by subclassing the widget and provide local copies of the JavaScript and CSS files, or allow the CDN in the CSP policy.

For example, to allow the default NASA Worldview base layer (replace x.y.z with the actual version):

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]

This widget specialized OpenLayersWidget and uses an OpenStreetMap base layer to display geographic objects on. Attributes are:

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.

The OpenLayersWidget note about using external assets also applies here. See also this FAQ answer about https access to map tiles.

OpenStreetMap tiles with CSP

This widget uses OpenStreetMap tiles instead of NASA Worldview. If Content Security Policy enabled, both the OpenLayers CDN resources (as required by OpenLayersWidget) and the OpenStreetMap tile servers must be allowed:

from django.utils.csp import CSP

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

Changed in Django 6.0:

The OSMWidget no longer uses a custom template. Consequently, the gis/openlayers-osm.html template was removed.

Customizing the base layer used in OpenLayers-based widgets

New in Django 6.0.

To customize the base layer displayed in OpenLayers-based geometry widgets, define a new layer builder in a custom JavaScript file. For example:

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>()});
 };

Then, subclass a standard geometry widget and set the 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"]