django.contrib.gis.forms.fields.GeometryField

class documentation

class GeometryField(forms.Field): (source)

Known subclasses: django.contrib.gis.forms.fields.GeometryCollectionField, django.contrib.gis.forms.fields.LineStringField, django.contrib.gis.forms.fields.MultiLineStringField, django.contrib.gis.forms.fields.MultiPointField, django.contrib.gis.forms.fields.MultiPolygonField, django.contrib.gis.forms.fields.PointField, django.contrib.gis.forms.fields.PolygonField

View In Hierarchy

This is the basic form field for a Geometry. Any textual input that is accepted by GEOSGeometry is accepted by this form. By default, this includes WKT, HEXEWKB, WKB (in a buffer), and GeoJSON.

Method __init__ Undocumented
Method clean Validate that the input value can be converted to a Geometry object and return it. Raise a ValidationError if the value cannot be instantiated as a Geometry.
Method has_changed Compare geographic value of data with its initial value.
Method to_python Transform the value to a Geometry object.
Class Variable default_error_messages Undocumented
Instance Variable geom_type Undocumented
Instance Variable srid Undocumented

Inherited from Field:

Method __deepcopy__ Undocumented
Method bound_data Return the value that should be shown for this field on render of a bound form, given the submitted POST data for the field and the initial data, if any.
Method get_bound_field Return a BoundField instance that will be used when accessing the form field in a template.
Method prepare_value Undocumented
Method run_validators Undocumented
Method validate Undocumented
Method widget_attrs Given a Widget instance (*not* a Widget class), return a dictionary of any HTML attributes that should be added to the Widget, based on this Field.
Class Variable default_validators Undocumented
Class Variable empty_values Undocumented
Instance Variable disabled Undocumented
Instance Variable error_messages Undocumented
Instance Variable help_text Undocumented
Instance Variable initial Undocumented
Instance Variable label Undocumented
Instance Variable label_suffix Undocumented
Instance Variable localize Undocumented
Instance Variable required Undocumented
Instance Variable show_hidden_initial Undocumented
Instance Variable validators Undocumented
Instance Variable widget Undocumented
def __init__(self, *, srid=None, geom_type=None, **kwargs): (source)
overrides django.forms.fields.Field.__init__

Undocumented

def clean(self, value): (source)
overrides django.forms.fields.Field.clean

Validate that the input value can be converted to a Geometry object and return it. Raise a ValidationError if the value cannot be instantiated as a Geometry.

def has_changed(self, initial, data): (source)
overrides django.forms.fields.Field.has_changed

Compare geographic value of data with its initial value.

def to_python(self, value): (source)
overrides django.forms.fields.Field.to_python

Transform the value to a Geometry object.

default_error_messages = (source)
overrides django.forms.fields.Field.default_error_messages

Undocumented

geom_type = (source)
overridden in django.contrib.gis.forms.fields.GeometryCollectionField, django.contrib.gis.forms.fields.LineStringField, django.contrib.gis.forms.fields.MultiLineStringField, django.contrib.gis.forms.fields.MultiPointField, django.contrib.gis.forms.fields.MultiPolygonField, django.contrib.gis.forms.fields.PointField, django.contrib.gis.forms.fields.PolygonField

Undocumented

srid = (source)

Undocumented