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>SetErrorBarColors</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="SetDrawYGrid.html" title="SetDrawYGrid" /><link rel="next" href="SetErrorBarLineWidth.html" title="SetErrorBarLineWidth" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">SetErrorBarColors</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="SetDrawYGrid.html">Prev</a> </td><th width="60%" align="center">PHPlot Function Reference</th><td width="20%" align="right"> <a accesskey="n" href="SetErrorBarLineWidth.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="SetErrorBarColors"></a><div class="titlepage"></div><div class="refnamediv"><h2><span class="refentrytitle">SetErrorBarColors</span></h2><p>SetErrorBarColors &#8212; Sets the colors used for data error bars</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">$plot-&gt;SetErrorBarColors(<em class="parameter"><code>$error_bar_colors</code></em>)</pre></div><div class="refsect1"><a id="idp1378049900"></a><h2>Description</h2><p>
<code class="function">SetErrorBarColors</code> sets the colors used for each
data set's error bars, in the same way <a class="xref" href="SetDataColors.html" title="SetDataColors"><span class="refentrytitle">SetDataColors</span></a>
sets the colors used for the data plot itself.
    </p></div><div class="refsect1"><a id="idp1378051348"></a><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="replaceable"><code>$error_bar_colors</code></em></span></dt><dd><p>
An array of color values, one for each data set's error bars.
Or, a single color value (not an array) to use for all data set error bars.
For other possibilities, see Notes.
See <a class="xref" href="conc-colors.html" title="3.5. Colors">Section 3.5, &#8220;Colors&#8221;</a> for more on color values.
          </p></dd></dl></div></div><div class="refsect1"><a id="idp1378053340"></a><h2>Notes</h2><p>
If an array is used for <em class="parameter"><code>$error_bar_colors</code></em>, it
must use zero-based sequential integer indexes.
    </p><p>
If <em class="parameter"><code>$error_bar_colors</code></em> is not an array, but a single color
value, then that color will be used for all data sets' error bars.
However, the array(r,g,b) notation is not allowed in
this case (because it looks like an array of 3 separate color values).
You can get around this restriction if you want to specify a single color 
as an R, G, B array by wrapping the array in another array, for example:
<code class="literal">array(array(102, 0, 192))</code>.
    </p><p>
Two special uses of the <em class="parameter"><code>$error_bar_colors</code></em> argument
are available.
If the argument is an empty string, or boolean False, the color map is reset
to the defaults. This can be used to restore the default color map.
If the argument is NULL or missing from the function call, the color map is
reset to the defaults, but only if it has not already been set.
This is used internal to PHPlot for one-time initialization.
    </p><p>
If SetErrorBarColors is never called, the default color map is the same as
for <a class="xref" href="SetDataColors.html" title="SetDataColors"><span class="refentrytitle">SetDataColors</span></a>. It contains 16 colors, starting with
SkyBlue, green, orange, and blue.
For the full list, see <a class="xref" href="conc-colors.html#conc-colors-datacolors" title="3.5.3. Plotting Colors">Section 3.5.3, &#8220;Plotting Colors&#8221;</a>.
    </p><p>
If you change the data colors with <a class="xref" href="SetDataColors.html" title="SetDataColors"><span class="refentrytitle">SetDataColors</span></a>,
you probably want to change the error bar colors to the same array.
    </p><p>
A data colors callback, as described in
<a class="xref" href="adv-datacolor-callback.html" title="4.5. Custom Data Color Selection">Section 4.5, &#8220;Custom Data Color Selection&#8221;</a>,
also controls selection of the color for error bars.
    </p></div><div class="refsect1"><a id="idp1378059076"></a><h2>History</h2><p>
Through PHPlot-5.0.7, the default color map contained these 8 colors:
SkyBlue, green, orange, blue, orange, red, violet, and azure1.
These were used if SetErrorBarColors was never called.
Also, through PHPlot-5.0.7, if SetErrorBarColors was called with an empty
string argument, the color map was set to just contain 'black'.
Starting with PHPlot-5.1.0, a new default color map with 16 colors was
defined. Given an empty string (or False), SetErrorBarColors now restores the
default color map.
    </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="SetDrawYGrid.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="SetErrorBarLineWidth.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">SetDrawYGrid </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> SetErrorBarLineWidth</td></tr></table></div></body></html>