📄 bigraphbase.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>BiGraphBase</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="BiGraphBase">BiGraphBase</h1><p> This is the abstract base class for <code><a href="BiGraph.html">BiGraph</a></code> and <code><a href="BiGraph2.html">BiGraph2</a></code>. If Mozilla support is needed use <code><a href="BiGraph2.html">BiGraph2</a></code>. If line chart and/or pie chart is needed then use <code><a href="BiGraph.html">BiGraph</a></code>. </p><p>This class extends <code><a href="BiComponent.html">BiComponent</a></code> and therefore all methods and fields available for <code><a href="BiComponent.html">BiComponent</a></code> are also available for <code>BiGraphBase</code>.</p><ul class="partial-class-tree"><li><code><a href="BiObject.html">BiObject</a></code><ul><li><code><a href="BiEventTarget.html">BiEventTarget</a></code><ul><li><code><a href="BiComponent.html">BiComponent</a></code><ul><li><code>BiGraphBase</code><ul id="api-derived-classes"><li><code><a href="BiGraph.html">BiGraph</a></code></li><li><code><a href="BiGraph2.html">BiGraph2</a></code></li></ul></li></ul></li></ul></li></ul></li></ul><h2>Constructor</h2><p><code> new BiGraphBase()</code></p><h3>Parameters</h3><p>No parameters.</p><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="autoScale"></a><code>autoScale</code></td><td><code class="type">Boolean</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> Allows you turn off the automatic scaling of the graph </td></tr><tr><td><a name="categories"></a><code>categories</code></td><td><code class="type"><code><a href="BiChartCategory.html">BiChartCategory[]</a></code></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>This is an array containing the categories used for the data of the graph. After this property is changed the graph component needs to be updated.</td></tr><tr><td><a name="categoryAxis"></a><code>categoryAxis</code></td><td><code class="type"><code><a href="BiChartCategoryAxis.html">BiChartCategoryAxis</a></code></code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>This property points to the category axis component</td></tr><tr><td><a name="chartArea"></a><code>chartArea</code></td><td><code class="type"><code><a href="BiChartArea.html">BiChartArea</a></code></code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>This property points to the chart area component</td></tr><tr><td><a name="charts"></a><code>charts</code></td><td><code class="type"><code><a href="BiAbstractChart.html">BiAbstractChart[]</a></code></code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>This is an array containing the chart components used to display the charts.</td></tr><tr><td><a name="chartType"></a><code>chartType</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 type of the chart. Available types are:<br> <br> bar<br> column<br> grid<br> line<br> pie<br> percentagestackedbar<br> percentagestackedcolum<br> stackedbar<br> stackedcolumn<br> grid </td></tr><tr><td><a name="fontSize"></a><code>fontSize</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> Sets the font size for the legend and axes. If <code><a href="#autoScale">autoScale</a></code> is true then this does not apply. </td></tr><tr><td><a name="grid"></a><code>grid</code></td><td><code class="type"><code><a href="BiGridChart.html">BiGridChart</a></code></code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td> This property returns the <code><a href="BiGrid.html">grid</a></code> used as the <code><a href="BiGridChart.html">grid chart</a></code> if the <code><a href="#chartType">chart type</a></code> is set to <code>grid</code>. Otherwise this is <code>null</code>. </td></tr><tr><td><a name="gridLines"></a><code>gridLines</code></td><td><code class="type"><code><a href="BiChartGridLines.html">BiChartGridLines</a></code></code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>This property points to the grid lines component</td></tr><tr><td><a name="legend"></a><code>legend</code></td><td><code class="type"><code><a href="BiChartLegend.html">BiChartLegend</a></code></code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>This property points to the legend component</td></tr><tr><td><a name="points"></a><code>points</code></td><td><code class="type"><code><a href="BiChartPoint.html">BiChartPoint[]</a></code></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>This is an array containing the points used for the data of the graph.</td></tr><tr><td><a name="presentationManager"></a><code>presentationManager</code></td><td><code class="type"><code><a href="BiChartPresentationManager.html">BiChartPresentationManager</a></code></code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>This returns the presentation manager for the graph</td></tr><tr><td><a name="series"></a><code>series</code></td><td><code class="type"><code><a href="BiChartSeries.html">BiChartSeries[]</a></code></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>This is an array containing the series used for the data of the graph. After this property is changed the graph component needs to be updated.</td></tr><tr><td><a name="valueAxis"></a><code>valueAxis</code></td><td><code class="type"><code><a href="BiChartValueAxis.html">BiChartValueAxis</a></code></code></td><td class="get-column"><img src="check.png" alt="checked"></td><td class="set-column"></td><td>This property points to the value axis component</td></tr></tbody></table><h2>Methods</h2><table><thead><tr><td>Name</td><td>Description</td></tr></thead><tbody><tr><td><code><a href="#addCategory">addCategory</a></code></td><td>Adds a category to the categories collection</td></tr><tr><td><code><a href="#addPoint">addPoint</a></code></td><td>Adds a point to the points collection</td></tr><tr><td><code><a href="#addSeries">addSeries</a></code></td><td> Adds a series to the series collection </td></tr><tr><td><code><a href="#clearCategories">clearCategories</a></code></td><td>Removes all categories from the categories collection</td></tr><tr><td><code><a href="#clearPoints">clearPoints</a></code></td><td>Removes all points from the points collection</td></tr><tr><td><code><a href="#clearSeries">clearSeries</a></code></td><td> Removes all series from the series collection </td></tr><tr><td><code><a href="#fromXmlDocument">fromXmlDocument</a></code></td><td>This takes an XML document describing the graph data and the graph presentation and makes the graph reflect that information.</td></tr><tr><td><code><a href="#getCategoryById">getCategoryById</a></code></td><td>Returns the category with the given id</td></tr><tr><td><code><a href="#getChartForSeries">getChartForSeries</a></code></td><td>Returns the chart component used to display the series.</td></tr><tr><td><code><a href="#getChartPresentationBySeriesId">getChartPresentationBySeriesId</a></code></td><td>This returns the chart presentation used to describe how to render chart belonging to a series.</td></tr><tr><td><code><a href="#getComponentByIds">getComponentByIds</a></code></td><td>This returns the component used to render the section for a certain data point.</td></tr><tr><td><code><a href="#getContextMenuForPoint">getContextMenuForPoint</a></code></td><td> This method is used to return the context menu for a certain point. Override this method to provide yout own menus. </td></tr><tr><td><code><a href="#getPointByIds">getPointByIds</a></code></td><td>Returns the point with the given series id and the given category id</td></tr><tr><td><code><a href="#getSeriesById">getSeriesById</a></code></td><td>Returns the series with the given id</td></tr><tr><td><code><a href="#getToolTipForPoint">getToolTipForPoint</a></code></td><td> This method is used to return the tool tip to show for a certain point. Override this method to provide yout own tool tips. </td></tr><tr><td><code><a href="#removeCategory">removeCategory</a></code></td><td>Removes a category from the categories collection</td></tr><tr><td><code><a href="#removePoint">removePoint</a></code></td><td>Removes a point from the points collection</td></tr><tr><td><code><a href="#removeSeries">removeSeries</a></code></td><td> Removes a series from the series collection </td></tr><tr><td><code><a href="#toXmlDocument">toXmlDocument</a></code></td><td>Serializes the graph to an XML document.</td></tr><tr><td><code><a href="#update">update</a></code></td><td> Updates the graph and recreates the internal charts. This should be called after changes to the graph. </td></tr><tr><td><code><a href="#updatePoint">updatePoint</a></code></td><td> 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. </td></tr></tbody></table><h2>Events</h2><table><thead><tr><td>Name</td><td>Type</td><td class="bubbles-header">Bubbles</td><td>Descripton</td></tr></thead><tbody><tr><td><a name="pointclick"></a><code>pointclick</code></td><td><code class="type"><code><a href="BiChartMouseEvent.html">BiChartMouseEvent</a></code></code></td><td class="bubbles-column"></td><td>Fires when the user clicks on a point in the graph</td></tr><tr><td><a name="pointcontextmenu"></a><code>pointcontextmenu</code></td><td><code class="type"><code><a href="BiChartMouseEvent.html">BiChartMouseEvent</a></code></code></td><td class="bubbles-column"></td><td>Fires when the user right clicks on a point</td></tr><tr><td><a name="pointdblclick"></a><code>pointdblclick</code></td><td><code class="type"><code><a href="BiChartMouseEvent.html">BiChartMouseEvent</a></code></code></td><td class="bubbles-column"></td><td>Fires when the user double clicks on a point</td></tr><tr><td><a name="pointmousedown"></a><code>pointmousedown</code></td><td><code class="type"><code><a href="BiChartMouseEvent.html">BiChartMouseEvent</a></code></code></td><td class="bubbles-column"></td><td>Fires when the user presses down the mouse button on a point</td></tr><tr><td><a name="pointmousemove"></a><code>pointmousemove</code></td><td><code class="type"><code><a href="BiChartMouseEvent.html">BiChartMouseEvent</a></code></code></td><td class="bubbles-column"></td><td>Fires when the user moves the mouse over a point</td></tr><tr><td><a name="pointmouseout"></a><code>pointmouseout</code></td><td><code class="type"><code><a href="BiChartMouseEvent.html">BiChartMouseEvent</a></code></code></td><td class="bubbles-column"></td><td> Fires when the mouse pointer leaves a point </td></tr><tr><td><a name="pointmouseover"></a><code>pointmouseover</code></td><td><code class="type"><code><a href="BiChartMouseEvent.html">BiChartMouseEvent</a></code></code></td><td class="bubbles-column"></td><td> Fires when the mouse pointer enters a point </td></tr><tr><td><a name="pointmouseup"></a><code>pointmouseup</code></td><td><code class="type"><code><a href="BiChartMouseEvent.html">BiChartMouseEvent</a></code></code></td><td class="bubbles-column"></td><td>Fires when the releases the mouse button on a point</td></tr><tr><td><a name="pointmousewheel"></a><code>pointmousewheel</code></td><td><code class="type"><code><a href="BiChartMouseEvent.html">BiChartMouseEvent</a></code></code></td><td class="bubbles-column"></td><td>This event is fired when the user scrolls the mouse wheel over a point</td></tr></tbody></table><h2>Static Methods</h2><p>None.</p><h2>Static Fields</h2><p>None.</p><h2>Remarks</h2><p>None.</p><h2>Method Details</h2><h3><a name="addCategory"></a>addCategory</h3><p>Adds a category to the categories collection</p><h4>Syntax</h4><pre class="method-syntax">object.addCategory(<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 add</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">void</code></p><h3><a name="addPoint"></a>addPoint</h3><p>Adds a point to the points collection</p><h4>Syntax</h4><pre class="method-syntax">object.addPoint(<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 add</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">void</code></p><h3><a name="addSeries"></a>addSeries</h3><p> Adds a series to the series collection </p><h4>Syntax</h4><pre class="method-syntax">object.addSeries(<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 add</td></tr></tbody></table><h4>Return Type</h4><p><code class="type">void</code></p>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -