123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897 |
- <!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:32 CEST 2014 -->
- <title>CrosshairState (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="CrosshairState (JFreeChart Class Library (version 1.0.19-fx))";
- }
- }
- catch(err) {
- }
- //-->
- var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":42,"i8":42,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":42,"i17":10,"i18":42,"i19":10,"i20":42,"i21":10};
- var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/CrosshairState.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/chart/plot/Crosshair.html" title="class in org.jfree.chart.plot"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../../org/jfree/chart/plot/DatasetRenderingOrder.html" title="class in org.jfree.chart.plot"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../index.html?org/jfree/chart/plot/CrosshairState.html" target="_top">Frames</a></li>
- <li><a href="CrosshairState.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><a href="#constructor.summary">Constr</a> | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li><a href="#constructor.detail">Constr</a> | </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.chart.plot</div>
- <h2 title="Class CrosshairState" class="title">Class CrosshairState</h2>
- </div>
- <div class="contentContainer">
- <ul class="inheritance">
- <li>java.lang.Object</li>
- <li>
- <ul class="inheritance">
- <li>org.jfree.chart.plot.CrosshairState</li>
- </ul>
- </li>
- </ul>
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <dl>
- <dt>Direct Known Subclasses:</dt>
- <dd><a href="../../../../org/jfree/chart/plot/CategoryCrosshairState.html" title="class in org.jfree.chart.plot">CategoryCrosshairState</a>, <a href="../../../../org/jfree/chart/plot/XYCrosshairState.html" title="class in org.jfree.chart.plot">XYCrosshairState</a></dd>
- </dl>
- <hr>
- <br>
- <pre>public class <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.61">CrosshairState</a>
- extends java.lang.Object</pre>
- <div class="block">Maintains state information about crosshairs on a plot between successive
- calls to the renderer's draw method. This class is used internally by
- JFreeChart - it is not intended for external use.</div>
- </li>
- </ul>
- </div>
- <div class="summary">
- <ul class="blockList">
- <li class="blockList">
- <!-- ======== CONSTRUCTOR SUMMARY ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.summary">
- <!-- -->
- </a>
- <h3>Constructor Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
- <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colOne" scope="col">Constructor and Description</th>
- </tr>
- <tr class="altColor">
- <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/CrosshairState.html#CrosshairState--">CrosshairState</a></span>()</code>
- <div class="block">Creates a new <code>CrosshairState</code> instance that calculates
- distance in Java2D space.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/CrosshairState.html#CrosshairState-boolean-">CrosshairState</a></span>(boolean calculateDistanceInDataSpace)</code>
- <div class="block">Creates a new <code>CrosshairState</code> instance.</div>
- </td>
- </tr>
- </table>
- </li>
- </ul>
- <!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>java.awt.geom.Point2D</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/CrosshairState.html#getAnchor--">getAnchor</a></span>()</code>
- <div class="block">Returns the anchor point.</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/chart/plot/CrosshairState.html#getAnchorX--">getAnchorX</a></span>()</code>
- <div class="block">Returns the x-coordinate (in data space) for the anchor point.</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/chart/plot/CrosshairState.html#getAnchorY--">getAnchorY</a></span>()</code>
- <div class="block">Returns the y-coordinate (in data space) for the anchor point.</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/chart/plot/CrosshairState.html#getCrosshairDistance--">getCrosshairDistance</a></span>()</code>
- <div class="block">Returns the distance between the anchor point and the current crosshair
- point.</div>
- </td>
- </tr>
- <tr id="i4" class="altColor">
- <td class="colFirst"><code>double</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/CrosshairState.html#getCrosshairX--">getCrosshairX</a></span>()</code>
- <div class="block">Get the x-value for the crosshair point.</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/chart/plot/CrosshairState.html#getCrosshairY--">getCrosshairY</a></span>()</code>
- <div class="block">Get the y-value for the crosshair point.</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/chart/plot/CrosshairState.html#getDatasetIndex--">getDatasetIndex</a></span>()</code>
- <div class="block">Returns the dataset index that the crosshair values relate to.</div>
- </td>
- </tr>
- <tr id="i7" class="rowColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/CrosshairState.html#getDomainAxisIndex--">getDomainAxisIndex</a></span>()</code>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">As of version 1.0.11, the domain axis should be determined
- using the dataset index.</span></div>
- </div>
- </td>
- </tr>
- <tr id="i8" class="altColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/CrosshairState.html#getRangeAxisIndex--">getRangeAxisIndex</a></span>()</code>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">As of version 1.0.11, the domain axis should be determined
- using the dataset index.</span></div>
- </div>
- </td>
- </tr>
- <tr id="i9" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/CrosshairState.html#setAnchor-java.awt.geom.Point2D-">setAnchor</a></span>(java.awt.geom.Point2D anchor)</code>
- <div class="block">Sets the anchor point.</div>
- </td>
- </tr>
- <tr id="i10" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/CrosshairState.html#setAnchorX-double-">setAnchorX</a></span>(double x)</code>
- <div class="block">Sets the x-coordinate (in data space) for the anchor point.</div>
- </td>
- </tr>
- <tr id="i11" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/CrosshairState.html#setAnchorY-double-">setAnchorY</a></span>(double y)</code>
- <div class="block">Sets the y-coordinate (in data space) for the anchor point.</div>
- </td>
- </tr>
- <tr id="i12" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/CrosshairState.html#setCrosshairDistance-double-">setCrosshairDistance</a></span>(double distance)</code>
- <div class="block">Sets the distance between the anchor point and the current crosshair
- point.</div>
- </td>
- </tr>
- <tr id="i13" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/CrosshairState.html#setCrosshairX-double-">setCrosshairX</a></span>(double x)</code>
- <div class="block">Sets the x coordinate for the crosshair.</div>
- </td>
- </tr>
- <tr id="i14" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/CrosshairState.html#setCrosshairY-double-">setCrosshairY</a></span>(double y)</code>
- <div class="block">Sets the y coordinate for the crosshair.</div>
- </td>
- </tr>
- <tr id="i15" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/CrosshairState.html#setDatasetIndex-int-">setDatasetIndex</a></span>(int index)</code>
- <div class="block">Sets the dataset index that the current crosshair values relate to.</div>
- </td>
- </tr>
- <tr id="i16" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/CrosshairState.html#updateCrosshairPoint-double-double-double-double-org.jfree.chart.plot.PlotOrientation-">updateCrosshairPoint</a></span>(double x,
- double y,
- double transX,
- double transY,
- <a href="../../../../org/jfree/chart/plot/PlotOrientation.html" title="class in org.jfree.chart.plot">PlotOrientation</a> orientation)</code>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">Use <a href="../../../../org/jfree/chart/plot/CrosshairState.html#updateCrosshairPoint-double-double-int-int-double-double-org.jfree.chart.plot.PlotOrientation-"><code>updateCrosshairPoint(double, double, int, int,
- double, double, PlotOrientation)</code></a>. See bug report 1086307.</span></div>
- </div>
- </td>
- </tr>
- <tr id="i17" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/CrosshairState.html#updateCrosshairPoint-double-double-int-int-double-double-org.jfree.chart.plot.PlotOrientation-">updateCrosshairPoint</a></span>(double x,
- double y,
- int domainAxisIndex,
- int rangeAxisIndex,
- double transX,
- double transY,
- <a href="../../../../org/jfree/chart/plot/PlotOrientation.html" title="class in org.jfree.chart.plot">PlotOrientation</a> orientation)</code>
- <div class="block">Evaluates a data point and if it is the closest to the anchor point it
- becomes the new crosshair point.</div>
- </td>
- </tr>
- <tr id="i18" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/CrosshairState.html#updateCrosshairX-double-">updateCrosshairX</a></span>(double candidateX)</code>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">Use <a href="../../../../org/jfree/chart/plot/CrosshairState.html#updateCrosshairX-double-int-"><code>updateCrosshairX(double, int)</code></a>. See bug report
- 1086307.</span></div>
- </div>
- </td>
- </tr>
- <tr id="i19" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/CrosshairState.html#updateCrosshairX-double-int-">updateCrosshairX</a></span>(double candidateX,
- int domainAxisIndex)</code>
- <div class="block">Evaluates an x-value and if it is the closest to the anchor x-value it
- becomes the new crosshair value.</div>
- </td>
- </tr>
- <tr id="i20" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/CrosshairState.html#updateCrosshairY-double-">updateCrosshairY</a></span>(double candidateY)</code>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span>
- <div class="block"><span class="deprecationComment">Use <a href="../../../../org/jfree/chart/plot/CrosshairState.html#updateCrosshairY-double-int-"><code>updateCrosshairY(double, int)</code></a>. See bug report
- 1086307.</span></div>
- </div>
- </td>
- </tr>
- <tr id="i21" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/plot/CrosshairState.html#updateCrosshairY-double-int-">updateCrosshairY</a></span>(double candidateY,
- int rangeAxisIndex)</code>
- <div class="block">Evaluates a y-value and if it is the closest to the anchor y-value it
- becomes the new crosshair value.</div>
- </td>
- </tr>
- </table>
- <ul class="blockList">
- <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
- <!-- -->
- </a>
- <h3>Methods inherited from class java.lang.Object</h3>
- <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- <div class="details">
- <ul class="blockList">
- <li class="blockList">
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.detail">
- <!-- -->
- </a>
- <h3>Constructor Detail</h3>
- <a name="CrosshairState--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>CrosshairState</h4>
- <pre>public <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.118">CrosshairState</a>()</pre>
- <div class="block">Creates a new <code>CrosshairState</code> instance that calculates
- distance in Java2D space.</div>
- </li>
- </ul>
- <a name="CrosshairState-boolean-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>CrosshairState</h4>
- <pre>public <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.129">CrosshairState</a>(boolean calculateDistanceInDataSpace)</pre>
- <div class="block">Creates a new <code>CrosshairState</code> instance.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>calculateDistanceInDataSpace</code> - a flag that controls whether the
- distance is calculated in data
- space or Java2D space.</dd>
- </dl>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ============ METHOD DETAIL ========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a name="getCrosshairDistance--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getCrosshairDistance</h4>
- <pre>public double <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.142">getCrosshairDistance</a>()</pre>
- <div class="block">Returns the distance between the anchor point and the current crosshair
- point.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The distance.</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>1.0.3</dd>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../org/jfree/chart/plot/CrosshairState.html#setCrosshairDistance-double-"><code>setCrosshairDistance(double)</code></a></dd>
- </dl>
- </li>
- </ul>
- <a name="setCrosshairDistance-double-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setCrosshairDistance</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.156">setCrosshairDistance</a>(double distance)</pre>
- <div class="block">Sets the distance between the anchor point and the current crosshair
- point. As each data point is processed, its distance to the anchor
- point is compared with this value and, if it is closer, the data point
- becomes the new crosshair point.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>distance</code> - the distance.</dd>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../org/jfree/chart/plot/CrosshairState.html#getCrosshairDistance--"><code>getCrosshairDistance()</code></a></dd>
- </dl>
- </li>
- </ul>
- <a name="updateCrosshairPoint-double-double-double-double-org.jfree.chart.plot.PlotOrientation-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>updateCrosshairPoint</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.179">updateCrosshairPoint</a>(double x,
- double y,
- double transX,
- double transY,
- <a href="../../../../org/jfree/chart/plot/PlotOrientation.html" title="class in org.jfree.chart.plot">PlotOrientation</a> orientation)</pre>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../org/jfree/chart/plot/CrosshairState.html#updateCrosshairPoint-double-double-int-int-double-double-org.jfree.chart.plot.PlotOrientation-"><code>updateCrosshairPoint(double, double, int, int,
- double, double, PlotOrientation)</code></a>. See bug report 1086307.</span></div>
- <div class="block">Evaluates a data point and if it is the closest to the anchor point it
- becomes the new crosshair point.
- <P>
- To understand this method, you need to know the context in which it will
- be called. An instance of this class is passed to an
- <a href="../../../../org/jfree/chart/renderer/xy/XYItemRenderer.html" title="interface in org.jfree.chart.renderer.xy"><code>XYItemRenderer</code></a> as
- each data point is plotted. As the point is plotted, it is passed to
- this method to see if it should be the new crosshair point.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>x</code> - x coordinate (measured against the domain axis).</dd>
- <dd><code>y</code> - y coordinate (measured against the range axis).</dd>
- <dd><code>transX</code> - x translated into Java2D space.</dd>
- <dd><code>transY</code> - y translated into Java2D space.</dd>
- <dd><code>orientation</code> - the plot orientation.</dd>
- </dl>
- </li>
- </ul>
- <a name="updateCrosshairPoint-double-double-int-int-double-double-org.jfree.chart.plot.PlotOrientation-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>updateCrosshairPoint</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.205">updateCrosshairPoint</a>(double x,
- double y,
- int domainAxisIndex,
- int rangeAxisIndex,
- double transX,
- double transY,
- <a href="../../../../org/jfree/chart/plot/PlotOrientation.html" title="class in org.jfree.chart.plot">PlotOrientation</a> orientation)</pre>
- <div class="block">Evaluates a data point and if it is the closest to the anchor point it
- becomes the new crosshair point.
- <P>
- To understand this method, you need to know the context in which it will
- be called. An instance of this class is passed to an
- <a href="../../../../org/jfree/chart/renderer/xy/XYItemRenderer.html" title="interface in org.jfree.chart.renderer.xy"><code>XYItemRenderer</code></a> as
- each data point is plotted. As the point is plotted, it is passed to
- this method to see if it should be the new crosshair point.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>x</code> - x coordinate (measured against the domain axis).</dd>
- <dd><code>y</code> - y coordinate (measured against the range axis).</dd>
- <dd><code>domainAxisIndex</code> - the index of the domain axis for this point.</dd>
- <dd><code>rangeAxisIndex</code> - the index of the range axis for this point.</dd>
- <dd><code>transX</code> - x translated into Java2D space.</dd>
- <dd><code>transY</code> - y translated into Java2D space.</dd>
- <dd><code>orientation</code> - the plot orientation.</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>1.0.4</dd>
- </dl>
- </li>
- </ul>
- <a name="updateCrosshairX-double-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>updateCrosshairX</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.250">updateCrosshairX</a>(double candidateX)</pre>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../org/jfree/chart/plot/CrosshairState.html#updateCrosshairX-double-int-"><code>updateCrosshairX(double, int)</code></a>. See bug report
- 1086307.</span></div>
- <div class="block">Evaluates an x-value and if it is the closest to the anchor x-value it
- becomes the new crosshair value.
- <P>
- Used in cases where only the x-axis is numerical.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>candidateX</code> - x position of the candidate for the new crosshair
- point.</dd>
- </dl>
- </li>
- </ul>
- <a name="updateCrosshairX-double-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>updateCrosshairX</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.266">updateCrosshairX</a>(double candidateX,
- int domainAxisIndex)</pre>
- <div class="block">Evaluates an x-value and if it is the closest to the anchor x-value it
- becomes the new crosshair value.
- <P>
- Used in cases where only the x-axis is numerical.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>candidateX</code> - x position of the candidate for the new crosshair
- point.</dd>
- <dd><code>domainAxisIndex</code> - the index of the domain axis for this x-value.</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>1.0.4</dd>
- </dl>
- </li>
- </ul>
- <a name="updateCrosshairY-double-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>updateCrosshairY</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.289">updateCrosshairY</a>(double candidateY)</pre>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../org/jfree/chart/plot/CrosshairState.html#updateCrosshairY-double-int-"><code>updateCrosshairY(double, int)</code></a>. See bug report
- 1086307.</span></div>
- <div class="block">Evaluates a y-value and if it is the closest to the anchor y-value it
- becomes the new crosshair value.
- <P>
- Used in cases where only the y-axis is numerical.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>candidateY</code> - y position of the candidate for the new crosshair
- point.</dd>
- </dl>
- </li>
- </ul>
- <a name="updateCrosshairY-double-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>updateCrosshairY</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.305">updateCrosshairY</a>(double candidateY,
- int rangeAxisIndex)</pre>
- <div class="block">Evaluates a y-value and if it is the closest to the anchor y-value it
- becomes the new crosshair value.
- <P>
- Used in cases where only the y-axis is numerical.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>candidateY</code> - y position of the candidate for the new crosshair
- point.</dd>
- <dd><code>rangeAxisIndex</code> - the index of the range axis for this y-value.</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>1.0.4</dd>
- </dl>
- </li>
- </ul>
- <a name="getAnchor--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getAnchor</h4>
- <pre>public java.awt.geom.Point2D <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.324">getAnchor</a>()</pre>
- <div class="block">Returns the anchor point.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The anchor point.</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>1.0.3</dd>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../org/jfree/chart/plot/CrosshairState.html#setAnchor-java.awt.geom.Point2D-"><code>setAnchor(Point2D)</code></a></dd>
- </dl>
- </li>
- </ul>
- <a name="setAnchor-java.awt.geom.Point2D-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setAnchor</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.341">setAnchor</a>(java.awt.geom.Point2D anchor)</pre>
- <div class="block">Sets the anchor point. This is usually the mouse click point in a chart
- panel, and the crosshair point will often be the data item that is
- closest to the anchor point.
- <br><br>
- Note that the x and y coordinates (in data space) are not updated by
- this method - the caller is responsible for ensuring that this happens
- in sync.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>anchor</code> - the anchor point (<code>null</code> permitted).</dd>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../org/jfree/chart/plot/CrosshairState.html#getAnchor--"><code>getAnchor()</code></a></dd>
- </dl>
- </li>
- </ul>
- <a name="getAnchorX--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getAnchorX</h4>
- <pre>public double <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.352">getAnchorX</a>()</pre>
- <div class="block">Returns the x-coordinate (in data space) for the anchor point.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The x-coordinate of the anchor point.</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>1.0.3</dd>
- </dl>
- </li>
- </ul>
- <a name="setAnchorX-double-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setAnchorX</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.365">setAnchorX</a>(double x)</pre>
- <div class="block">Sets the x-coordinate (in data space) for the anchor point. Note that
- this does NOT update the anchor itself - the caller is responsible for
- ensuring this is done in sync.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>x</code> - the x-coordinate.</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>1.0.3</dd>
- </dl>
- </li>
- </ul>
- <a name="getAnchorY--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getAnchorY</h4>
- <pre>public double <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.376">getAnchorY</a>()</pre>
- <div class="block">Returns the y-coordinate (in data space) for the anchor point.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The y-coordinate of teh anchor point.</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>1.0.3</dd>
- </dl>
- </li>
- </ul>
- <a name="setAnchorY-double-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setAnchorY</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.389">setAnchorY</a>(double y)</pre>
- <div class="block">Sets the y-coordinate (in data space) for the anchor point. Note that
- this does NOT update the anchor itself - the caller is responsible for
- ensuring this is done in sync.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>y</code> - the y-coordinate.</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>1.0.3</dd>
- </dl>
- </li>
- </ul>
- <a name="getCrosshairX--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getCrosshairX</h4>
- <pre>public double <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.400">getCrosshairX</a>()</pre>
- <div class="block">Get the x-value for the crosshair point.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The x position of the crosshair point.</dd>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../org/jfree/chart/plot/CrosshairState.html#setCrosshairX-double-"><code>setCrosshairX(double)</code></a></dd>
- </dl>
- </li>
- </ul>
- <a name="setCrosshairX-double-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setCrosshairX</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.415">setCrosshairX</a>(double x)</pre>
- <div class="block">Sets the x coordinate for the crosshair. This is the coordinate in data
- space measured against the domain axis.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>x</code> - the coordinate.</dd>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../org/jfree/chart/plot/CrosshairState.html#getCrosshairX--"><code>getCrosshairX()</code></a>,
- <a href="../../../../org/jfree/chart/plot/CrosshairState.html#setCrosshairY-double-"><code>setCrosshairY(double)</code></a>,
- <a href="../../../../org/jfree/chart/plot/CrosshairState.html#updateCrosshairPoint-double-double-double-double-org.jfree.chart.plot.PlotOrientation-"><code>updateCrosshairPoint(double, double, double, double,
- PlotOrientation)</code></a></dd>
- </dl>
- </li>
- </ul>
- <a name="getCrosshairY--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getCrosshairY</h4>
- <pre>public double <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.427">getCrosshairY</a>()</pre>
- <div class="block">Get the y-value for the crosshair point. This is the coordinate in data
- space measured against the range axis.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The y position of the crosshair point.</dd>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../org/jfree/chart/plot/CrosshairState.html#setCrosshairY-double-"><code>setCrosshairY(double)</code></a></dd>
- </dl>
- </li>
- </ul>
- <a name="setCrosshairY-double-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setCrosshairY</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.441">setCrosshairY</a>(double y)</pre>
- <div class="block">Sets the y coordinate for the crosshair.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>y</code> - the y coordinate.</dd>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../org/jfree/chart/plot/CrosshairState.html#getCrosshairY--"><code>getCrosshairY()</code></a>,
- <a href="../../../../org/jfree/chart/plot/CrosshairState.html#setCrosshairX-double-"><code>setCrosshairX(double)</code></a>,
- <a href="../../../../org/jfree/chart/plot/CrosshairState.html#updateCrosshairPoint-double-double-double-double-org.jfree.chart.plot.PlotOrientation-"><code>updateCrosshairPoint(double, double, double, double,
- PlotOrientation)</code></a></dd>
- </dl>
- </li>
- </ul>
- <a name="getDatasetIndex--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getDatasetIndex</h4>
- <pre>public int <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.456">getDatasetIndex</a>()</pre>
- <div class="block">Returns the dataset index that the crosshair values relate to. The
- dataset is mapped to specific axes, and this is how the crosshairs are
- mapped also.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The dataset index.</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>1.0.11</dd>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../org/jfree/chart/plot/CrosshairState.html#setDatasetIndex-int-"><code>setDatasetIndex(int)</code></a></dd>
- </dl>
- </li>
- </ul>
- <a name="setDatasetIndex-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>setDatasetIndex</h4>
- <pre>public void <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.469">setDatasetIndex</a>(int index)</pre>
- <div class="block">Sets the dataset index that the current crosshair values relate to.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>index</code> - the dataset index.</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>1.0.11</dd>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../org/jfree/chart/plot/CrosshairState.html#getDatasetIndex--"><code>getDatasetIndex()</code></a></dd>
- </dl>
- </li>
- </ul>
- <a name="getDomainAxisIndex--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getDomainAxisIndex</h4>
- <pre>public int <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.483">getDomainAxisIndex</a>()</pre>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">As of version 1.0.11, the domain axis should be determined
- using the dataset index.</span></div>
- <div class="block">Returns the domain axis index for the crosshair x-value.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The domain axis index.</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>1.0.4</dd>
- </dl>
- </li>
- </ul>
- <a name="getRangeAxisIndex--">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>getRangeAxisIndex</h4>
- <pre>public int <a href="../../../../src-html/org/jfree/chart/plot/CrosshairState.html#line.497">getRangeAxisIndex</a>()</pre>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">As of version 1.0.11, the domain axis should be determined
- using the dataset index.</span></div>
- <div class="block">Returns the range axis index for the crosshair y-value.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The range axis index.</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>1.0.4</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/CrosshairState.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/chart/plot/Crosshair.html" title="class in org.jfree.chart.plot"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../../org/jfree/chart/plot/DatasetRenderingOrder.html" title="class in org.jfree.chart.plot"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../index.html?org/jfree/chart/plot/CrosshairState.html" target="_top">Frames</a></li>
- <li><a href="CrosshairState.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><a href="#constructor.summary">Constr</a> | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li><a href="#constructor.detail">Constr</a> | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.bottom">
- <!-- -->
- </a></div>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- </body>
- </html>
|