Changeset 172
- Timestamp:
- Apr 19, 2011, 9:55:41 PM (14 years ago)
- File:
-
- 1 edited
-
trunk/docs/api/zoo-format.txt (modified) (3 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/docs/api/zoo-format.txt
r163 r172 51 51 52 52 options 53 {Object}A reference to options passed to the constructor.53 ``{Object}`` A reference to options passed to the constructor. 54 54 55 55 .. _externalProjection: 56 56 57 57 externalProjection 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. 59 63 60 64 .. _internalProjection: 61 65 62 66 internalProjection 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. 64 72 65 73 .. _data: 66 74 67 75 data 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>`. 69 77 70 78 .. _keepData: 71 79 72 80 keepData 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. 74 82 75 83 **Functions** … … 78 86 79 87 ZOO.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 81 101 82 102 .. _destroy: 83 103 84 104 destroy 105 :: 106 107 destroy: function() 108 85 109 Clean up. 86 110 … … 88 112 89 113 read 114 :: 115 116 read: function(data) 117 90 118 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 91 127 92 128 .. _write: 93 129 94 130 write 131 :: 132 133 write: function(data) 134 95 135 Accept an object, and return a string.
Note: See TracChangeset
for help on using the changeset viewer.
