HeatMapDataset.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_05) on Thu Jul 31 14:50:42 CEST 2014 -->
  6. <title>HeatMapDataset (JFreeChart Class Library (version 1.0.19-fx))</title>
  7. <meta name="date" content="2014-07-31">
  8. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="HeatMapDataset (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="class-use/HeatMapDataset.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  47. <li><a href="../../../../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../../../../org/jfree/data/general/DefaultValueDataset.html" title="class in org.jfree.data.general"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/data/general/HeatMapUtilities.html" title="class in org.jfree.data.general"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/data/general/HeatMapDataset.html" target="_top">Frames</a></li>
  57. <li><a href="HeatMapDataset.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li>Field&nbsp;|&nbsp;</li>
  79. <li>Constr&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li>Field&nbsp;|&nbsp;</li>
  85. <li>Constr&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">org.jfree.data.general</div>
  96. <h2 title="Interface HeatMapDataset" class="title">Interface HeatMapDataset</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <div class="description">
  100. <ul class="blockList">
  101. <li class="blockList">
  102. <dl>
  103. <dt>All Known Implementing Classes:</dt>
  104. <dd><a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html" title="class in org.jfree.data.general">DefaultHeatMapDataset</a></dd>
  105. </dl>
  106. <hr>
  107. <br>
  108. <pre>public interface <a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.50">HeatMapDataset</a></pre>
  109. <div class="block">A dataset that represents a rectangular grid of (x, y, z) values. The x
  110. and y values appear at regular intervals in the dataset, while the z-values
  111. can take any value (including <code>null</code> for unknown values).</div>
  112. <dl>
  113. <dt><span class="simpleTagLabel">Since:</span></dt>
  114. <dd>1.0.13</dd>
  115. </dl>
  116. </li>
  117. </ul>
  118. </div>
  119. <div class="summary">
  120. <ul class="blockList">
  121. <li class="blockList">
  122. <!-- ========== METHOD SUMMARY =========== -->
  123. <ul class="blockList">
  124. <li class="blockList"><a name="method.summary">
  125. <!-- -->
  126. </a>
  127. <h3>Method Summary</h3>
  128. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  129. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  130. <tr>
  131. <th class="colFirst" scope="col">Modifier and Type</th>
  132. <th class="colLast" scope="col">Method and Description</th>
  133. </tr>
  134. <tr id="i0" class="altColor">
  135. <td class="colFirst"><code>double</code></td>
  136. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getMaximumXValue--">getMaximumXValue</a></span>()</code>
  137. <div class="block">Returns the highest x-value represented in this dataset.</div>
  138. </td>
  139. </tr>
  140. <tr id="i1" class="rowColor">
  141. <td class="colFirst"><code>double</code></td>
  142. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getMaximumYValue--">getMaximumYValue</a></span>()</code>
  143. <div class="block">Returns the highest y-value represented in this dataset.</div>
  144. </td>
  145. </tr>
  146. <tr id="i2" class="altColor">
  147. <td class="colFirst"><code>double</code></td>
  148. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getMinimumXValue--">getMinimumXValue</a></span>()</code>
  149. <div class="block">Returns the lowest x-value represented in this dataset.</div>
  150. </td>
  151. </tr>
  152. <tr id="i3" class="rowColor">
  153. <td class="colFirst"><code>double</code></td>
  154. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getMinimumYValue--">getMinimumYValue</a></span>()</code>
  155. <div class="block">Returns the lowest y-value represented in this dataset.</div>
  156. </td>
  157. </tr>
  158. <tr id="i4" class="altColor">
  159. <td class="colFirst"><code>int</code></td>
  160. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getXSampleCount--">getXSampleCount</a></span>()</code>
  161. <div class="block">Returns the number of x values across the width of the dataset.</div>
  162. </td>
  163. </tr>
  164. <tr id="i5" class="rowColor">
  165. <td class="colFirst"><code>double</code></td>
  166. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getXValue-int-">getXValue</a></span>(int&nbsp;xIndex)</code>
  167. <div class="block">A convenience method that returns the x-value for the given index.</div>
  168. </td>
  169. </tr>
  170. <tr id="i6" class="altColor">
  171. <td class="colFirst"><code>int</code></td>
  172. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getYSampleCount--">getYSampleCount</a></span>()</code>
  173. <div class="block">Returns the number of y values (or samples) for the dataset.</div>
  174. </td>
  175. </tr>
  176. <tr id="i7" class="rowColor">
  177. <td class="colFirst"><code>double</code></td>
  178. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getYValue-int-">getYValue</a></span>(int&nbsp;yIndex)</code>
  179. <div class="block">A convenience method that returns the y-value for the given index.</div>
  180. </td>
  181. </tr>
  182. <tr id="i8" class="altColor">
  183. <td class="colFirst"><code>java.lang.Number</code></td>
  184. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getZ-int-int-">getZ</a></span>(int&nbsp;xIndex,
  185. int&nbsp;yIndex)</code>
  186. <div class="block">Returns the z-value at the specified sample position in the dataset.</div>
  187. </td>
  188. </tr>
  189. <tr id="i9" class="rowColor">
  190. <td class="colFirst"><code>double</code></td>
  191. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getZValue-int-int-">getZValue</a></span>(int&nbsp;xIndex,
  192. int&nbsp;yIndex)</code>
  193. <div class="block">Returns the z-value at the specified sample position in the dataset.</div>
  194. </td>
  195. </tr>
  196. </table>
  197. </li>
  198. </ul>
  199. </li>
  200. </ul>
  201. </div>
  202. <div class="details">
  203. <ul class="blockList">
  204. <li class="blockList">
  205. <!-- ============ METHOD DETAIL ========== -->
  206. <ul class="blockList">
  207. <li class="blockList"><a name="method.detail">
  208. <!-- -->
  209. </a>
  210. <h3>Method Detail</h3>
  211. <a name="getXSampleCount--">
  212. <!-- -->
  213. </a>
  214. <ul class="blockList">
  215. <li class="blockList">
  216. <h4>getXSampleCount</h4>
  217. <pre>int&nbsp;<a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.59">getXSampleCount</a>()</pre>
  218. <div class="block">Returns the number of x values across the width of the dataset. The
  219. values are evenly spaced between <a href="../../../../org/jfree/data/general/HeatMapDataset.html#getMinimumXValue--"><code>getMinimumXValue()</code></a> and
  220. <a href="../../../../org/jfree/data/general/HeatMapDataset.html#getMaximumXValue--"><code>getMaximumXValue()</code></a>.</div>
  221. <dl>
  222. <dt><span class="returnLabel">Returns:</span></dt>
  223. <dd>The number of x-values (always &gt; 0).</dd>
  224. </dl>
  225. </li>
  226. </ul>
  227. <a name="getYSampleCount--">
  228. <!-- -->
  229. </a>
  230. <ul class="blockList">
  231. <li class="blockList">
  232. <h4>getYSampleCount</h4>
  233. <pre>int&nbsp;<a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.68">getYSampleCount</a>()</pre>
  234. <div class="block">Returns the number of y values (or samples) for the dataset. The
  235. values are evenly spaced between <a href="../../../../org/jfree/data/general/HeatMapDataset.html#getMinimumYValue--"><code>getMinimumYValue()</code></a> and
  236. <a href="../../../../org/jfree/data/general/HeatMapDataset.html#getMaximumYValue--"><code>getMaximumYValue()</code></a>.</div>
  237. <dl>
  238. <dt><span class="returnLabel">Returns:</span></dt>
  239. <dd>The number of y-values (always &gt; 0).</dd>
  240. </dl>
  241. </li>
  242. </ul>
  243. <a name="getMinimumXValue--">
  244. <!-- -->
  245. </a>
  246. <ul class="blockList">
  247. <li class="blockList">
  248. <h4>getMinimumXValue</h4>
  249. <pre>double&nbsp;<a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.77">getMinimumXValue</a>()</pre>
  250. <div class="block">Returns the lowest x-value represented in this dataset. A requirement
  251. of this interface is that this method must never return infinite or
  252. Double.NAN values.</div>
  253. <dl>
  254. <dt><span class="returnLabel">Returns:</span></dt>
  255. <dd>The lowest x-value represented in this dataset.</dd>
  256. </dl>
  257. </li>
  258. </ul>
  259. <a name="getMaximumXValue--">
  260. <!-- -->
  261. </a>
  262. <ul class="blockList">
  263. <li class="blockList">
  264. <h4>getMaximumXValue</h4>
  265. <pre>double&nbsp;<a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.86">getMaximumXValue</a>()</pre>
  266. <div class="block">Returns the highest x-value represented in this dataset. A requirement
  267. of this interface is that this method must never return infinite or
  268. Double.NAN values.</div>
  269. <dl>
  270. <dt><span class="returnLabel">Returns:</span></dt>
  271. <dd>The highest x-value represented in this dataset.</dd>
  272. </dl>
  273. </li>
  274. </ul>
  275. <a name="getMinimumYValue--">
  276. <!-- -->
  277. </a>
  278. <ul class="blockList">
  279. <li class="blockList">
  280. <h4>getMinimumYValue</h4>
  281. <pre>double&nbsp;<a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.95">getMinimumYValue</a>()</pre>
  282. <div class="block">Returns the lowest y-value represented in this dataset. A requirement
  283. of this interface is that this method must never return infinite or
  284. Double.NAN values.</div>
  285. <dl>
  286. <dt><span class="returnLabel">Returns:</span></dt>
  287. <dd>The lowest y-value represented in this dataset.</dd>
  288. </dl>
  289. </li>
  290. </ul>
  291. <a name="getMaximumYValue--">
  292. <!-- -->
  293. </a>
  294. <ul class="blockList">
  295. <li class="blockList">
  296. <h4>getMaximumYValue</h4>
  297. <pre>double&nbsp;<a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.104">getMaximumYValue</a>()</pre>
  298. <div class="block">Returns the highest y-value represented in this dataset. A requirement
  299. of this interface is that this method must never return infinite or
  300. Double.NAN values.</div>
  301. <dl>
  302. <dt><span class="returnLabel">Returns:</span></dt>
  303. <dd>The highest y-value represented in this dataset.</dd>
  304. </dl>
  305. </li>
  306. </ul>
  307. <a name="getXValue-int-">
  308. <!-- -->
  309. </a>
  310. <ul class="blockList">
  311. <li class="blockList">
  312. <h4>getXValue</h4>
  313. <pre>double&nbsp;<a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.113">getXValue</a>(int&nbsp;xIndex)</pre>
  314. <div class="block">A convenience method that returns the x-value for the given index.</div>
  315. <dl>
  316. <dt><span class="paramLabel">Parameters:</span></dt>
  317. <dd><code>xIndex</code> - the xIndex.</dd>
  318. <dt><span class="returnLabel">Returns:</span></dt>
  319. <dd>The x-value.</dd>
  320. </dl>
  321. </li>
  322. </ul>
  323. <a name="getYValue-int-">
  324. <!-- -->
  325. </a>
  326. <ul class="blockList">
  327. <li class="blockList">
  328. <h4>getYValue</h4>
  329. <pre>double&nbsp;<a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.122">getYValue</a>(int&nbsp;yIndex)</pre>
  330. <div class="block">A convenience method that returns the y-value for the given index.</div>
  331. <dl>
  332. <dt><span class="paramLabel">Parameters:</span></dt>
  333. <dd><code>yIndex</code> - the yIndex.</dd>
  334. <dt><span class="returnLabel">Returns:</span></dt>
  335. <dd>The y-value.</dd>
  336. </dl>
  337. </li>
  338. </ul>
  339. <a name="getZValue-int-int-">
  340. <!-- -->
  341. </a>
  342. <ul class="blockList">
  343. <li class="blockList">
  344. <h4>getZValue</h4>
  345. <pre>double&nbsp;<a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.133">getZValue</a>(int&nbsp;xIndex,
  346. int&nbsp;yIndex)</pre>
  347. <div class="block">Returns the z-value at the specified sample position in the dataset.
  348. For a missing or unknown value, this method should return Double.NAN.</div>
  349. <dl>
  350. <dt><span class="paramLabel">Parameters:</span></dt>
  351. <dd><code>xIndex</code> - the position of the x sample in the dataset.</dd>
  352. <dd><code>yIndex</code> - the position of the y sample in the dataset.</dd>
  353. <dt><span class="returnLabel">Returns:</span></dt>
  354. <dd>The z-value.</dd>
  355. </dl>
  356. </li>
  357. </ul>
  358. <a name="getZ-int-int-">
  359. <!-- -->
  360. </a>
  361. <ul class="blockListLast">
  362. <li class="blockList">
  363. <h4>getZ</h4>
  364. <pre>java.lang.Number&nbsp;<a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.152">getZ</a>(int&nbsp;xIndex,
  365. int&nbsp;yIndex)</pre>
  366. <div class="block">Returns the z-value at the specified sample position in the dataset.
  367. This method can return <code>null</code> to indicate a missing/unknown
  368. value.
  369. <br><br>
  370. Bear in mind that the class implementing this interface may
  371. store its data using primitives rather than objects, so calling this
  372. method may require a new <code>Number</code> object to be allocated...
  373. for this reason, it is generally preferable to use the
  374. <a href="../../../../org/jfree/data/general/HeatMapDataset.html#getZValue-int-int-"><code>getZValue(int, int)</code></a> method unless you *know* that the dataset
  375. implementation stores the z-values using objects.</div>
  376. <dl>
  377. <dt><span class="paramLabel">Parameters:</span></dt>
  378. <dd><code>xIndex</code> - the position of the x sample in the dataset.</dd>
  379. <dd><code>yIndex</code> - the position of the y sample in the dataset.</dd>
  380. <dt><span class="returnLabel">Returns:</span></dt>
  381. <dd>The z-value (possibly <code>null</code>).</dd>
  382. </dl>
  383. </li>
  384. </ul>
  385. </li>
  386. </ul>
  387. </li>
  388. </ul>
  389. </div>
  390. </div>
  391. <!-- ========= END OF CLASS DATA ========= -->
  392. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  393. <div class="bottomNav"><a name="navbar.bottom">
  394. <!-- -->
  395. </a>
  396. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  397. <a name="navbar.bottom.firstrow">
  398. <!-- -->
  399. </a>
  400. <ul class="navList" title="Navigation">
  401. <li><a href="../../../../overview-summary.html">Overview</a></li>
  402. <li><a href="package-summary.html">Package</a></li>
  403. <li class="navBarCell1Rev">Class</li>
  404. <li><a href="class-use/HeatMapDataset.html">Use</a></li>
  405. <li><a href="package-tree.html">Tree</a></li>
  406. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  407. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  408. <li><a href="../../../../help-doc.html">Help</a></li>
  409. </ul>
  410. </div>
  411. <div class="subNav">
  412. <ul class="navList">
  413. <li><a href="../../../../org/jfree/data/general/DefaultValueDataset.html" title="class in org.jfree.data.general"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  414. <li><a href="../../../../org/jfree/data/general/HeatMapUtilities.html" title="class in org.jfree.data.general"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  415. </ul>
  416. <ul class="navList">
  417. <li><a href="../../../../index.html?org/jfree/data/general/HeatMapDataset.html" target="_top">Frames</a></li>
  418. <li><a href="HeatMapDataset.html" target="_top">No&nbsp;Frames</a></li>
  419. </ul>
  420. <ul class="navList" id="allclasses_navbar_bottom">
  421. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  422. </ul>
  423. <div>
  424. <script type="text/javascript"><!--
  425. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  426. if(window==top) {
  427. allClassesLink.style.display = "block";
  428. }
  429. else {
  430. allClassesLink.style.display = "none";
  431. }
  432. //-->
  433. </script>
  434. </div>
  435. <div>
  436. <ul class="subNavList">
  437. <li>Summary:&nbsp;</li>
  438. <li>Nested&nbsp;|&nbsp;</li>
  439. <li>Field&nbsp;|&nbsp;</li>
  440. <li>Constr&nbsp;|&nbsp;</li>
  441. <li><a href="#method.summary">Method</a></li>
  442. </ul>
  443. <ul class="subNavList">
  444. <li>Detail:&nbsp;</li>
  445. <li>Field&nbsp;|&nbsp;</li>
  446. <li>Constr&nbsp;|&nbsp;</li>
  447. <li><a href="#method.detail">Method</a></li>
  448. </ul>
  449. </div>
  450. <a name="skip.navbar.bottom">
  451. <!-- -->
  452. </a></div>
  453. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  454. </body>
  455. </html>