GeoDjango フォーム API

GeoDjango はジオローカライズされたデータを地図上に視覚的に表示・編集するために、いくつかの特殊なフォームフィールドとウィジェットを提供します。デフォルトでは、 NASA が提供する WMS レイヤーをベースとした OpenLayers を利用した地図を使います。

フィールドの引数

通常の フォームフィールドの引数 に加えて、 GeoDjango のフォームフィールドは以下のオプションの引数を取ります。

srid

Field.srid

これはフィールドの値を変換するSRIDコードです。例えば、マップウィジェットのSRIDがアプリケーションやデータベースで一般的に使われるSRIDと異なる場合、フィールドは入力値を自動的にそのSRIDに変換します。

geom_type

Field.geom_type

通常、その属性を設定または変更する必要はありません。この属性はフィールドクラスに応じて設定されるべきです。これはOpenGIS標準のジオメトリ名に一致します。

フォームフィールド クラス

GeometryField

class GeometryField[ソース]

PointField

class PointField[ソース]

LineStringField

class LineStringField[ソース]

PolygonField

class PolygonField[ソース]

MultiPointField

class MultiPointField[ソース]

MultiLineStringField

class MultiLineStringField[ソース]

MultiPolygonField

class MultiPolygonField[ソース]

GeometryCollectionField

class GeometryCollectionField[ソース]

フォームウィジェット

GeoDjango のフォームウィジェットを使うと、ビジュアルマップ上に地理情報を表示したり編集したりできます。現在利用可能なウィジェットはどれも 3D ジオメトリをサポートしていないので、 ジオメトリフィールドは Textarea ウィジェットを使ってフォールバックします。

ウィジェットの属性

GeoDjango ウィジェットはテンプレートベースなので、その属性のほとんどは他の Django ウィジェットの属性と異なります。

BaseGeometryWidget.base_layer

New in Django 6.0.

対応する JavaScript のマップウィジェットで使用されるデフォルトのベースマップレイヤーの識別子を指定する文字列です。これはレンダリング時にウィジェットのオプションの一部として渡され、MapWidget が初期化するマップタイルプロバイダーまたはベースレイヤーを判断できるようにします（デフォルトは None です）。

BaseGeometryWidget.geom_type

OpenGIS ジオメトリタイプ。通常、フォームフィールドによって設定されます。

BaseGeometryWidget.map_srid

地図で使用されるSRIDコード (デフォルトは4326)。

BaseGeometryWidget.display_raw

主にデバッグのために、現在のジオメトリのシリアライズされた表現を示すテキストエリア入力を表示するかどうかを指定するブール値 (デフォルトは False).

BaseGeometryWidget.supports_3d

ウィジェットが3Dデータの編集をサポートしているかどうかを示します (デフォルトは False です) 。

BaseGeometryWidget.template_name

地図ウィジェットのレンダリングに使用されるテンプレート。

ウィジェットの属性は、他のDjangoウィジェットと同じように渡すことができます。例えば、次のようにします:

from django.contrib.gis import forms


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

Widget クラス

BaseGeometryWidget

class BaseGeometryWidget[ソース]

これは、サブクラスが必要とするロジックを含む抽象ベースウィジェットです。このウィジェットを直接ジオメトリフィールドに使うことはできません。GeoDjango ウィジェットのレンダリングは base_layer クラス属性で識別されるベースレイヤー名に基づいていることに注意してください。

OpenLayersWidget

class OpenLayersWidget[ソース]

これはすべての GeoDjango フォームフィールドで使用されるデフォルトウィジェットです。属性は以下の通りです。

base_layer

New in Django 6.0.

nasaWorldview

template_name

gis/openlayers.html.

map_srid

3857

OpenLayersWidget および OSMWidget は、コンテンツ配信ネットワーク cdn.jsdelivr.net 上でホストされている ol.js および ol.css ファイルを読み込みます。これらのファイルは、ウィジェットをサブクラス化し、内部の Media クラスの js および css プロパティを設定することで上書きできます（定数として定義されたアセット を参照）。

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[ソース]

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

デフォルトの中心緯度と経度はそれぞれ 47 と 5 で、フランス東部の位置です。

default_zoom

デフォルトの地図の縮尺は 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"]