HeatMapUtilities.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349
  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>HeatMapUtilities (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="HeatMapUtilities (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":9,"i1":9,"i2":9};
  22. var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/HeatMapUtilities.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/HeatMapDataset.html" title="interface in org.jfree.data.general"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/data/general/KeyedValueDataset.html" title="interface 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/HeatMapUtilities.html" target="_top">Frames</a></li>
  57. <li><a href="HeatMapUtilities.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 HeatMapUtilities" class="title">Class HeatMapUtilities</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>org.jfree.data.general.HeatMapUtilities</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <hr>
  111. <br>
  112. <pre>public abstract class <a href="../../../../src-html/org/jfree/data/general/HeatMapUtilities.html#line.58">HeatMapUtilities</a>
  113. extends java.lang.Object</pre>
  114. <div class="block">A utility class for the <a href="../../../../org/jfree/data/general/HeatMapDataset.html" title="interface in org.jfree.data.general"><code>HeatMapDataset</code></a>.</div>
  115. <dl>
  116. <dt><span class="simpleTagLabel">Since:</span></dt>
  117. <dd>1.0.13</dd>
  118. </dl>
  119. </li>
  120. </ul>
  121. </div>
  122. <div class="summary">
  123. <ul class="blockList">
  124. <li class="blockList">
  125. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  126. <ul class="blockList">
  127. <li class="blockList"><a name="constructor.summary">
  128. <!-- -->
  129. </a>
  130. <h3>Constructor Summary</h3>
  131. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  132. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  133. <tr>
  134. <th class="colOne" scope="col">Constructor and Description</th>
  135. </tr>
  136. <tr class="altColor">
  137. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapUtilities.html#HeatMapUtilities--">HeatMapUtilities</a></span>()</code>&nbsp;</td>
  138. </tr>
  139. </table>
  140. </li>
  141. </ul>
  142. <!-- ========== METHOD SUMMARY =========== -->
  143. <ul class="blockList">
  144. <li class="blockList"><a name="method.summary">
  145. <!-- -->
  146. </a>
  147. <h3>Method Summary</h3>
  148. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  149. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>
  150. <tr>
  151. <th class="colFirst" scope="col">Modifier and Type</th>
  152. <th class="colLast" scope="col">Method and Description</th>
  153. </tr>
  154. <tr id="i0" class="altColor">
  155. <td class="colFirst"><code>static java.awt.image.BufferedImage</code></td>
  156. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapUtilities.html#createHeatMapImage-org.jfree.data.general.HeatMapDataset-org.jfree.chart.renderer.PaintScale-">createHeatMapImage</a></span>(<a href="../../../../org/jfree/data/general/HeatMapDataset.html" title="interface in org.jfree.data.general">HeatMapDataset</a>&nbsp;dataset,
  157. <a href="../../../../org/jfree/chart/renderer/PaintScale.html" title="interface in org.jfree.chart.renderer">PaintScale</a>&nbsp;paintScale)</code>
  158. <div class="block">Creates an image that displays the values from the specified dataset.</div>
  159. </td>
  160. </tr>
  161. <tr id="i1" class="rowColor">
  162. <td class="colFirst"><code>static <a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a></code></td>
  163. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapUtilities.html#extractColumnFromHeatMapDataset-org.jfree.data.general.HeatMapDataset-int-java.lang.Comparable-">extractColumnFromHeatMapDataset</a></span>(<a href="../../../../org/jfree/data/general/HeatMapDataset.html" title="interface in org.jfree.data.general">HeatMapDataset</a>&nbsp;dataset,
  164. int&nbsp;column,
  165. java.lang.Comparable&nbsp;seriesName)</code>
  166. <div class="block">Returns a dataset containing one series that holds a copy of the (y, z)
  167. data from one column (x-index) of the specified dataset.</div>
  168. </td>
  169. </tr>
  170. <tr id="i2" class="altColor">
  171. <td class="colFirst"><code>static <a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a></code></td>
  172. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapUtilities.html#extractRowFromHeatMapDataset-org.jfree.data.general.HeatMapDataset-int-java.lang.Comparable-">extractRowFromHeatMapDataset</a></span>(<a href="../../../../org/jfree/data/general/HeatMapDataset.html" title="interface in org.jfree.data.general">HeatMapDataset</a>&nbsp;dataset,
  173. int&nbsp;row,
  174. java.lang.Comparable&nbsp;seriesName)</code>
  175. <div class="block">Returns a dataset containing one series that holds a copy of the (x, z)
  176. data from one row (y-index) of the specified dataset.</div>
  177. </td>
  178. </tr>
  179. </table>
  180. <ul class="blockList">
  181. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  182. <!-- -->
  183. </a>
  184. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  185. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  186. </ul>
  187. </li>
  188. </ul>
  189. </li>
  190. </ul>
  191. </div>
  192. <div class="details">
  193. <ul class="blockList">
  194. <li class="blockList">
  195. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  196. <ul class="blockList">
  197. <li class="blockList"><a name="constructor.detail">
  198. <!-- -->
  199. </a>
  200. <h3>Constructor Detail</h3>
  201. <a name="HeatMapUtilities--">
  202. <!-- -->
  203. </a>
  204. <ul class="blockListLast">
  205. <li class="blockList">
  206. <h4>HeatMapUtilities</h4>
  207. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/data/general/HeatMapUtilities.html#line.58">HeatMapUtilities</a>()</pre>
  208. </li>
  209. </ul>
  210. </li>
  211. </ul>
  212. <!-- ============ METHOD DETAIL ========== -->
  213. <ul class="blockList">
  214. <li class="blockList"><a name="method.detail">
  215. <!-- -->
  216. </a>
  217. <h3>Method Detail</h3>
  218. <a name="extractRowFromHeatMapDataset-org.jfree.data.general.HeatMapDataset-int-java.lang.Comparable-">
  219. <!-- -->
  220. </a>
  221. <ul class="blockList">
  222. <li class="blockList">
  223. <h4>extractRowFromHeatMapDataset</h4>
  224. <pre>public static&nbsp;<a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a>&nbsp;<a href="../../../../src-html/org/jfree/data/general/HeatMapUtilities.html#line.70">extractRowFromHeatMapDataset</a>(<a href="../../../../org/jfree/data/general/HeatMapDataset.html" title="interface in org.jfree.data.general">HeatMapDataset</a>&nbsp;dataset,
  225. int&nbsp;row,
  226. java.lang.Comparable&nbsp;seriesName)</pre>
  227. <div class="block">Returns a dataset containing one series that holds a copy of the (x, z)
  228. data from one row (y-index) of the specified dataset.</div>
  229. <dl>
  230. <dt><span class="paramLabel">Parameters:</span></dt>
  231. <dd><code>dataset</code> - the dataset (<code>null</code> not permitted).</dd>
  232. <dd><code>row</code> - the row (y) index.</dd>
  233. <dd><code>seriesName</code> - the series name/key (<code>null</code> not permitted).</dd>
  234. <dt><span class="returnLabel">Returns:</span></dt>
  235. <dd>The dataset.</dd>
  236. </dl>
  237. </li>
  238. </ul>
  239. <a name="extractColumnFromHeatMapDataset-org.jfree.data.general.HeatMapDataset-int-java.lang.Comparable-">
  240. <!-- -->
  241. </a>
  242. <ul class="blockList">
  243. <li class="blockList">
  244. <h4>extractColumnFromHeatMapDataset</h4>
  245. <pre>public static&nbsp;<a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a>&nbsp;<a href="../../../../src-html/org/jfree/data/general/HeatMapUtilities.html#line.91">extractColumnFromHeatMapDataset</a>(<a href="../../../../org/jfree/data/general/HeatMapDataset.html" title="interface in org.jfree.data.general">HeatMapDataset</a>&nbsp;dataset,
  246. int&nbsp;column,
  247. java.lang.Comparable&nbsp;seriesName)</pre>
  248. <div class="block">Returns a dataset containing one series that holds a copy of the (y, z)
  249. data from one column (x-index) of the specified dataset.</div>
  250. <dl>
  251. <dt><span class="paramLabel">Parameters:</span></dt>
  252. <dd><code>dataset</code> - the dataset (<code>null</code> not permitted).</dd>
  253. <dd><code>column</code> - the column (x) index.</dd>
  254. <dd><code>seriesName</code> - the series name (<code>null</code> not permitted).</dd>
  255. <dt><span class="returnLabel">Returns:</span></dt>
  256. <dd>The dataset.</dd>
  257. </dl>
  258. </li>
  259. </ul>
  260. <a name="createHeatMapImage-org.jfree.data.general.HeatMapDataset-org.jfree.chart.renderer.PaintScale-">
  261. <!-- -->
  262. </a>
  263. <ul class="blockListLast">
  264. <li class="blockList">
  265. <h4>createHeatMapImage</h4>
  266. <pre>public static&nbsp;java.awt.image.BufferedImage&nbsp;<a href="../../../../src-html/org/jfree/data/general/HeatMapUtilities.html#line.111">createHeatMapImage</a>(<a href="../../../../org/jfree/data/general/HeatMapDataset.html" title="interface in org.jfree.data.general">HeatMapDataset</a>&nbsp;dataset,
  267. <a href="../../../../org/jfree/chart/renderer/PaintScale.html" title="interface in org.jfree.chart.renderer">PaintScale</a>&nbsp;paintScale)</pre>
  268. <div class="block">Creates an image that displays the values from the specified dataset.</div>
  269. <dl>
  270. <dt><span class="paramLabel">Parameters:</span></dt>
  271. <dd><code>dataset</code> - the dataset (<code>null</code> not permitted).</dd>
  272. <dd><code>paintScale</code> - the paint scale for the z-values (<code>null</code>
  273. not permitted).</dd>
  274. <dt><span class="returnLabel">Returns:</span></dt>
  275. <dd>A buffered image.</dd>
  276. </dl>
  277. </li>
  278. </ul>
  279. </li>
  280. </ul>
  281. </li>
  282. </ul>
  283. </div>
  284. </div>
  285. <!-- ========= END OF CLASS DATA ========= -->
  286. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  287. <div class="bottomNav"><a name="navbar.bottom">
  288. <!-- -->
  289. </a>
  290. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  291. <a name="navbar.bottom.firstrow">
  292. <!-- -->
  293. </a>
  294. <ul class="navList" title="Navigation">
  295. <li><a href="../../../../overview-summary.html">Overview</a></li>
  296. <li><a href="package-summary.html">Package</a></li>
  297. <li class="navBarCell1Rev">Class</li>
  298. <li><a href="class-use/HeatMapUtilities.html">Use</a></li>
  299. <li><a href="package-tree.html">Tree</a></li>
  300. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  301. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  302. <li><a href="../../../../help-doc.html">Help</a></li>
  303. </ul>
  304. </div>
  305. <div class="subNav">
  306. <ul class="navList">
  307. <li><a href="../../../../org/jfree/data/general/HeatMapDataset.html" title="interface in org.jfree.data.general"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  308. <li><a href="../../../../org/jfree/data/general/KeyedValueDataset.html" title="interface in org.jfree.data.general"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  309. </ul>
  310. <ul class="navList">
  311. <li><a href="../../../../index.html?org/jfree/data/general/HeatMapUtilities.html" target="_top">Frames</a></li>
  312. <li><a href="HeatMapUtilities.html" target="_top">No&nbsp;Frames</a></li>
  313. </ul>
  314. <ul class="navList" id="allclasses_navbar_bottom">
  315. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  316. </ul>
  317. <div>
  318. <script type="text/javascript"><!--
  319. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  320. if(window==top) {
  321. allClassesLink.style.display = "block";
  322. }
  323. else {
  324. allClassesLink.style.display = "none";
  325. }
  326. //-->
  327. </script>
  328. </div>
  329. <div>
  330. <ul class="subNavList">
  331. <li>Summary:&nbsp;</li>
  332. <li>Nested&nbsp;|&nbsp;</li>
  333. <li>Field&nbsp;|&nbsp;</li>
  334. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  335. <li><a href="#method.summary">Method</a></li>
  336. </ul>
  337. <ul class="subNavList">
  338. <li>Detail:&nbsp;</li>
  339. <li>Field&nbsp;|&nbsp;</li>
  340. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  341. <li><a href="#method.detail">Method</a></li>
  342. </ul>
  343. </div>
  344. <a name="skip.navbar.bottom">
  345. <!-- -->
  346. </a></div>
  347. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  348. </body>
  349. </html>