<!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/xhtml;charset=UTF-8"/>
<title>Wt: Wt::Chart::SeriesIterator Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Wt
 <span id="projectnumber">3.2.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li>
<li class="navelem"><a class="el" href="namespaceWt_1_1Chart.html">Chart</a> </li>
<li class="navelem"><a class="el" href="classWt_1_1Chart_1_1SeriesIterator.html">SeriesIterator</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::Chart::SeriesIterator Class Reference<div class="ingroups"><a class="el" href="group__charts.html">Charts (Wt::Chart)</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::Chart::SeriesIterator" -->
<p>Abstract base class for iterating over series data in <a class="el" href="classWt_1_1Chart_1_1WChart2DRenderer.html" title="Helper class for rendering a cartesian chart.">WChart2DRenderer</a>.
<a href="classWt_1_1Chart_1_1SeriesIterator.html#details">More...</a></p>
<p><code>#include <Wt/Chart/WChart2DRenderer></code></p>
<p>Inherited by Wt::Chart::ExtremesIterator, Wt::Chart::LabelRenderIterator, Wt::Chart::MarkerRenderIterator, and Wt::Chart::SeriesRenderIterator.</p>
<p><a href="classWt_1_1Chart_1_1SeriesIterator-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac4ad700f8ef3b9b7423cd51aa4e753e5"></a><!-- doxytag: member="Wt::Chart::SeriesIterator::~SeriesIterator" ref="ac4ad700f8ef3b9b7423cd51aa4e753e5" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Chart_1_1SeriesIterator.html#ac4ad700f8ef3b9b7423cd51aa4e753e5">~SeriesIterator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Chart_1_1SeriesIterator.html#a3770ca1184657ea89fe0ef8d3e5a63e2">startSegment</a> (int currentXSegment, int currentYSegment, const <a class="el" href="classWt_1_1WRectF.html">WRectF</a> &currentSegmentArea)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start handling a new segment. <a href="#a3770ca1184657ea89fe0ef8d3e5a63e2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Chart_1_1SeriesIterator.html#a5846a9aba05403f3d699f983be268ef4">endSegment</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">End handling a particular segment. <a href="#a5846a9aba05403f3d699f983be268ef4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Chart_1_1SeriesIterator.html#a3d5181f724905decd4055001968c73bd">startSeries</a> (const <a class="el" href="classWt_1_1Chart_1_1WDataSeries.html">WDataSeries</a> &series, double groupWidth, int numBarGroups, int currentBarGroup)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start iterating a particular series. <a href="#a3d5181f724905decd4055001968c73bd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0f753351dbcde0fb4ad88f34efc5a5f"></a><!-- doxytag: member="Wt::Chart::SeriesIterator::endSeries" ref="ab0f753351dbcde0fb4ad88f34efc5a5f" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Chart_1_1SeriesIterator.html#ab0f753351dbcde0fb4ad88f34efc5a5f">endSeries</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">End iterating a particular series. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Chart_1_1SeriesIterator.html#a72bbbcfd1bac947d79d1ae8eb0bd3f5d">newValue</a> (const <a class="el" href="classWt_1_1Chart_1_1WDataSeries.html">WDataSeries</a> &series, double x, double y, double stackY, const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> &xIndex, const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> &yIndex)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Process a value. <a href="#a72bbbcfd1bac947d79d1ae8eb0bd3f5d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd909a460bfb6a381034d70965f7cf91"></a><!-- doxytag: member="Wt::Chart::SeriesIterator::currentXSegment" ref="abd909a460bfb6a381034d70965f7cf91" args="() const " -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Chart_1_1SeriesIterator.html#abd909a460bfb6a381034d70965f7cf91">currentXSegment</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current X segment. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0c9b0c88e92e6431b471f014c8dec2ab"></a><!-- doxytag: member="Wt::Chart::SeriesIterator::currentYSegment" ref="a0c9b0c88e92e6431b471f014c8dec2ab" args="() const " -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Chart_1_1SeriesIterator.html#a0c9b0c88e92e6431b471f014c8dec2ab">currentYSegment</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current Y segment. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract base class for iterating over series data in <a class="el" href="classWt_1_1Chart_1_1WChart2DRenderer.html" title="Helper class for rendering a cartesian chart.">WChart2DRenderer</a>. </p>
<p>This class is specialized for rendering series data.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Chart_1_1WChart2DRenderer.html#a4a2c1a148f5eb2533beb3372b08b0efe" title="Iterates over the series using an iterator.">WChart2DRenderer::iterateSeries()</a> </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5846a9aba05403f3d699f983be268ef4"></a><!-- doxytag: member="Wt::Chart::SeriesIterator::endSegment" ref="a5846a9aba05403f3d699f983be268ef4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Chart::SeriesIterator::endSegment </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>End handling a particular segment. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Chart_1_1SeriesIterator.html#a3770ca1184657ea89fe0ef8d3e5a63e2" title="Start handling a new segment.">startSegment()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a72bbbcfd1bac947d79d1ae8eb0bd3f5d"></a><!-- doxytag: member="Wt::Chart::SeriesIterator::newValue" ref="a72bbbcfd1bac947d79d1ae8eb0bd3f5d" args="(const WDataSeries &series, double x, double y, double stackY, const WModelIndex &xIndex, const WModelIndex &yIndex)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Chart::SeriesIterator::newValue </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Chart_1_1WDataSeries.html">WDataSeries</a> & </td>
<td class="paramname"><em>series</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>stackY</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> & </td>
<td class="paramname"><em>xIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WModelIndex.html">WModelIndex</a> & </td>
<td class="paramname"><em>yIndex</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Process a value. </p>
<p>Processes a value with model coordinates (<em>x</em>, <em>y</em>). The y value may differ from the model's y value, because of stacked series. The y value here corresponds to the location on the chart, after stacking.</p>
<p>The <em>stackY</em> argument is the y value from the previous series (also after stacking). It will be 0, unless this series is stacked. </p>
</div>
</div>
<a class="anchor" id="a3770ca1184657ea89fe0ef8d3e5a63e2"></a><!-- doxytag: member="Wt::Chart::SeriesIterator::startSegment" ref="a3770ca1184657ea89fe0ef8d3e5a63e2" args="(int currentXSegment, int currentYSegment, const WRectF &currentSegmentArea)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Chart::SeriesIterator::startSegment </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>currentXSegment</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>currentYSegment</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WRectF.html">WRectF</a> & </td>
<td class="paramname"><em>currentSegmentArea</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Start handling a new segment. </p>
<p>Because of a 'break' specified in an axis, axes may be divided in one or two segments (in fact only the API limits this now to two). The iterator will iterate all segments seperately, but each time with a different clipping region specified in the painter, corresponding to that segment.</p>
<p>The <em>currentSegmentArea</em> specifies the clipping area. </p>
</div>
</div>
<a class="anchor" id="a3d5181f724905decd4055001968c73bd"></a><!-- doxytag: member="Wt::Chart::SeriesIterator::startSeries" ref="a3d5181f724905decd4055001968c73bd" args="(const WDataSeries &series, double groupWidth, int numBarGroups, int currentBarGroup)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::Chart::SeriesIterator::startSeries </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Chart_1_1WDataSeries.html">WDataSeries</a> & </td>
<td class="paramname"><em>series</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>groupWidth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>numBarGroups</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>currentBarGroup</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Start iterating a particular series. </p>
<p>Returns whether the series values should be iterated. The <em>groupWidth</em> is the width (in pixels) of a single bar group. The chart contains <em>numBarGroups</em>, and the current series is in the <em>currentBarGroup</em>'th group. </p>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"><address style="text-align: right; margin: 3px"><small>
Generated on Thu Nov 1 2012 for <a href="http://www.webtoolkit.eu/wt">the
C++ Web Toolkit (Wt)</a> by <a
href="http://www.doxygen.org/index.html"><img src="doxygen.png"
alt="doxygen" border="0" style="vertical-align: middle; display:
inline-block; height: 2em"></a> 1.7.5.1</small></address>
</body>
</html>
