| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
- <meta http-equiv="content-type" content="text/html; charset=utf-8" />
- <meta name="generator" content="JsDoc Toolkit" />
-
- <title>JsDoc Reference - pv.Flatten</title>
- <style type="text/css">
- /* default.css */
- body
- {
- font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
- width: 800px;
- }
- .header
- {
- clear: both;
- background-color: #ccc;
- padding: 8px;
- }
- h1
- {
- font-size: 150%;
- font-weight: bold;
- padding: 0;
- margin: 1em 0 0 .3em;
- }
- hr
- {
- border: none 0;
- border-top: 1px solid #7F8FB1;
- height: 1px;
- }
- pre.code
- {
- display: block;
- padding: 8px;
- border: 1px dashed #ccc;
- }
- #index
- {
- margin-top: 24px;
- float: left;
- width: 160px;
- position: absolute;
- left: 8px;
- background-color: #F3F3F3;
- padding: 8px;
- }
- #content
- {
- margin-left: 190px;
- width: 600px;
- }
- .classList
- {
- list-style-type: none;
- padding: 0;
- margin: 0 0 0 8px;
- font-family: arial, sans-serif;
- font-size: 1em;
- overflow: auto;
- }
- .classList li
- {
- padding: 0;
- margin: 0 0 8px 0;
- }
- .summaryTable { width: 100%; }
- h1.classTitle
- {
- font-size:170%;
- line-height:130%;
- }
- h2 { font-size: 110%; }
- caption, div.sectionTitle
- {
- background-color: #7F8FB1;
- color: #fff;
- font-size:130%;
- text-align: left;
- padding: 2px 6px 2px 6px;
- border: 1px #7F8FB1 solid;
- }
- div.sectionTitle { margin-bottom: 8px; }
- .summaryTable thead { display: none; }
- .summaryTable td
- {
- vertical-align: top;
- padding: 4px;
- border-bottom: 1px #7F8FB1 solid;
- border-right: 1px #7F8FB1 solid;
- }
- /*col#summaryAttributes {}*/
- .summaryTable td.attributes
- {
- border-left: 1px #7F8FB1 solid;
- width: 140px;
- text-align: right;
- }
- td.attributes, .fixedFont
- {
- line-height: 15px;
- color: #002EBE;
- font-family: "Courier New",Courier,monospace;
- font-size: 13px;
- }
- .summaryTable td.nameDescription
- {
- text-align: left;
- font-size: 13px;
- line-height: 15px;
- }
- .summaryTable td.nameDescription, .description
- {
- line-height: 15px;
- padding: 4px;
- padding-left: 4px;
- }
- pre
- {
- border-left: solid 10px #ddd;
- padding-left: 1.5em;
- }
- .summaryTable { margin-bottom: 8px; }
- ul.inheritsList
- {
- list-style: square;
- margin-left: 20px;
- padding-left: 0;
- }
- .detailList {
- margin-left: 20px;
- line-height: 15px;
- }
- .detailList dt { margin-left: 20px; }
- .detailList .heading
- {
- font-weight: bold;
- padding-bottom: 6px;
- margin-left: 0;
- }
- .light, td.attributes, .light a:link, .light a:visited
- {
- color: #777;
- font-style: italic;
- }
- .fineprint
- {
- text-align: right;
- font-size: 10px;
- }
- </style>
- </head>
- <body>
- <!-- ============================== header ================================= -->
- <!-- begin static/header.html -->
- <div id="header">
- </div>
- <!-- end static/header.html -->
- <!-- ============================== classes index ============================ -->
- <div id="index">
- <!-- begin publish.classesIndex -->
- <div align="center"><a href="../index.html">Class Index</a>
- | <a href="../files.html">File Index</a></div>
- <hr />
- <h2>Classes</h2>
- <ul class="classList">
-
- <li><i><a href="../symbols/_global_.html">_global_</a></i></li>
-
- <li><a href="../symbols/Array.html">Array</a></li>
-
- <li><a href="../symbols/Date.html">Date</a></li>
-
- <li><a href="../symbols/pv.html">pv</a></li>
-
- <li><a href="../symbols/pv.Anchor.html">pv.Anchor</a></li>
-
- <li><a href="../symbols/pv.Area.html">pv.Area</a></li>
-
- <li><a href="../symbols/pv.Bar.html">pv.Bar</a></li>
-
- <li><a href="../symbols/pv.Color.html">pv.Color</a></li>
-
- <li><a href="../symbols/pv.Color.Hsl.html">pv.Color.Hsl</a></li>
-
- <li><a href="../symbols/pv.Color.Rgb.html">pv.Color.Rgb</a></li>
-
- <li><a href="../symbols/pv.Colors.html">pv.Colors</a></li>
-
- <li><a href="../symbols/pv.Dot.html">pv.Dot</a></li>
-
- <li><a href="../symbols/pv.Flatten.html">pv.Flatten</a></li>
-
- <li><a href="../symbols/pv.Image.html">pv.Image</a></li>
-
- <li><a href="../symbols/pv.Label.html">pv.Label</a></li>
-
- <li><a href="../symbols/pv.Layout.grid.html">pv.Layout.grid</a></li>
-
- <li><a href="../symbols/pv.Layout.icicle.html">pv.Layout.icicle</a></li>
-
- <li><a href="../symbols/pv.Layout.stack.html">pv.Layout.stack</a></li>
-
- <li><a href="../symbols/pv.Layout.sunburst.html">pv.Layout.sunburst</a></li>
-
- <li><a href="../symbols/pv.Layout.treemap.html">pv.Layout.treemap</a></li>
-
- <li><a href="../symbols/pv.Line.html">pv.Line</a></li>
-
- <li><a href="../symbols/pv.Mark.html">pv.Mark</a></li>
-
- <li><a href="../symbols/pv.Nest.html">pv.Nest</a></li>
-
- <li><a href="../symbols/pv.ns.html">pv.ns</a></li>
-
- <li><a href="../symbols/pv.Panel.html">pv.Panel</a></li>
-
- <li><a href="../symbols/pv.Rule.html">pv.Rule</a></li>
-
- <li><a href="../symbols/pv.Scale.linear.html">pv.Scale.linear</a></li>
-
- <li><a href="../symbols/pv.Scale.log.html">pv.Scale.log</a></li>
-
- <li><a href="../symbols/pv.Scale.ordinal.html">pv.Scale.ordinal</a></li>
-
- <li><a href="../symbols/pv.Tree.html">pv.Tree</a></li>
-
- <li><a href="../symbols/pv.Vector.html">pv.Vector</a></li>
-
- <li><a href="../symbols/pv.version.html">pv.version</a></li>
-
- <li><a href="../symbols/pv.Wedge.html">pv.Wedge</a></li>
-
- </ul>
- <hr />
- <!-- end publish.classesIndex -->
- </div>
-
- <div id="content">
- <!-- ============================== class title ============================ -->
- <h1 class="classTitle">
-
- Class pv.Flatten
- </h1>
- <!-- ============================== class summary ========================== -->
- <p class="description">
-
-
- Represents a flatten operator for the specified array. Flattening
- allows hierarchical maps to be flattened into an array. The levels in the
- input tree are specified by <i>key</i> functions.
- <p>For example, consider the following hierarchical data structure of Barley
- yields, from various sites in Minnesota during 1931-2:
- <pre>{ 1931: {
- Manchuria: {
- "University Farm": 27.00,
- "Waseca": 48.87,
- "Morris": 27.43,
- ... },
- Glabron: {
- "University Farm": 43.07,
- "Waseca": 55.20,
- ... } },
- 1932: {
- ... } }</pre>
- To facilitate visualization, it may be useful to flatten the tree into a
- tabular array:
- <pre>var array = pv.flatten(yields)
- .key("year")
- .key("variety")
- .key("site")
- .key("yield")
- .array();</pre>
- This returns an array of object elements. Each element in the array has
- attributes corresponding to this flatten operator's keys:
- <pre>{ site: "University Farm", variety: "Manchuria", year: 1931, yield: 27 },
- { site: "Waseca", variety: "Manchuria", year: 1931, yield: 48.87 },
- { site: "Morris", variety: "Manchuria", year: 1931, yield: 27.43 },
- { site: "University Farm", variety: "Glabron", year: 1931, yield: 43.07 },
- { site: "Waseca", variety: "Glabron", year: 1931, yield: 55.2 }, ...</pre>
- <p>The flatten operator is roughly the inverse of the <a href="../symbols/pv.Nest.html">pv.Nest</a> and
- <a href="../symbols/pv.Tree.html">pv.Tree</a> operators.
-
-
- <br /><i>Defined in: </i> <a href="../symbols/src/data_Flatten.js.html">Flatten.js</a>.
-
- </p>
- <!-- ============================== constructor summary ==================== -->
-
- <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class pv.Flatten.">
- <caption>Class Summary</caption>
- <thead>
- <tr>
- <th scope="col">Constructor Attributes</th>
- <th scope="col">Constructor Name and Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription" >
- <div class="fixedFont">
- <b><a href="../symbols/pv.Flatten.html#constructor">pv.Flatten</a></b>(map)
- </div>
- <div class="description">Constructs a flatten operator for the specified map.</div>
- </td>
- </tr>
- </tbody>
- </table>
-
- <!-- ============================== properties summary ===================== -->
-
- <!-- ============================== methods summary ======================== -->
-
-
-
- <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class pv.Flatten.">
- <caption>Method Summary</caption>
- <thead>
- <tr>
- <th scope="col">Method Attributes</th>
- <th scope="col">Method Name and Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/pv.Flatten.html#array">array</a></b>()
- </div>
- <div class="description">Returns the flattened array.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/pv.Flatten.html#key">key</a></b>(key, f)
- </div>
- <div class="description">Flattens using the specified key function.</div>
- </td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
- <!-- ============================== events summary ======================== -->
-
- <!-- ============================== constructor details ==================== -->
-
- <div class="details"><a name="constructor"> </a>
- <div class="sectionTitle">
- Class Detail
- </div>
-
- <div class="fixedFont">
- <b>pv.Flatten</b>(map)
- </div>
-
- <div class="description">
- Constructs a flatten operator for the specified map. This constructor should
- not be invoked directly; use <a href="../symbols/pv.html#.flatten">pv.flatten</a> instead.
-
- </div>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <b>map</b>
-
- </dt>
- <dd>a map to flatten.</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
-
- <!-- ============================== field details ========================== -->
-
- <!-- ============================== method details ========================= -->
-
- <div class="sectionTitle">
- Method Detail
- </div>
-
- <a name="array"> </a>
- <div class="fixedFont">
-
-
- <b>array</b>()
-
- </div>
- <div class="description">
- Returns the flattened array. Each entry in the array is an object; each
- object has attributes corresponding to this flatten operator's keys.
-
-
- </div>
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd>an array of elements from the flattened map.</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="key"> </a>
- <div class="fixedFont">
-
- <span class="light">{<a href="../symbols/pv.Nest.html">pv.Nest</a>}</span>
- <b>key</b>(key, f)
-
- </div>
- <div class="description">
- Flattens using the specified key function. Multiple keys may be added to the
- flatten; the tiers of the underlying tree must correspond to the specified
- keys, in order. The order of the returned array is undefined; however, you
- can easily sort it.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{string}</span> <b>key</b>
-
- </dt>
- <dd>the key name.</dd>
-
- <dt>
- <span class="light fixedFont">{function}</span> <b>f</b>
- <i>Optional</i>
- </dt>
- <dd>an optional value map function.</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{<a href="../symbols/pv.Nest.html">pv.Nest</a>}</span> this.</dd>
-
- </dl>
-
-
-
-
-
-
-
- <!-- ============================== event details ========================= -->
-
-
- <hr />
- </div>
-
- <!-- ============================== footer ================================= -->
- <div class="fineprint" style="clear:both">
-
- 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)
- </div>
- </body>
- </html>
|