API des formulaires GeoDjango

GeoDjango propose quelques champs et composants de formulaires spécialisés afin d’afficher et de modifier visuellement des données géolocalisées sur une carte. Par défaut, ils utilisent des cartes motorisées par OpenLayers, avec une couche de base WMS fournie par la NASA.

Paramètres de champs

En plus des paramètres de champs de formulaires habituels, les champs de formulaires GeoDjango acceptent les paramètres facultatifs suivants.

srid

Field.srid

Il s’agit du code SRID utilisé pour transformer la valeur du champ. Par exemple, si le SRID du composant de carte est différent du SRID utilisé plus généralement par votre application ou base de données, le champ convertit automatiquement les valeurs d’entrée dans ce SRID.

geom_type

Field.geom_type

Cet attribut n’a généralement pas besoin d’être défini ou modifié, car il est automatiquement défini en fonction de la classe du champ. Il correspond au nom d’objet géométrique du standard OpenGIS.

Classes de champs de formulaires

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]

Composants de formulaires

Les composants de formulaires GeoDjango permettent d’afficher et de modifier des données géographiques visuellement sur une carte. Notez qu’aucun des composants actuellement disponibles ne prend en charge les objets géométriques 3D, ce qui fait que les champs géométriques se rabattent sur un composant Textarea s’ils ont affaire à de tels objets.

Attributs de composants

Les composants GeoDjango sont basés sur les gabarits, ce qui fait que leurs attributs sont majoritairement différents des autres attributs de composants Django.

BaseGeometryWidget.base_layer

New in Django 6.0.

Une chaîne indiquant l’identifiant de la couche cartographique de base par défaut à utiliser par le composant de carte JavaScript correspondant. Elle est transmise dans les options du composant au moment du rendu, permettant à MapWidget de déterminer quel fournisseur de tuiles de carte ou de couche de base à initialiser (vaut None par défaut).

BaseGeometryWidget.geom_type

Le type de géométrie OpenGIS, généralement défini par le champ de formulaire.

BaseGeometryWidget.map_srid

Code SRID utilisé par la carte (la valeur par défaut est 4326).

BaseGeometryWidget.display_raw

Valeur booléenne indiquant si une boîte de saisie de texte affichant la représentation sérialisée de l’objet géométrique en cours est visible, principalement à des fins de débogage (la valeur par défaut est False).

BaseGeometryWidget.supports_3d

Indique si le composant prend en charge l’édition de données 3D (la valeur par défaut est False).

BaseGeometryWidget.template_name

Le gabarit utilisé pour produire le composant de carte.

Vous pouvez transmettre des attributs de composants de la même façon que pour tout autre composant Django. Par exemple :

from django.contrib.gis import forms


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

Classes de composants

BaseGeometryWidget

class BaseGeometryWidget[source]

Il s’agit d’un composant de base abstrait contenant la logique nécessaire aux sous-classes. Il n’est pas possible d’utiliser directement ce composant pour un champ géométrique. Notez que la production de composants GeoDjango est basée sur un nom de couche de base, identifié par l’attribut de classe base_layer.

OpenLayersWidget

class OpenLayersWidget[source]

Il s’agit du composant par défaut utilisé par tous les champs de formulaires GeoDjango. Ses attributs sont :

base_layer

New in Django 6.0.

nasaWorldview

template_name

gis/openlayers.html.

map_srid

3857

OpenLayersWidget et OSMWidget incluent les fichiers ol.js et ol.css hébergés sur le réseau de diffusion de contenu cdn.jsdelivr.net. Ces fichiers peuvent être surchargés en créant une sous-classe du composant et en définissant les propriétés js et css de la classe Media interne (voir Fichiers annexes définis statiquement).

Fichiers statiques externes avec CSP

Lorsque ContentSecurityPolicyMiddleware est activé, les fichiers externes par défaut du CDN OpenLayers (ol.js et ol.css) seront bloqués, sauf si une clause spécifique les autorise. Cela peut être corrigé de deux manières : servir ces fichiers localement en créant une sous-classe du composant et en indiquant des copies locales des fichier JavaScript et CSS, ou autoriser le CDN dans la politique CSP.

Par exemple, pour autoriser la couche de base par défaut « NASA Worldview » (remplacez x.y.z par la version actuelle) :

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]

Ce composant spécialise OpenLayersWidget en utilisant une couche de base OpenStreetMap pour afficher les objets géographiques. Ses attributs sont :

base_layer

New in Django 6.0.

osm

default_lat

default_lon

Les latitude et longitude du centre sont respectivement 47 et 5 par défaut, ce qui correspond à un emplacement à l’est de la France.

default_zoom

Le zoom de carte par défaut est 12.

La note OpenLayersWidget au sujet des fichiers statiques externes est aussi valable dans ce cas. Voir aussi cette réponse de FAQ au sujet de l’accès https aux tuiles de cartes.

Tuiles OpenStreetMap et CSP

Ce composant utilise des tuiles OpenStreetMap au lieu de la couche NASA Worldview. Si Politique de sécurité de contenu (CSP) est activé, il est nécessaire d’autoriser à la fois les ressources CDN OpenLayers (tels que requis par OpenLayersWidget) et les serveurs de tuiles OpenStreetMap :

from django.utils.csp import CSP

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

Changed in Django 6.0:

Le composant OSMWidget n’utilise plus de gabarit personnalisé. Par conséquent, le gabarit gis/openlayers-osm.html a été supprimé.

Personnalisation de la couche de base utilisée dans les composants basés sur OpenLayers

New in Django 6.0.

Pour personnaliser la couche de base affichée dans les composants géométriques basés sur OpenLayers, définissez un nouveau constructeur de couche dans un fichier JavaScript personnalisé. Par exemple :

chemin-vers-fichier.js

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

Puis, créez une sous-classe du composant géométrique standard et définissez l’attribut 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"]