Changeset 172


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

add missing function details

File:
1 edited

Legend:

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

    r163 r172  
    5151
    5252options
    53   {Object} A reference to options passed to the constructor.
     53  ``{Object}`` A reference to options passed to the constructor.
    5454 
    5555.. _externalProjection:   
    5656
    5757externalProjection     
    58   {ZOO.Projection} When passed a externalProjection and internalProjection, the format will reproject the geometries it reads or writes.
     58  :ref:`{ZOO.Projection} <api-zoo-projection>` When passed a externalProjection and internalProjection,
     59  the format will reproject the geometries it reads or writes. The externalProjection is the projection
     60  used by the content which is passed into read or which comes out of write.  In order to reproject,
     61  a projection transformation function for the specified projections must be available.  This support
     62  is provided via zoo-proj4js.
    5963
    6064.. _internalProjection:   
    6165
    6266internalProjection     
    63   {ZOO.Projection} When passed a externalProjection and internalProjection, the format will reproject the geometries it reads or writes.
     67  :ref:`{ZOO.Projection} <api-zoo-projection>` When passed a externalProjection and internalProjection,
     68  the format will reproject the geometries it reads or writes. The internalProjection is the projection
     69  used by the geometries which are returned by read or which are passed into write.  In order to reproject,
     70  a projection transformation function for the specified projections must be available.  This support
     71  is provided via zoo-proj4js.
    6472
    6573.. _data:   
    6674
    6775data   
    68   {Object} When keepData is true, this is the parsed string sent to read.
     76  ``{Object}`` When :ref:`keepData <keepData>` is true, this is the parsed string sent to :ref:`read <read>`.
    6977
    7078.. _keepData:   
    7179
    7280keepData       
    73   {Object} Maintain a reference (data) to the most recently read data.
     81  ``{Object}`` Maintain a reference (:ref:`data <data>`) to the most recently read data.  Default is false.
    7482
    7583**Functions**
     
    7886
    7987ZOO.Format     
    80   Instances of this class are not useful.
     88  Instances of this class are not useful.  See one of the subclasses.
     89
     90  *Parameters*
     91 
     92  ``options {Object}`` An optional object with properties to set on the format
     93 
     94  *Valid options*
     95
     96  ``keepData {Boolean}`` If true, upon read, the data property will be set to the parsed object (e.g. the json or xml object).
     97
     98  *Returns*
     99
     100  An instance of ZOO.Format
    81101 
    82102.. _destroy:     
    83103 
    84104destroy
     105  ::
     106 
     107    destroy: function()
     108
    85109  Clean up.
    86110
     
    88112 
    89113read   
     114  ::
     115 
     116    read: function(data)
     117
    90118  Read data from a string, and return an object whose type depends on the subclass.
     119
     120  *Parameters*
     121 
     122  ``data {string}`` Data to read/parse.
     123
     124  *Returns*
     125
     126  Depends on the subclass
    91127
    92128.. _write:     
    93129
    94130write   
     131  ::
     132 
     133    write: function(data)
     134
    95135  Accept an object, and return a string.     
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