You are here

Home » API reference » Views GeoJSON 8

README.txt in Views GeoJSON 8

Same filename and directory in other branches
  1. 6 README.txt
  2. 7 README.txt
CONTENTS OF THIS FILE
---------------------

* Summary
* Requirements
* Installation
* Usage
  * Bounding Box Support
* To Do
* Credits
* Current Maintainers


SUMMARY
-------

Views GeoJSON is a style plugin for Views to deliver location-specific data in GeoJSON format, (see GeoJSON spec: http://geojson.org/geojson-spec.html).

Each row is output as a GeoJSON "Features" including geospatial data and optional metadata. All features are wrapped in a "Feature Collection" object.


REQUIREMENTS
------------

Drupal modules:
* Views
* Serialization
* Rest

Optional Drupal modules:
* Geofield 8.x-1.0-alpha2 or greater

INSTALLATION
------------

Install the module as usual.
See https://www.drupal.org/node/1897420 for help installing Drupal 8 modules.


USAGE
-----

1. Create a View with a Feed display on content with geospatial data.
2. Add fields to output a Geofield, longitude & latitude or WKT.
3. Optionally add fields for name and description.
4. Set Format for the display to "GeoJSON Feed".
5. In the "Style options" for this format:
  * Choose Map Data Source (Other: Lat/Lon Point, Geofield, etc.)
  * Assign the fields that represent Latitude and Longitude.
  * Optionally choose fields representing name and description for each point.
  * Optionally set a JSONP prefix, (see http://en.wikipedia.org/wiki/JSONP).
  * Set the Content-type header to be sent. The default is "application/json",
    the standard MIME type for JSON, per http://www.ietf.org/rfc/rfc4627.txt.
6. If using with the OpenLayers module, your new GeoJSON layer will be available
  as an Overlay layer on the "Layers & Styles" tab when editing your map.

Bounding Box Filtering
--------------------
GeoJSON views can accept a bounding box as an argument to return only the
points within that box.

It has been tested with OpenLayers' Bounding Box Strategy but should work
with any mapping tool that requests bounding box coordinates as
"?bbox=left,bottom,right,top" in the query string. Argument ID "bbox" is
default for OpenLayers but can be changed.

OpenLayers 7.x-2.x-dev is currently required for OpenLayers BBOX integration.
See OpenLayers issue http://drupal.org/node/1493344, "Support BBOX strategy in
the GeoJSON layer type".

1. Create a GeoJSON view as above in USAGE.
2. Add a layer to OpenLayers of type GeoJSON, at
   admin/structure/openlayers/layers/add/openlayers_layer_type_geojson,
   specifying the URL to your GeoJSON feed and checking the box for "Use
   Bounding Box Strategy".
3. In your GeoJSON View configuration, add a Contextual Filter of type:
   "Custom: Bounding box".
4. In the Contextual Filter settings, under "When the filter value is NOT in
   the URL as a normal Drupal argument", choose: "Provide default value".
5. In the "Type" dropdown, choose: "Bounding box from query string".
6. For OpenLayers, leave "Query argument ID" as "bbox" and click Apply.


TO DO
-----
* Support addditional GeoJSON feature types like LineString.
* Support an optional altitude coordinate for Point positions.
* Support additional coordinate systems.


CREDITS
-------

This module was originally born from a patch by tmcw to the OpenLayers module
(http://drupal.org/node/889190#comment-3376628) and adapted to model the Views
Datasource module (http://drupal.org/project/views_datasource).

Much of the code is drawn directly from these sources.


CURRENT MAINTAINERS
-------------------

* jeffschuler - http://drupal.org/user/239714

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4. * Summary

  5. * Requirements

  6. * Installation

  7. * Usage

  8.   * Bounding Box Support

  9. * To Do

  10. * Credits

  11. * Current Maintainers

  12. 

  13. 

  14. SUMMARY

  15. -------

  16. 

  17. Views GeoJSON is a style plugin for Views to deliver location-specific data in GeoJSON format, (see GeoJSON spec: http://geojson.org/geojson-spec.html).

  18. 

  19. Each row is output as a GeoJSON "Features" including geospatial data and optional metadata. All features are wrapped in a "Feature Collection" object.

  20. 

  21. 

  22. REQUIREMENTS

  23. ------------

  24. 

  25. Drupal modules:

  26. * Views

  27. * Serialization

  28. * Rest

  29. 

  30. Optional Drupal modules:

  31. * Geofield 8.x-1.0-alpha2 or greater

  32. 

  33. INSTALLATION

  34. ------------

  35. 

  36. Install the module as usual.

  37. See https://www.drupal.org/node/1897420 for help installing Drupal 8 modules.

  38. 

  39. 

  40. USAGE

  41. -----

  42. 

  43. 1. Create a View with a Feed display on content with geospatial data.

  44. 2. Add fields to output a Geofield, longitude & latitude or WKT.

  45. 3. Optionally add fields for name and description.

  46. 4. Set Format for the display to "GeoJSON Feed".

  47. 5. In the "Style options" for this format:

  48.   * Choose Map Data Source (Other: Lat/Lon Point, Geofield, etc.)

  49.   * Assign the fields that represent Latitude and Longitude.

  50.   * Optionally choose fields representing name and description for each point.

  51.   * Optionally set a JSONP prefix, (see http://en.wikipedia.org/wiki/JSONP).

  52.   * Set the Content-type header to be sent. The default is "application/json",

  53.     the standard MIME type for JSON, per http://www.ietf.org/rfc/rfc4627.txt.

  54. 6. If using with the OpenLayers module, your new GeoJSON layer will be available

  55.   as an Overlay layer on the "Layers & Styles" tab when editing your map.

  56. 

  57. Bounding Box Filtering

  58. --------------------

  59. GeoJSON views can accept a bounding box as an argument to return only the

  60. points within that box.

  61. 

  62. It has been tested with OpenLayers' Bounding Box Strategy but should work

  63. with any mapping tool that requests bounding box coordinates as

  64. "?bbox=left,bottom,right,top" in the query string. Argument ID "bbox" is

  65. default for OpenLayers but can be changed.

  66. 

  67. OpenLayers 7.x-2.x-dev is currently required for OpenLayers BBOX integration.

  68. See OpenLayers issue http://drupal.org/node/1493344, "Support BBOX strategy in

  69. the GeoJSON layer type".

  70. 

  71. 1. Create a GeoJSON view as above in USAGE.

  72. 2. Add a layer to OpenLayers of type GeoJSON, at

  73.    admin/structure/openlayers/layers/add/openlayers_layer_type_geojson,

  74.    specifying the URL to your GeoJSON feed and checking the box for "Use

  75.    Bounding Box Strategy".

  76. 3. In your GeoJSON View configuration, add a Contextual Filter of type:

  77.    "Custom: Bounding box".

  78. 4. In the Contextual Filter settings, under "When the filter value is NOT in

  79.    the URL as a normal Drupal argument", choose: "Provide default value".

  80. 5. In the "Type" dropdown, choose: "Bounding box from query string".

  81. 6. For OpenLayers, leave "Query argument ID" as "bbox" and click Apply.

  82. 

  83. 

  84. TO DO

  85. -----

  86. * Support addditional GeoJSON feature types like LineString.

  87. * Support an optional altitude coordinate for Point positions.

  88. * Support additional coordinate systems.

  89. 

  90. 

  91. CREDITS

  92. -------

  93. 

  94. This module was originally born from a patch by tmcw to the OpenLayers module

  95. (http://drupal.org/node/889190#comment-3376628) and adapted to model the Views

  96. Datasource module (http://drupal.org/project/views_datasource).

  97. 

  98. Much of the code is drawn directly from these sources.

  99. 

  100. 

  101. CURRENT MAINTAINERS

  102. -------------------

  103. 

  104. * jeffschuler - http://drupal.org/user/239714