GeoDjango Forms APILink to this heading#

sridLink to this heading#

Field.sridLink to this definition#

This is the SRID code that the field value should be transformed to. For example, if the map widget SRID is different from the SRID more generally used by your application or database, the field will automatically convert input values into that SRID.

geom_typeLink to this heading#

Field.geom_typeLink to this definition#

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

GeometryFieldLink to this heading#

class GeometryFieldLink to this definition#

PointFieldLink to this heading#

class PointFieldLink to this definition#

LineStringFieldLink to this heading#

class LineStringFieldLink to this definition#

PolygonFieldLink to this heading#

class PolygonFieldLink to this definition#

MultiPointFieldLink to this heading#

class MultiPointFieldLink to this definition#

MultiLineStringFieldLink to this heading#

class MultiLineStringFieldLink to this definition#

MultiPolygonFieldLink to this heading#

class MultiPolygonFieldLink to this definition#

GeometryCollectionFieldLink to this heading#

class GeometryCollectionFieldLink to this definition#

Widget attributesLink to this heading#

GeoDjango widgets are template-based, so their attributes are mostly different from other Django widget attributes.

BaseGeometryWidget.geom_typeLink to this definition#

The OpenGIS geometry type, generally set by the form field.

BaseGeometryWidget.map_heightLink to this definition#

BaseGeometryWidget.map_widthLink to this definition#

Height and width of the widget map (default is 400x600).

BaseGeometryWidget.map_sridLink to this definition#

SRID code used by the map (default is 4326).

BaseGeometryWidget.display_rawLink to this definition#

Boolean value specifying if a textarea input showing the serialized representation of the current geometry is visible, mainly for debugging purposes (default is False).

BaseGeometryWidget.supports_3dLink to this definition#

Indicates if the widget supports edition of 3D data (default is False).

BaseGeometryWidget.template_nameLink to this definition#

The template used to render the map widget.

You can pass widget attributes in the same manner that for any other Django widget. For example:

from django.contrib.gis import forms

class MyGeoForm(forms.Form):
    point = forms.PointField(widget=
        forms.OSMWidget(attrs={'map_width': 800, 'map_height': 500}))

Widget classesLink to this heading#

BaseGeometryWidget

class BaseGeometryWidgetLink to this definition#

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 template, identified by the template_name class attribute.

OpenLayersWidget

class OpenLayersWidgetLink to this definition#

This is the default widget used by all GeoDjango form fields. template_name is gis/openlayers.html.

OpenLayersWidget and OSMWidget use the openlayers.js file hosted on the openlayers.org website. This works for basic usage during development, but isn’t appropriate for a production deployment as openlayers.org/api/ has no guaranteed uptime and runs on a slow server. You are therefore advised to subclass these widgets in order to specify your own version of the openlayers.js file in the js property of the inner Media class (see Assets as a static definition). You can host a copy of openlayers.js tailored to your needs on your own server or refer to a copy from a content-delivery network like https://cdnjs.com/. This will also allow you to serve the JavaScript file(s) using the https protocol if needed.

OSMWidget

class OSMWidgetLink to this definition#

This widget uses an OpenStreetMap base layer (Mapnik) to display geographic objects on. template_name is gis/openlayers-osm.html.

The OpenLayersWidget note about JavaScript file hosting above also applies here. See also this FAQ answer about https access to map tiles.