source: trunk/docs/api/zoo-format-geojson.txt @ 167

Last change on this file since 167 was 167, checked in by jmckenna, 11 years ago

minor

File size: 6.9 KB
Line 
1.. _api-zoo-format-geojson:
2
3ZOO.Format.GeoJSON
4==================
5
6Read and write GeoJSON.
7
8Properties     
9----------
10
11.. list-table::
12   :widths: 20 50
13   :header-rows: 1
14
15   * - NAME
16     - DESCRIPTION
17   * - :ref:`ZOO.Format.GeoJSON <ZOO.Format.GeoJSON>`
18     - Create a new parser for GeoJSON.
19   * - :ref:`read <read>`
20     - Deserialize a GeoJSON string.
21   * - :ref:`isValidType <isValidType>`
22     - Check if a GeoJSON object is a valid representative of the given type.
23   * - :ref:`parseFeature <parseFeature>`
24     - Convert a feature object from GeoJSON into an ZOO.Feature.
25   * - :ref:`parseGeometry <parseGeometry>`
26     - Convert a geometry object from GeoJSON into an ZOO.Geometry.   
27     
28parseCoords Properties 
29----------------------
30
31.. list-table::
32   :widths: 20 50
33   :header-rows: 1
34
35   * - NAME
36     - DESCRIPTION
37   * - :ref:`parseCoords <parseCoords>`
38     - Object with properties corresponding to the GeoJSON geometry types. 
39     
40parseCoords Functions   
41---------------------
42
43.. list-table::
44   :widths: 12 50
45   :header-rows: 1
46
47   * - NAME
48     - DESCRIPTION
49   * - :ref:`parseCoords.point <parseCoords.point>`
50     - Convert a coordinate array from GeoJSON into an ZOO.Geometry.Point.
51   * - :ref:`parseCoords.multipoint <parseCoords.multipoint>`
52     - Convert a coordinate array from GeoJSON into an ZOO.Geometry.MultiPoint.
53   * - :ref:`parseCoords.linestring <parseCoords.linestring>`
54     - Convert a coordinate array from GeoJSON into an ZOO.Geometry.LineString.
55   * - :ref:`parseCoords.multilinestring <parseCoords.multilinestring>`
56     - Convert a coordinate array from GeoJSON into an ZOO.Geometry.MultiLineString.
57   * - :ref:`parseCoords.polygon <parseCoords.polygon>`
58     - Convert a coordinate array from GeoJSON into an ZOO.Geometry.Polygon. 
59   * - :ref:`parseCoords.multipolygon <parseCoords.multipolygon>`
60     - Convert a coordinate array from GeoJSON into an ZOO.Geometry.MultiPolygon.
61   * - :ref:`parseCoords.box <parseCoords.box>`
62     - Convert a coordinate array from GeoJSON into an ZOO.Geometry.Polygon.
63   * - :ref:`write <write>`
64     - Serialize a feature, geometry, array of features into a GeoJSON string.
65   * - :ref:`createCRSObject <createCRSObject>`
66     - Create the CRS object for an object.     
67     
68extract Properties
69------------------
70
71.. list-table::
72   :widths: 20 50
73   :header-rows: 1
74
75   * - NAME
76     - DESCRIPTION
77   * - :ref:`extract <extract>`
78     - Object with properties corresponding to the GeoJSON types.   
79     
80extract Functions       
81-----------------
82
83.. list-table::
84   :widths: 12 50
85   :header-rows: 1
86
87   * - NAME
88     - DESCRIPTION
89   * - :ref:`extract.feature <extract.feature>`
90     - Return a partial GeoJSON object representing a single feature.
91   * - :ref:`extract.geometry <extract.geometry>`
92     - Return a GeoJSON object representing a single geometry.
93   * - :ref:`extract.point <extract.point>`
94     - Return an array of coordinates from a point.
95   * - :ref:`extract.multipoint <extract.multipoint>`
96     - Return an array of coordinates from a multipoint. 
97   * - :ref:`extract.linestring <extract.linestring>`
98     - Return an array of coordinate arrays from a linestring.
99   * - :ref:`extract.multilinestring <extract.multilinestring>`
100     - Return an array of linestring arrays from a linestring.
101   * - :ref:`extract.polygon <extract.polygon>`
102     - Return an array of linear ring arrays from a polygon.
103   * - :ref:`extract.multipolygon <extract.multipolygon>`
104     - Return an array of polygon arrays from a multipolygon. 
105   * - :ref:`extract.collection <extract.collection>`
106     - Return an array of geometries from a geometry collection.     
107     
108**Functions**   
109 
110.. _ZOO.Format.GeoJSON:                         
111 
112ZOO.Format.GeoJSON     
113  Create a new parser for GeoJSON.
114 
115.. _read:                           
116 
117read   
118  Deserialize a GeoJSON string.
119 
120.. _isValidType:                             
121 
122isValidType     
123  Check if a GeoJSON object is a valid representative of the given type.
124 
125.. _parseFeature:                               
126 
127parseFeature   
128  Convert a feature object from GeoJSON into an ZOO.Feature.
129 
130.. _parseGeometry:                                 
131 
132parseGeometry   
133  Convert a geometry object from GeoJSON into an ZOO.Geometry.
134 
135**parseCoords Properties**
136
137.. _parseCoords:                                 
138
139parseCoords     
140  Object with properties corresponding to the GeoJSON geometry types.
141 
142**parseCoords Functions**
143
144.. _parseCoords.point:                                 
145
146parseCoords.point       
147  Convert a coordinate array from GeoJSON into an ZOO.Geometry.Point.
148 
149.. _parseCoords.multipoint:                                   
150 
151parseCoords.multipoint 
152  Convert a coordinate array from GeoJSON into an ZOO.Geometry.MultiPoint.
153 
154.. _parseCoords.linestring:                                     
155 
156parseCoords.linestring 
157  Convert a coordinate array from GeoJSON into an ZOO.Geometry.LineString.
158 
159.. _parseCoords.multilinestring:
160 
161parseCoords.multilinestring     
162  Convert a coordinate array from GeoJSON into an ZOO.Geometry.MultiLineString.
163 
164.. _parseCoords.polygon: 
165 
166parseCoords.polygon     
167  Convert a coordinate array from GeoJSON into an ZOO.Geometry.Polygon.
168
169.. _parseCoords.multipolygon: 
170
171parseCoords.multipolygon       
172  Convert a coordinate array from GeoJSON into an ZOO.Geometry.MultiPolygon.
173 
174.. _parseCoords.box: 
175 
176parseCoords.box
177  Convert a coordinate array from GeoJSON into an ZOO.Geometry.Polygon.
178 
179.. _write: 
180 
181write   
182  Serialize a feature, geometry, array of features into a GeoJSON string.
183 
184.. _createCRSObject:   
185 
186createCRSObject
187  Create the CRS object for an object.
188 
189**extract Properties**
190
191.. _extract:   
192
193extract
194  Object with properties corresponding to the GeoJSON types.
195 
196**extract Functions**
197
198.. _extract.feature:   
199
200extract.feature
201  Return a partial GeoJSON object representing a single feature.
202 
203.. _extract.geometry:     
204 
205extract.geometry       
206  Return a GeoJSON object representing a single geometry.
207 
208.. _extract.point:       
209 
210extract.point   
211  Return an array of coordinates from a point.
212 
213.. _extract.multipoint:         
214 
215extract.multipoint     
216  Return an array of coordinates from a multipoint.
217 
218.. _extract.linestring:           
219 
220extract.linestring     
221  Return an array of coordinate arrays from a linestring.
222 
223.. _extract.multilinestring:             
224 
225extract.multilinestring
226  Return an array of linestring arrays from a linestring.
227 
228.. _extract.polygon:             
229 
230extract.polygon
231  Return an array of linear ring arrays from a polygon.
232 
233.. _extract.multipolygon:                 
234 
235extract.multipolygon   
236  Return an array of polygon arrays from a multipolygon.
237 
238.. _extract.collection: 
239 
240extract.collection     
241  Return an array of geometries from a geometry collection.
Note: See TracBrowser for help on using the repository browser.

Search

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png