Date.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4. <head>
  5. <meta http-equiv="content-type" content="text/html; charset=utf-8" />
  6. <meta name="generator" content="JsDoc Toolkit" />
  7. <title>JsDoc Reference - Date</title>
  8. <style type="text/css">
  9. /* default.css */
  10. body
  11. {
  12. font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
  13. width: 800px;
  14. }
  15. .header
  16. {
  17. clear: both;
  18. background-color: #ccc;
  19. padding: 8px;
  20. }
  21. h1
  22. {
  23. font-size: 150%;
  24. font-weight: bold;
  25. padding: 0;
  26. margin: 1em 0 0 .3em;
  27. }
  28. hr
  29. {
  30. border: none 0;
  31. border-top: 1px solid #7F8FB1;
  32. height: 1px;
  33. }
  34. pre.code
  35. {
  36. display: block;
  37. padding: 8px;
  38. border: 1px dashed #ccc;
  39. }
  40. #index
  41. {
  42. margin-top: 24px;
  43. float: left;
  44. width: 160px;
  45. position: absolute;
  46. left: 8px;
  47. background-color: #F3F3F3;
  48. padding: 8px;
  49. }
  50. #content
  51. {
  52. margin-left: 190px;
  53. width: 600px;
  54. }
  55. .classList
  56. {
  57. list-style-type: none;
  58. padding: 0;
  59. margin: 0 0 0 8px;
  60. font-family: arial, sans-serif;
  61. font-size: 1em;
  62. overflow: auto;
  63. }
  64. .classList li
  65. {
  66. padding: 0;
  67. margin: 0 0 8px 0;
  68. }
  69. .summaryTable { width: 100%; }
  70. h1.classTitle
  71. {
  72. font-size:170%;
  73. line-height:130%;
  74. }
  75. h2 { font-size: 110%; }
  76. caption, div.sectionTitle
  77. {
  78. background-color: #7F8FB1;
  79. color: #fff;
  80. font-size:130%;
  81. text-align: left;
  82. padding: 2px 6px 2px 6px;
  83. border: 1px #7F8FB1 solid;
  84. }
  85. div.sectionTitle { margin-bottom: 8px; }
  86. .summaryTable thead { display: none; }
  87. .summaryTable td
  88. {
  89. vertical-align: top;
  90. padding: 4px;
  91. border-bottom: 1px #7F8FB1 solid;
  92. border-right: 1px #7F8FB1 solid;
  93. }
  94. /*col#summaryAttributes {}*/
  95. .summaryTable td.attributes
  96. {
  97. border-left: 1px #7F8FB1 solid;
  98. width: 140px;
  99. text-align: right;
  100. }
  101. td.attributes, .fixedFont
  102. {
  103. line-height: 15px;
  104. color: #002EBE;
  105. font-family: "Courier New",Courier,monospace;
  106. font-size: 13px;
  107. }
  108. .summaryTable td.nameDescription
  109. {
  110. text-align: left;
  111. font-size: 13px;
  112. line-height: 15px;
  113. }
  114. .summaryTable td.nameDescription, .description
  115. {
  116. line-height: 15px;
  117. padding: 4px;
  118. padding-left: 4px;
  119. }
  120. pre
  121. {
  122. border-left: solid 10px #ddd;
  123. padding-left: 1.5em;
  124. }
  125. .summaryTable { margin-bottom: 8px; }
  126. ul.inheritsList
  127. {
  128. list-style: square;
  129. margin-left: 20px;
  130. padding-left: 0;
  131. }
  132. .detailList {
  133. margin-left: 20px;
  134. line-height: 15px;
  135. }
  136. .detailList dt { margin-left: 20px; }
  137. .detailList .heading
  138. {
  139. font-weight: bold;
  140. padding-bottom: 6px;
  141. margin-left: 0;
  142. }
  143. .light, td.attributes, .light a:link, .light a:visited
  144. {
  145. color: #777;
  146. font-style: italic;
  147. }
  148. .fineprint
  149. {
  150. text-align: right;
  151. font-size: 10px;
  152. }
  153. </style>
  154. </head>
  155. <body>
  156. <!-- ============================== header ================================= -->
  157. <!-- begin static/header.html -->
  158. <div id="header">
  159. </div>
  160. <!-- end static/header.html -->
  161. <!-- ============================== classes index ============================ -->
  162. <div id="index">
  163. <!-- begin publish.classesIndex -->
  164. <div align="center"><a href="../index.html">Class Index</a>
  165. | <a href="../files.html">File Index</a></div>
  166. <hr />
  167. <h2>Classes</h2>
  168. <ul class="classList">
  169. <li><i><a href="../symbols/_global_.html">_global_</a></i></li>
  170. <li><a href="../symbols/Array.html">Array</a></li>
  171. <li><a href="../symbols/Date.html">Date</a></li>
  172. <li><a href="../symbols/pv.html">pv</a></li>
  173. <li><a href="../symbols/pv.Anchor.html">pv.Anchor</a></li>
  174. <li><a href="../symbols/pv.Area.html">pv.Area</a></li>
  175. <li><a href="../symbols/pv.Bar.html">pv.Bar</a></li>
  176. <li><a href="../symbols/pv.Color.html">pv.Color</a></li>
  177. <li><a href="../symbols/pv.Color.Hsl.html">pv.Color.Hsl</a></li>
  178. <li><a href="../symbols/pv.Color.Rgb.html">pv.Color.Rgb</a></li>
  179. <li><a href="../symbols/pv.Colors.html">pv.Colors</a></li>
  180. <li><a href="../symbols/pv.Dot.html">pv.Dot</a></li>
  181. <li><a href="../symbols/pv.Flatten.html">pv.Flatten</a></li>
  182. <li><a href="../symbols/pv.Image.html">pv.Image</a></li>
  183. <li><a href="../symbols/pv.Label.html">pv.Label</a></li>
  184. <li><a href="../symbols/pv.Layout.grid.html">pv.Layout.grid</a></li>
  185. <li><a href="../symbols/pv.Layout.icicle.html">pv.Layout.icicle</a></li>
  186. <li><a href="../symbols/pv.Layout.stack.html">pv.Layout.stack</a></li>
  187. <li><a href="../symbols/pv.Layout.sunburst.html">pv.Layout.sunburst</a></li>
  188. <li><a href="../symbols/pv.Layout.treemap.html">pv.Layout.treemap</a></li>
  189. <li><a href="../symbols/pv.Line.html">pv.Line</a></li>
  190. <li><a href="../symbols/pv.Mark.html">pv.Mark</a></li>
  191. <li><a href="../symbols/pv.Nest.html">pv.Nest</a></li>
  192. <li><a href="../symbols/pv.ns.html">pv.ns</a></li>
  193. <li><a href="../symbols/pv.Panel.html">pv.Panel</a></li>
  194. <li><a href="../symbols/pv.Rule.html">pv.Rule</a></li>
  195. <li><a href="../symbols/pv.Scale.linear.html">pv.Scale.linear</a></li>
  196. <li><a href="../symbols/pv.Scale.log.html">pv.Scale.log</a></li>
  197. <li><a href="../symbols/pv.Scale.ordinal.html">pv.Scale.ordinal</a></li>
  198. <li><a href="../symbols/pv.Tree.html">pv.Tree</a></li>
  199. <li><a href="../symbols/pv.Vector.html">pv.Vector</a></li>
  200. <li><a href="../symbols/pv.version.html">pv.version</a></li>
  201. <li><a href="../symbols/pv.Wedge.html">pv.Wedge</a></li>
  202. </ul>
  203. <hr />
  204. <!-- end publish.classesIndex -->
  205. </div>
  206. <div id="content">
  207. <!-- ============================== class title ============================ -->
  208. <h1 class="classTitle">
  209. Built-In Class Date
  210. </h1>
  211. <!-- ============================== class summary ========================== -->
  212. <p class="description">
  213. The built-in Date class.
  214. </p>
  215. <!-- ============================== constructor summary ==================== -->
  216. <!-- ============================== properties summary ===================== -->
  217. <!-- ============================== methods summary ======================== -->
  218. <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class Date.">
  219. <caption>Method Summary</caption>
  220. <thead>
  221. <tr>
  222. <th scope="col">Method Attributes</th>
  223. <th scope="col">Method Name and Description</th>
  224. </tr>
  225. </thead>
  226. <tbody>
  227. <tr>
  228. <td class="attributes">&nbsp;</td>
  229. <td class="nameDescription">
  230. <div class="fixedFont"><b><a href="../symbols/Date.html#format">format</a></b>(format)
  231. </div>
  232. <div class="description">Converts a date to a string using the specified formatting.</div>
  233. </td>
  234. </tr>
  235. <tr>
  236. <td class="attributes">&lt;static&gt; &nbsp;</td>
  237. <td class="nameDescription">
  238. <div class="fixedFont">Date.<b><a href="../symbols/Date.html#.parse">parse</a></b>(s, format)
  239. </div>
  240. <div class="description">Parses a date from a string, optionally using the specified formatting.</div>
  241. </td>
  242. </tr>
  243. </tbody>
  244. </table>
  245. <!-- ============================== events summary ======================== -->
  246. <!-- ============================== constructor details ==================== -->
  247. <!-- ============================== field details ========================== -->
  248. <!-- ============================== method details ========================= -->
  249. <div class="sectionTitle">
  250. Method Detail
  251. </div>
  252. <a name="format"> </a>
  253. <div class="fixedFont">
  254. <span class="light">{string}</span>
  255. <b>format</b>(format)
  256. </div>
  257. <div class="description">
  258. Converts a date to a string using the specified formatting. If the
  259. <tt>Date</tt> object already supports the <tt>toLocaleFormat</tt> method, as
  260. in Firefox, this is simply an alias to the built-in method.
  261. <p>The format string is in the same format expected by the <tt>strftime</tt>
  262. function in C. The following conversion specifications are supported:<ul>
  263. <li>%a - abbreviated weekday name.</li>
  264. <li>%A - full weekday name.</li>
  265. <li>%b - abbreviated month names.</li>
  266. <li>%B - full month names.</li>
  267. <li>%c - locale's appropriate date and time.</li>
  268. <li>%C - century number.</li>
  269. <li>%d - day of month [01,31] (zero padded).</li>
  270. <li>%D - same as %m/%d/%y.</li>
  271. <li>%e - day of month [ 1,31] (space padded).</li>
  272. <li>%h - same as %b.</li>
  273. <li>%H - hour (24-hour clock) [00,23] (zero padded).</li>
  274. <li>%I - hour (12-hour clock) [01,12] (zero padded).</li>
  275. <li>%m - month number [01,12] (zero padded).</li>
  276. <li>%M - minute [0,59] (zero padded).</li>
  277. <li>%n - newline character.</li>
  278. <li>%p - locale's equivalent of a.m. or p.m.</li>
  279. <li>%r - same as %I:%M:%S %p.</li>
  280. <li>%R - same as %H:%M.</li>
  281. <li>%S - second [00,61] (zero padded).</li>
  282. <li>%t - tab character.</li>
  283. <li>%T - same as %H:%M:%S.</li>
  284. <li>%x - same as %m/%d/%y.</li>
  285. <li>%X - same as %I:%M:%S %p.</li>
  286. <li>%y - year with century [00,99] (zero padded).</li>
  287. <li>%Y - year including century.</li>
  288. <li>%% - %.</li>
  289. </ul>The following conversion specifications are <i>unsupported</i> (for now):<ul>
  290. <li>%j - day number [1,366].</li>
  291. <li>%u - weekday number [1,7].</li>
  292. <li>%U - week number [00,53].</li>
  293. <li>%V - week number [01,53].</li>
  294. <li>%w - weekday number [0,6].</li>
  295. <li>%W - week number [00,53].</li>
  296. <li>%Z - timezone name or abbreviation.</li>
  297. </ul>
  298. </div>
  299. <dl class="detailList">
  300. <dt class="heading">Parameters:</dt>
  301. <dt>
  302. <span class="light fixedFont">{string}</span> <b>format</b>
  303. </dt>
  304. <dd>a format string.</dd>
  305. </dl>
  306. <dl class="detailList">
  307. <dt class="heading">Returns:</dt>
  308. <dd><span class="light fixedFont">{string}</span> the formatted date.</dd>
  309. </dl>
  310. <dl class="detailList">
  311. <dt class="heading">See:</dt>
  312. <dd><a
  313. href="http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Date/toLocaleFormat">Date.toLocaleFormat</a>
  314. documentation.</dd>
  315. <dd><a
  316. href="http://www.opengroup.org/onlinepubs/007908799/xsh/strftime.html">strftime</a>
  317. documentation.</dd>
  318. </dl>
  319. <hr />
  320. <a name=".parse"> </a>
  321. <div class="fixedFont">&lt;static&gt;
  322. <span class="light">{<a href="../symbols/Date.html">Date</a>}</span>
  323. <span class="light">Date.</span><b>parse</b>(s, format)
  324. </div>
  325. <div class="description">
  326. Parses a date from a string, optionally using the specified formatting. If
  327. only a single argument is specified (i.e., <tt>format</tt> is not specified),
  328. this method invokes the native implementation to guarantee
  329. backwards-compatibility.
  330. <p>The format string is in the same format expected by the <tt>strptime</tt>
  331. function in C. The following conversion specifications are supported:<ul>
  332. <li>%b - abbreviated month names.</li>
  333. <li>%B - full month names.</li>
  334. <li>%h - same as %b.</li>
  335. <li>%d - day of month [1,31].</li>
  336. <li>%e - same as %d.</li>
  337. <li>%H - hour (24-hour clock) [0,23].</li>
  338. <li>%m - month number [1,12].</li>
  339. <li>%M - minute [0,59].</li>
  340. <li>%S - second [0,61].</li>
  341. <li>%y - year with century [0,99].</li>
  342. <li>%Y - year including century.</li>
  343. <li>%% - %.</li>
  344. </ul>The following conversion specifications are <i>unsupported</i> (for now):<ul>
  345. <li>%a - day of week, either abbreviated or full name.</li>
  346. <li>%A - same as %a.</li>
  347. <li>%c - locale's appropriate date and time.</li>
  348. <li>%C - century number.</li>
  349. <li>%D - same as %m/%d/%y.</li>
  350. <li>%I - hour (12-hour clock) [1,12].</li>
  351. <li>%j - day number [1,366].</li>
  352. <li>%n - any white space.</li>
  353. <li>%p - locale's equivalent of a.m. or p.m.</li>
  354. <li>%r - same as %I:%M:%S %p.</li>
  355. <li>%R - same as %H:%M.</li>
  356. <li>%t - same as %n.</li>
  357. <li>%T - same as %H:%M:%S.</li>
  358. <li>%U - week number [0,53].</li>
  359. <li>%w - weekday [0,6].</li>
  360. <li>%W - week number [0,53].</li>
  361. <li>%x - locale's equivalent to %m/%d/%y.</li>
  362. <li>%X - locale's equivalent to %I:%M:%S %p.</li>
  363. </ul>
  364. </div>
  365. <dl class="detailList">
  366. <dt class="heading">Parameters:</dt>
  367. <dt>
  368. <span class="light fixedFont">{string}</span> <b>s</b>
  369. </dt>
  370. <dd>the string to parse as a date.</dd>
  371. <dt>
  372. <span class="light fixedFont">{string}</span> <b>format</b>
  373. <i>Optional</i>
  374. </dt>
  375. <dd>an optional format string.</dd>
  376. </dl>
  377. <dl class="detailList">
  378. <dt class="heading">Returns:</dt>
  379. <dd><span class="light fixedFont">{<a href="../symbols/Date.html">Date</a>}</span> the parsed date.</dd>
  380. </dl>
  381. <dl class="detailList">
  382. <dt class="heading">See:</dt>
  383. <dd><a
  384. href="http://www.opengroup.org/onlinepubs/007908799/xsh/strptime.html">strptime</a>
  385. documentation.</dd>
  386. </dl>
  387. <!-- ============================== event details ========================= -->
  388. <hr />
  389. </div>
  390. <!-- ============================== footer ================================= -->
  391. <div class="fineprint" style="clear:both">
  392. Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.0 on Tue Oct 06 2009 09:59:01 GMT-0700 (PDT)
  393. </div>
  394. </body>
  395. </html>