1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
4
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<link rel="stylesheet" href="../../../../../style.css" type="text/css" media="screen">
6
<link rel="stylesheet" href="../../../../../print.css" type="text/css" media="print">
7
<meta content="IChart,com.yahoo.astra.fl.charts.IChart,dataProvider,itemToAxisValue,itemToPosition" name="keywords">
8
<title>com.yahoo.astra.fl.charts.IChart</title>
11
<script type="text/javascript" language="javascript" src="../../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../../cookies.js"></script><script type="text/javascript" language="javascript">
13
asdocTitle = 'IChart - YUI Flash Component Documentation';
14
var baseRef = '../../../../../';
15
window.onload = configPage;
17
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
19
<td align="left" class="titleTableTitle">YUI Flash Component Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../../all-classes.html')" href="../../../../../package-summary.html">All Packages</a> | <a onclick="loadClassListFrame('../../../../../all-classes.html')" href="../../../../../class-summary.html">All Classes</a> | <a onclick="loadClassListFrame('../../../../../index-list.html')" href="../../../../../all-index-A.html">Index</a> | <a href="../../../../../index.html?com/yahoo/astra/fl/charts/IChart.html&com/yahoo/astra/fl/charts/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../../images/logo.jpg"></td>
21
<tr class="titleTableRow2">
22
<td align="left" id="subTitle" class="titleTableSubTitle">Interface IChart</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a></td>
24
<tr class="titleTableRow3">
25
<td colspan="2"> </td>
28
<script type="text/javascript" language="javascript">
30
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Interface IChart"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
32
<div class="MainContent">
33
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
35
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.yahoo.astra.fl.charts</a></td>
38
<td class="classHeaderTableLabel">Interface</td><td class="classSignature">public interface IChart extends <a href="none">flash.events.IEventDispatcher</a></td>
41
<td class="classHeaderTableLabel">Implementors</td><td><a href="../charts/CartesianChart.html">CartesianChart</a></td>
45
Methods and properties expected to be defined by all charts.
51
<a name="propertySummary"></a>
52
<div class="summarySection">
53
<div class="summaryTableTitle">Public Properties</div>
54
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
56
<th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined by</th>
59
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#dataProvider">dataProvider</a> : Object<div class="summaryTableDescription">
60
The data to be displayed by the chart.</div>
61
</td><td class="summaryTableOwnerCol">IChart</td>
65
<a name="methodSummary"></a>
66
<div class="summarySection">
67
<div class="summaryTableTitle">Public Methods</div>
68
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
70
<th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined by</th>
73
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
74
<div class="summarySignature">
75
<a class="signatureLink" href="#itemToAxisValue()">itemToAxisValue</a>(series:<a href="series/ISeries.html">ISeries</a>, itemIndex:int, axis:<a href="axes/IAxis.html">IAxis</a>, stack:Boolean = true):Object</div>
76
<div class="summaryTableDescription">
77
Retreives the value of an item on one of the chart's axes.</div>
78
</td><td class="summaryTableOwnerCol">IChart</td>
81
<td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol">
82
<div class="summarySignature">
83
<a class="signatureLink" href="#itemToPosition()">itemToPosition</a>(series:<a href="series/ISeries.html">ISeries</a>, itemIndex:int):Point</div>
84
<div class="summaryTableDescription">
85
Calculates the position of a data point along the axis.</div>
86
</td><td class="summaryTableOwnerCol">IChart</td>
90
<script type="text/javascript" language="javascript">
94
<div class="MainContent">
95
<a name="propertyDetail"></a>
96
<div class="detailSectionHeader">Property detail</div>
97
<a name="dataProvider"></a>
98
<table cellspacing="0" cellpadding="0" class="detailHeader">
100
<td class="detailHeaderName">dataProvider</td><td class="detailHeaderType">property</td>
103
<div class="detailBody">
104
<code>dataProvider:Object</code> [read-write]<p>
105
The data to be displayed by the chart. Accepted data types include
106
all of the following:
109
<li>An ISeries instance with its own data provider.</li>
110
<li>An Array containing ISeries instances</li>
111
<li>An Array containing Numbers.</li>
112
<li>An Array containing complex objects.</li>
114
<li>An Array containing Arrays of Numbers or complex objects.</li>
117
</p><p>Note: When complex objects or XML is used in the data provider,
118
developers must define "fields" used to access data used by the chart.
119
For instance, CartesianChart exposes <code>horizontalField</code> and
120
<code>verticalField</code> properties. PieChart exposes <code>dataField</code>
121
and <code>categoryField</code> properties.
123
<p>The chart will automatically convert the input data to an Array of
124
ISeries objects. Don't access <code>dataProvider</code> if you intend
125
to retreive the data in its original form.
127
<span class="label">Implementation</span>
129
<code> public function get dataProvider():Object</code>
131
<code> public function set dataProvider(value:Object):void</code>
134
<span class="label">See also</span>
136
<div class="seeAlso">
137
<a href="series/ISeries.html" target="">com.yahoo.astra.fl.charts.series.ISeries</a>
140
<a name="methodDetail"></a>
141
<div class="detailSectionHeader">Method detail</div>
142
<a name="itemToAxisValue()"></a>
143
<table cellspacing="0" cellpadding="0" class="detailHeader">
145
<td class="detailHeaderName">itemToAxisValue</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
148
<div class="detailBody">
149
<code>public function itemToAxisValue(series:<a href="series/ISeries.html">ISeries</a>, itemIndex:int, axis:<a href="axes/IAxis.html">IAxis</a>, stack:Boolean = true):Object</code><p>
150
Retreives the value of an item on one of the chart's axes.
152
</p><span class="label">Parameters</span>
153
<table border="0" cellspacing="0" cellpadding="0">
155
<td width="20px"></td><td><code><span class="label">series</span>:<a href="series/ISeries.html">ISeries</a></code> — The series in which the item appears.
159
<td class="paramSpacer"> </td>
162
<td width="20px"></td><td><code><span class="label">itemIndex</span>:int</code> — The index of the item within the series.
166
<td class="paramSpacer"> </td>
169
<td width="20px"></td><td><code><span class="label">axis</span>:<a href="axes/IAxis.html">IAxis</a></code> — The axis for which to extract the value.
173
<td class="paramSpacer"> </td>
176
<td width="20px"></td><td><code><span class="label">stack</span>:Boolean</code> (default = <code>true</code>)<code></code></td>
180
<span class="label">Returns</span>
181
<table border="0" cellspacing="0" cellpadding="0">
183
<td width="20"></td><td><code>Object</code> — The value of the item on the axis. Most likely a field on the axis.
188
<a name="itemToPosition()"></a>
189
<table cellspacing="0" cellpadding="0" class="detailHeader">
191
<td class="detailHeaderName">itemToPosition</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td>
194
<div class="detailBody">
195
<code>public function itemToPosition(series:<a href="series/ISeries.html">ISeries</a>, itemIndex:int):Point</code><p>
196
Calculates the position of a data point along the axis.
198
</p><span class="label">Parameters</span>
199
<table border="0" cellspacing="0" cellpadding="0">
201
<td width="20px"></td><td><code><span class="label">series</span>:<a href="series/ISeries.html">ISeries</a></code> — The series in which the data appears.
205
<td class="paramSpacer"> </td>
208
<td width="20px"></td><td><code><span class="label">itemIndex</span>:int</code> — The index of the item within the series.
213
<span class="label">Returns</span>
214
<table border="0" cellspacing="0" cellpadding="0">
216
<td width="20"></td><td><code>Point</code> — The display position in pixels on the axis
226
<center class="copyright">