bigraphbase.html

来自「ajax 框价．是个好工具．javascript 矿家．可以用在任何平台．」· HTML 代码 · 共 915 行 · 第 1/2 页

<h3><a name="clearCategories"></a>clearCategories</h3>
<p>Removes all categories from the categories collection</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.clearCategories()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="clearPoints"></a>clearPoints</h3>
<p>Removes all points from the points collection</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.clearPoints()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="clearSeries"></a>clearSeries</h3>
<p>
				Removes all series from the series collection
			</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.clearSeries()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="fromXmlDocument"></a>fromXmlDocument</h3>
<p>This takes an XML document describing the graph data and the graph
				presentation and makes the graph reflect that information.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.fromXmlDocument(<span class="methodArgument">oDocument</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>oDocument</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 describing the graph</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="getCategoryById"></a>getCategoryById</h3>
<p>Returns the category with the given id</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getCategoryById(<span class="methodArgument">sId</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>sId</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The id of the category to retrieve</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type"><code><a href="BiChartCategory.html">BiChartCategory</a></code></code></p>
<h3><a name="getChartForSeries"></a>getChartForSeries</h3>
<p>Returns the chart component used to display the series.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getChartForSeries(<span class="methodArgument">oSeries</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>oSeries</code></td>
<td><code class="type"><code><a href="BiChartSeries.html">BiChartSeries</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The series to get the chart for</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type"><code><a href="BiAbstractChart.html">BiAbstractChart</a></code></code></p>
<h3><a name="getChartPresentationBySeriesId"></a>getChartPresentationBySeriesId</h3>
<p>This returns the chart presentation used to describe how to render chart belonging to a series.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getChartPresentationBySeriesId(<span class="methodArgument">sSeriesId</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>sSeriesId</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The id of the series to get the presentation for</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type"><code><a href="BiChartPresentation.html">BiChartPresentation</a></code></code></p>
<h3><a name="getComponentByIds"></a>getComponentByIds</h3>
<p>This returns the component used to render the section for a certain data point.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getComponentByIds(<span class="methodArgument">sSeriesId</span>, <span class="methodArgument">sCategoryId</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>sSeriesId</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The id of the series to get the component for</td>
</tr>
<tr>
<td><code>sCategoryId</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The id of the category to get the component for</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type"><code><a href="BiAbstractChartSection.html">BiAbstractChartSection</a></code></code></p>
<h3><a name="getContextMenuForPoint"></a>getContextMenuForPoint</h3>
<p>
				This method is used to return the context menu for a certain point.
				Override this method to provide yout own menus.
			</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getContextMenuForPoint(<span class="methodArgument">oSeries</span>, <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>oSeries</code></td>
<td><code class="type"><code><a href="BiChartSeries.html">BiChartSeries</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The series to get the tool tip for</td>
</tr>
<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 tool tip for</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type"><code><a href="BiMenu.html">BiMenu</a></code></code></p>
<h3><a name="getPointByIds"></a>getPointByIds</h3>
<p>Returns the point with the given series id and the given category id</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getPointByIds(<span class="methodArgument">sSeriesId</span>, <span class="methodArgument">sCategoryId</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>sSeriesId</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The series id of the point to retrieve</td>
</tr>
<tr>
<td><code>sCategoryId</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The category id of the point to retrieve</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type"><code><a href="BiChartPoint.html">BiChartPoint</a></code></code></p>
<h3><a name="getSeriesById"></a>getSeriesById</h3>
<p>Returns the series with the given id</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getSeriesById(<span class="methodArgument">sId</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>sId</code></td>
<td><code class="type">String</code></td>
<td class="optional-column"></td>
<td></td>
<td>The id of the series to retrieve</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type"><code><a href="BiChartSeries.html">BiChartSeries</a></code></code></p>
<h3><a name="getToolTipForPoint"></a>getToolTipForPoint</h3>
<p>
				This method is used to return the tool tip to show for a certain point.
				Override this method to provide yout own tool tips.
			</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getToolTipForPoint(<span class="methodArgument">oSeries</span>, <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>oSeries</code></td>
<td><code class="type"><code><a href="BiChartSeries.html">BiChartSeries</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The series to get the tool tip for</td>
</tr>
<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 tool tip for</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type"><code><a href="BiToolTip.html">BiToolTip</a></code></code></p>
<h3><a name="removeCategory"></a>removeCategory</h3>
<p>Removes a category from the categories collection</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.removeCategory(<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 remove</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="removePoint"></a>removePoint</h3>
<p>Removes a point from the points collection</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.removePoint(<span class="methodArgument">oPoint</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>oPoint</code></td>
<td><code class="type"><code><a href="BiChartPoint.html">BiChartPoint</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The point to remove</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="removeSeries"></a>removeSeries</h3>
<p>
				Removes a series from the series collection
			</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.removeSeries(<span class="methodArgument">oSeries</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>oSeries</code></td>
<td><code class="type"><code><a href="BiChartSeries.html">BiChartSeries</a></code></code></td>
<td class="optional-column"></td>
<td></td>
<td>The series to remove</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="toXmlDocument"></a>toXmlDocument</h3>
<p>Serializes the graph to an XML document.</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.toXmlDocument()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type"><code><a href="BiXmlDocument.html">BiXmlDocument</a></code></code></p>
<h3><a name="update"></a>update</h3>
<p>
				Updates the graph and recreates the internal charts. This should
				be called after changes to the graph.
			</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.update()</pre>
<h4>Parameters</h4>
<p>No arguments.</p>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="updatePoint"></a>updatePoint</h3>
<p>
				Updates the graph and recreates the internal representations
				for the given point. This should be called after changes to a point
				or a series. Leaving out the category makes this update all the
				points in the given series.
			</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.updatePoint(<span class="methodArgument">sSeriesId</span> [, <span class="methodArgument">sCategoryId</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>sSeriesId</code></td>
<td><code class="type">string</code></td>
<td class="optional-column"></td>
<td></td>
<td>
						The id of the series that the graph should be update to
						reflect. This usually updates the chart assosciated with
						the series.
					</td>
</tr>
<tr>
<td><code>sCategoryId</code></td>
<td><code class="type">string</code></td>
<td class="optional-column"><img src="check.png" alt="checked"></td>
<td></td>
<td>
						The id of the category that the graph should be update to
						reflect. If provided this means that a point should be udpated.
						This usually updates means that a certain bar or marker is
						updated.
					</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
</body>
</html>