Changeset 177


Ignore:
Timestamp:
Apr 20, 2011, 12:00:57 AM (11 years ago)
Author:
jmckenna
Message:

add missing function details

File:
1 edited

Legend:

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

    r162 r177  
    4949
    5050proj   
    51   {Object} Proj4js.Proj instance.
     51  ``{Object}`` Proj4js.Proj instance.
    5252 
    5353.. _projCode:     
    5454 
    5555projCode       
    56   {String}
     56  ``{String}``
    5757
    5858**Functions**
     
    6363  This class offers several methods for interacting with a wrapped zoo-pro4js projection object.
    6464
     65  *Parameters*
     66 
     67  | ``projCode {String}`` A string identifying the Well Known Identifier for the projection.
     68  | ``options {Object}`` An optional object to set additional properties.
     69
     70  *Returns*
     71
     72  :ref:`{ZOO.Projection} <api-zoo-projection>` A projection object.
     73 
    6574.. _getCode:     
    6675
    6776getCode
     77  ::
     78 
     79    getCode: function()
     80
    6881  Get the string SRS code.
     82 
     83  *Returns*
     84
     85  ``{String}`` The SRS code.
    6986 
    7087.. _getUnits:       
    7188
    7289getUnits       
     90  ::
     91 
     92    getUnits: function()
     93
    7394  Get the units string for the projection -- returns null if zoo-proj4js is not available.
    7495
     96  *Returns*
     97
     98  ``{String}`` The units abbreviation.
     99 
    75100.. _toString:       
    76101
    77102toString       
     103  ::
     104 
     105    toString: function()
     106
    78107  Convert projection to string (getCode wrapper).
     108 
     109  *Returns*
     110
     111  ``{String}`` The projection code. 
    79112 
    80113.. _equals:         
    81114 
    82115equals 
    83   Test equality of two projection instances.
     116  ::
     117 
     118    equals: function(projection)
     119
     120  Test equality of two projection instances.  Determines equality based soley on the projection code.
     121
     122  *Returns*
     123
     124  ``{Boolean}`` The two projections are equivalent.
    84125 
    85126.. _destroy:           
    86127 
    87128destroy
    88   Destroy projection object.
     129  ::
     130 
     131    destroy: function()
     132
     133  Destroy projection object.
    89134 
    90135.. _transform:             
    91136 
    92137transform       
    93   Transform a point coordinate from one projection to another.
     138  ::
     139 
     140    ZOO.Projection.transform = function(point,source,dest)
     141
     142  Transform a point coordinate from one projection to another.  Note that the input point is
     143  transformed in place.
     144 
     145  *Parameters*
     146 
     147  | ``point {{ZOO.Geometry.Point> | Object}`` An object with x and y properties representing coordinates in those dimensions.
     148  | ``sourceProj {ZOO.Projection}`` Source map coordinate system
     149  | ``destProj {ZOO.Projection}`` Destination map coordinate system
     150
     151  *Returns*
     152 
     153  ``point {object}`` A transformed coordinate.  The original point is modified.
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