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>SetDataType</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="SetDataLabelColor.html" title="SetDataLabelColor" /><link rel="next" href="SetDataValueLabelColor.html" title="SetDataValueLabelColor" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">SetDataType</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="SetDataLabelColor.html">Prev</a> </td><th width="60%" align="center">PHPlot Function Reference</th><td width="20%" align="right"> <a accesskey="n" href="SetDataValueLabelColor.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="SetDataType"></a><div class="titlepage"></div><div class="refnamediv"><h2><span class="refentrytitle">SetDataType</span></h2><p>SetDataType — Indicate the format of the data array</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">$plot->SetDataType(<em class="parameter"><code>$dt</code></em>)</pre></div><div class="refsect1"><a id="idp1377882596"></a><h2>Description</h2><p><code class="function">SetDataType</code> tells PHPlot how to interpret the dataarray set with <a class="xref" href="SetDataValues.html" title="SetDataValues"><span class="refentrytitle">SetDataValues</span></a>.More information on data types can be found in <a class="xref" href="conc-datatypes.html" title="3.3. PHPlot Data Types">Section 3.3, “PHPlot Data Types”</a>.</p></div><div class="refsect1"><a id="idp1377884364"></a><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="replaceable"><code>$dt</code></em></span></dt><dd><p>The data array format type, which must be one of the following values:</p><div class="informaltable"><table summary="Available data types" border="1"><colgroup><col class="c1" /><col class="c2" /></colgroup><thead><tr><th>Data Type</th><th>Description</th></tr></thead><tbody><tr><td>text-data</td><td>Plot with implied X: <code class="literal">(Label, Y1, [Y2, ...])</code></td></tr><tr><td>data-data</td><td>Plot with explicit X: <code class="literal">(Label, X, Y1, [Y2, ...])</code></td></tr><tr><td>data-data-error</td><td>Error plot: <code class="literal">(Label, X, Y1, Y1err+, Y1err-, [Y2, ...])</code></td></tr><tr><td>text-data-single</td><td>Simple pie chart data: <code class="literal">(Label, Value)</code></td></tr><tr><td>text-data-yx</td><td>Horizontal plot with implied Y: <code class="literal">(Label, X1, [X2, ...])</code></td></tr><tr><td>data-data-yx</td><td>Horizontal plot with explicit Y: <code class="literal">(Label, Y, X1, [X2, ...])</code></td></tr><tr><td>data-data-yx-error</td><td>Horizontal error plot: <code class="literal">(Label, Y, X1, X1err+, X1err-, [X2, ...])</code></td></tr><tr><td>data-data-xyz</td><td>Plot with X, Y, Z data: <code class="literal">(Label, X, Y1, Z1, [Y2, Z2, ...])</code></td></tr></tbody></table></div><p>Note: The descriptions above show one row of the data array.</p></dd></dl></div></div><div class="refsect1"><a id="idp1377896316"></a><h2>Notes</h2><p>The default data type is <code class="literal">text-data</code>.</p><p>An example of a <code class="literal">text-data</code> data array is:</p><pre class="programlisting">$data = array( array('Jan', 100, 150, 200),array('Feb', 110, 140, 210),array('Mar', 120, 145, 200),array('Apr', 110, 160, 220) );</pre><p>This defines the data for 3 data sets with 4 points on each, and a month nameas label for each point.This is also a valid data array for data type <code class="literal">text-data-yx</code>.</p><p>An example of a <code class="literal">data-data</code> data array is:</p><pre class="programlisting">$data = array( array('', 2, 15),array('', 4, 14),array('', 6, 10),array('', 8, 20) );</pre><p>Here the labels are empty strings, next are the X values, then a singleset of Y values (1 data set, 1 plot line).This is also a valid data array for data type <code class="literal">data-data-yx</code>,with each row containing a Y value, followed by a single X value.</p><p>An example of a <code class="literal">data-data-error</code> data array is:</p><pre class="programlisting">$data = array( array('1999', 1, 23.5, 5, 3),array('2000', 2, 20.1, 4, 4),array('2001', 3, 19.1, 3, 4),array('2002', 4, 16.8, 4, 3) );</pre><p>Here the labels are years, next are the X values 1-4, then a singleset of Y values with error ranges between 3 and 5 for each point.</p><p>An example of a <code class="literal">text-data-single</code> data array,used only for pie charts, is:</p><pre class="programlisting">$data = array( array('', 10),array('', 40),array('', 50) );</pre><p>Here the labels are empty,and 3 segments with relative weights of 10, 40, and 50 are defined.</p><p>Data type alias <code class="literal">data-data-error-yx</code> can be used in placeof <code class="literal">data-data-yx-error</code>. There are other data type aliases,such as <code class="literal">text-linear</code>, which exist for compatibility with veryold versions of PHPlot, but they are not documented.</p></div><div class="refsect1"><a id="idp1377904924"></a><h2>History</h2><p>Data type <code class="literal">data-data-yx-error</code> was added in PHPlot-6.1.0for horizontal error plots.Data type <code class="literal">data-data-xyz</code> was added in PHPlot-5.5.0 forthe <a class="link" href="conc-plottypes.html#plottype-bubbles" title="3.4.4. Plot Type: bubbles (Bubble Plot)">bubbles</a> plot type.Data type <code class="literal">data-data-yx</code> for horizontal plots was addedin PHPlot-5.1.3.Data type <code class="literal">text-data-yx</code> for horizontal bar charts was addedin PHPlot-5.1.2.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="SetDataLabelColor.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="SetDataValueLabelColor.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">SetDataLabelColor </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> SetDataValueLabelColor</td></tr></table></div></body></html>