pv.Layout.icicle.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577
  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.Layout.icicle</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.Layout.icicle
  210. </h1>
  211. <!-- ============================== class summary ========================== -->
  212. <p class="description">
  213. A tree layout in the form of an icicle. <img src="../icicle.png"
  214. width="160" height="160" align="right"> The first row corresponds to the root
  215. of the tree; subsequent rows correspond to each tier. Rows are subdivided
  216. into cells based on the size of nodes, per <a href="#size">#size</a>. Within a row, cells
  217. are sorted by size.
  218. <p>This tree layout is intended to be extended (see <a href="../symbols/pv.Mark.html#extend">pv.Mark#extend</a>)
  219. by a <a href="../symbols/pv.Bar.html">pv.Bar</a>. The data property returns an array of nodes for use by
  220. other property functions. The following node attributes are supported:
  221. <ul>
  222. <li><tt>left</tt> - the cell left position.
  223. <li><tt>top</tt> - the cell top position.
  224. <li><tt>width</tt> - the cell width.
  225. <li><tt>height</tt> - the cell height.
  226. <li><tt>depth</tt> - the node depth (tier; the root is 0).
  227. <li><tt>keys</tt> - an array of string keys for the node.
  228. <li><tt>size</tt> - the aggregate node size.
  229. <li><tt>children</tt> - child nodes, if any.
  230. <li><tt>data</tt> - the associated tree element, for leaf nodes.
  231. </ul>
  232. To produce a default icicle layout, say:
  233. <pre>.add(pv.Bar)
  234. .extend(pv.Layout.icicle(tree))</pre>
  235. To customize the tree to highlight leaf nodes bigger than 10,000 (1E4), you
  236. might say:
  237. <pre>.add(pv.Bar)
  238. .extend(pv.Layout.icicle(tree))
  239. .fillStyle(function(n) n.data > 1e4 ? "#ff0" : "#fff")</pre>
  240. The format of the <tt>tree</tt> argument is any hierarchical object whose
  241. leaf nodes are numbers corresponding to their size. For an example, and
  242. information on how to convert tabular data into such a tree, see
  243. <a href="../symbols/pv.Tree.html">pv.Tree</a>. If the leaf nodes are not numbers, a <a href="#size">#size</a> function
  244. can be specified to override how the tree is interpreted. This size function
  245. can also be used to transform the data.
  246. <p>By default, the icicle fills the full width and height of the parent
  247. panel. An optional root key can be specified using <a href="#root">#root</a> for
  248. convenience.
  249. <br /><i>Defined in: </i> <a href="../symbols/src/layout_Icicle.js.html">Icicle.js</a>.
  250. </p>
  251. <!-- ============================== constructor summary ==================== -->
  252. <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class pv.Layout.icicle.">
  253. <caption>Class Summary</caption>
  254. <thead>
  255. <tr>
  256. <th scope="col">Constructor Attributes</th>
  257. <th scope="col">Constructor Name and Description</th>
  258. </tr>
  259. </thead>
  260. <tbody>
  261. <tr>
  262. <td class="attributes">&nbsp;</td>
  263. <td class="nameDescription" >
  264. <div class="fixedFont">
  265. <b><a href="../symbols/pv.Layout.icicle.html#constructor">pv.Layout.icicle</a></b>(tree)
  266. </div>
  267. <div class="description">Returns a new icicle tree layout.</div>
  268. </td>
  269. </tr>
  270. </tbody>
  271. </table>
  272. <!-- ============================== properties summary ===================== -->
  273. <!-- ============================== methods summary ======================== -->
  274. <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class pv.Layout.icicle.">
  275. <caption>Method Summary</caption>
  276. <thead>
  277. <tr>
  278. <th scope="col">Method Attributes</th>
  279. <th scope="col">Method Name and Description</th>
  280. </tr>
  281. </thead>
  282. <tbody>
  283. <tr>
  284. <td class="attributes">&nbsp;</td>
  285. <td class="nameDescription">
  286. <div class="fixedFont"><b><a href="../symbols/pv.Layout.icicle.html#root">root</a></b>(v)
  287. </div>
  288. <div class="description">Specifies the root key; optional.</div>
  289. </td>
  290. </tr>
  291. <tr>
  292. <td class="attributes">&nbsp;</td>
  293. <td class="nameDescription">
  294. <div class="fixedFont"><b><a href="../symbols/pv.Layout.icicle.html#size">size</a></b>(f)
  295. </div>
  296. <div class="description">Specifies the sizing function.</div>
  297. </td>
  298. </tr>
  299. </tbody>
  300. </table>
  301. <!-- ============================== events summary ======================== -->
  302. <!-- ============================== constructor details ==================== -->
  303. <div class="details"><a name="constructor"> </a>
  304. <div class="sectionTitle">
  305. Class Detail
  306. </div>
  307. <div class="fixedFont">
  308. <b>pv.Layout.icicle</b>(tree)
  309. </div>
  310. <div class="description">
  311. Returns a new icicle tree layout.
  312. </div>
  313. <dl class="detailList">
  314. <dt class="heading">Parameters:</dt>
  315. <dt>
  316. <b>tree</b>
  317. </dt>
  318. <dd>a tree (an object) who leaf attributes have sizes.</dd>
  319. </dl>
  320. <dl class="detailList">
  321. <dt class="heading">Returns:</dt>
  322. <dd><span class="light fixedFont">{<a href="../symbols/pv.Layout.icicle.html">pv.Layout.icicle</a>}</span> a tree layout.</dd>
  323. </dl>
  324. </div>
  325. <!-- ============================== field details ========================== -->
  326. <!-- ============================== method details ========================= -->
  327. <div class="sectionTitle">
  328. Method Detail
  329. </div>
  330. <a name="root"> </a>
  331. <div class="fixedFont">
  332. <span class="light">{<a href="../symbols/pv.Layout.icicle.html">pv.Layout.icicle</a>}</span>
  333. <b>root</b>(v)
  334. </div>
  335. <div class="description">
  336. Specifies the root key; optional. The root key is prepended to the
  337. <tt>keys</tt> attribute for all generated nodes. This method is provided
  338. for convenience and does not affect layout.
  339. </div>
  340. <dl class="detailList">
  341. <dt class="heading">Parameters:</dt>
  342. <dt>
  343. <span class="light fixedFont">{string}</span> <b>v</b>
  344. </dt>
  345. <dd>the root key.</dd>
  346. </dl>
  347. <dl class="detailList">
  348. <dt class="heading">Returns:</dt>
  349. <dd><span class="light fixedFont">{<a href="../symbols/pv.Layout.icicle.html">pv.Layout.icicle</a>}</span> this.</dd>
  350. </dl>
  351. <hr />
  352. <a name="size"> </a>
  353. <div class="fixedFont">
  354. <span class="light">{<a href="../symbols/pv.Layout.icicle.html">pv.Layout.icicle</a>}</span>
  355. <b>size</b>(f)
  356. </div>
  357. <div class="description">
  358. Specifies the sizing function. By default, the sizing function is
  359. <tt>Number</tt>. The sizing function is invoked for each node in the tree
  360. (passed to the constructor): the sizing function must return
  361. <tt>undefined</tt> or <tt>NaN</tt> for internal nodes, and a number for
  362. leaf nodes. The aggregate sizes of internal nodes will be automatically
  363. computed by the layout.
  364. <p>For example, if the tree data structure represents a file system, with
  365. files as leaf nodes, and each file has a <tt>bytes</tt> attribute, you can
  366. specify a size function as:
  367. <pre>.size(function(d) d.bytes)</pre>
  368. This function will return <tt>undefined</tt> for internal nodes (since
  369. these do not have a <tt>bytes</tt> attribute), and a number for leaf nodes.
  370. <p>Note that the built-in <tt>Math.sqrt</tt> and <tt>Math.log</tt> methods
  371. can also be used as sizing functions. These function similarly to
  372. <tt>Number</tt>, except perform a root and log scale, respectively.
  373. </div>
  374. <dl class="detailList">
  375. <dt class="heading">Parameters:</dt>
  376. <dt>
  377. <span class="light fixedFont">{function}</span> <b>f</b>
  378. </dt>
  379. <dd>the new sizing function.</dd>
  380. </dl>
  381. <dl class="detailList">
  382. <dt class="heading">Returns:</dt>
  383. <dd><span class="light fixedFont">{<a href="../symbols/pv.Layout.icicle.html">pv.Layout.icicle</a>}</span> this.</dd>
  384. </dl>
  385. <!-- ============================== event details ========================= -->
  386. <hr />
  387. </div>
  388. <!-- ============================== footer ================================= -->
  389. <div class="fineprint" style="clear:both">
  390. 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)
  391. </div>
  392. </body>
  393. </html>