123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455 |
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!-- NewPage -->
- <html lang="en">
- <head>
- <!-- Generated by javadoc (1.8.0_05) on Thu Jul 31 14:50:42 CEST 2014 -->
- <title>HeatMapDataset (JFreeChart Class Library (version 1.0.19-fx))</title>
- <meta name="date" content="2014-07-31">
- <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
- <script type="text/javascript" src="../../../../script.js"></script>
- </head>
- <body>
- <script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="HeatMapDataset (JFreeChart Class Library (version 1.0.19-fx))";
- }
- }
- catch(err) {
- }
- //-->
- var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6};
- var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
- var altColor = "altColor";
- var rowColor = "rowColor";
- var tableTab = "tableTab";
- var activeTableTab = "activeTableTab";
- </script>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- <!-- ========= START OF TOP NAVBAR ======= -->
- <div class="topNav"><a name="navbar.top">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.top.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="class-use/HeatMapDataset.html">Use</a></li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../../index-files/index-1.html">Index</a></li>
- <li><a href="../../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../../org/jfree/data/general/DefaultValueDataset.html" title="class in org.jfree.data.general"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../../org/jfree/data/general/HeatMapUtilities.html" title="class in org.jfree.data.general"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../index.html?org/jfree/data/general/HeatMapDataset.html" target="_top">Frames</a></li>
- <li><a href="HeatMapDataset.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_top">
- <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_top");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.top">
- <!-- -->
- </a></div>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <!-- ======== START OF CLASS DATA ======== -->
- <div class="header">
- <div class="subTitle">org.jfree.data.general</div>
- <h2 title="Interface HeatMapDataset" class="title">Interface HeatMapDataset</h2>
- </div>
- <div class="contentContainer">
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <dl>
- <dt>All Known Implementing Classes:</dt>
- <dd><a href="../../../../org/jfree/data/general/DefaultHeatMapDataset.html" title="class in org.jfree.data.general">DefaultHeatMapDataset</a></dd>
- </dl>
- <hr>
- <br>
- <pre>public interface <a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.50">HeatMapDataset</a></pre>
- <div class="block">A dataset that represents a rectangular grid of (x, y, z) values. The x
- and y values appear at regular intervals in the dataset, while the z-values
- can take any value (including <code>null</code> for unknown values).</div>
- <dl>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>1.0.13</dd>
- </dl>
- </li>
- </ul>
- </div>
- <div class="summary">
- <ul class="blockList">
- <li class="blockList">
- <!-- ========== METHOD SUMMARY =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.summary">
- <!-- -->
- </a>
- <h3>Method Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
- <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Method and Description</th>
- </tr>
- <tr id="i0" class="altColor">
- <td class="colFirst"><code>double</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getMaximumXValue--">getMaximumXValue</a></span>()</code>
- <div class="block">Returns the highest x-value represented in this dataset.</div>
- </td>
- </tr>
- <tr id="i1" class="rowColor">
- <td class="colFirst"><code>double</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getMaximumYValue--">getMaximumYValue</a></span>()</code>
- <div class="block">Returns the highest y-value represented in this dataset.</div>
- </td>
- </tr>
- <tr id="i2" class="altColor">
- <td class="colFirst"><code>double</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getMinimumXValue--">getMinimumXValue</a></span>()</code>
- <div class="block">Returns the lowest x-value represented in this dataset.</div>
- </td>
- </tr>
- <tr id="i3" class="rowColor">
- <td class="colFirst"><code>double</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getMinimumYValue--">getMinimumYValue</a></span>()</code>
- <div class="block">Returns the lowest y-value represented in this dataset.</div>
- </td>
- </tr>
- <tr id="i4" class="altColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getXSampleCount--">getXSampleCount</a></span>()</code>
- <div class="block">Returns the number of x values across the width of the dataset.</div>
- </td>
- </tr>
- <tr id="i5" class="rowColor">
- <td class="colFirst"><code>double</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getXValue-int-">getXValue</a></span>(int xIndex)</code>
- <div class="block">A convenience method that returns the x-value for the given index.</div>
- </td>
- </tr>
- <tr id="i6" class="altColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getYSampleCount--">getYSampleCount</a></span>()</code>
- <div class="block">Returns the number of y values (or samples) for the dataset.</div>
- </td>
- </tr>
- <tr id="i7" class="rowColor">
- <td class="colFirst"><code>double</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getYValue-int-">getYValue</a></span>(int yIndex)</code>
- <div class="block">A convenience method that returns the y-value for the given index.</div>
- </td>
- </tr>
- <tr id="i8" class="altColor">
- <td class="colFirst"><code>java.lang.Number</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getZ-int-int-">getZ</a></span>(int xIndex,
- int yIndex)</code>
- <div class="block">Returns the z-value at the specified sample position in the dataset.</div>
- </td>
- </tr>
- <tr id="i9" class="rowColor">
- <td class="colFirst"><code>double</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/general/HeatMapDataset.html#getZValue-int-int-">getZValue</a></span>(int xIndex,
- int yIndex)</code>
- <div class="block">Returns the z-value at the specified sample position in the dataset.</div>
- </td>
- </tr>
- </table>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- <div class="details">
- <ul class="blockList">
- <li class="blockList">
- <!-- ============ METHOD DETAIL ========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a name="getXSampleCount--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getXSampleCount</h4>
- <pre>int <a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.59">getXSampleCount</a>()</pre>
- <div class="block">Returns the number of x values across the width of the dataset. The
- values are evenly spaced between <a href="../../../../org/jfree/data/general/HeatMapDataset.html#getMinimumXValue--"><code>getMinimumXValue()</code></a> and
- <a href="../../../../org/jfree/data/general/HeatMapDataset.html#getMaximumXValue--"><code>getMaximumXValue()</code></a>.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The number of x-values (always > 0).</dd>
- </dl>
- </li>
- </ul>
- <a name="getYSampleCount--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getYSampleCount</h4>
- <pre>int <a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.68">getYSampleCount</a>()</pre>
- <div class="block">Returns the number of y values (or samples) for the dataset. The
- values are evenly spaced between <a href="../../../../org/jfree/data/general/HeatMapDataset.html#getMinimumYValue--"><code>getMinimumYValue()</code></a> and
- <a href="../../../../org/jfree/data/general/HeatMapDataset.html#getMaximumYValue--"><code>getMaximumYValue()</code></a>.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The number of y-values (always > 0).</dd>
- </dl>
- </li>
- </ul>
- <a name="getMinimumXValue--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getMinimumXValue</h4>
- <pre>double <a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.77">getMinimumXValue</a>()</pre>
- <div class="block">Returns the lowest x-value represented in this dataset. A requirement
- of this interface is that this method must never return infinite or
- Double.NAN values.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The lowest x-value represented in this dataset.</dd>
- </dl>
- </li>
- </ul>
- <a name="getMaximumXValue--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getMaximumXValue</h4>
- <pre>double <a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.86">getMaximumXValue</a>()</pre>
- <div class="block">Returns the highest x-value represented in this dataset. A requirement
- of this interface is that this method must never return infinite or
- Double.NAN values.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The highest x-value represented in this dataset.</dd>
- </dl>
- </li>
- </ul>
- <a name="getMinimumYValue--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getMinimumYValue</h4>
- <pre>double <a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.95">getMinimumYValue</a>()</pre>
- <div class="block">Returns the lowest y-value represented in this dataset. A requirement
- of this interface is that this method must never return infinite or
- Double.NAN values.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The lowest y-value represented in this dataset.</dd>
- </dl>
- </li>
- </ul>
- <a name="getMaximumYValue--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getMaximumYValue</h4>
- <pre>double <a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.104">getMaximumYValue</a>()</pre>
- <div class="block">Returns the highest y-value represented in this dataset. A requirement
- of this interface is that this method must never return infinite or
- Double.NAN values.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The highest y-value represented in this dataset.</dd>
- </dl>
- </li>
- </ul>
- <a name="getXValue-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getXValue</h4>
- <pre>double <a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.113">getXValue</a>(int xIndex)</pre>
- <div class="block">A convenience method that returns the x-value for the given index.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>xIndex</code> - the xIndex.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The x-value.</dd>
- </dl>
- </li>
- </ul>
- <a name="getYValue-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getYValue</h4>
- <pre>double <a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.122">getYValue</a>(int yIndex)</pre>
- <div class="block">A convenience method that returns the y-value for the given index.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>yIndex</code> - the yIndex.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The y-value.</dd>
- </dl>
- </li>
- </ul>
- <a name="getZValue-int-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getZValue</h4>
- <pre>double <a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.133">getZValue</a>(int xIndex,
- int yIndex)</pre>
- <div class="block">Returns the z-value at the specified sample position in the dataset.
- For a missing or unknown value, this method should return Double.NAN.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>xIndex</code> - the position of the x sample in the dataset.</dd>
- <dd><code>yIndex</code> - the position of the y sample in the dataset.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The z-value.</dd>
- </dl>
- </li>
- </ul>
- <a name="getZ-int-int-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>getZ</h4>
- <pre>java.lang.Number <a href="../../../../src-html/org/jfree/data/general/HeatMapDataset.html#line.152">getZ</a>(int xIndex,
- int yIndex)</pre>
- <div class="block">Returns the z-value at the specified sample position in the dataset.
- This method can return <code>null</code> to indicate a missing/unknown
- value.
- <br><br>
- Bear in mind that the class implementing this interface may
- store its data using primitives rather than objects, so calling this
- method may require a new <code>Number</code> object to be allocated...
- for this reason, it is generally preferable to use the
- <a href="../../../../org/jfree/data/general/HeatMapDataset.html#getZValue-int-int-"><code>getZValue(int, int)</code></a> method unless you *know* that the dataset
- implementation stores the z-values using objects.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>xIndex</code> - the position of the x sample in the dataset.</dd>
- <dd><code>yIndex</code> - the position of the y sample in the dataset.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The z-value (possibly <code>null</code>).</dd>
- </dl>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- </div>
- <!-- ========= END OF CLASS DATA ========= -->
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <div class="bottomNav"><a name="navbar.bottom">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.bottom.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="class-use/HeatMapDataset.html">Use</a></li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../../index-files/index-1.html">Index</a></li>
- <li><a href="../../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../../org/jfree/data/general/DefaultValueDataset.html" title="class in org.jfree.data.general"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../../org/jfree/data/general/HeatMapUtilities.html" title="class in org.jfree.data.general"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../index.html?org/jfree/data/general/HeatMapDataset.html" target="_top">Frames</a></li>
- <li><a href="HeatMapDataset.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_bottom">
- <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_bottom");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.bottom">
- <!-- -->
- </a></div>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- </body>
- </html>
|