Blame | Last modification | View Log | RSS feed
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?><!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"><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /><title>TuneYAutoTicks</title><link rel="stylesheet" type="text/css" href="phplotdoc.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /><link rel="home" href="index.html" title="PHPlot Reference Manual" /><link rel="up" href="reference.html" title="PHPlot Function Reference" /><link rel="prev" href="TuneXAutoTicks.html" title="TuneXAutoTicks" /><link rel="next" href="part3.html" title="Part III. Developer's Guide to PHPlot" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">TuneYAutoTicks</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="TuneXAutoTicks.html">Prev</a> </td><th width="60%" align="center">PHPlot Function Reference</th><td width="20%" align="right"> <a accesskey="n" href="part3.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="TuneYAutoTicks"></a><div class="titlepage"></div><div class="refnamediv"><h2><span class="refentrytitle">TuneYAutoTicks</span></h2><p>TuneYAutoTicks — Adjust tuning parameters for Y axis tick increment calculation</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">$plot->TuneYAutoTicks([<span class="optional"><em class="parameter"><code>$min_ticks</code></em></span>], [<span class="optional"><em class="parameter"><code>$tick_mode</code></em></span>], [<span class="optional"><em class="parameter"><code>$tick_inc_integer</code></em></span>])</pre></div><div class="refsect1"><a id="idp1379406788"></a><h2>Description</h2><p><code class="function">TuneYAutoTicks</code> is used to adjust the parameters used byPHPlot when automatically calculating the tick increment along the Y axis.</p></div><div class="refsect1"><a id="idp1379407860"></a><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="replaceable"><code>$min_ticks</code></em></span></dt><dd><p>Sets the minimum number of tick intervals along the Y axis.This is an integer greater than zero.See <a class="xref" href="adv-autorange.html#autotick-min-ticks" title="4.6.8.1. Tick Increment parameter: min_ticks">Section 4.6.8.1, “Tick Increment parameter: min_ticks”</a> for more information.</p></dd><dt><span class="term"><em class="replaceable"><code>$tick_mode</code></em></span></dt><dd><p>Selects from one of three available modes for calculating the tick incrementalong the Y axis:</p><div class="informaltable"><table summary="Y axis tick modes" border="1"><colgroup><col class="c1" /><col class="c2" /></colgroup><thead><tr><th>Mode</th><th>Description</th></tr></thead><tbody><tr><td>decimal</td><td>Use a power of 10 times 1, 2, or 5</td></tr><tr><td>binary</td><td>Use a power of 2</td></tr><tr><td>date</td><td>Use a date/time value</td></tr></tbody></table></div><p>See <a class="xref" href="adv-autorange.html#autotick-mode" title="4.6.8.2. Tick Increment parameter: tick_mode">Section 4.6.8.2, “Tick Increment parameter: tick_mode”</a> for more information.</p></dd><dt><span class="term"><em class="replaceable"><code>$tick_inc_integer</code></em></span></dt><dd><p>If TRUE, forces PHPlot to pick a whole number (integer) tick increment.If FALSE, allows fractional tick increments.See the <a class="xref" href="adv-autorange.html#autotick-tick-inc-integer" title="4.6.8.3. Tick Increment parameter: tick_inc_integer">Section 4.6.8.3, “Tick Increment parameter: tick_inc_integer”</a> for more information.</p></dd></dl></div></div><div class="refsect1"><a id="idp1379417188"></a><h2>Notes</h2><p>Specifying <code class="literal">NULL</code>, or omitting trailing unused parameters,results in no change to that parameter.</p><p>If the tick increment is set with <a class="xref" href="SetYTickIncrement.html" title="SetYTickIncrement"><span class="refentrytitle">SetYTickIncrement</span></a> orindirectly with <a class="xref" href="SetNumYTicks.html" title="SetNumYTicks"><span class="refentrytitle">SetNumYTicks</span></a>, then PHPlot does not needto calculate the tick increment, and the parameters set with<code class="function">TuneYAutoTicks</code> are not used.</p><p>This applies to the Y axis only, where Y is the dependent variable forvertical plots, and the independent variable for horizontal plots.See also <a class="xref" href="TuneXAutoTicks.html" title="TuneXAutoTicks"><span class="refentrytitle">TuneXAutoTicks</span></a>.</p><p>See <a class="xref" href="adv-autorange.html#adv-autorange-tick" title="4.6.7. Automatic Tick Increment Calculation">Section 4.6.7, “Automatic Tick Increment Calculation”</a> for more information on thetick increment calculations and parameters.</p><p>The default for <code class="literal">min_ticks</code> is 8.The maximum number of tick intervals is about 2.5 times the minimum number.</p><p>The default for <code class="literal">tick_mode</code> depends on the label formattingtype along the Y axis. If <a class="xref" href="SetYLabelType.html" title="SetYLabelType"><span class="refentrytitle">SetYLabelType</span></a>('time') is used toselect date/time formatting of labels, then the default for tick_mode is<code class="literal">'date'</code>, otherwise it is <code class="literal">'decimal'</code>.</p><p>The default for <code class="literal">tick_inc_integer</code> is FALSE, meaning PHPlotmay use fractional tick increments. (Note this does not mean a tickincrement such as 2.5 would ever be selected. PHPlot uses whole numbersabove 1 and fractional increments between 0 and 1.)</p></div><div class="refsect1"><a id="idp1379424212"></a><h2>Example</h2><p>Use a minimum of 9 tick intervals along the Y axis, and pick a power of2 as a tick increment:</p><pre class="programlisting">$plot->TuneYAutoRange(9, 'binary');</pre><p></p></div><div class="refsect1"><a id="idp1379425332"></a><h2>History</h2><p>This function was added in PHPlot-6.0.0.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="TuneXAutoTicks.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="part3.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">TuneXAutoTicks </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Part III. Developer's Guide to PHPlot</td></tr></table></div></body></html>