source: cows/branches/cows-vis/cows/pylons/project_templates/cows_server/+package+/public/js/yui/api/JSON.html @ 5259

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/cows/branches/cows-vis/cows/pylons/project_templates/cows_server/+package+/public/js/yui/api/JSON.html@5259
Revision 5259, 25.5 KB checked in by domlowe, 11 years ago (diff)

adding yui javascript

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2<html>
3<head>
4        <title>API: json  JSON   (YUI Library)</title>
5        <link rel="stylesheet" type="text/css" href="assets/api.css">
6    <script type="text/javascript" src="assets/api-js"></script>
7    <script type="text/javascript" src="assets/ac-js"></script>
8</head>
9
10<body id="yahoo-com">
11
12<div id="doc3" class="yui-t2">
13
14        <div id="hd">
15        <a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
16        <h3>json&nbsp; <span class="subtitle">3.0.0pr1</span></h3>
17        <p>
18        <a href="./index.html">Yahoo! UI Library</a> 
19            &gt; <a href="./module_json.html">json</a>
20                 &gt; JSON
21               
22            </p>
23
24
25        </div>
26
27        <div id="bd">
28                <div id="yui-main">
29                        <div class="yui-b">
30            <form name="yui-classopts-form">
31    <span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> <label for="showprivate">Show Private</label></span>
32    <span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> <label for="showprotected">Show Protected</label></span>
33    <span id="classopts"><input type="checkbox" name="showdeprecated" id="showdeprecated" /> <label for="showdeprecated">Show Deprecated</label></span>
34            </form>
35
36                    <h2>
37                       
38
39                        <code>static</code>
40                       
41                            Class <b>JSON</b>
42                        <span class="extends">
43                        </span>
44
45                        <span class="extends">
46                        </span>
47                       
48                        </code>
49                    </h2>
50                    <!-- class tree goes here -->
51                   
52               
53 
54
55                    <div class="summary description">
56                        The JSON Utility provides methods to serialize JavaScript objects into
57JSON strings and parse JavaScript objects from strings containing JSON data.
58Three modules are available for inclusion:
59<ol>
60<li>1. <code>json-parse</code> for parsing JSON strings into native JavaScript data</li>
61<li>2. <code>json-stringify</code> for stringification of JavaScript objects into JSON strings</li>
62<li>3. <code>json</code> for both parsing and stringification</li>
63</ol>
64Both <code>json-parse</code> and <code>json-stringify</code> create functions in a static JSON class under your YUI instance (e.g. Y.JSON.parse(..)).
65                    </div>
66
67
68                        <div class="section field details">
69                            <h3 id="properties">Properties</h3>
70                            <div class="content">
71                                    <div class="private">
72                                    <h4><a name="property__BRACKETS">_BRACKETS</a>
73                                        <code>- private {RegExp}</code>
74                                    </h4>
75                                    <div class="detail">
76                                        <div class="description">
77                                            Third step in the validation.  Regex used to remove all open square
78brackets following a colon, comma, or at the beginning of the string.
79                                        </div>
80                                    </div>
81     
82                                       
83
84
85                                    <hr />
86                                    </div>
87                                    <div class="private">
88                                    <h4><a name="property__CHARS">_CHARS</a>
89                                        <code>- private static {Object}</code>
90                                    </h4>
91                                    <div class="detail">
92                                        <div class="description">
93                                            Character substitution map for common escapes and special characters.
94                                        </div>
95                                    </div>
96     
97                                       
98
99
100                                    <hr />
101                                    </div>
102                                    <div class="private">
103                                    <h4><a name="property__ESCAPES">_ESCAPES</a>
104                                        <code>- private {RegExp}</code>
105                                    </h4>
106                                    <div class="detail">
107                                        <div class="description">
108                                            First step in the validation.  Regex used to replace all escape
109sequences (i.e. "\\", etc) with '@' characters (a non-JSON character).
110                                        </div>
111                                    </div>
112     
113                                       
114
115
116                                    <hr />
117                                    </div>
118                                    <div class="private">
119                                    <h4><a name="property__INVALID">_INVALID</a>
120                                        <code>- private {RegExp}</code>
121                                    </h4>
122                                    <div class="detail">
123                                        <div class="description">
124                                            Final step in the validation.  Regex used to test the string left after
125all previous replacements for invalid characters.
126                                        </div>
127                                    </div>
128     
129                                       
130
131
132                                    <hr />
133                                    </div>
134                                    <div class="private">
135                                    <h4><a name="property__SPECIAL_CHARS">_SPECIAL_CHARS</a>
136                                        <code>- private {RegExp}</code>
137                                    </h4>
138                                    <div class="detail">
139                                        <div class="description">
140                                            Regex used to capture characters that need escaping before enclosing
141their containing string in quotes.
142                                        </div>
143                                    </div>
144     
145                                       
146
147
148                                    <hr />
149                                    </div>
150                                    <div class="private">
151                                    <h4><a name="property__UNICODE_EXCEPTIONS">_UNICODE_EXCEPTIONS</a>
152                                        <code>- private {RegExp}</code>
153                                    </h4>
154                                    <div class="detail">
155                                        <div class="description">
156                                            Replace certain Unicode characters that JavaScript may handle incorrectly
157during eval--either by deleting them or treating them as line endings--with
158escae sequences.
159IMPORTANT NOTE: This regex will be used to modify the input if a match is
160found.
161                                        </div>
162                                    </div>
163     
164                                       
165
166
167                                    <hr />
168                                    </div>
169                                    <div class="private">
170                                    <h4><a name="property__VALUES">_VALUES</a>
171                                        <code>- private {RegExp}</code>
172                                    </h4>
173                                    <div class="detail">
174                                        <div class="description">
175                                            Second step in the validation.  Regex used to replace all simple
176values with ']' characters.
177                                        </div>
178                                    </div>
179     
180                                       
181
182
183                                    <hr />
184                                    </div>
185
186
187                            </div>
188                        </div>
189
190
191                        <div class="section method details">
192                            <h3 id="methods">Methods</h3>
193                            <div class="content">
194                                    <div class="private">
195                                    <h4>
196                                        <a name="method__revive">_revive</a></h4>
197                                    <div class="detail">
198                                        <code>
199                                         private
200                                       
201                                       
202                                        MIXED
203                                            <strong>_revive</strong>
204                                           (
205                                               
206                                                       
207                                                         data
208                                                   
209                                               
210                                                        ,
211                                                         reviver
212                                                   
213                                               
214                                            )
215                                        </code>
216                                       
217                                        <div class="description">
218                                            Traverses nested objects, applying a reviver function to each (key,value)
219from the scope if the key:value's containing object.  The value returned
220from the function will replace the original value in the key:value pair.
221If the value returned is undefined, the key will be omitted from the
222returned object.
223                                        </div>
224
225                                        <div class="description">
226
227                                                <dl>
228                                                    <dt>Parameters:</dt>
229                                                        <dd>
230                                                            <code>data &lt;MIXED&gt;</code>
231                                                              Any JavaScript data
232                                                        </dd>
233                                                        <dd>
234                                                            <code>reviver &lt;Function&gt;</code>
235                                                              filter or mutation function
236                                                        </dd>
237                                                </dl>
238
239                                                <dl>
240                                                    <dt>Returns:
241                                                    <code>
242                                                        MIXED
243                                                    </code></dt>
244                                                    <dd>The results of the filtered data</dd>
245                                                </dl>
246
247
248             
249
250                                        </div>
251
252                                    </div>
253                                    <hr />
254                                    </div>
255                                    <div class="">
256                                    <h4>
257                                        <a name="method_dateToString">dateToString</a></h4>
258                                    <div class="detail">
259                                        <code>
260                                       
261                                         static
262                                       
263                                        String
264                                            <strong>dateToString</strong>
265                                           (
266                                               
267                                                       
268                                                         d
269                                                   
270                                               
271                                            )
272                                        </code>
273                                       
274                                        <div class="description">
275                                            Serializes a Date instance as a UTC date string.  Used internally by
276stringify.  Override this method if you need Dates serialized in a
277different format.
278                                        </div>
279
280                                        <div class="description">
281
282                                                <dl>
283                                                    <dt>Parameters:</dt>
284                                                        <dd>
285                                                            <code>d &lt;Date&gt;</code>
286                                                              The Date to serialize
287                                                        </dd>
288                                                </dl>
289
290                                                <dl>
291                                                    <dt>Returns:
292                                                    <code>
293                                                        String
294                                                    </code></dt>
295                                                    <dd>stringified Date in UTC format YYYY-MM-DDTHH:mm:SSZ</dd>
296                                                </dl>
297
298
299             
300
301                                        </div>
302
303                                    </div>
304                                    <hr />
305                                    </div>
306                                    <div class="">
307                                    <h4>
308                                        <a name="method_parse">parse</a></h4>
309                                    <div class="detail">
310                                        <code>
311                                       
312                                         static
313                                       
314                                        MIXED
315                                            <strong>parse</strong>
316                                           (
317                                               
318                                                       
319                                                         s
320                                                   
321                                               
322                                                        ,
323                                                         reviver
324                                                   
325                                               
326                                            )
327                                        </code>
328                                       
329                                        <div class="description">
330                                            Parse a JSON string, returning the native JavaScript representation.
331                                        </div>
332
333                                        <div class="description">
334
335                                                <dl>
336                                                    <dt>Parameters:</dt>
337                                                        <dd>
338                                                            <code>s &lt;string&gt;</code>
339                                                              JSON string data
340                                                        </dd>
341                                                        <dd>
342                                                            <code>reviver &lt;function&gt;</code>
343                                                              (optional) function(k,v) passed each key value pair of object literals, allowing pruning or altering values
344                                                        </dd>
345                                                </dl>
346
347                                                <dl>
348                                                    <dt>Returns:
349                                                    <code>
350                                                        MIXED
351                                                    </code></dt>
352                                                    <dd>the native JavaScript representation of the JSON string</dd>
353                                                </dl>
354
355
356             
357
358                                        </div>
359
360                                    </div>
361                                    <hr />
362                                    </div>
363                                    <div class="">
364                                    <h4>
365                                        <a name="method_stringify">stringify</a></h4>
366                                    <div class="detail">
367                                        <code>
368                                       
369                                         static
370                                       
371                                        string
372                                            <strong>stringify</strong>
373                                           (
374                                               
375                                                       
376                                                         o
377                                                   
378                                               
379                                                        ,
380                                                         w
381                                                   
382                                               
383                                                        ,
384                                                         d
385                                                   
386                                               
387                                            )
388                                        </code>
389                                       
390                                        <div class="description">
391                                            Converts an arbitrary value to a JSON string representation.
392Cyclical object or array references are replaced with null.
393If a whitelist is provided, only matching object keys will be included.
394If a depth limit is provided, objects and arrays at that depth will
395be stringified as empty.
396                                        </div>
397
398                                        <div class="description">
399
400                                                <dl>
401                                                    <dt>Parameters:</dt>
402                                                        <dd>
403                                                            <code>o &lt;MIXED&gt;</code>
404                                                              any arbitrary object to convert to JSON string
405                                                        </dd>
406                                                        <dd>
407                                                            <code>w &lt;Array|Function&gt;</code>
408                                                              (optional) whitelist of acceptable object
409keys to include, or a replacer function to modify the
410raw value before serialization
411                                                        </dd>
412                                                        <dd>
413                                                            <code>d &lt;number&gt;</code>
414                                                              (optional) depth limit to recurse objects/arrays
415(practical minimum 1)
416                                                        </dd>
417                                                </dl>
418
419                                                <dl>
420                                                    <dt>Returns:
421                                                    <code>
422                                                        string
423                                                    </code></dt>
424                                                    <dd>JSON string representation of the input</dd>
425                                                </dl>
426
427
428             
429
430                                        </div>
431
432                                    </div>
433                                    <hr />
434                                    </div>
435                            </div>
436                        </div>
437
438
439
440
441
442
443
444                        </div>
445                </div>
446                <div class="yui-b">
447            <div class="nav">
448
449                    <div class="module">
450                        <h4>Modules</h4>
451                        <ul class="content">
452
453                                <li class=""><a href="module_anim.html">anim</a></li>
454
455                                <li class=""><a href="module_attribute.html">attribute</a></li>
456
457                                <li class=""><a href="module_base.html">base</a></li>
458
459                                <li class=""><a href="module_cookie.html">cookie</a></li>
460
461                                <li class=""><a href="module_dd.html">dd</a></li>
462
463                                <li class=""><a href="module_dd-plugin.html">dd-plugin</a></li>
464
465                                <li class=""><a href="module_dom.html">dom</a></li>
466
467                                <li class=""><a href="module_dump.html">dump</a></li>
468
469                                <li class=""><a href="module_event.html">event</a></li>
470
471                                <li class=""><a href="module_io.html">io</a></li>
472
473                                <li class="selected"><a href="module_json.html">json</a></li>
474
475                                <li class=""><a href="module_node.html">node</a></li>
476
477                                <li class=""><a href="module_oop.html">oop</a></li>
478
479                                <li class=""><a href="module_queue.html">queue</a></li>
480
481                                <li class=""><a href="module_substitute.html">substitute</a></li>
482
483                                <li class=""><a href="module_yui.html">yui</a></li>
484                        </ul>
485                    </div>
486
487                    <div class="module">
488                        <h4>Classes</h4>
489                        <ul class="content">
490                                <li class="selected"><a href="JSON.html">JSON</a></li>
491                        </ul>
492                    </div>
493
494                    <div class="module">
495                        <h4>Files</h4>
496                        <ul class="content">       
497                                <li class=""><a href="json-parse.js.html">json-parse.js</a></li>
498                                <li class=""><a href="json-stringify.js.html">json-stringify.js</a></li>
499                        </ul>
500                    </div>
501
502                    <div class="module">
503                        <h4>Properties</h4>
504                        <ul class="content">       
505                                <li class="private"><a href="#property__BRACKETS">_BRACKETS</a>
506                                        <!--<code>&lt;{RegExp}&gt;</code>-->
507                                </li>
508                                <li class="private"><a href="#property__CHARS">_CHARS</a>
509                                        <!--<code>&lt;{RegExp}&gt;</code>-->
510                                </li>
511                                <li class="private"><a href="#property__ESCAPES">_ESCAPES</a>
512                                        <!--<code>&lt;{RegExp}&gt;</code>-->
513                                </li>
514                                <li class="private"><a href="#property__INVALID">_INVALID</a>
515                                        <!--<code>&lt;{RegExp}&gt;</code>-->
516                                </li>
517                                <li class="private"><a href="#property__SPECIAL_CHARS">_SPECIAL_CHARS</a>
518                                        <!--<code>&lt;{RegExp}&gt;</code>-->
519                                </li>
520                                <li class="private"><a href="#property__UNICODE_EXCEPTIONS">_UNICODE_EXCEPTIONS</a>
521                                        <!--<code>&lt;{RegExp}&gt;</code>-->
522                                </li>
523                                <li class="private"><a href="#property__VALUES">_VALUES</a>
524                                        <!--<code>&lt;{RegExp}&gt;</code>-->
525                                </li>
526                        </ul>
527                    </div>
528
529                    <div class="module">
530                        <h4>Methods</h4>
531                        <ul class="content">       
532                                <li class="private"><!--<code>MIXED</code>-->
533                                <a href="#method__revive">_revive</a>
534                                </li>
535                                <li class=""><!--<code>String</code>-->
536                                <a href="#method_dateToString">dateToString</a>
537                                </li>
538                                <li class=""><!--<code>MIXED</code>-->
539                                <a href="#method_parse">parse</a>
540                                </li>
541                                <li class=""><!--<code>string</code>-->
542                                <a href="#method_stringify">stringify</a>
543                                </li>
544                        </ul>
545                    </div>
546
547
548
549            </div>
550                </div>
551        </div>
552        <div id="ft">
553        <hr />
554        Copyright &copy; 2008 Yahoo! Inc. All rights reserved.
555        </div>
556</div>
557</body>
558</html>
Note: See TracBrowser for help on using the repository browser.