API Formulir GeoDjango

GeoDjango menyediakan beberapa bidang formulir khusus dan widget untuk secara penglihatan menampilkan dan merubah data geolokal pada peta. Secara awalan, mereka menggunakan peta ditenagai-OpenLayers, dengan lapisan WMS dasar disediakan oleh NASA.

Argumen bidang

Sebagai tambahan pada form field arguments 1 biasa, bidang formulir GeoDjango mengambil argumen pilihan berikut.

srid

Field.srid

Ini adalah kode SRID dimana nilai bidang harus dirubah. Sebagai contoh, jika widget peta SRID berbeda dari SRID lebih umumnya digunakan oleh aplikasi anda atau basisdata, bidang akan otomatis merubah nilai masukan menjadi SRID itu.

geom_type

Field.geom_type

You generally shouldn't have to set or change that attribute which should be set up depending on the field class. It matches the OpenGIS standard geometry name.

Kelas-kelas bidang formulir

GeometryField

class GeometryField[sumber]

PointField

class PointField[sumber]

LineStringField

class LineStringField[sumber]

PolygonField

class PolygonField[sumber]

MultiPointField

class MultiPointField[sumber]

MultiLineStringField

class MultiLineStringField[sumber]

MultiPolygonField

class MultiPolygonField[sumber]

GeometryCollectionField

class GeometryCollectionField[sumber]

Widget formulir

GeoDjango form widgets allow you to display and edit geographic data on a visual map. Note that none of the currently available widgets supports 3D geometries, hence geometry fields will fallback using a Textarea widget for such data.

Atribut widget

Widget GeoDjango adalah berdasarkan-cetakan, jadi atribut-atribut mereka kebanyakan berbeda dari atribut widget Django.

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

Jenis geometri OpenGis, umumnya disetel oleh bidang formulir.

BaseGeometryWidget.map_srid

Kode SRID digunakan oleh peta (awalan adalah 4326).

BaseGeometryWidget.display_raw

Nilai boolean menentukan jika sebuah masukan textarea menunjukkan perwakilan terserial dari geometri saat ini adalah terlihat, utamanya untuk tujuan mencari kesalahan (awalan adalah False).

BaseGeometryWidget.supports_3d

Menunjukkan jika edisi dukungan widget dari data 3D (awalan adalah False).

BaseGeometryWidget.template_name

Cetakan digunakan untuk membangun widget peta.

Anda dapat melewatkan atribut widget dalam cara sama yang untuk widget Django apapun. Sebagai contoh:

from django.contrib.gis import forms


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

Kelas-kelas widget

BaseGeometryWidget

class BaseGeometryWidget[sumber]

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[sumber]

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 Aset sebagai pengertian tetap).

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[sumber]

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

Nilai awalan tengah garis lintang dan bujur 47 dan 5, masing-masing, yang bertempat di Perancis Timur.

default_zoom

Pembesaran peta awalan adalah 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"]