<h2>org.das2.event.BoxSelectionEvent</h2><p>This is the range analog to the DataPointSelectionEvent. The DataPointSelectionEvent is a point, and this is a box. Note that it's acceptable to have null xrange and yrange, so that the same code can support a variety of applications. It's left to the programmer to see that these are used consistently.</p> <h2>BoxSelectionEvent( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html'>Object</a> source, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/DatumRange.html'>DatumRange</a> xrange, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/DatumRange.html'>DatumRange</a> yrange )</h2> <p>create the BoxSelectionEvent with additional planes of data.</p> <h2>BoxSelectionEvent( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html'>Object</a> source, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/DatumRange.html'>DatumRange</a> xrange, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/DatumRange.html'>DatumRange</a> yrange, <a href='https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html'>java.util.HashMap</a> planes )</h2> <p>create the BoxSelectionEvent with additional planes of data.</p> <hr> <a name="getDataSet"></a> <h2>getDataSet</h2> getDataSet( ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qds/QDataSet.html'>QDataSet</a> <p>get the dataset attached to this event.</p> <h3>Returns:</h3> the dataset attached to this event. <br><br> <a href="https://github.com/autoplot/dev/search?q=getDataSet&unscoped_q=getDataSet">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectionEvent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectionEvent.html#getDataSet">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectionEvent.java">[view source]</a> <br> <br> <hr> <a name="getFinishX"></a> <h2>getFinishX</h2> getFinishX( ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a> <p>get the X coordinate of the mouse button release</p> <h3>Returns:</h3> the release coordinate X <br><br> <a href="https://github.com/autoplot/dev/search?q=getFinishX&unscoped_q=getFinishX">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectionEvent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectionEvent.html#getFinishX">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectionEvent.java">[view source]</a> <br> <br> <hr> <a name="getFinishY"></a> <h2>getFinishY</h2> getFinishY( ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a> <p>get the Y coordinate of the mouse button release</p> <h3>Returns:</h3> the release coordinate Y <br><br> <a href="https://github.com/autoplot/dev/search?q=getFinishY&unscoped_q=getFinishY">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectionEvent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectionEvent.html#getFinishY">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectionEvent.java">[view source]</a> <br> <br> <hr> <a name="getPlane"></a> <h2>getPlane</h2> getPlane( <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> plane ) → <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html'>Object</a> <p>get the data attached to the plane name. This allows applications to attach additional data to the event. For example, the BoxSelectorMouseModule attaches the key pressed.</p> <h3>Parameters</h3> plane - a String <h3>Returns:</h3> the value associated with the plane, or null. <br><br> <a href="https://github.com/autoplot/dev/search?q=getPlane&unscoped_q=getPlane">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectionEvent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectionEvent.html#getPlane">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectionEvent.java">[view source]</a> <br> <br> <hr> <a name="getPlaneIds"></a> <h2>getPlaneIds</h2> getPlaneIds( ) → <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String[]</a> <p>return the list of additional data planes attached to this event.</p> <h3>Returns:</h3> a String[] <br><br> <a href="https://github.com/autoplot/dev/search?q=getPlaneIds&unscoped_q=getPlaneIds">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectionEvent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectionEvent.html#getPlaneIds">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectionEvent.java">[view source]</a> <br> <br> <hr> <a name="getStartX"></a> <h2>getStartX</h2> getStartX( ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a> <p>get the X coordinate or the mouse button press</p> <h3>Returns:</h3> the X coordinate or the mouse button press <br><br> <a href="https://github.com/autoplot/dev/search?q=getStartX&unscoped_q=getStartX">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectionEvent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectionEvent.html#getStartX">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectionEvent.java">[view source]</a> <br> <br> <hr> <a name="getStartY"></a> <h2>getStartY</h2> getStartY( ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a> <p>get the Y coordinate or the mouse button press</p> <h3>Returns:</h3> the Y coordinate or the mouse button press <br><br> <a href="https://github.com/autoplot/dev/search?q=getStartY&unscoped_q=getStartY">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectionEvent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectionEvent.html#getStartY">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectionEvent.java">[view source]</a> <br> <br> <hr> <a name="getXRange"></a> <h2>getXRange</h2> getXRange( ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/DatumRange.html'>DatumRange</a> <p>get the X data range of the gesture</p> <h3>Returns:</h3> the X data range of the gesture <br><br> <a href="https://github.com/autoplot/dev/search?q=getXRange&unscoped_q=getXRange">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectionEvent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectionEvent.html#getXRange">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectionEvent.java">[view source]</a> <br> <br> <hr> <a name="getYRange"></a> <h2>getYRange</h2> getYRange( ) → <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/DatumRange.html'>DatumRange</a> <p>get the Y data range of the gesture</p> <h3>Returns:</h3> the Y data range of the gesture <br><br> <a href="https://github.com/autoplot/dev/search?q=getYRange&unscoped_q=getYRange">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectionEvent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectionEvent.html#getYRange">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectionEvent.java">[view source]</a> <br> <br> <hr> <a name="setDataSet"></a> <h2>setDataSet</h2> setDataSet( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/qds/QDataSet.html'>QDataSet</a> ds ) → void <p>attach a dataset to this event.</p> <h3>Parameters</h3> ds - a dataset for this event. <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=setDataSet&unscoped_q=setDataSet">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectionEvent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectionEvent.html#setDataSet">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectionEvent.java">[view source]</a> <br> <br> <hr> <a name="setFinish"></a> <h2>setFinish</h2> setFinish( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a> x, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a> y ) → void <p>set the end coordinates of the mouse release.</p> <h3>Parameters</h3> x - the release coordinate X <br> y - the release coordinate Y <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=setFinish&unscoped_q=setFinish">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectionEvent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectionEvent.html#setFinish">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectionEvent.java">[view source]</a> <br> <br> <hr> <a name="setStart"></a> <h2>setStart</h2> setStart( <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a> x, <a href='http://www-pw.physics.uiowa.edu/~jbf/autoplot/doc/org/das2/datum/Datum.html'>Datum</a> y ) → void <p>set the coordinates of the mouse button press</p> <h3>Parameters</h3> x - the x coordinate <br> y - the y coordinate <h3>Returns:</h3> void (returns nothing) <br><br> <a href="https://github.com/autoplot/dev/search?q=setStart&unscoped_q=setStart">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectionEvent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectionEvent.html#setStart">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectionEvent.java">[view source]</a> <br> <br> <hr> <a name="toString"></a> <h2>toString</h2> toString( ) → <a href='https://docs.oracle.com/javase/8/docs/api/java/lang/String.html'>String</a> <p></p> <h3>Returns:</h3> java.lang.String <br><br> <a href="https://github.com/autoplot/dev/search?q=toString&unscoped_q=toString">[search for examples]</a> <a href="https://github.com/autoplot/documentation/tree/master/javadoc/org/das2/event/BoxSelectionEvent.md">[view on GitHub]</a> <a href="http://www-pw.physics.uiowa.edu/~jbf/autoplot/javadoc2018/org/das2/event/BoxSelectionEvent.html#toString">[view on old javadoc]</a> <a href="https://saturn.physics.uiowa.edu/svn/das2/dasCore/community/autoplot2011/trunk/dasCore/src/org/das2/event/BoxSelectionEvent.java">[view source]</a> <br> <br>