| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957 |
- <!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.Scale.log</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.Scale.log
- </h1>
- <!-- ============================== class summary ========================== -->
- <p class="description">
-
-
- Represents a log scale. <style
- type="text/css">sub{line-height:0}</style> <img src="../log.png"
- width="190" height="175" align="right"> Most commonly, a log scale represents
- a 1-dimensional log transformation from a numeric domain of input data
- [<i>d<sub>0</sub></i>, <i>d<sub>1</sub></i>] to a numeric range of pixels
- [<i>r<sub>0</sub></i>, <i>r<sub>1</sub></i>]. The equation for such a scale
- is:
- <blockquote><i>f(x) = (log(x) - log(d<sub>0</sub>)) / (log(d<sub>1</sub>) -
- log(d<sub>0</sub>)) * (r<sub>1</sub> - r<sub>0</sub>) +
- r<sub>0</sub></i></blockquote>
- where <i>log(x)</i> represents the zero-symmetric logarthim of <i>x</i> using
- the scale's associated base (default: 10, see <a href="../symbols/pv.html#.logSymmetric">pv.logSymmetric</a>). For
- example, a log scale from the domain [1, 100] to range [0, 640]:
- <blockquote><i>f(x) = (log(x) - log(1)) / (log(100) - log(1)) * (640 - 0) + 0</i><br>
- <i>f(x) = log(x) / 2 * 640</i><br>
- <i>f(x) = log(x) * 320</i><br>
- </blockquote>
- Thus, saying
- <pre>.height(function(d) Math.log(d) * 138.974)</pre>
- is equivalent to
- <pre>.height(pv.Scale.log(1, 100).range(0, 640))</pre>
- As you can see, scales do not always make code smaller, but they should make
- code more explicit and easier to maintain. In addition to readability, scales
- offer several useful features:
- <p>1. The range can be expressed in colors, rather than pixels. Changing the
- example above to
- <pre>.fillStyle(pv.Scale.log(1, 100).range("red", "green"))</pre>
- will cause it to fill the marks "red" on an input value of 1, "green" on an
- input value of 100, and some color in-between for intermediate values.
- <p>2. The domain and range can be subdivided for a "poly-log"
- transformation. For example, you may want a diverging color scale that is
- increasingly red for small values, and increasingly green for large values:
- <pre>.fillStyle(pv.Scale.log(1, 10, 100).range("red", "white", "green"))</pre>
- The domain can be specified as a series of <i>n</i> monotonically-increasing
- values; the range must also be specified as <i>n</i> values, resulting in
- <i>n - 1</i> contiguous log scales.
- <p>3. Log scales can be inverted for interaction. The <a href="#invert">#invert</a> method
- takes a value in the output range, and returns the corresponding value in the
- input domain. This is frequently used to convert the mouse location (see
- <a href="../symbols/pv.Mark.html#mouse">pv.Mark#mouse</a>) to a value in the input domain. Note that inversion is
- only supported for numeric ranges, and not colors.
- <p>4. A scale can be queried for reasonable "tick" values. The <a href="#ticks">#ticks</a>
- method provides a convenient way to get a series of evenly-spaced rounded
- values in the input domain. Frequently these are used in conjunction with
- <a href="../symbols/pv.Rule.html">pv.Rule</a> to display tick marks or grid lines.
- <p>5. A scale can be "niced" to extend the domain to suitable rounded
- numbers. If the minimum and maximum of the domain are messy because they are
- derived from data, you can use <a href="#nice">#nice</a> to round these values down and
- up to even numbers.
-
-
- <br /><i>Defined in: </i> <a href="../symbols/src/data_LogScale.js.html">LogScale.js</a>.
-
- </p>
- <!-- ============================== constructor summary ==================== -->
-
- <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class pv.Scale.log.">
- <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.Scale.log.html#constructor">pv.Scale.log</a></b>()
- </div>
- <div class="description">Returns a log scale for the specified domain.</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.Scale.log.">
- <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.Scale.log.html#base">base</a></b>(v)
- </div>
- <div class="description">Sets or gets the logarithm base.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/pv.Scale.log.html#by">by</a></b>(f)
- </div>
- <div class="description">Returns a view of this scale by the specified accessor function <tt>f</tt>.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/pv.Scale.log.html#domain">domain</a></b>()
- </div>
- <div class="description">Sets or gets the input domain.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/pv.Scale.log.html#invert">invert</a></b>()
- </div>
- <div class="description">Sets or gets the output range.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/pv.Scale.log.html#nice">nice</a></b>()
- </div>
- <div class="description">"Nices" this scale, extending the bounds of the input domain to
- evenly-rounded values.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/pv.Scale.log.html#range">range</a></b>()
- </div>
- <div class="description"></div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/pv.Scale.log.html#tickFormat">tickFormat</a></b>(t)
- </div>
- <div class="description">Formats the specified tick value using the appropriate precision, assuming
- base 10.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/pv.Scale.log.html#ticks">ticks</a></b>()
- </div>
- <div class="description">Returns an array of evenly-spaced, suitably-rounded values in the input
- domain.</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.Scale.log</b>()
- </div>
-
- <div class="description">
- Returns a log scale for the specified domain. The arguments to this
- constructor are optional, and equivalent to calling <a href="#domain">#domain</a>.
-
- </div>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{number...}</span> <b>domain...</b>
-
- </dt>
- <dd>domain values.</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{<a href="../symbols/pv.Scale.log.html">pv.Scale.log</a>}</span> a log scale.</dd>
-
- </dl>
-
-
-
- </div>
-
- <!-- ============================== field details ========================== -->
-
- <!-- ============================== method details ========================= -->
-
- <div class="sectionTitle">
- Method Detail
- </div>
-
- <a name="base"> </a>
- <div class="fixedFont">
-
- <span class="light">{<a href="../symbols/pv.Scale.log.html">pv.Scale.log</a>}</span>
- <b>base</b>(v)
-
- </div>
- <div class="description">
- Sets or gets the logarithm base. Defaults to 10.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{number}</span> <b>v</b>
- <i>Optional</i>
- </dt>
- <dd>the new base.</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{<a href="../symbols/pv.Scale.log.html">pv.Scale.log</a>}</span> <tt>this</tt>, or the current base.</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="by"> </a>
- <div class="fixedFont">
-
- <span class="light">{<a href="../symbols/pv.Scale.log.html">pv.Scale.log</a>}</span>
- <b>by</b>(f)
-
- </div>
- <div class="description">
- Returns a view of this scale by the specified accessor function <tt>f</tt>.
- Given a scale <tt>y</tt>, <tt>y.by(function(d) d.foo)</tt> is equivalent to
- <tt>function(d) y(d.foo)</tt>.
- <p>This method is provided for convenience, such that scales can be
- succinctly defined inline. For example, given an array of data elements
- that have a <tt>score</tt> attribute with the domain [0, 1], the height
- property could be specified as:
- <pre>.height(pv.Scale.log().range(0, 480).by(function(d) d.score))</pre>
- This is equivalent to:
- <pre>.height(function(d) d.score * 480)</pre>
- This method should be used judiciously; it is typically more clear to
- invoke the scale directly, passing in the value to be scaled.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{function}</span> <b>f</b>
-
- </dt>
- <dd>an accessor function.</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{<a href="../symbols/pv.Scale.log.html">pv.Scale.log</a>}</span> a view of this scale by the specified accessor
- function.</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="domain"> </a>
- <div class="fixedFont">
-
- <span class="light">{<a href="../symbols/pv.Scale.log.html">pv.Scale.log</a>}</span>
- <b>domain</b>()
-
- </div>
- <div class="description">
- Sets or gets the input domain. This method can be invoked several ways:
- <p>1. <tt>domain(min, ..., max)</tt>
- <p>Specifying the domain as a series of numbers is the most explicit and
- recommended approach. Most commonly, two numbers are specified: the minimum
- and maximum value. However, for a diverging scale, or other subdivided
- poly-log scales, multiple values can be specified. Values can be derived
- from data using <a href="../symbols/pv.html#.min">pv.min</a> and <a href="../symbols/pv.html#.max">pv.max</a>. For example:
- <pre>.domain(1, pv.max(array))</pre>
- An alternative method for deriving minimum and maximum values from data
- follows.
- <p>2. <tt>domain(array, minf, maxf)</tt>
- <p>When both the minimum and maximum value are derived from data, the
- arguments to the <tt>domain</tt> method can be specified as the array of
- data, followed by zero, one or two accessor functions. For example, if the
- array of data is just an array of numbers:
- <pre>.domain(array)</pre>
- On the other hand, if the array elements are objects representing stock
- values per day, and the domain should consider the stock's daily low and
- daily high:
- <pre>.domain(array, function(d) d.low, function(d) d.high)</pre>
- The first method of setting the domain is preferred because it is more
- explicit; setting the domain using this second method should be used only
- if brevity is required.
- <p>3. <tt>domain()</tt>
- <p>Invoking the <tt>domain</tt> method with no arguments returns the
- current domain as an array of numbers.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{number...}</span> <b>domain...</b>
-
- </dt>
- <dd>domain values.</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{<a href="../symbols/pv.Scale.log.html">pv.Scale.log</a>}</span> <tt>this</tt>, or the current domain.</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="invert"> </a>
- <div class="fixedFont">
-
- <span class="light">{<a href="../symbols/pv.Scale.log.html">pv.Scale.log</a>}</span>
- <b>invert</b>()
-
- </div>
- <div class="description">
- Sets or gets the output range. This method can be invoked several ways:
- <p>1. <tt>range(min, ..., max)</tt>
- <p>The range may be specified as a series of numbers or colors. Most
- commonly, two numbers are specified: the minimum and maximum pixel values.
- For a color scale, values may be specified as <a href="../symbols/pv.Color.html">pv.Color</a>s or
- equivalent strings. For a diverging scale, or other subdivided poly-log
- scales, multiple values can be specified. For example:
- <pre>.range("red", "white", "green")</pre>
- <p>Currently, only numbers and colors are supported as range values. The
- number of range values must exactly match the number of domain values, or
- the behavior of the scale is undefined.
- <p>2. <tt>range()</tt>
- <p>Invoking the <tt>range</tt> method with no arguments returns the current
- range as an array of numbers or colors.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{...}</span> <b>range...</b>
-
- </dt>
- <dd>range values.</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{<a href="../symbols/pv.Scale.log.html">pv.Scale.log</a>}</span> <tt>this</tt>, or the current range.</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="nice"> </a>
- <div class="fixedFont">
-
- <span class="light">{<a href="../symbols/pv.Scale.log.html">pv.Scale.log</a>}</span>
- <b>nice</b>()
-
- </div>
- <div class="description">
- "Nices" this scale, extending the bounds of the input domain to
- evenly-rounded values. This method uses <a href="../symbols/pv.html#.logFloor">pv.logFloor</a> and {@link
- pv.logCeil}. Nicing is useful if the domain is computed dynamically from
- data, and may be irregular. For example, given a domain of
- [0.20147987687960267, 0.996679553296417], a call to <tt>nice()</tt> might
- extend the domain to [0.1, 1].
- <p>This method must be invoked each time after setting the domain (and
- base).
-
-
- </div>
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{<a href="../symbols/pv.Scale.log.html">pv.Scale.log</a>}</span> <tt>this</tt>.</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="range"> </a>
- <div class="fixedFont">
-
- <span class="light">{<a href="../symbols/pv.Scale.log.html">pv.Scale.log</a>}</span>
- <b>range</b>()
-
- </div>
- <div class="description">
-
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{...}</span> <b>range...</b>
-
- </dt>
- <dd>range values.</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{<a href="../symbols/pv.Scale.log.html">pv.Scale.log</a>}</span> <tt>this</tt>.</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="tickFormat"> </a>
- <div class="fixedFont">
-
- <span class="light">{string}</span>
- <b>tickFormat</b>(t)
-
- </div>
- <div class="description">
- Formats the specified tick value using the appropriate precision, assuming
- base 10.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{number}</span> <b>t</b>
-
- </dt>
- <dd>a tick value.</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{string}</span> a formatted tick value.</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="ticks"> </a>
- <div class="fixedFont">
-
- <span class="light">{number[]}</span>
- <b>ticks</b>()
-
- </div>
- <div class="description">
- Returns an array of evenly-spaced, suitably-rounded values in the input
- domain. These values are frequently used in conjunction with {@link
- pv.Rule} to display tick marks or grid lines.
-
-
- </div>
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{number[]}</span> an array input domain values to use as ticks.</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>
|