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>SetLegendColorboxBorders</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="SetLegendBgColor.html" title="SetLegendBgColor" /><link rel="next" href="SetLegendPixels.html" title="SetLegendPixels" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">SetLegendColorboxBorders</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="SetLegendBgColor.html">Prev</a> </td><th width="60%" align="center">PHPlot Function Reference</th><td width="20%" align="right"> <a accesskey="n" href="SetLegendPixels.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="SetLegendColorboxBorders"></a><div class="titlepage"></div><div class="refnamediv"><h2><span class="refentrytitle">SetLegendColorboxBorders</span></h2><p>SetLegendColorboxBorders &#8212; Control the borders around color boxes in the legend</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">$plot-&gt;SetLegendColorboxBorders([<span class="optional"><em class="parameter"><code>$cbbmode</code></em></span>])</pre></div><div class="refsect1"><a id="idp1378237860"></a><h2>Description</h2><p>
<code class="function">SetLegendColorboxBorders</code> controls the appearance of the
borders around the color boxes in the legend. The borders can be off, on
using the Text color, or on using the set of Data Border colors.
    </p></div><div class="refsect1"><a id="idp1378238996"></a><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="replaceable"><code>$cbbmode</code></em></span></dt><dd><p>
Optional string indicating the color mode for the legend color boxes.
If supplied, it must be one of the following values:
            </p><div class="informaltable"><table summary="SetLegendColorboxBorders parameter values" border="1"><colgroup><col class="c1" /><col class="c2" /></colgroup><thead><tr><th>Mode</th><th>Description</th></tr></thead><tbody><tr><td>none</td><td>No color box borders are drawn</td></tr><tr><td>textcolor</td><td>Use the Textcolor for all legend color boxes</td></tr><tr><td>databordercolor</td><td>Use successive entries from the Data Border
                        Colors array for each legend color box</td></tr></tbody></table></div><p>
If omitted, <code class="literal">textcolor</code> is used.
          </p></dd></dl></div></div><div class="refsect1"><a id="idp1378245772"></a><h2>Notes</h2><p>
By default, the color boxes are drawn using the text color set with
<a class="xref" href="SetTextColor.html" title="SetTextColor"><span class="refentrytitle">SetTextColor</span></a>, which defaults to black.
    </p><p>
If the color box border mode is <code class="literal">databordercolor</code>,
then the colors set with <a class="xref" href="SetDataBorderColors.html" title="SetDataBorderColors"><span class="refentrytitle">SetDataBorderColors</span></a> are used.
(These are the same colors used as borders for the bars in a bar chart.)
The top line (or bottom line, if <a class="xref" href="SetLegendReverse.html" title="SetLegendReverse"><span class="refentrytitle">SetLegendReverse</span></a>(True) is
used) in the legend will have a color box using the first data color
(see <a class="xref" href="SetDataColors.html" title="SetDataColors"><span class="refentrytitle">SetDataColors</span></a>) and a border using the first data border
color, etc.
    </p></div><div class="refsect1"><a id="idp1378248756"></a><h2>History</h2><p>
This function was added in PHPlot-6.0.0. In earlier releases, the legend
color boxes always had a border using the text color.
    </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="SetLegendBgColor.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="SetLegendPixels.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">SetLegendBgColor </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> SetLegendPixels</td></tr></table></div></body></html>