pv.Flatten.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547
  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 - pv.Flatten</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. Class pv.Flatten
  210. </h1>
  211. <!-- ============================== class summary ========================== -->
  212. <p class="description">
  213. Represents a flatten operator for the specified array. Flattening
  214. allows hierarchical maps to be flattened into an array. The levels in the
  215. input tree are specified by <i>key</i> functions.
  216. <p>For example, consider the following hierarchical data structure of Barley
  217. yields, from various sites in Minnesota during 1931-2:
  218. <pre>{ 1931: {
  219. Manchuria: {
  220. "University Farm": 27.00,
  221. "Waseca": 48.87,
  222. "Morris": 27.43,
  223. ... },
  224. Glabron: {
  225. "University Farm": 43.07,
  226. "Waseca": 55.20,
  227. ... } },
  228. 1932: {
  229. ... } }</pre>
  230. To facilitate visualization, it may be useful to flatten the tree into a
  231. tabular array:
  232. <pre>var array = pv.flatten(yields)
  233. .key("year")
  234. .key("variety")
  235. .key("site")
  236. .key("yield")
  237. .array();</pre>
  238. This returns an array of object elements. Each element in the array has
  239. attributes corresponding to this flatten operator's keys:
  240. <pre>{ site: "University Farm", variety: "Manchuria", year: 1931, yield: 27 },
  241. { site: "Waseca", variety: "Manchuria", year: 1931, yield: 48.87 },
  242. { site: "Morris", variety: "Manchuria", year: 1931, yield: 27.43 },
  243. { site: "University Farm", variety: "Glabron", year: 1931, yield: 43.07 },
  244. { site: "Waseca", variety: "Glabron", year: 1931, yield: 55.2 }, ...</pre>
  245. <p>The flatten operator is roughly the inverse of the <a href="../symbols/pv.Nest.html">pv.Nest</a> and
  246. <a href="../symbols/pv.Tree.html">pv.Tree</a> operators.
  247. <br /><i>Defined in: </i> <a href="../symbols/src/data_Flatten.js.html">Flatten.js</a>.
  248. </p>
  249. <!-- ============================== constructor summary ==================== -->
  250. <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class pv.Flatten.">
  251. <caption>Class Summary</caption>
  252. <thead>
  253. <tr>
  254. <th scope="col">Constructor Attributes</th>
  255. <th scope="col">Constructor Name and Description</th>
  256. </tr>
  257. </thead>
  258. <tbody>
  259. <tr>
  260. <td class="attributes">&nbsp;</td>
  261. <td class="nameDescription" >
  262. <div class="fixedFont">
  263. <b><a href="../symbols/pv.Flatten.html#constructor">pv.Flatten</a></b>(map)
  264. </div>
  265. <div class="description">Constructs a flatten operator for the specified map.</div>
  266. </td>
  267. </tr>
  268. </tbody>
  269. </table>
  270. <!-- ============================== properties summary ===================== -->
  271. <!-- ============================== methods summary ======================== -->
  272. <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class pv.Flatten.">
  273. <caption>Method Summary</caption>
  274. <thead>
  275. <tr>
  276. <th scope="col">Method Attributes</th>
  277. <th scope="col">Method Name and Description</th>
  278. </tr>
  279. </thead>
  280. <tbody>
  281. <tr>
  282. <td class="attributes">&nbsp;</td>
  283. <td class="nameDescription">
  284. <div class="fixedFont"><b><a href="../symbols/pv.Flatten.html#array">array</a></b>()
  285. </div>
  286. <div class="description">Returns the flattened array.</div>
  287. </td>
  288. </tr>
  289. <tr>
  290. <td class="attributes">&nbsp;</td>
  291. <td class="nameDescription">
  292. <div class="fixedFont"><b><a href="../symbols/pv.Flatten.html#key">key</a></b>(key, f)
  293. </div>
  294. <div class="description">Flattens using the specified key function.</div>
  295. </td>
  296. </tr>
  297. </tbody>
  298. </table>
  299. <!-- ============================== events summary ======================== -->
  300. <!-- ============================== constructor details ==================== -->
  301. <div class="details"><a name="constructor"> </a>
  302. <div class="sectionTitle">
  303. Class Detail
  304. </div>
  305. <div class="fixedFont">
  306. <b>pv.Flatten</b>(map)
  307. </div>
  308. <div class="description">
  309. Constructs a flatten operator for the specified map. This constructor should
  310. not be invoked directly; use <a href="../symbols/pv.html#.flatten">pv.flatten</a> instead.
  311. </div>
  312. <dl class="detailList">
  313. <dt class="heading">Parameters:</dt>
  314. <dt>
  315. <b>map</b>
  316. </dt>
  317. <dd>a map to flatten.</dd>
  318. </dl>
  319. </div>
  320. <!-- ============================== field details ========================== -->
  321. <!-- ============================== method details ========================= -->
  322. <div class="sectionTitle">
  323. Method Detail
  324. </div>
  325. <a name="array"> </a>
  326. <div class="fixedFont">
  327. <b>array</b>()
  328. </div>
  329. <div class="description">
  330. Returns the flattened array. Each entry in the array is an object; each
  331. object has attributes corresponding to this flatten operator's keys.
  332. </div>
  333. <dl class="detailList">
  334. <dt class="heading">Returns:</dt>
  335. <dd>an array of elements from the flattened map.</dd>
  336. </dl>
  337. <hr />
  338. <a name="key"> </a>
  339. <div class="fixedFont">
  340. <span class="light">{<a href="../symbols/pv.Nest.html">pv.Nest</a>}</span>
  341. <b>key</b>(key, f)
  342. </div>
  343. <div class="description">
  344. Flattens using the specified key function. Multiple keys may be added to the
  345. flatten; the tiers of the underlying tree must correspond to the specified
  346. keys, in order. The order of the returned array is undefined; however, you
  347. can easily sort it.
  348. </div>
  349. <dl class="detailList">
  350. <dt class="heading">Parameters:</dt>
  351. <dt>
  352. <span class="light fixedFont">{string}</span> <b>key</b>
  353. </dt>
  354. <dd>the key name.</dd>
  355. <dt>
  356. <span class="light fixedFont">{function}</span> <b>f</b>
  357. <i>Optional</i>
  358. </dt>
  359. <dd>an optional value map function.</dd>
  360. </dl>
  361. <dl class="detailList">
  362. <dt class="heading">Returns:</dt>
  363. <dd><span class="light fixedFont">{<a href="../symbols/pv.Nest.html">pv.Nest</a>}</span> this.</dd>
  364. </dl>
  365. <!-- ============================== event details ========================= -->
  366. <hr />
  367. </div>
  368. <!-- ============================== footer ================================= -->
  369. <div class="fineprint" style="clear:both">
  370. 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:02 GMT-0700 (PDT)
  371. </div>
  372. </body>
  373. </html>