Changeset 176


Ignore:
Timestamp:
Apr 19, 2011, 11:51:47 PM (9 years ago)
Author:
jmckenna
Message:

add missing function details

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/docs/api/zoo-format-wkt.txt

    r164 r176  
    4444ZOO.Format.WKT 
    4545  Create a new parser for WKT
     46
     47  *Parameters*
     48 
     49  ``options {Object}`` An optional object whose properties will be set on this instance
     50
     51  *Returns*
     52
     53  :ref:`{ZOO.Format.WKT} <api-zoo-format-wkt>` A new WKT parser.
    4654 
    4755.. _read:     
    4856 
    4957read   
    50   Deserialize a WKT string and return a vector feature or an array of vector features.
     58  ::
     59 
     60    read: function(wkt)
     61
     62  Deserialize a WKT string and return a vector feature or an array of vector features. 
     63  Supports WKT for POINT, MULTIPOINT, LINESTRING, MULTILINESTRING, POLYGON, MULTIPOLYGON,
     64  and GEOMETRYCOLLECTION.
     65 
     66  *Parameters*
     67 
     68  ``wkt {String}`` A WKT string
     69 
     70  *Returns*
     71
     72  {<ZOO.Feature.Vector>|Array} A feature or array of features for GEOMETRYCOLLECTION WKT.
    5173 
    5274.. _write:       
    5375 
    5476write   
     77  ::
     78 
     79    write: function(features)
     80
    5581  Serialize a feature or array of features into a WKT string.
     82 
     83  *Parameters*
     84 
     85  ``features {<ZOO.Feature.Vector>|Array}`` A feature or array of features
     86
     87  *Returns*
     88
     89  ``{String}`` The WKT string representation of the input geometries
    5690 
    5791.. _extract:         
    5892 
    5993extract
    60   Object with properties corresponding to the geometry types.
     94  Object with properties corresponding to the geometry types. Property values are
     95  functions that do the actual data extraction.
    6196 
    6297.. _parse:           
    6398 
    6499parse   
    65   Object with properties corresponding to the geometry types.
     100  Object with properties corresponding to the geometry types. Property values are
     101  functions that do the actual parsing.
    66102 
    67103.. _parse.point:             
     
    70106  Return point feature given a point WKT fragment.
    71107 
     108  *Parameters*
     109 
     110  ``str {String}`` A WKT fragment representing the point
     111 
     112  *Returns*
     113 
     114  :ref:`{ZOO.Feature} <api-zoo-feature>` A point feature 
     115 
    72116.. _parse.multipoint:               
    73117 
    74118parse.multipoint       
    75119  Return a multipoint feature given a multipoint WKT fragment.
    76  
     120
     121  *Parameters*
     122 
     123  ``str {String}`` A WKT fragment representing the multipoint
     124
     125  *Returns*
     126
     127  :ref:`{ZOO.Feature} <api-zoo-feature>` A multipoint feature
     128 
    77129.. _parse.linestring:               
    78130 
    79131parse.linestring       
    80132  Return a linestring feature given a linestring WKT fragment.
     133
     134  *Parameters*
     135 
     136  ``str {String}`` A WKT fragment representing the linestring
     137
     138  *Returns*
     139
     140  :ref:`{ZOO.Feature} <api-zoo-feature>` A linestring feature
    81141 
    82142.. _parse.multilinestring:                 
     
    85145  Return a multilinestring feature given a multilinestring WKT fragment.
    86146 
     147  *Parameters*
     148 
     149  ``str {String}`` A WKT fragment representing the multilinestring
     150 
     151  *Returns*
     152
     153  :ref:`{ZOO.Feature} <api-zoo-feature>` A multilinestring feature 
     154 
    87155.. _parse.polygon:                 
    88156 
    89157parse.polygon   
    90158  Return a polygon feature given a polygon WKT fragment.
     159
     160  *Parameters*
     161 
     162  ``str {String}`` A WKT fragment representing the polygon
     163 
     164  *Returns*
     165
     166  :ref:`{ZOO.Feature} <api-zoo-feature>` A polygon feature
    91167 
    92168.. _parse.multipolygon:                   
     
    94170parse.multipolygon     
    95171  Return a multipolygon feature given a multipolygon WKT fragment.
     172
     173  *Parameters*
     174 
     175  ``str {String}`` A WKT fragment representing the multipolygon
     176
     177  *Returns*
     178
     179  :ref:`{ZOO.Feature} <api-zoo-feature>` A multipolygon feature 
    96180 
    97181.. _parse.geometrycollection:                     
     
    100184  Return an array of features given a geometrycollection WKT fragment.
    101185
     186  *Parameters*
     187 
     188  ``str {String}`` A WKT fragment representing the geometrycollection
     189
     190  *Returns*
     191
     192  ``{Array}`` An array of ZOO.Feature
Note: See TracChangeset for help on using the changeset viewer.

Search

Context Navigation

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