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>SetLegendWorld</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="SetLegendUseShapes.html" title="SetLegendUseShapes" /><link rel="next" href="SetLightGridColor.html" title="SetLightGridColor" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">SetLegendWorld</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="SetLegendUseShapes.html">Prev</a> </td><th width="60%" align="center">PHPlot Function Reference</th><td width="20%" align="right"> <a accesskey="n" href="SetLightGridColor.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="SetLegendWorld"></a><div class="titlepage"></div><div class="refnamediv"><h2><span class="refentrytitle">SetLegendWorld</span></h2><p>SetLegendWorld &#8212; Position the legend on the image (world coordinates)</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">$plot-&gt;SetLegendWorld(<em class="parameter"><code>$x</code></em>, <em class="parameter"><code>$y</code></em>)</pre></div><div class="refsect1"><a id="idp1378339612"></a><h2>Description</h2><p>
<code class="function">SetLegendWorld</code> lets you position the legend on the
image, using world coordinates, rather than letting PHPlot position it for you.
(World coordinates are the coordinate space of your data points.)
    </p></div><div class="refsect1"><a id="idp1378340748"></a><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="replaceable"><code>$x</code></em>, </span><span class="term"><em class="replaceable"><code>$y</code></em></span></dt><dd><p>
World coordinates of the upper left corner of the legend box.
The units and origin are the same as the data you are plotting.
          </p></dd></dl></div></div><div class="refsect1"><a id="idp1378342572"></a><h2>Notes</h2><p>
The default behavior is for PHPlot to position the legend in the
upper right corner of the plot area.
    </p><p>
See <a class="xref" href="SetLegendPosition.html" title="SetLegendPosition"><span class="refentrytitle">SetLegendPosition</span></a> for more flexible legend
positioning options.
<code class="literal">SetLegendWorld($x, $y)</code> is equivalent to
<code class="literal">SetLegendPosition(0, 0, 'world', $x, $y)</code>.
This places the top left corner of the legend at world coordinates $x, $y
with no pixel offset.
    </p><p>
See also <a class="xref" href="SetLegendPixels.html" title="SetLegendPixels"><span class="refentrytitle">SetLegendPixels</span></a>.
    </p><p>
This function will not work with pie charts, because they have no valid
world coordinates.
    </p></div><div class="refsect1"><a id="idp1378345628"></a><h2>History</h2><p>
This function did actually work with pie charts through PHPlot-5.5.0,
although we are not sure what it did, since pie charts do not have valid
world coordinates.
    </p><p>
Through PHPlot-5.0rc3, it was required that the
data array, axis types, and any other setting which affects the scale of
the data be set up before this function is used.
Starting at PHPlot-5.0.4 this is no longer required, as the coordinates
you supply are not scaled until the plot is drawn.
    </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="SetLegendUseShapes.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="SetLightGridColor.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">SetLegendUseShapes </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> SetLightGridColor</td></tr></table></div></body></html>