📄 bichartpoint.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>BiChartPoint</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="BiChartPoint">BiChartPoint</h1>
<p>
This class is used to describe how to display a data point in the graph.
Each point is bound to a series and a category.
</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>BiChartPoint</code>.</p>
<ul class="partial-class-tree">
<li><code><a href="BiObject.html">BiObject</a></code><ul>
<li><code>BiChartPoint</code><ul id="api-derived-classes"></ul></li></ul>
</li>
</ul>
<h2>Constructor</h2>
<p><code>
new BiChartPoint(<span class="methodArgument">oGraph</span>, <span class="methodArgument">sSeriesId</span>, <span class="methodArgument">sCategoryId</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 this point is a part of</td>
</tr>
<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 this point describes</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 this point describes</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="categoryId"></a><code>categoryId</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 category this point descibes</td>
</tr>
<tr>
<td><a name="explode"></a><code>explode</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 amount to move the pie chart section from the middle</td>
</tr>
<tr>
<td><a name="fillAngle"></a><code>fillAngle</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 fill angle used when painting the section of the chart this point descibes.</td>
</tr>
<tr>
<td><a name="fillColor"></a><code>fillColor</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 fill color for the section of the chart this point descibes</td>
</tr>
<tr>
<td><a name="fillColor2"></a><code>fillColor2</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 alternate fill color used when fill type is gradient</td>
</tr>
<tr>
<td><a name="fillOpacity"></a><code>fillOpacity</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 fill opacity for the section of the chart this point descibes</td>
</tr>
<tr>
<td><a name="fillType"></a><code>fillType</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 fill type used when painting the section of the chart this point descibes</td>
</tr>
<tr>
<td><a name="markerType"></a><code>markerType</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 marker type for the section of the chart this point descibes</td>
</tr>
<tr>
<td><a name="markerVisible"></a><code>markerVisible</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>Whether markers are visible for the section of the chart this point descibes</td>
</tr>
<tr>
<td><a name="seriesId"></a><code>seriesId</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 this point descibes</td>
</tr>
<tr>
<td><a name="strokeColor"></a><code>strokeColor</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 stroke color for the section of the chart this point descibes</td>
</tr>
<tr>
<td><a name="strokeOpacity"></a><code>strokeOpacity</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 stroke opacity for the section of the chart this point descibes</td>
</tr>
</tbody>
</table>
<h2>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>
Gets the properties for the point from an XML Element.
</td>
</tr>
<tr>
<td><code><a href="#getComponent">getComponent</a></code></td>
<td>Returns the component (if any) that is used to display the point in the chart</td>
</tr>
<tr>
<td><code><a href="#hasExplode">hasExplode</a></code></td>
<td>Returns true if the <code><a href="#explode">explode</a></code> property has been set on the point</td>
</tr>
<tr>
<td><code><a href="#hasFillAngle">hasFillAngle</a></code></td>
<td>Returns true if the <code><a href="#fillAngle">fillAngle</a></code> property has been set on the point</td>
</tr>
<tr>
<td><code><a href="#hasFillColor">hasFillColor</a></code></td>
<td>Returns true if the <code><a href="#fillColor">fillColor</a></code> property has been set on the point</td>
</tr>
<tr>
<td><code><a href="#hasFillColor2">hasFillColor2</a></code></td>
<td>Returns true if the <code><a href="#fillColor2">fillColor2</a></code> property has been set on the point</td>
</tr>
<tr>
<td><code><a href="#hasFillOpacity">hasFillOpacity</a></code></td>
<td>Returns true if the <code><a href="#fillOpacity">fillOpacity</a></code> property has been set on the point</td>
</tr>
<tr>
<td><code><a href="#hasFillType">hasFillType</a></code></td>
<td>Returns true if the <code><a href="#fillType">fillType</a></code> property has been set on the point</td>
</tr>
<tr>
<td><code><a href="#hasMarkerType">hasMarkerType</a></code></td>
<td>Returns true if the <code><a href="#markerType">markerType</a></code> property has been set on the point</td>
</tr>
<tr>
<td><code><a href="#hasMarkerVisible">hasMarkerVisible</a></code></td>
<td>Returns true if the <code><a href="#markerVisible">markerVisible</a></code> property has been set on the point</td>
</tr>
<tr>
<td><code><a href="#hasStrokeColor">hasStrokeColor</a></code></td>
<td>Returns true if the <code><a href="#strokeColor">strokeColor</a></code> property has been set on the point</td>
</tr>
<tr>
<td><code><a href="#hasStrokeOpacity">hasStrokeOpacity</a></code></td>
<td>Returns true if the <code><a href="#strokeOpacity">strokeOpacity</a></code> property has been set on the point</td>
</tr>
<tr>
<td><code><a href="#toXmlElement">toXmlElement</a></code></td>
<td>Serializes the point to an XML element</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 point object from an XML element describing that point.
</td>
</tr>
</tbody>
</table>
<h2>Static Fields</h2>
<p>None.</p>
<h2>Remarks</h2>
<p>None.</p>
<h2>Method Details</h2>
<h3><a name="fromXmlElement"></a>fromXmlElement</h3>
<p>
Gets the properties for the point from an XML Element.
</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.fromXmlElement(<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>oNode</code></td>
<td><code class="type">XmlElement</code></td>
<td class="optional-column"></td>
<td></td>
<td>The element describing the point</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type">void</code></p>
<h3><a name="getComponent"></a>getComponent</h3>
<p>Returns the component (if any) that is used to display the point in the chart</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.getComponent()</pre>
<h4>Parameters</h4>
<h4>Return Type</h4>
<p></p>
<h3><a name="hasExplode"></a>hasExplode</h3>
<p>Returns true if the <code><a href="#explode">explode</a></code> property has been set on the point</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.hasExplode()</pre>
<h4>Parameters</h4>
<h4>Return Type</h4>
<p><code class="type">Boolean</code></p>
<h3><a name="hasFillAngle"></a>hasFillAngle</h3>
<p>Returns true if the <code><a href="#fillAngle">fillAngle</a></code> property has been set on the point</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.hasFillAngle()</pre>
<h4>Parameters</h4>
<h4>Return Type</h4>
<p><code class="type">Boolean</code></p>
<h3><a name="hasFillColor"></a>hasFillColor</h3>
<p>Returns true if the <code><a href="#fillColor">fillColor</a></code> property has been set on the point</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.hasFillColor()</pre>
<h4>Parameters</h4>
<h4>Return Type</h4>
<p><code class="type">Boolean</code></p>
<h3><a name="hasFillColor2"></a>hasFillColor2</h3>
<p>Returns true if the <code><a href="#fillColor2">fillColor2</a></code> property has been set on the point</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.hasFillColor2()</pre>
<h4>Parameters</h4>
<h4>Return Type</h4>
<p><code class="type">Boolean</code></p>
<h3><a name="hasFillOpacity"></a>hasFillOpacity</h3>
<p>Returns true if the <code><a href="#fillOpacity">fillOpacity</a></code> property has been set on the point</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.hasFillOpacity()</pre>
<h4>Parameters</h4>
<h4>Return Type</h4>
<p><code class="type">Boolean</code></p>
<h3><a name="hasFillType"></a>hasFillType</h3>
<p>Returns true if the <code><a href="#fillType">fillType</a></code> property has been set on the point</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.hasFillType()</pre>
<h4>Parameters</h4>
<h4>Return Type</h4>
<p><code class="type">Boolean</code></p>
<h3><a name="hasMarkerType"></a>hasMarkerType</h3>
<p>Returns true if the <code><a href="#markerType">markerType</a></code> property has been set on the point</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.hasMarkerType()</pre>
<h4>Parameters</h4>
<h4>Return Type</h4>
<p><code class="type">Boolean</code></p>
<h3><a name="hasMarkerVisible"></a>hasMarkerVisible</h3>
<p>Returns true if the <code><a href="#markerVisible">markerVisible</a></code> property has been set on the point</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.hasMarkerVisible()</pre>
<h4>Parameters</h4>
<h4>Return Type</h4>
<p><code class="type">Boolean</code></p>
<h3><a name="hasStrokeColor"></a>hasStrokeColor</h3>
<p>Returns true if the <code><a href="#strokeColor">strokeColor</a></code> property has been set on the point</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.hasStrokeColor()</pre>
<h4>Parameters</h4>
<h4>Return Type</h4>
<p><code class="type">Boolean</code></p>
<h3><a name="hasStrokeOpacity"></a>hasStrokeOpacity</h3>
<p>Returns true if the <code><a href="#strokeOpacity">strokeOpacity</a></code> property has been set on the point</p>
<h4>Syntax</h4>
<pre class="method-syntax">object.hasStrokeOpacity()</pre>
<h4>Parameters</h4>
<h4>Return Type</h4>
<p><code class="type">Boolean</code></p>
<h3><a name="toXmlElement"></a>toXmlElement</h3>
<p>Serializes the point to an XML element</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 point object from an XML element describing that point.
</p>
<h4>Syntax</h4>
<pre class="method-syntax">BiChartPoint.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 point 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 point</td>
</tr>
</tbody>
</table>
<h4>Return Type</h4>
<p><code class="type"><code><a href="BiChartPoint.html">BiChartPoint</a></code></code></p>
</body>
</html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -