Array.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592
  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 - Array</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 Array
  210. </h1>
  211. <!-- ============================== class summary ========================== -->
  212. <p class="description">
  213. The built-in Array 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 Array.">
  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/Array.html#filter">filter</a></b>(f, o)
  231. </div>
  232. <div class="description">Creates a new array with all elements that pass the test implemented by the
  233. provided function.</div>
  234. </td>
  235. </tr>
  236. <tr>
  237. <td class="attributes">&nbsp;</td>
  238. <td class="nameDescription">
  239. <div class="fixedFont"><b><a href="../symbols/Array.html#forEach">forEach</a></b>(f, o)
  240. </div>
  241. <div class="description">Executes a provided function once per array element.</div>
  242. </td>
  243. </tr>
  244. <tr>
  245. <td class="attributes">&nbsp;</td>
  246. <td class="nameDescription">
  247. <div class="fixedFont"><b><a href="../symbols/Array.html#map">map</a></b>(f, o)
  248. </div>
  249. <div class="description">Creates a new array with the results of calling a provided function on
  250. every element in this array.</div>
  251. </td>
  252. </tr>
  253. <tr>
  254. <td class="attributes">&nbsp;</td>
  255. <td class="nameDescription">
  256. <div class="fixedFont"><b><a href="../symbols/Array.html#reduce">reduce</a></b>(f, v)
  257. </div>
  258. <div class="description">Apply a function against an accumulator and each value of the array (from
  259. left-to-right) as to reduce it to a single value.</div>
  260. </td>
  261. </tr>
  262. </tbody>
  263. </table>
  264. <!-- ============================== events summary ======================== -->
  265. <!-- ============================== constructor details ==================== -->
  266. <!-- ============================== field details ========================== -->
  267. <!-- ============================== method details ========================= -->
  268. <div class="sectionTitle">
  269. Method Detail
  270. </div>
  271. <a name="filter"> </a>
  272. <div class="fixedFont">
  273. <b>filter</b>(f, o)
  274. </div>
  275. <div class="description">
  276. Creates a new array with all elements that pass the test implemented by the
  277. provided function. Implemented in Javascript 1.6.
  278. </div>
  279. <dl class="detailList">
  280. <dt class="heading">Parameters:</dt>
  281. <dt>
  282. <span class="light fixedFont">{function}</span> <b>f</b>
  283. </dt>
  284. <dd>function to test each element of the array.</dd>
  285. <dt>
  286. <b>o</b>
  287. <i>Optional</i>
  288. </dt>
  289. <dd>object to use as <tt>this</tt> when executing <tt>f</tt>.</dd>
  290. </dl>
  291. <dl class="detailList">
  292. <dt class="heading">See:</dt>
  293. <dd><a
  294. href="https://developer.mozilla.org/En/Core_JavaScript_1.5_Reference/Objects/Array/filter">filter</a>
  295. documentation.</dd>
  296. </dl>
  297. <hr />
  298. <a name="forEach"> </a>
  299. <div class="fixedFont">
  300. <b>forEach</b>(f, o)
  301. </div>
  302. <div class="description">
  303. Executes a provided function once per array element. Implemented in
  304. Javascript 1.6.
  305. </div>
  306. <dl class="detailList">
  307. <dt class="heading">Parameters:</dt>
  308. <dt>
  309. <span class="light fixedFont">{function}</span> <b>f</b>
  310. </dt>
  311. <dd>function to execute for each element.</dd>
  312. <dt>
  313. <b>o</b>
  314. <i>Optional</i>
  315. </dt>
  316. <dd>object to use as <tt>this</tt> when executing <tt>f</tt>.</dd>
  317. </dl>
  318. <dl class="detailList">
  319. <dt class="heading">See:</dt>
  320. <dd><a
  321. href="https://developer.mozilla.org/En/Core_JavaScript_1.5_Reference/Objects/Array/ForEach">forEach</a>
  322. documentation.</dd>
  323. </dl>
  324. <hr />
  325. <a name="map"> </a>
  326. <div class="fixedFont">
  327. <b>map</b>(f, o)
  328. </div>
  329. <div class="description">
  330. Creates a new array with the results of calling a provided function on
  331. every element in this array. Implemented in Javascript 1.6.
  332. </div>
  333. <dl class="detailList">
  334. <dt class="heading">Parameters:</dt>
  335. <dt>
  336. <span class="light fixedFont">{function}</span> <b>f</b>
  337. </dt>
  338. <dd>function that produces an element of the new Array from
  339. an element of the current one.</dd>
  340. <dt>
  341. <b>o</b>
  342. <i>Optional</i>
  343. </dt>
  344. <dd>object to use as <tt>this</tt> when executing <tt>f</tt>.</dd>
  345. </dl>
  346. <dl class="detailList">
  347. <dt class="heading">See:</dt>
  348. <dd><a
  349. href="https://developer.mozilla.org/En/Core_JavaScript_1.5_Reference/Objects/Array/Map">map</a>
  350. documentation.</dd>
  351. </dl>
  352. <hr />
  353. <a name="reduce"> </a>
  354. <div class="fixedFont">
  355. <b>reduce</b>(f, v)
  356. </div>
  357. <div class="description">
  358. Apply a function against an accumulator and each value of the array (from
  359. left-to-right) as to reduce it to a single value. Implemented in Javascript
  360. 1.8.
  361. </div>
  362. <dl class="detailList">
  363. <dt class="heading">Parameters:</dt>
  364. <dt>
  365. <span class="light fixedFont">{function}</span> <b>f</b>
  366. </dt>
  367. <dd>function to execute on each value in the array.</dd>
  368. <dt>
  369. <b>v</b>
  370. <i>Optional</i>
  371. </dt>
  372. <dd>object to use as the first argument to the first call of
  373. <tt>t</tt>.</dd>
  374. </dl>
  375. <dl class="detailList">
  376. <dt class="heading">See:</dt>
  377. <dd><a
  378. href="https://developer.mozilla.org/En/Core_JavaScript_1.5_Reference/Objects/Array/Reduce">reduce</a>
  379. documentation.</dd>
  380. </dl>
  381. <!-- ============================== event details ========================= -->
  382. <hr />
  383. </div>
  384. <!-- ============================== footer ================================= -->
  385. <div class="fineprint" style="clear:both">
  386. 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)
  387. </div>
  388. </body>
  389. </html>