django.contrib.gis.db.models.fields.GeometryField

class documentation

class GeometryField(BaseSpatialField): (source)

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

View In Hierarchy

The base Geometry field -- maps to the OpenGIS Specification Geometry type.

Method __init__ The initialization function for geometry fields. In addition to the parameters from BaseSpatialField, it takes the following as keyword arguments:
Method contribute_to_class Undocumented
Method deconstruct Undocumented
Method formfield Undocumented
Method select_format Return the selection format string, depending on the requirements of the spatial backend. For example, Oracle and MySQL require custom selection formats in order to retrieve geometries in OGC WKB.
Class Variable description Undocumented
Class Variable geom_class Undocumented
Class Variable geom_type Undocumented
Instance Variable dim Undocumented
Instance Variable geography Undocumented
Instance Variable _extent Undocumented
Instance Variable _tolerance Undocumented

Inherited from BaseSpatialField:

Method db_type Undocumented
Method geodetic Return true if this field's SRID corresponds with a coordinate system that uses non-projected units (e.g., latitude/longitude).
Method get_db_prep_value Undocumented
Method get_placeholder Return the placeholder for the spatial column for the given value.
Method get_prep_value Undocumented
Method get_raster_prep_value Return a GDALRaster if conversion is successful, otherwise return None.
Method get_srid Return the default SRID for the given geometry or raster, taking into account the SRID set for the field. For example, if the input geometry or raster doesn't have an SRID, then the SRID of the field will be returned.
Method spheroid Undocumented
Method units Undocumented
Method units_name Undocumented
Class Variable empty_strings_allowed Undocumented
Instance Variable spatial_index Undocumented
Instance Variable srid Undocumented
def __init__(self, verbose_name=None, dim=2, geography=False, *, extent=(-180.0, -90.0, 180.0, 90.0), tolerance=0.05, **kwargs): (source)
overrides django.contrib.gis.db.models.fields.BaseSpatialField.__init__

The initialization function for geometry fields. In addition to the parameters from BaseSpatialField, it takes the following as keyword arguments: dim: The number of dimensions for this geometry. Defaults to 2. extent: Customize the extent, in a 4-tuple of WGS 84 coordinates, for the geometry field entry in the `USER_SDO_GEOM_METADATA` table. Defaults to (-180.0, -90.0, 180.0, 90.0). tolerance: Define the tolerance, in meters, to use for the geometry field entry in the `USER_SDO_GEOM_METADATA` table. Defaults to 0.05.

def contribute_to_class(self, cls, name, **kwargs): (source)

Undocumented

def deconstruct(self): (source)
overrides django.contrib.gis.db.models.fields.BaseSpatialField.deconstruct

Undocumented

def formfield(self, **kwargs): (source)

Undocumented

def select_format(self, compiler, sql, params): (source)

Return the selection format string, depending on the requirements of the spatial backend. For example, Oracle and MySQL require custom selection formats in order to retrieve geometries in OGC WKB.

description = (source)
overrides django.contrib.gis.db.models.fields.BaseSpatialField.description
overridden in django.contrib.gis.db.models.fields.GeometryCollectionField, django.contrib.gis.db.models.fields.LineStringField, django.contrib.gis.db.models.fields.MultiLineStringField, django.contrib.gis.db.models.fields.MultiPointField, django.contrib.gis.db.models.fields.MultiPolygonField, django.contrib.gis.db.models.fields.PointField, django.contrib.gis.db.models.fields.PolygonField

Undocumented

geom_class = (source)

Undocumented

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

Undocumented

dim = (source)

Undocumented

geography = (source)

Undocumented

_extent = (source)

Undocumented

_tolerance = (source)

Undocumented