Subversion Repositories cheapmusic

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
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>SetDrawYDataLabelLines</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="SetDrawYAxis.html" title="SetDrawYAxis" /><link rel="next" href="SetDrawYGrid.html" title="SetDrawYGrid" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">SetDrawYDataLabelLines</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="SetDrawYAxis.html">Prev</a> </td><th width="60%" align="center">PHPlot Function Reference</th><td width="20%" align="right"> <a accesskey="n" href="SetDrawYGrid.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="SetDrawYDataLabelLines"></a><div class="titlepage"></div><div class="refnamediv"><h2><span class="refentrytitle">SetDrawYDataLabelLines</span></h2><p>SetDrawYDataLabelLines &#8212; Draw data label lines for horizontal plots</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">$plot-&gt;SetDrawYDataLabelLines(<em class="parameter"><code>$dydl</code></em>)</pre></div><div class="refsect1"><a id="idp1378032852"></a><h2>Description</h2><p>
3
<code class="function">SetDrawYDataLabelLines</code> enables drawing of data label lines
4
for horizontal plot types that support them.
5
Data label lines are horizontal lines drawn from the data points to the
6
edge or edges of the plot with the axis data labels.  In the usual case,
7
with the Y axis data labels on the left side of the plot, the data label
8
lines would be drawn from the data points to the left side of the plot area.
9
Depending on the data label locations set with
10
<a class="xref" href="SetYDataLabelPos.html" title="SetYDataLabelPos"><span class="refentrytitle">SetYDataLabelPos</span></a>, the lines would be drawn left, right, or in
11
both directions from the data points to the sides of the plot area.
12
    </p><p>
13
To use data label lines, you generally want to turn off Y ticks, Y tick labels,
14
and the Y grid lines.
15
Your data array needs to provide data labels, which will be drawn by
16
default on the left side of the plot area.
17
    </p></div><div class="refsect1"><a id="idp1378035140"></a><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="replaceable"><code>$dydl</code></em></span></dt><dd><p>
18
True to draw the data label lines, False to not draw the lines.
19
          </p></dd></dl></div></div><div class="refsect1"><a id="idp1378036660"></a><h2>Notes</h2><p>
20
Y data label lines only work with these plot types: lines, points, and
21
linepoints, and only when using a data type that indicates a horizontal plot.
22
Data label lines can only be drawn if Y axis data labels are on.
23
    </p><p>
24
If a graph contains multiple data sets, data label lines drawn from the left
25
edge will end at the maximum X value for each Y value.  Data label lines drawn
26
from the right edge will end at the minimum Y value for each X value.
27
(Remember that the X and Y axes are in the same position for vertical and
28
horizontal plots, but the roles of X and Y are reversed for horizontal plots.)
29
    </p><p>
30
By default, data label lines are not drawn.
31
    </p><p>
32
For an example of Y data label lines, see <a class="xref" href="ex-horizlinepts.html" title="5.48. Example - Horizontal Linepoints Plot with Data Value Labels and Lines">Section 5.48, &#8220;Example - Horizontal Linepoints Plot with Data Value Labels and Lines&#8221;</a>.
33
    </p><p>
34
This function is for horizontal plot types. For the usual vertical plot
35
types, see <a class="xref" href="SetDrawXDataLabelLines.html" title="SetDrawXDataLabelLines"><span class="refentrytitle">SetDrawXDataLabelLines</span></a>.
36
    </p></div><div class="refsect1"><a id="idp1378039564"></a><h2>History</h2><p>
37
This function was added in PHPlot-6.0.0. In earlier releases, there was no
38
support for data label lines in any horizontal plot type.
39
    </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="SetDrawYAxis.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="SetDrawYGrid.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">SetDrawYAxis </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> SetDrawYGrid</td></tr></table></div></body></html>