You are here

description.html in Geofield 8

File

doc/drupal_org_documentation/description.html
View source
<p>Geofield is an advanced module for storing, managing and representing dynamic Geographic data in Drupal. It supports all geo-types (points, lines, polygons, multi types geometries, etc.), and integrates with various Js Mapping Libraries (Google Maps, Leaflet, Open Layers, etc.) and advanced Geocoding / Reverse Geocoding functionalities, via many other  Drupal Geo Mapping modules.</p>
<h2><a href="http://www.geodemocracy.com/geofield_d8/web/" target="blank">>>>> Live Demo <<<<</a></h2>
<h2><b>Widgets (Data Input)</b></h2>
<p><b>Latitude and  Longitude</b><br>
  Supports entering data as both Decimal Degrees (122.340932) and Degrees-Minutes-Seconds (-123° 49' 55.2" W). The Degrees-Minutes-Seconds input is very tolerant of inconsistent input.</p>
<p><b>Bouding Box</b><br>
  Four textfields where lat / lon can be entered</p>
<p><b>Well Known Text (WKT)</b><br>
  A textarea for direct WKT input</p>
<p><b>Draw on an OpenLayers Map</b><br>
  Allows drawing of Points, Lines, Polygons and Bounding Boxes</p>
<p><b>HTML5 Geolocation</b><br>
  Transparently asks the browser for the user's current location. Works great on Chrome and smartphones with GPS.</p>
<p><b>Geocode from another field</b><br>
  There is native integrations with the Geocoder module (<a href="http://drupal.org/project/geocoder" rel="nofollow">http://drupal.org/project/geocoder</a>).
  This allows you to use data from one field to populate your geofield automatically. Supported geocoders include:</p>
<ul>
  <li><b>Various <a href="https://packagist.org/providers/geocoder-php/provider-implementation" target="_blank" rel="nofollow">PHP Geocoder Providers</a></b>: Address Field, Textfield</li>
  <li><b>KML</b>: File field, Textfield</li>
  <li><b>GPX</b>: File field, Textfield</li>
  <li><b>GeoJSON</b>: File field, Textfield</li>
  <li><b>Geotagged Image File</b>: File field, Image field</li>
</ul><h2><b>Formatters (Data Output)</b></h2>
<p><b>Latitude and Longitude</b><br>
  Supports display as both Decimal Degrees (122.340932) and Degrees-Minutes-Seconds (-123° 49' 55.2" W)</p>
<p><b>Well Known Text (WKT)</b></p>
<p><b>GeoJSON</b></p>
<p><b>KML</b><br>
  KML is the format used by Google Earth</p>
<p><b>GPX</b><br>
  GPX is the format used by GPS devices</p>
<p><b>Google Maps, Leaflet and OpenLayers (only for D7) Maps</b><br>
  Display your data on a map, integrating other Drupal Geofield Mapping modules (see below).</p>
<h2><b>Installation and Setup</b></h2>
<p><i>For Drupal 7 version all you need to do is install the <a href="http://drupal.org/project/geophp" rel="nofollow">Drupal GeoPHP module</a>, which is required by geofield.</i></p>
<hr>
<h2><b>Drupal 8 & 9, and GeoPHP library dependency</b></h2>
<p>Since <strong>8.x-1.0-alpha2</strong> version, this module is not depending on Drupal GeoPHP module anymore.<br>
  <b>The Drupal 8 & 9 version of Geofield module needs to be installed <a href="https://www.drupal.org/docs/develop/using-composer/using-composer-to-manage-drupal-site-dependencies" target="_blank" rel="nofollow">using Composer</a></b>, it means simply running the following command from your project root (where the main composer.json file is sited):</p>
<p><b>$ composer require 'drupal/geofield'</b></p>
<p>This process will also download the required <a href="https://github.com/phayes/geoPHP" title="GeoPHP library" target="_blank" rel="nofollow">GeoPHP library</a> dependency, that will be sited in the /vendor folder (as Drupal 8 default settings).</p>
<p><u>Note:</u> Since version 8.x-1.20 Geofield also supports the <a href="https://www.drupal.org/project/ludwig" target="blank">Ludwig module/project</a>,
  that offers an alternative to users who are not friendly with the command line
  tools or want to avoid Composer usage for other reasons.
<hr><p>Once installed you can enable the module in the usual way, both from the extend/modules backend interfaces or via drush with the following command:</p>
<p><b>$ drush en geofield</b></p>
<p>Once enabled the module it will be possible to add a "Geofield" field type to<br>
  any entity type/bundle and then choose the preferred widget or formatter.</p>
<h2><b>Compatible Modules</b></h2>
<ul><li><b><a href="https://www.drupal.org/project/geofield_map" title="Geofield Map" target="_blank" rel="nofollow">Geofield Map</a></b>: an advanced, complete and easy-to-use Geo Mapping solution for Drupal 8, based on Geofield</li>
  <li><b><a href="/project/openlayers" rel="nofollow">OpenLayers</a></b>: A very powerful mapping system based on the OpenLayers JavaScript library.</li>
  <li><b><a href="/project/staticmap" rel="nofollow">Static Map</a></b>: Simple maps based on Google Maps</li>
  <li><b><a href="/project/leaflet" rel="nofollow">Leaflet</a></b>: Moderately powerful mapping system based on the Leaflet JavaScript library</li>
  <li><b><a href="/project/leaflet_widget" rel="nofollow">Leaflet Widget</a></b>: Input widget based on Leaflet library</li>
  <li><b><a href="/project/geocoder" rel="nofollow">Geocoder</a></b>: Geocode string &amp; text addresses or file-uploads into Geofield locations and viceversa (Reverse Geocode)</li>
  <li><b><a href="/project/geocoder_autocomplete" rel="nofollow">Geocoder AutoComplete</a></b>: Auto-complete widget for Geocoder</li>
  <li><b><a href="/project/addressfield" rel="nofollow">Address Field</a></b>: Holds internationally compatible postal addresses based on xNAL. Compatible with Geocoder.</li>
  <li><b><a href="/project/sync_postgis" rel="nofollow">Sync PostGIS</a></b>: Sync geofield data into an external postGIS database, allowing you to perform full postGIS spatial queries.</li>
  <li><b><a href="/project/openlayers_solr" rel="nofollow">Openlayers Apachesolr</a></b>: Integrates OpenLayers, Apache Solr, and Geofield</li>
  <li><b><a href="/project/openlayers_cck_migrate" rel="nofollow">Openlayers CCK Migrate</a></b>: Migrate your old D6 openlayer_wkt fields to Geofield</li>
  <li><b><a href="/project/rss_field_formatters" rel="nofollow">RSS Field Formatters</a></b>: Provides <code class=" language-php"><span class="token markup"><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span><span class="token namespace">georss:</span>point</span><span class="token punctuation">&gt;</span></span></span></code>, <code class=" language-php"><span class="token markup"><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span><span class="token namespace">georss:</span>polygon</span><span class="token punctuation">&gt;</span></span></span></code> etc. element for geofields</li>
  <li><b><a href="/project/views_geojson" rel="nofollow">Views GeoJSON</a></b>: Allows outputting of geofields into geoJSON using a view. Specifically useful with OpenLayers to build AJAX powered maps with lots of data.</li>
  <li><b><a href="/project/search_api_location" rel="nofollow">Search API Location</a></b>: Adds geospatial-based searching to the <a href="/project/search_api" rel="nofollow">Search API</a> module.</li>
  <li><b><a href="/project/spatial" rel="nofollow">Spatial Tools</a></b>: Tools for processing spatial files (ESRI Shapefiles, KML)</li>
  <li><b><a href="https://github.com/phayes/geofield_postgis" rel="nofollow">Geofield PostGIS</a></b>: Provides a PostGIS backend plugin for geofield. Geofield geometries are stored directly in PostGIS geometry or geography columns.</li>
  <li><b><a href="https://www.drupal.org/project/geofield_proximity_polygon" rel="nofollow">Geofield Proximity Plugin</a></b>: An add-on for the Geofield module with an alternative way to calculate distances from an origin point to polygons and multi-polygons in Views on single-valued and multi-valued Geofields.</li>
</ul><h2><b>Resources</b></h2>
<ul><li><a href="https://www.drupal.org/node/1089574" rel="nofollow">Documentation for Drupal 7</a> (incomplete and outdated)</li>
  <li><a href="https://git.drupalcode.org/project/geofield/-/blob/7.x-1.x/README.txt" target="_blank" rel="nofollow">README.txt for Drupal 7</a></li>
  <li><a href="https://git.drupalcode.org/project/geofield/-/blob/8.x-1.x/README.md" target="_blank" rel="nofollow">README.md for Drupal 8 & 9</a></li>
  <li>Book: <a href="http://shop.oreilly.com/product/0636920021230.do" rel="nofollow">Mapping with Drupal</a>
  </li>
</ul><h2><b>Credit</b></h2>
<p>A special thanks to the following organization for sponsoring the development of geofield: <a href="http://www.highwire.org" rel="nofollow">HighWire Press</a>, <a href="http://www.phase2technology.com/" rel="nofollow">Phase 2</a>, and <a href="http://www.geoscienceworld.org/" rel="nofollow">GeoScienceWorld</a>. Also, thanks to all of our <a href="http://drupal.org/node/1087170/committers" rel="nofollow">contributing developers</a> and many others who have helped with bug fixing and documentation.</p><