Subversion Repositories cheapmusic

Rev

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>SetXTitle</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="SetXTimeFormat.html" title="SetXTimeFormat" /><link rel="next" href="SetXTitleColor.html" title="SetXTitleColor" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">SetXTitle</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="SetXTimeFormat.html">Prev</a> </td><th width="60%" align="center">PHPlot Function Reference</th><td width="20%" align="right"> <a accesskey="n" href="SetXTitleColor.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="SetXTitle"></a><div class="titlepage"></div><div class="refnamediv"><h2><span class="refentrytitle">SetXTitle</span></h2><p>SetXTitle &#8212; Sets the X axis title, and optionally its position</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">$plot-&gt;SetXTitle(<em class="parameter"><code>$xtitle</code></em>, [<span class="optional"><em class="parameter"><code>$xpos</code></em></span>])</pre></div><div class="refsect1"><a id="idp1379097356"></a><h2>Description</h2><p>
<code class="function">SetXTitle</code> sets the text to be displayed as the X axis
title. Optionally, it also sets the position of the title and the axis
itself: below the graph (the usual place), above the graph, both, or
neither.
    </p></div><div class="refsect1"><a id="idp1379098500"></a><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="replaceable"><code>$xtitle</code></em></span></dt><dd><p>
The text string to use for the X axis title.
The string can contain multiple lines, separated by newlines (in PHP: "\n").
          </p></dd><dt><span class="term"><em class="replaceable"><code>$xpos</code></em></span></dt><dd><p>
Optional position for the X axis and title. Use one of the following
strings for the position:
            </p><div class="informaltable"><table summary="X axis position choices" border="1"><colgroup><col class="c1" /><col class="c2" /></colgroup><thead><tr><th>Position</th><th>Description</th></tr></thead><tbody><tr><td>plotdown</td><td>X axis below the plot</td></tr><tr><td>plotup</td><td>X axis above the plot</td></tr><tr><td>both</td><td>One X axis above, and one below</td></tr><tr><td>none</td><td>No X axis, no X axis title</td></tr></tbody></table></div><p>
The default is 'plotdown'.
          </p></dd></dl></div></div><div class="refsect1"><a id="idp1379106364"></a><h2>Notes</h2><p>
By default, there is no X axis title.
If <code class="function">SetXTitle</code> is called with an empty string as the title,
the default behavior is restored.
This includes not leaving space on the graph for the title.
    </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="SetXTimeFormat.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="SetXTitleColor.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">SetXTimeFormat </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> SetXTitleColor</td></tr></table></div></body></html>