Changeset 174 for trunk/docs/api

Timestamp:

Apr 19, 2011, 11:09:59 PM (14 years ago)

Author:

jmckenna

Message:

add missing function details

File:

• trunk/docs/api/zoo-format-geojson.txt (modified) (12 diffs)

trunk/docs/api/zoo-format-geojson.txt

@@ -112 +112 @@
 ZOO.Format.GeoJSON      
   Create a new parser for GeoJSON.
+
+
+  *Parameters*
+
+  ``options {Object}`` An optional object whose properties will be set on this instance.
   
 .. _read:                           
   
 read    
+  ::
+  
+    read: function(json,type,filter)
+
   Deserialize a GeoJSON string.
+
+  *Parameters*
+
+  | ``json {String}`` A GeoJSON string
+  | ``type {String}`` Optional string that determines the structure of the output.  Supported values are "Geometry", "Feature", and "FeatureCollection".  If absent or null, a default of "FeatureCollection" is assumed.
+  | ``filter {Function}`` A function which will be called for every key and value at every level of the final result.  Each value will be replaced by the result of the filter function.  This can be used to reform generic objects into instances of classes, or to transform date strings into Date objects.
+
+  *Returns*
+
+  ``{Object}`` The return depends on the value of the type argument.  If type is "FeatureCollection" (the default), 
+  the return will be an array of :ref:`ZOO.Feature <api-zoo-feature>`.  If type is "Geometry", the input json must 
+  represent a single geometry, and the return will be an :ref:`ZOO.Geometry <api-zoo-geometry>`.  If type 
+  is "Feature", the input json must represent a single feature, and the return will be an :ref:`ZOO.Feature <api-zoo-feature>`.
   
 .. _isValidType:                             
   
 isValidType     
+  ::
+  
+    isValidType: function(obj,type)
+
   Check if a GeoJSON object is a valid representative of the given type.
+
+  *Returns*
+
+  ``{Boolean}`` The object is valid GeoJSON object of the given type.
   
 .. _parseFeature:                               
   
 parseFeature    
-  Convert a feature object from GeoJSON into an ZOO.Feature.
+  ::
+  
+    parseFeature: function(obj)
+
+  Convert a feature object from GeoJSON into a :ref:`ZOO.Feature <api-zoo-feature>`.
+
+  *Parameters*
+  
+  ``obj {Object}`` An object created from a GeoJSON object
+
+  *Returns*
+
+  :ref:`{ZOO.Feature} <api-zoo-feature>` A feature.  
   
 .. _parseGeometry:                                 
   
 parseGeometry   
-  Convert a geometry object from GeoJSON into an ZOO.Geometry.
+  ::
+  
+    parseGeometry: function(obj)
+
+  Convert a geometry object from GeoJSON into a :ref:`ZOO.Geometry <api-zoo-geometry>`.
+
+  *Parameters*
+  
+  ``obj {Object}`` An object created from a GeoJSON object
+
+  *Returns*
+
+  :ref:`{ZOO.Geometry} <api-zoo-geometry>` A geometry.
   
 **parseCoords Properties**
@@ -138 +192 @@
 
 parseCoords     
-  Object with properties corresponding to the GeoJSON geometry types.
+  Object with properties corresponding to the GeoJSON geometry types. Property 
+  values are functions that do the actual parsing.
   
 **parseCoords Functions**
@@ -145 +200 @@
 
 parseCoords.point       
-  Convert a coordinate array from GeoJSON into an ZOO.Geometry.Point.
+  Convert a coordinate array from GeoJSON into a :ref:`ZOO.Geometry.Point <api-zoo-geometry-point>`.
+
+  *Parameters*
+
+  ``array {Object}`` The coordinates array from the GeoJSON fragment.
+
+  *Returns*
+
+  :ref:`{ZOO.Geometry.Point} <api-zoo-geometry-point>` A geometry.
   
 .. _parseCoords.multipoint:                                   
   
 parseCoords.multipoint  
-  Convert a coordinate array from GeoJSON into an ZOO.Geometry.MultiPoint.
+  Convert a coordinate array from GeoJSON into a :ref:`ZOO.Geometry.MultiPoint <api-zoo-geometry-multipoint>`.
+
+  *Parameters*
+  
+  ``array {Object}`` The coordinates array from the GeoJSON fragment.
+
+  *Returns*
+
+  :ref:`{ZOO.Geometry.MultiPoint} <api-zoo-geometry-multipoint>` A geometry.
   
 .. _parseCoords.linestring:                                     
   
 parseCoords.linestring  
-  Convert a coordinate array from GeoJSON into an ZOO.Geometry.LineString.
+  Convert a coordinate array from GeoJSON into a :ref:`ZOO.Geometry.LineString <api-zoo-geometry-linestring>`.
+
+  *Parameters*
+  
+  ``array {Object}`` The coordinates array from the GeoJSON fragment.
+  
+  *Returns*
+
+  :ref:`{ZOO.Geometry.LineString} <api-zoo-geometry-linestring>` A geometry. 
   
 .. _parseCoords.multilinestring: 
   
 parseCoords.multilinestring     
-  Convert a coordinate array from GeoJSON into an ZOO.Geometry.MultiLineString.
+  Convert a coordinate array from GeoJSON into a :ref:`ZOO.Geometry.MultiLineString <api-zoo-geometry-multilinestring>`.
+
+  *Parameters*
+  
+  ``array {Object}`` The coordinates array from the GeoJSON fragment.
+
+  *Returns*
+
+  :ref:`{ZOO.Geometry.MultiLineString} <api-zoo-geometry-multilinestring>` A geometry.
   
 .. _parseCoords.polygon:  
   
 parseCoords.polygon     
-  Convert a coordinate array from GeoJSON into an ZOO.Geometry.Polygon.
-
+  Convert a coordinate array from GeoJSON into a :ref:`ZOO.Geometry.Polygon <api-zoo-geometry-polygon>`.
+
+  *Parameters*
+  
+  ``array {Object}`` The coordinates array from the GeoJSON fragment.
+
+  *Returns*
+
+  :ref:`{ZOO.Geometry.Polygon} <api-zoo-geometry-polygon>` A geometry.
+  
 .. _parseCoords.multipolygon:  
 
 parseCoords.multipolygon        
-  Convert a coordinate array from GeoJSON into an ZOO.Geometry.MultiPolygon.
+  Convert a coordinate array from GeoJSON into a :ref:`ZOO.Geometry.MultiPolygon <api-zoo-geometry-multipolygon>`.
+  
+  *Parameters*
+
+  ``array {Object}`` The coordinates array from the GeoJSON fragment.
+
+  *Returns*
+
+  :ref:`{ZOO.Geometry.MultiPolygon} <api-zoo-geometry-multipolygon>` A geometry.  
   
 .. _parseCoords.box:  
   
 parseCoords.box 
-  Convert a coordinate array from GeoJSON into an ZOO.Geometry.Polygon.
+  Convert a coordinate array from GeoJSON into a :ref:`ZOO.Geometry.Polygon <api-zoo-geometry-polygon>`.
+
+  *Parameters*
+  
+  ``array {Object}`` The coordinates array from the GeoJSON fragment.
+
+  *Returns*
+
+  :ref:`{ZOO.Geometry.Polygon} <api-zoo-geometry-polygon>` A geometry.  
   
 .. _write:  
   
 write   
+  ::
+  
+    write: function(obj,pretty)
+
   Serialize a feature, geometry, array of features into a GeoJSON string.
+
+  *Parameters*
+  
+  | ``obj {Object}`` A :ref:`{ZOO.Feature} <api-zoo-feature>`, :ref:`{ZOO.Geometry} <api-zoo-geometry>`, or an array of features.
+  | ``pretty {Boolean}`` Structure the output with newlines and indentation.  Default is false.
+
+  *Returns*
+
+  ``{String}`` The GeoJSON string representation of the input geometry, features, or array of features. 
   
 .. _createCRSObject:    
   
 createCRSObject 
+  ::
+  
+    createCRSObject: function(object)
+
   Create the CRS object for an object.
   
+  *Parameters*
+  
+  ``object`` :ref:`{ZOO.Feature} <api-zoo-feature>`
+
+  *Returns*
+
+  ``{Object}`` An object which can be assigned to the crs property of a GeoJSON object. 
+  
 **extract Properties**
 
@@ -192 +328 @@
 
 extract 
-  Object with properties corresponding to the GeoJSON types.
+  Object with properties corresponding to the GeoJSON types. Property values are 
+  functions that do the actual value extraction.
   
 **extract Functions**
@@ -200 +337 @@
 extract.feature 
   Return a partial GeoJSON object representing a single feature.
+
+
+  *Parameters*
+  
+  ``feature`` :ref:`{ZOO.Feature} <api-zoo-feature>`
+
+  *Returns*
+
+  ``{Object}`` An object representing the point.  
   
 .. _extract.geometry:      
@@ -205 +351 @@
 extract.geometry        
   Return a GeoJSON object representing a single geometry.
+
+  *Parameters*
+  
+  ``geometry`` :ref:`{ZOO.Geometry} <api-zoo-geometry>`
+  
+  *Returns*
+
+  ``{Object}`` An object representing the geometry. 
   
 .. _extract.point:        
@@ -210 +364 @@
 extract.point   
   Return an array of coordinates from a point.
+
+  *Parameters*
+  
+  ``point`` :ref:`{ZOO.Geometry.Point} <api-zoo-geometry-point>`
+
+  *Returns*
+
+  ``{Array}`` An array of coordinates representing the point. 
   
 .. _extract.multipoint:          
@@ -215 +377 @@
 extract.multipoint      
   Return an array of coordinates from a multipoint.
+
+  *Parameters*
+  
+  ``multipoint`` :ref:`{ZOO.Geometry.MultiPoint} <api-zoo-geometry-multipoint>`
+
+  *Returns*
+
+  ``{Array}`` An array of point coordinate arrays representing the multipoint.
   
 .. _extract.linestring:            
@@ -220 +390 @@
 extract.linestring      
   Return an array of coordinate arrays from a linestring.
+
+  *Parameters*
+  
+  ``linestring`` :ref:`{ZOO.Geometry.LineString} <api-zoo-geometry-linestring>`
+
+  *Returns*
+
+  ``{Array}`` An array of coordinate arrays representing the linestring. 
   
 .. _extract.multilinestring:              
@@ -225 +403 @@
 extract.multilinestring 
   Return an array of linestring arrays from a linestring.
+
+  *Parameters*
+  
+  ``multilinestring`` :ref:`{ZOO.Geometry.MultiLineString} <api-zoo-geometry-multilinestring>`
+
+  *Returns*
+
+  ``{Array}`` An array of linestring arrays representing the multilinestring. 
   
 .. _extract.polygon:             
@@ -230 +416 @@
 extract.polygon 
   Return an array of linear ring arrays from a polygon.
+
+  *Parameters*
+  
+  ``polygon`` :ref:`{ZOO.Geometry.Polygon} <api-zoo-geometry-polygon>`
+  
+  *Returns*
+
+  ``{Array}`` An array of linear ring arrays representing the polygon. 
   
 .. _extract.multipolygon:                 
@@ -236 +430 @@
   Return an array of polygon arrays from a multipolygon.
   
+  *Parameters*
+  
+  ``multipolygon`` :ref:`{ZOO.Geometry.MultiPolygon} <api-zoo-geometry-multipolygon>`
+
+  *Returns*
+
+  ``{Array}`` An array of polygon arrays representing the multipolygon  
+  
 .. _extract.collection:  
   
 extract.collection      
   Return an array of geometries from a geometry collection.
+
+  *Parameters*
+
+  ``collection`` :ref:`{ZOO.Geometry.Collection} <api-zoo-geometry-collection>`
+
+  *Returns*
+
+  ``{Array}`` An array of geometry objects representing the geometry collection.