| 98 |
- |
1 |
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
|
|
|
2 |
<!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 — Control the borders around color boxes in the legend</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">$plot->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>
|
|
|
3 |
<code class="function">SetLegendColorboxBorders</code> controls the appearance of the
|
|
|
4 |
borders around the color boxes in the legend. The borders can be off, on
|
|
|
5 |
using the Text color, or on using the set of Data Border colors.
|
|
|
6 |
</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>
|
|
|
7 |
Optional string indicating the color mode for the legend color boxes.
|
|
|
8 |
If supplied, it must be one of the following values:
|
|
|
9 |
</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
|
|
|
10 |
Colors array for each legend color box</td></tr></tbody></table></div><p>
|
|
|
11 |
If omitted, <code class="literal">textcolor</code> is used.
|
|
|
12 |
</p></dd></dl></div></div><div class="refsect1"><a id="idp1378245772"></a><h2>Notes</h2><p>
|
|
|
13 |
By default, the color boxes are drawn using the text color set with
|
|
|
14 |
<a class="xref" href="SetTextColor.html" title="SetTextColor"><span class="refentrytitle">SetTextColor</span></a>, which defaults to black.
|
|
|
15 |
</p><p>
|
|
|
16 |
If the color box border mode is <code class="literal">databordercolor</code>,
|
|
|
17 |
then the colors set with <a class="xref" href="SetDataBorderColors.html" title="SetDataBorderColors"><span class="refentrytitle">SetDataBorderColors</span></a> are used.
|
|
|
18 |
(These are the same colors used as borders for the bars in a bar chart.)
|
|
|
19 |
The top line (or bottom line, if <a class="xref" href="SetLegendReverse.html" title="SetLegendReverse"><span class="refentrytitle">SetLegendReverse</span></a>(True) is
|
|
|
20 |
used) in the legend will have a color box using the first data color
|
|
|
21 |
(see <a class="xref" href="SetDataColors.html" title="SetDataColors"><span class="refentrytitle">SetDataColors</span></a>) and a border using the first data border
|
|
|
22 |
color, etc.
|
|
|
23 |
</p></div><div class="refsect1"><a id="idp1378248756"></a><h2>History</h2><p>
|
|
|
24 |
This function was added in PHPlot-6.0.0. In earlier releases, the legend
|
|
|
25 |
color boxes always had a border using the text color.
|
|
|
26 |
</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>
|