DefaultHeatMapDataset.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666
  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>DefaultHeatMapDataset (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="DefaultHeatMapDataset (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/DefaultHeatMapDataset.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/DatasetUtilities.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/DefaultKeyedValueDataset.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/DefaultHeatMapDataset.html" target="_top">Frames</a></li>
  57. <li><a href="DefaultHeatMapDataset.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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="Class DefaultHeatMapDataset" class="title">Class DefaultHeatMapDataset</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li>java.lang.Object</li>
  101. <li>
  102. <ul class="inheritance">
  103. <li><a href="../../../../org/jfree/data/general/AbstractDataset.html" title="class in org.jfree.data.general">org.jfree.data.general.AbstractDataset</a></li>
  104. <li>
  105. <ul class="inheritance">
  106. <li>org.jfree.data.general.DefaultHeatMapDataset</li>
  107. </ul>
  108. </li>
  109. </ul>
  110. </li>
  111. </ul>
  112. <div class="description">
  113. <ul class="blockList">
  114. <li class="blockList">
  115. <dl>
  116. <dt>All Implemented Interfaces:</dt>
  117. <dd>java.io.ObjectInputValidation, java.io.Serializable, java.lang.Cloneable, <a href="../../../../org/jfree/data/general/Dataset.html" title="interface in org.jfree.data.general">Dataset</a>, <a href="../../../../org/jfree/data/general/HeatMapDataset.html" title="interface in org.jfree.data.general">HeatMapDataset</a>, org.jfree.util.PublicCloneable</dd>
  118. </dl>
  119. <hr>
  120. <br>
  121. <pre>public class <a href="../../../../src-html/org/jfree/data/general/DefaultHeatMapDataset.html#line.52">DefaultHeatMapDataset</a>
  122. extends <a href="../../../../org/jfree/data/general/AbstractDataset.html" title="class in org.jfree.data.general">AbstractDataset</a>
  123. implements <a href="../../../../org/jfree/data/general/HeatMapDataset.html" title="interface in org.jfree.data.general">HeatMapDataset</a>, java.lang.Cloneable, org.jfree.util.PublicCloneable, java.io.Serializable</pre>
  124. <div class="block">A default implementation of the <a href="../../../../org/jfree/data/general/HeatMapDataset.html" title="interface in org.jfree.data.general"><code>HeatMapDataset</code></a> interface.</div>
  125. <dl>
  126. <dt><span class="simpleTagLabel">Since:</span></dt>
  127. <dd>1.0.13</dd>
  128. <dt><span class="seeLabel">See Also:</span></dt>
  129. <dd><a href="../../../../serialized-form.html#org.jfree.data.general.DefaultHeatMapDataset">Serialized Form</a></dd>
  130. </dl>
  131. </li>
  132. </ul>
  133. </div>
  134. <div class="summary">
  135. <ul class="blockList">
  136. <li class="blockList">
  137. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  138. <ul class="blockList">
  139. <li class="blockList"><a name="constructor.summary">
  140. <!-- -->
  141. </a>
  142. <h3>Constructor Summary</h3>
  143. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  144. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  145. <tr>
  146. <th class="colOne" scope="col">Constructor and Description</th>
  147. </tr>
  148. <tr class="altColor">
  149. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html#DefaultHeatMapDataset-int-int-double-double-double-double-">DefaultHeatMapDataset</a></span>(int&nbsp;xSamples,
  150. int&nbsp;ySamples,
  151. double&nbsp;minX,
  152. double&nbsp;maxX,
  153. double&nbsp;minY,
  154. double&nbsp;maxY)</code>
  155. <div class="block">Creates a new dataset where all the z-values are initially 0.</div>
  156. </td>
  157. </tr>
  158. </table>
  159. </li>
  160. </ul>
  161. <!-- ========== METHOD SUMMARY =========== -->
  162. <ul class="blockList">
  163. <li class="blockList"><a name="method.summary">
  164. <!-- -->
  165. </a>
  166. <h3>Method Summary</h3>
  167. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  168. <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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  169. <tr>
  170. <th class="colFirst" scope="col">Modifier and Type</th>
  171. <th class="colLast" scope="col">Method and Description</th>
  172. </tr>
  173. <tr id="i0" class="altColor">
  174. <td class="colFirst"><code>java.lang.Object</code></td>
  175. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html#clone--">clone</a></span>()</code>
  176. <div class="block">Returns an independent copy of this dataset.</div>
  177. </td>
  178. </tr>
  179. <tr id="i1" class="rowColor">
  180. <td class="colFirst"><code>boolean</code></td>
  181. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  182. <div class="block">Tests this dataset for equality with an arbitrary object.</div>
  183. </td>
  184. </tr>
  185. <tr id="i2" class="altColor">
  186. <td class="colFirst"><code>double</code></td>
  187. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html#getMaximumXValue--">getMaximumXValue</a></span>()</code>
  188. <div class="block">Returns the highest x-value represented in this dataset.</div>
  189. </td>
  190. </tr>
  191. <tr id="i3" class="rowColor">
  192. <td class="colFirst"><code>double</code></td>
  193. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html#getMaximumYValue--">getMaximumYValue</a></span>()</code>
  194. <div class="block">Returns the highest y-value represented in this dataset.</div>
  195. </td>
  196. </tr>
  197. <tr id="i4" class="altColor">
  198. <td class="colFirst"><code>double</code></td>
  199. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html#getMinimumXValue--">getMinimumXValue</a></span>()</code>
  200. <div class="block">Returns the lowest x-value represented in this dataset.</div>
  201. </td>
  202. </tr>
  203. <tr id="i5" class="rowColor">
  204. <td class="colFirst"><code>double</code></td>
  205. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html#getMinimumYValue--">getMinimumYValue</a></span>()</code>
  206. <div class="block">Returns the lowest y-value represented in this dataset.</div>
  207. </td>
  208. </tr>
  209. <tr id="i6" class="altColor">
  210. <td class="colFirst"><code>int</code></td>
  211. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html#getXSampleCount--">getXSampleCount</a></span>()</code>
  212. <div class="block">Returns the number of x values across the width of the dataset.</div>
  213. </td>
  214. </tr>
  215. <tr id="i7" class="rowColor">
  216. <td class="colFirst"><code>double</code></td>
  217. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html#getXValue-int-">getXValue</a></span>(int&nbsp;xIndex)</code>
  218. <div class="block">A convenience method that returns the x-value for the given index.</div>
  219. </td>
  220. </tr>
  221. <tr id="i8" class="altColor">
  222. <td class="colFirst"><code>int</code></td>
  223. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html#getYSampleCount--">getYSampleCount</a></span>()</code>
  224. <div class="block">Returns the number of y values (or samples) for the dataset.</div>
  225. </td>
  226. </tr>
  227. <tr id="i9" class="rowColor">
  228. <td class="colFirst"><code>double</code></td>
  229. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html#getYValue-int-">getYValue</a></span>(int&nbsp;yIndex)</code>
  230. <div class="block">A convenience method that returns the y-value for the given index.</div>
  231. </td>
  232. </tr>
  233. <tr id="i10" class="altColor">
  234. <td class="colFirst"><code>java.lang.Number</code></td>
  235. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html#getZ-int-int-">getZ</a></span>(int&nbsp;xIndex,
  236. int&nbsp;yIndex)</code>
  237. <div class="block">Returns the z-value at the specified sample position in the dataset.</div>
  238. </td>
  239. </tr>
  240. <tr id="i11" class="rowColor">
  241. <td class="colFirst"><code>double</code></td>
  242. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html#getZValue-int-int-">getZValue</a></span>(int&nbsp;xIndex,
  243. int&nbsp;yIndex)</code>
  244. <div class="block">Returns the z-value at the specified sample position in the dataset.</div>
  245. </td>
  246. </tr>
  247. <tr id="i12" class="altColor">
  248. <td class="colFirst"><code>void</code></td>
  249. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html#setZValue-int-int-double-">setZValue</a></span>(int&nbsp;xIndex,
  250. int&nbsp;yIndex,
  251. double&nbsp;z)</code>
  252. <div class="block">Updates a z-value in the dataset and sends a <a href="../../../../org/jfree/data/general/DatasetChangeEvent.html" title="class in org.jfree.data.general"><code>DatasetChangeEvent</code></a>
  253. to all registered listeners.</div>
  254. </td>
  255. </tr>
  256. <tr id="i13" class="rowColor">
  257. <td class="colFirst"><code>void</code></td>
  258. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html#setZValue-int-int-double-boolean-">setZValue</a></span>(int&nbsp;xIndex,
  259. int&nbsp;yIndex,
  260. double&nbsp;z,
  261. boolean&nbsp;notify)</code>
  262. <div class="block">Updates a z-value in the dataset and, if requested, sends a
  263. <a href="../../../../org/jfree/data/general/DatasetChangeEvent.html" title="class in org.jfree.data.general"><code>DatasetChangeEvent</code></a> to all registered listeners.</div>
  264. </td>
  265. </tr>
  266. </table>
  267. <ul class="blockList">
  268. <li class="blockList"><a name="methods.inherited.from.class.org.jfree.data.general.AbstractDataset">
  269. <!-- -->
  270. </a>
  271. <h3>Methods inherited from class&nbsp;org.jfree.data.general.<a href="../../../../org/jfree/data/general/AbstractDataset.html" title="class in org.jfree.data.general">AbstractDataset</a></h3>
  272. <code><a href="../../../../org/jfree/data/general/AbstractDataset.html#addChangeListener-org.jfree.data.general.DatasetChangeListener-">addChangeListener</a>, <a href="../../../../org/jfree/data/general/AbstractDataset.html#fireDatasetChanged--">fireDatasetChanged</a>, <a href="../../../../org/jfree/data/general/AbstractDataset.html#getGroup--">getGroup</a>, <a href="../../../../org/jfree/data/general/AbstractDataset.html#getNotify--">getNotify</a>, <a href="../../../../org/jfree/data/general/AbstractDataset.html#hasListener-java.util.EventListener-">hasListener</a>, <a href="../../../../org/jfree/data/general/AbstractDataset.html#notifyListeners-org.jfree.data.general.DatasetChangeEvent-">notifyListeners</a>, <a href="../../../../org/jfree/data/general/AbstractDataset.html#removeChangeListener-org.jfree.data.general.DatasetChangeListener-">removeChangeListener</a>, <a href="../../../../org/jfree/data/general/AbstractDataset.html#setGroup-org.jfree.data.general.DatasetGroup-">setGroup</a>, <a href="../../../../org/jfree/data/general/AbstractDataset.html#setNotify-boolean-">setNotify</a>, <a href="../../../../org/jfree/data/general/AbstractDataset.html#validateObject--">validateObject</a></code></li>
  273. </ul>
  274. <ul class="blockList">
  275. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  276. <!-- -->
  277. </a>
  278. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  279. <code>finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  280. </ul>
  281. </li>
  282. </ul>
  283. </li>
  284. </ul>
  285. </div>
  286. <div class="details">
  287. <ul class="blockList">
  288. <li class="blockList">
  289. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  290. <ul class="blockList">
  291. <li class="blockList"><a name="constructor.detail">
  292. <!-- -->
  293. </a>
  294. <h3>Constructor Detail</h3>
  295. <a name="DefaultHeatMapDataset-int-int-double-double-double-double-">
  296. <!-- -->
  297. </a>
  298. <ul class="blockListLast">
  299. <li class="blockList">
  300. <h4>DefaultHeatMapDataset</h4>
  301. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/data/general/DefaultHeatMapDataset.html#line.87">DefaultHeatMapDataset</a>(int&nbsp;xSamples,
  302. int&nbsp;ySamples,
  303. double&nbsp;minX,
  304. double&nbsp;maxX,
  305. double&nbsp;minY,
  306. double&nbsp;maxY)</pre>
  307. <div class="block">Creates a new dataset where all the z-values are initially 0. This is
  308. a fixed size array of z-values.</div>
  309. <dl>
  310. <dt><span class="paramLabel">Parameters:</span></dt>
  311. <dd><code>xSamples</code> - the number of x-values.</dd>
  312. <dd><code>ySamples</code> - the number of y-values</dd>
  313. <dd><code>minX</code> - the minimum x-value in the dataset.</dd>
  314. <dd><code>maxX</code> - the maximum x-value in the dataset.</dd>
  315. <dd><code>minY</code> - the minimum y-value in the dataset.</dd>
  316. <dd><code>maxY</code> - the maximum y-value in the dataset.</dd>
  317. </dl>
  318. </li>
  319. </ul>
  320. </li>
  321. </ul>
  322. <!-- ============ METHOD DETAIL ========== -->
  323. <ul class="blockList">
  324. <li class="blockList"><a name="method.detail">
  325. <!-- -->
  326. </a>
  327. <h3>Method Detail</h3>
  328. <a name="getXSampleCount--">
  329. <!-- -->
  330. </a>
  331. <ul class="blockList">
  332. <li class="blockList">
  333. <h4>getXSampleCount</h4>
  334. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/data/general/DefaultHeatMapDataset.html#line.129">getXSampleCount</a>()</pre>
  335. <div class="block">Returns the number of x values across the width of the dataset. The
  336. values are evenly spaced between <a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html#getMinimumXValue--"><code>getMinimumXValue()</code></a> and
  337. <a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html#getMaximumXValue--"><code>getMaximumXValue()</code></a>.</div>
  338. <dl>
  339. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  340. <dd><code><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getXSampleCount--">getXSampleCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/data/general/HeatMapDataset.html" title="interface in org.jfree.data.general">HeatMapDataset</a></code></dd>
  341. <dt><span class="returnLabel">Returns:</span></dt>
  342. <dd>The number of x-values (always &gt; 0).</dd>
  343. </dl>
  344. </li>
  345. </ul>
  346. <a name="getYSampleCount--">
  347. <!-- -->
  348. </a>
  349. <ul class="blockList">
  350. <li class="blockList">
  351. <h4>getYSampleCount</h4>
  352. <pre>public&nbsp;int&nbsp;<a href="../../../../src-html/org/jfree/data/general/DefaultHeatMapDataset.html#line.141">getYSampleCount</a>()</pre>
  353. <div class="block">Returns the number of y values (or samples) for the dataset. The
  354. values are evenly spaced between <a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html#getMinimumYValue--"><code>getMinimumYValue()</code></a> and
  355. <a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html#getMaximumYValue--"><code>getMaximumYValue()</code></a>.</div>
  356. <dl>
  357. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  358. <dd><code><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getYSampleCount--">getYSampleCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/data/general/HeatMapDataset.html" title="interface in org.jfree.data.general">HeatMapDataset</a></code></dd>
  359. <dt><span class="returnLabel">Returns:</span></dt>
  360. <dd>The number of y-values (always &gt; 0).</dd>
  361. </dl>
  362. </li>
  363. </ul>
  364. <a name="getMinimumXValue--">
  365. <!-- -->
  366. </a>
  367. <ul class="blockList">
  368. <li class="blockList">
  369. <h4>getMinimumXValue</h4>
  370. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/data/general/DefaultHeatMapDataset.html#line.153">getMinimumXValue</a>()</pre>
  371. <div class="block">Returns the lowest x-value represented in this dataset. A requirement
  372. of this interface is that this method must never return infinite or
  373. Double.NAN values.</div>
  374. <dl>
  375. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  376. <dd><code><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getMinimumXValue--">getMinimumXValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/data/general/HeatMapDataset.html" title="interface in org.jfree.data.general">HeatMapDataset</a></code></dd>
  377. <dt><span class="returnLabel">Returns:</span></dt>
  378. <dd>The lowest x-value represented in this dataset.</dd>
  379. </dl>
  380. </li>
  381. </ul>
  382. <a name="getMaximumXValue--">
  383. <!-- -->
  384. </a>
  385. <ul class="blockList">
  386. <li class="blockList">
  387. <h4>getMaximumXValue</h4>
  388. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/data/general/DefaultHeatMapDataset.html#line.165">getMaximumXValue</a>()</pre>
  389. <div class="block">Returns the highest x-value represented in this dataset. A requirement
  390. of this interface is that this method must never return infinite or
  391. Double.NAN values.</div>
  392. <dl>
  393. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  394. <dd><code><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getMaximumXValue--">getMaximumXValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/data/general/HeatMapDataset.html" title="interface in org.jfree.data.general">HeatMapDataset</a></code></dd>
  395. <dt><span class="returnLabel">Returns:</span></dt>
  396. <dd>The highest x-value represented in this dataset.</dd>
  397. </dl>
  398. </li>
  399. </ul>
  400. <a name="getMinimumYValue--">
  401. <!-- -->
  402. </a>
  403. <ul class="blockList">
  404. <li class="blockList">
  405. <h4>getMinimumYValue</h4>
  406. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/data/general/DefaultHeatMapDataset.html#line.177">getMinimumYValue</a>()</pre>
  407. <div class="block">Returns the lowest y-value represented in this dataset. A requirement
  408. of this interface is that this method must never return infinite or
  409. Double.NAN values.</div>
  410. <dl>
  411. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  412. <dd><code><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getMinimumYValue--">getMinimumYValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/data/general/HeatMapDataset.html" title="interface in org.jfree.data.general">HeatMapDataset</a></code></dd>
  413. <dt><span class="returnLabel">Returns:</span></dt>
  414. <dd>The lowest y-value represented in this dataset.</dd>
  415. </dl>
  416. </li>
  417. </ul>
  418. <a name="getMaximumYValue--">
  419. <!-- -->
  420. </a>
  421. <ul class="blockList">
  422. <li class="blockList">
  423. <h4>getMaximumYValue</h4>
  424. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/data/general/DefaultHeatMapDataset.html#line.189">getMaximumYValue</a>()</pre>
  425. <div class="block">Returns the highest y-value represented in this dataset. A requirement
  426. of this interface is that this method must never return infinite or
  427. Double.NAN values.</div>
  428. <dl>
  429. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  430. <dd><code><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getMaximumYValue--">getMaximumYValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/data/general/HeatMapDataset.html" title="interface in org.jfree.data.general">HeatMapDataset</a></code></dd>
  431. <dt><span class="returnLabel">Returns:</span></dt>
  432. <dd>The highest y-value represented in this dataset.</dd>
  433. </dl>
  434. </li>
  435. </ul>
  436. <a name="getXValue-int-">
  437. <!-- -->
  438. </a>
  439. <ul class="blockList">
  440. <li class="blockList">
  441. <h4>getXValue</h4>
  442. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/data/general/DefaultHeatMapDataset.html#line.201">getXValue</a>(int&nbsp;xIndex)</pre>
  443. <div class="block">A convenience method that returns the x-value for the given index.</div>
  444. <dl>
  445. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  446. <dd><code><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getXValue-int-">getXValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/data/general/HeatMapDataset.html" title="interface in org.jfree.data.general">HeatMapDataset</a></code></dd>
  447. <dt><span class="paramLabel">Parameters:</span></dt>
  448. <dd><code>xIndex</code> - the xIndex.</dd>
  449. <dt><span class="returnLabel">Returns:</span></dt>
  450. <dd>The x-value.</dd>
  451. </dl>
  452. </li>
  453. </ul>
  454. <a name="getYValue-int-">
  455. <!-- -->
  456. </a>
  457. <ul class="blockList">
  458. <li class="blockList">
  459. <h4>getYValue</h4>
  460. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/data/general/DefaultHeatMapDataset.html#line.215">getYValue</a>(int&nbsp;yIndex)</pre>
  461. <div class="block">A convenience method that returns the y-value for the given index.</div>
  462. <dl>
  463. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  464. <dd><code><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getYValue-int-">getYValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/data/general/HeatMapDataset.html" title="interface in org.jfree.data.general">HeatMapDataset</a></code></dd>
  465. <dt><span class="paramLabel">Parameters:</span></dt>
  466. <dd><code>yIndex</code> - the yIndex.</dd>
  467. <dt><span class="returnLabel">Returns:</span></dt>
  468. <dd>The y-value.</dd>
  469. </dl>
  470. </li>
  471. </ul>
  472. <a name="getZValue-int-int-">
  473. <!-- -->
  474. </a>
  475. <ul class="blockList">
  476. <li class="blockList">
  477. <h4>getZValue</h4>
  478. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/data/general/DefaultHeatMapDataset.html#line.231">getZValue</a>(int&nbsp;xIndex,
  479. int&nbsp;yIndex)</pre>
  480. <div class="block">Returns the z-value at the specified sample position in the dataset.
  481. For a missing or unknown value, this method should return Double.NAN.</div>
  482. <dl>
  483. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  484. <dd><code><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getZValue-int-int-">getZValue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/data/general/HeatMapDataset.html" title="interface in org.jfree.data.general">HeatMapDataset</a></code></dd>
  485. <dt><span class="paramLabel">Parameters:</span></dt>
  486. <dd><code>xIndex</code> - the position of the x sample in the dataset.</dd>
  487. <dd><code>yIndex</code> - the position of the y sample in the dataset.</dd>
  488. <dt><span class="returnLabel">Returns:</span></dt>
  489. <dd>The z-value.</dd>
  490. </dl>
  491. </li>
  492. </ul>
  493. <a name="getZ-int-int-">
  494. <!-- -->
  495. </a>
  496. <ul class="blockList">
  497. <li class="blockList">
  498. <h4>getZ</h4>
  499. <pre>public&nbsp;java.lang.Number&nbsp;<a href="../../../../src-html/org/jfree/data/general/DefaultHeatMapDataset.html#line.247">getZ</a>(int&nbsp;xIndex,
  500. int&nbsp;yIndex)</pre>
  501. <div class="block">Returns the z-value at the specified sample position in the dataset.
  502. In this implementation, where the underlying values are stored in an
  503. array of double primitives, you should avoid using this method and
  504. use <a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html#getZValue-int-int-"><code>getZValue(int, int)</code></a> instead.</div>
  505. <dl>
  506. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  507. <dd><code><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getZ-int-int-">getZ</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/jfree/data/general/HeatMapDataset.html" title="interface in org.jfree.data.general">HeatMapDataset</a></code></dd>
  508. <dt><span class="paramLabel">Parameters:</span></dt>
  509. <dd><code>xIndex</code> - the position of the x sample in the dataset.</dd>
  510. <dd><code>yIndex</code> - the position of the y sample in the dataset.</dd>
  511. <dt><span class="returnLabel">Returns:</span></dt>
  512. <dd>The z-value.</dd>
  513. </dl>
  514. </li>
  515. </ul>
  516. <a name="setZValue-int-int-double-">
  517. <!-- -->
  518. </a>
  519. <ul class="blockList">
  520. <li class="blockList">
  521. <h4>setZValue</h4>
  522. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/data/general/DefaultHeatMapDataset.html#line.259">setZValue</a>(int&nbsp;xIndex,
  523. int&nbsp;yIndex,
  524. double&nbsp;z)</pre>
  525. <div class="block">Updates a z-value in the dataset and sends a <a href="../../../../org/jfree/data/general/DatasetChangeEvent.html" title="class in org.jfree.data.general"><code>DatasetChangeEvent</code></a>
  526. to all registered listeners.</div>
  527. <dl>
  528. <dt><span class="paramLabel">Parameters:</span></dt>
  529. <dd><code>xIndex</code> - the x-index.</dd>
  530. <dd><code>yIndex</code> - the y-index.</dd>
  531. <dd><code>z</code> - the new z-value.</dd>
  532. </dl>
  533. </li>
  534. </ul>
  535. <a name="setZValue-int-int-double-boolean-">
  536. <!-- -->
  537. </a>
  538. <ul class="blockList">
  539. <li class="blockList">
  540. <h4>setZValue</h4>
  541. <pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/jfree/data/general/DefaultHeatMapDataset.html#line.272">setZValue</a>(int&nbsp;xIndex,
  542. int&nbsp;yIndex,
  543. double&nbsp;z,
  544. boolean&nbsp;notify)</pre>
  545. <div class="block">Updates a z-value in the dataset and, if requested, sends a
  546. <a href="../../../../org/jfree/data/general/DatasetChangeEvent.html" title="class in org.jfree.data.general"><code>DatasetChangeEvent</code></a> to all registered listeners.</div>
  547. <dl>
  548. <dt><span class="paramLabel">Parameters:</span></dt>
  549. <dd><code>xIndex</code> - the x-index.</dd>
  550. <dd><code>yIndex</code> - the y-index.</dd>
  551. <dd><code>z</code> - the new z-value.</dd>
  552. <dd><code>notify</code> - notify listeners?</dd>
  553. </dl>
  554. </li>
  555. </ul>
  556. <a name="equals-java.lang.Object-">
  557. <!-- -->
  558. </a>
  559. <ul class="blockList">
  560. <li class="blockList">
  561. <h4>equals</h4>
  562. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/data/general/DefaultHeatMapDataset.html#line.287">equals</a>(java.lang.Object&nbsp;obj)</pre>
  563. <div class="block">Tests this dataset for equality with an arbitrary object.</div>
  564. <dl>
  565. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  566. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  567. <dt><span class="paramLabel">Parameters:</span></dt>
  568. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  569. <dt><span class="returnLabel">Returns:</span></dt>
  570. <dd>A boolean.</dd>
  571. </dl>
  572. </li>
  573. </ul>
  574. <a name="clone--">
  575. <!-- -->
  576. </a>
  577. <ul class="blockListLast">
  578. <li class="blockList">
  579. <h4>clone</h4>
  580. <pre>public&nbsp;java.lang.Object&nbsp;<a href="../../../../src-html/org/jfree/data/general/DefaultHeatMapDataset.html#line.329">clone</a>()
  581. throws java.lang.CloneNotSupportedException</pre>
  582. <div class="block">Returns an independent copy of this dataset.</div>
  583. <dl>
  584. <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
  585. <dd><code>clone</code>&nbsp;in interface&nbsp;<code>org.jfree.util.PublicCloneable</code></dd>
  586. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  587. <dd><code><a href="../../../../org/jfree/data/general/AbstractDataset.html#clone--">clone</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/jfree/data/general/AbstractDataset.html" title="class in org.jfree.data.general">AbstractDataset</a></code></dd>
  588. <dt><span class="returnLabel">Returns:</span></dt>
  589. <dd>A clone.</dd>
  590. <dt><span class="throwsLabel">Throws:</span></dt>
  591. <dd><code>java.lang.CloneNotSupportedException</code> - if there is a problem
  592. cloning.</dd>
  593. </dl>
  594. </li>
  595. </ul>
  596. </li>
  597. </ul>
  598. </li>
  599. </ul>
  600. </div>
  601. </div>
  602. <!-- ========= END OF CLASS DATA ========= -->
  603. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  604. <div class="bottomNav"><a name="navbar.bottom">
  605. <!-- -->
  606. </a>
  607. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  608. <a name="navbar.bottom.firstrow">
  609. <!-- -->
  610. </a>
  611. <ul class="navList" title="Navigation">
  612. <li><a href="../../../../overview-summary.html">Overview</a></li>
  613. <li><a href="package-summary.html">Package</a></li>
  614. <li class="navBarCell1Rev">Class</li>
  615. <li><a href="class-use/DefaultHeatMapDataset.html">Use</a></li>
  616. <li><a href="package-tree.html">Tree</a></li>
  617. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  618. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  619. <li><a href="../../../../help-doc.html">Help</a></li>
  620. </ul>
  621. </div>
  622. <div class="subNav">
  623. <ul class="navList">
  624. <li><a href="../../../../org/jfree/data/general/DatasetUtilities.html" title="class in org.jfree.data.general"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  625. <li><a href="../../../../org/jfree/data/general/DefaultKeyedValueDataset.html" title="class in org.jfree.data.general"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  626. </ul>
  627. <ul class="navList">
  628. <li><a href="../../../../index.html?org/jfree/data/general/DefaultHeatMapDataset.html" target="_top">Frames</a></li>
  629. <li><a href="DefaultHeatMapDataset.html" target="_top">No&nbsp;Frames</a></li>
  630. </ul>
  631. <ul class="navList" id="allclasses_navbar_bottom">
  632. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  633. </ul>
  634. <div>
  635. <script type="text/javascript"><!--
  636. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  637. if(window==top) {
  638. allClassesLink.style.display = "block";
  639. }
  640. else {
  641. allClassesLink.style.display = "none";
  642. }
  643. //-->
  644. </script>
  645. </div>
  646. <div>
  647. <ul class="subNavList">
  648. <li>Summary:&nbsp;</li>
  649. <li>Nested&nbsp;|&nbsp;</li>
  650. <li>Field&nbsp;|&nbsp;</li>
  651. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  652. <li><a href="#method.summary">Method</a></li>
  653. </ul>
  654. <ul class="subNavList">
  655. <li>Detail:&nbsp;</li>
  656. <li>Field&nbsp;|&nbsp;</li>
  657. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  658. <li><a href="#method.detail">Method</a></li>
  659. </ul>
  660. </div>
  661. <a name="skip.navbar.bottom">
  662. <!-- -->
  663. </a></div>
  664. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  665. </body>
  666. </html>