?? bichartseries.html
字號:
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"><html><!--
Generated using api.website.xsl version 2003-07-17
-->
<head>
<META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>BiChartSeries</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link type="text/css" rel="stylesheet" href="api.css"><script type="text/javascript">
function showDerivedClasses() {
var ul = document.getElementById("api-derived-classes");
var lis = ul.childNodes;
var l = lis.length;
for (var i = 1; i < l; i++)
lis[i].style.display = "";
lis[0].style.display = "none";
}
</script></head>
<body>
<h1 id="BiChartSeries">BiChartSeries</h1>
<p>
This describes a series of values that is used with the <code><a href="BiGraph.html">graph</a></code>
control. Each series has a unique <code><a href="#id">id</a></code> and every value of the series
belongs to a certain <code><a href="BiChartCategory.html">category</a></code>.
</p>
<p>This class extends
<code><a href="BiObject.html">BiObject</a></code>
and therefore all methods and fields available for
<code><a href="BiObject.html">BiObject</a></code>
are also available for <code>BiChartSeries</code>.</p>
<ul class="partial-class-tree">
<li><code><a href="BiObject.html">BiObject</a></code><ul>
<li><code>BiChartSeries</code><ul id="api-derived-classes"></ul></li></ul>
</li>
</ul>
<h2>Constructor</h2>
<p><code>
new BiChartSeries(<span class="methodArgument">oGraph</span>, <span class="methodArgument">sId</span> [, <span class="methodArgument">sTitle</span> [, <span class="methodArgument">oValues</span>]])</code></p>
<h3>Parameters</h3>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>oGraph</code></td>
<td><code class="type"><code><a href="BiGraph.html">BiGraph</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The graph that the series belongs to</td>
</tr>
<tr>
<td><code>sId</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The id of the series</td>
</tr>
<tr>
<td><code>sTitle</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"><img src="check.png" alt="checked"></td>
<td></td>
<td>The title of the series</td>
</tr>
<tr>
<td><code>oValues</code></td>
<td><code class="type">Number[]</code></td>
<td class="optional-column"><img src="check.png" alt="checked"></td>
<td><code>[]</code></td>
<td>The values in the series given in the same order as the categories</td>
</tr>
</tbody>
</table>
<h2>Properties</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="get-header">get</td>
<td class="set-header">set</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><a name="absSum"></a><code>absSum</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The sum of the absolute values in the series</td>
</tr>
<tr>
<td><a name="id"></a><code>id</code></td>
<td><code class="type">String</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The id of the series</td>
</tr>
<tr>
<td><a name="index"></a><code>index</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The index of the series</td>
</tr>
<tr>
<td><a name="maximumValue"></a><code>maximumValue</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The maximum of the values in the series</td>
</tr>
<tr>
<td><a name="minimumValue"></a><code>minimumValue</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The maximum of the values in the series</td>
</tr>
<tr>
<td><a name="sum"></a><code>sum</code></td>
<td><code class="type">Number</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"></td>
<td>The sum of the values in the series</td>
</tr>
<tr>
<td><a name="title"></a><code>title</code></td>
<td><code class="type">String</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"><img src="check.png" alt="checked"></td>
<td>The title of the series</td>
</tr>
<tr>
<td><a name="values"></a><code>values</code></td>
<td><code class="type">Number[]</code></td>
<td class="get-column"><img src="check.png" alt="checked"></td>
<td class="set-column"><img src="check.png" alt="checked"></td>
<td>
The values in the series. This is the same order as the order of
the categories. If a value for a certain category is missing the
value for that is <code>null</code> in the array.
</td>
</tr>
</tbody>
</table>
<h2>Methods</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="#getValueByCategory">getValueByCategory</a></code></td>
<td>Returns the value for the given category</td>
</tr>
<tr>
<td><code><a href="#getValueByCategoryId">getValueByCategoryId</a></code></td>
<td>Returns the value for the given category id</td>
</tr>
<tr>
<td><code><a href="#getValueByIndex">getValueByIndex</a></code></td>
<td>Returns the value for the given index</td>
</tr>
<tr>
<td><code><a href="#setValueByCategory">setValueByCategory</a></code></td>
<td>Sets the value for the given category</td>
</tr>
<tr>
<td><code><a href="#setValueByCategoryId">setValueByCategoryId</a></code></td>
<td>Sets the value for the given category id</td>
</tr>
<tr>
<td><code><a href="#setValueByIndex">setValueByIndex</a></code></td>
<td>Sets the value for the given index</td>
</tr>
<tr>
<td><code><a href="#toXmlElement">toXmlElement</a></code></td>
<td>Serializes the series to an XML element (sub tree)</td>
</tr>
</tbody>
</table>
<h2>Events</h2>
<p>None.</p>
<h2>Static Methods</h2>
<table>
<thead>
<tr>
<td>Name</td>
<td>Description</td>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="#fromXmlElement">fromXmlElement</a></code></td>
<td>Creates a new series object from an XML element</td>
</tr>
</tbody>
</table>
<h2>Static Fields</h2>
<p>None.</p>
<h2>Remarks</h2>
<p>
Changing the series does not update the chart. The graph components needs
to be updated manually.
</p>
<h2>Method Details</h2>
<h3><a name="getValueByCategory"></a>getValueByCategory</h3>
<p>Returns the value for the given category</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getValueByCategory(<span class="methodArgument">oCategory</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>oCategory</code></td>
<td><code class="type"><code><a href="BiChartCategory.html">BiChartCategory</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The category to get the value for</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Number</code></p>
<h3><a name="getValueByCategoryId"></a>getValueByCategoryId</h3>
<p>Returns the value for the given category id</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getValueByCategoryId(<span class="methodArgument">sCatId</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>sCatId</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The category id to get the value for</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Number</code></p>
<h3><a name="getValueByIndex"></a>getValueByIndex</h3>
<p>Returns the value for the given index</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getValueByIndex(<span class="methodArgument">i</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>i</code></td>
<td><code class="type">Number</code></td>
<td class="optional-column"></td>
<td></td>
<td>The index to get the value for</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">Number</code></p>
<h3><a name="setValueByCategory"></a>setValueByCategory</h3>
<p>Sets the value for the given category</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.setValueByCategory(<span class="methodArgument">oCategory</span>, <span class="methodArgument">nValue</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>oCategory</code></td>
<td><code class="type"><code><a href="BiChartCategory.html">BiChartCategory</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The category to set the value for</td>
</tr>
<tr>
<td><code>nValue</code></td>
<td><code class="type">Number</code></td>
<td class="optional-column"></td>
<td></td>
<td>The value to set</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="setValueByCategoryId"></a>setValueByCategoryId</h3>
<p>Sets the value for the given category id</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.setValueByCategoryId(<span class="methodArgument">sCatId</span>, <span class="methodArgument">nValue</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>sCatId</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The category id to set the value for</td>
</tr>
<tr>
<td><code>nValue</code></td>
<td><code class="type">Number</code></td>
<td class="optional-column"></td>
<td></td>
<td>The value to set</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="setValueByIndex"></a>setValueByIndex</h3>
<p>Sets the value for the given index</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.setValueByIndex(<span class="methodArgument">i</span>, <span class="methodArgument">nValue</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>i</code></td>
<td><code class="type">Number</code></td>
<td class="optional-column"></td>
<td></td>
<td>The category id to set the value for</td>
</tr>
<tr>
<td><code>nValue</code></td>
<td><code class="type">Number</code></td>
<td class="optional-column"></td>
<td></td>
<td>The value to set</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="toXmlElement"></a>toXmlElement</h3>
<p>Serializes the series to an XML element (sub tree)</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.toXmlElement(<span class="methodArgument">oDoc</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>oDoc</code></td>
<td><code class="type"><code><a href="BiXmlDocument.html">BiXmlDocument</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The XML document to create the element in</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">XmlElement</code></p>
<h2>Static Method Details</h2>
<h3><a name="fromXmlElement"></a>fromXmlElement</h3>
<p>Creates a new series object from an XML element</p>
<h4>Syntax</h4>
<pre class="method-syntax">BiChartSeries.fromXmlElement(<span class="methodArgument">oGraph</span>, <span class="methodArgument">oNode</span>)</pre>
<h4>Parameters</h4>
<table>
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td class="optional-header">Optional</td>
<td>Default</td>
<td>Descripton</td>
</tr>
</thead>
<tbody>
<tr>
<td><code>oGraph</code></td>
<td><code class="type"><code><a href="BiGraph.html">BiGraph</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The graph that the series belongs to</td>
</tr>
<tr>
<td><code>oNode</code></td>
<td><code class="type">XmlElement</code></td>
<td class="optional-column"></td>
<td></td>
<td>The element describing the series</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type"><code><a href="BiChartSeries.html">BiChartSeries</a></code></code></p>
</body>
</html>
?? 快捷鍵說明
復制代碼
Ctrl + C
搜索代碼
Ctrl + F
全屏模式
F11
切換主題
Ctrl + Shift + D
顯示快捷鍵
?
增大字號
Ctrl + =
減小字號
Ctrl + -