GeoDjango Forms API

    In addition to the regular form field arguments, GeoDjango form fields take the following optional arguments.

    Field.``srid

    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_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.

    GeometryField

    class GeometryField

    PointField

    class PointField

    class LineStringField

    PolygonField

    class PolygonField

    class MultiPointField

    MultiLineStringField

    class MultiLineStringField

    class MultiPolygonField

    GeometryCollectionField

    class GeometryCollectionField

    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.

    Widget attributes

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

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

    BaseGeometryWidget.``map_height

    BaseGeometryWidget.``map_width

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

    BaseGeometryWidget.``map_srid

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

    BaseGeometryWidget.``display_raw

    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_3d

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

    BaseGeometryWidget.``template_name

    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:

    Widget classes

    BaseGeometryWidget

    class BaseGeometryWidget

    OpenLayersWidget

    class

    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 cdnjs.cloudflare.com content-delivery network. You can 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 ).

    OSMWidget

    class OSMWidget

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

    • template_name

      gis/openlayers-osm.html

    • default_lat

    • default_zoom

      The default map zoom is 12.

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