670 lines
37 KiB
HTML
670 lines
37 KiB
HTML
<!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 (version 1.7.0_51) on Wed Apr 06 13:11:04 EDT 2016 -->
|
|
<title>LinearAxis (Parallel Java 2 Library Documentation)</title>
|
|
<meta name="date" content="2016-04-06">
|
|
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="LinearAxis (Parallel Java 2 Library Documentation)";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar_top">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/LinearAxis.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="../../../../../edu/rit/numeric/plot/impl/Label.html" title="class in edu.rit.numeric.plot.impl"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../../edu/rit/numeric/plot/impl/LogarithmicAxis.html" title="class in edu.rit.numeric.plot.impl"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../index.html?edu/rit/numeric/plot/impl/LinearAxis.html" target="_top">Frames</a></li>
|
|
<li><a href="LinearAxis.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><a href="#fields_inherited_from_class_edu.rit.numeric.plot.impl.NumericalAxis">Field</a> | </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">edu.rit.numeric.plot.impl</div>
|
|
<h2 title="Class LinearAxis" class="title">Class LinearAxis</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li><a href="../../../../../edu/rit/numeric/plot/impl/Axis.html" title="class in edu.rit.numeric.plot.impl">edu.rit.numeric.plot.impl.Axis</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li><a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html" title="class in edu.rit.numeric.plot.impl">edu.rit.numeric.plot.impl.NumericalAxis</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>edu.rit.numeric.plot.impl.LinearAxis</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="strong">LinearAxis</span>
|
|
extends <a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html" title="class in edu.rit.numeric.plot.impl">NumericalAxis</a></pre>
|
|
<div class="block">Class LinearAxis provides a linear axis on a plot. The axis goes from a
|
|
starting value to an ending value in a linear fashion.</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Summary</h3>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="fields_inherited_from_class_edu.rit.numeric.plot.impl.NumericalAxis">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Fields inherited from class edu.rit.numeric.plot.impl.<a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html" title="class in edu.rit.numeric.plot.impl">NumericalAxis</a></h3>
|
|
<code><a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html#myTicksAboveOrRight">myTicksAboveOrRight</a>, <a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html#myTicksBelowOrLeft">myTicksBelowOrLeft</a></code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="fields_inherited_from_class_edu.rit.numeric.plot.impl.Axis">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Fields inherited from class edu.rit.numeric.plot.impl.<a href="../../../../../edu/rit/numeric/plot/impl/Axis.html" title="class in edu.rit.numeric.plot.impl">Axis</a></h3>
|
|
<code><a href="../../../../../edu/rit/numeric/plot/impl/Axis.html#DEFAULT_PAINT">DEFAULT_PAINT</a>, <a href="../../../../../edu/rit/numeric/plot/impl/Axis.html#DEFAULT_STROKE">DEFAULT_STROKE</a>, <a href="../../../../../edu/rit/numeric/plot/impl/Axis.html#myLength">myLength</a>, <a href="../../../../../edu/rit/numeric/plot/impl/Axis.html#myPaint">myPaint</a>, <a href="../../../../../edu/rit/numeric/plot/impl/Axis.html#myStroke">myStroke</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="overviewSummary" 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><strong><a href="../../../../../edu/rit/numeric/plot/impl/LinearAxis.html#LinearAxis(double, double, int, int, double, double)">LinearAxis</a></strong>(double theStart,
|
|
double theEnd,
|
|
int theMajorDivisionCount,
|
|
int theMinorDivisionCount,
|
|
double theCrossing,
|
|
double theLength)</code>
|
|
<div class="block">Construct a new linear axis.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colOne"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/LinearAxis.html#LinearAxis(double, double, int, int, double, double, java.awt.Stroke, java.awt.Paint)">LinearAxis</a></strong>(double theStart,
|
|
double theEnd,
|
|
int theMajorDivisionCount,
|
|
int theMinorDivisionCount,
|
|
double theCrossing,
|
|
double theLength,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Stroke.html?is-external=true" title="class or interface in java.awt">Stroke</a> theStroke,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Paint.html?is-external=true" title="class or interface in java.awt">Paint</a> thePaint)</code>
|
|
<div class="block">Construct a new linear axis.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/LinearAxis.html#LinearAxis(double, double, int, int, double, double, java.awt.Stroke, java.awt.Paint, edu.rit.numeric.plot.impl.Ticks, edu.rit.numeric.plot.impl.Ticks)">LinearAxis</a></strong>(double theStart,
|
|
double theEnd,
|
|
int theMajorDivisionCount,
|
|
int theMinorDivisionCount,
|
|
double theCrossing,
|
|
double theLength,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Stroke.html?is-external=true" title="class or interface in java.awt">Stroke</a> theStroke,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Paint.html?is-external=true" title="class or interface in java.awt">Paint</a> thePaint,
|
|
<a href="../../../../../edu/rit/numeric/plot/impl/Ticks.html" title="class in edu.rit.numeric.plot.impl">Ticks</a> theTicksBelowOrLeft,
|
|
<a href="../../../../../edu/rit/numeric/plot/impl/Ticks.html" title="class in edu.rit.numeric.plot.impl">Ticks</a> theTicksAboveOrRight)</code>
|
|
<div class="block">Construct a new linear axis.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colOne"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/LinearAxis.html#LinearAxis(double, double, int, int, double, double, edu.rit.numeric.plot.impl.Ticks, edu.rit.numeric.plot.impl.Ticks)">LinearAxis</a></strong>(double theStart,
|
|
double theEnd,
|
|
int theMajorDivisionCount,
|
|
int theMinorDivisionCount,
|
|
double theCrossing,
|
|
double theLength,
|
|
<a href="../../../../../edu/rit/numeric/plot/impl/Ticks.html" title="class in edu.rit.numeric.plot.impl">Ticks</a> theTicksBelowOrLeft,
|
|
<a href="../../../../../edu/rit/numeric/plot/impl/Ticks.html" title="class in edu.rit.numeric.plot.impl">Ticks</a> theTicksAboveOrRight)</code>
|
|
<div class="block">Construct a new linear axis.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
|
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Method and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static double</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/LinearAxis.html#autoscale(double)">autoscale</a></strong>(double max)</code>
|
|
<div class="block">Determine a pleasing scale for a linear axis.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>double</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/LinearAxis.html#getCrossing()">getCrossing</a></strong>()</code>
|
|
<div class="block">Returns the value of the point where the perpendicular axis crosses this
|
|
axis.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>double</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/LinearAxis.html#getDisplayDistance(double)">getDisplayDistance</a></strong>(double value)</code>
|
|
<div class="block">Returns the distance on the display from the start of this axis to the
|
|
given value.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>double</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/LinearAxis.html#getEnd()">getEnd</a></strong>()</code>
|
|
<div class="block">Returns the ending value of this axis.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>double</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/LinearAxis.html#getMajorDivision(int)">getMajorDivision</a></strong>(int i)</code>
|
|
<div class="block">Returns the value of the given major division.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/LinearAxis.html#getMajorDivisionCount()">getMajorDivisionCount</a></strong>()</code>
|
|
<div class="block">Returns the number of major divisions on this axis.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>double</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/LinearAxis.html#getMinorDivision(int)">getMinorDivision</a></strong>(int i)</code>
|
|
<div class="block">Returns the value of the given minor division.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/LinearAxis.html#getMinorDivisionCount()">getMinorDivisionCount</a></strong>()</code>
|
|
<div class="block">Returns the number of minor divisions on this axis.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>double</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/LinearAxis.html#getStart()">getStart</a></strong>()</code>
|
|
<div class="block">Returns the starting value of this axis.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../../edu/rit/numeric/plot/impl/LinearAxis.html#includesValue(double)">includesValue</a></strong>(double value)</code>
|
|
<div class="block">Returns true if the given value falls within the bounds of this axis,
|
|
false otherwise.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods_inherited_from_class_edu.rit.numeric.plot.impl.NumericalAxis">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class edu.rit.numeric.plot.impl.<a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html" title="class in edu.rit.numeric.plot.impl">NumericalAxis</a></h3>
|
|
<code><a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html#drawHorizontal(java.awt.Graphics2D)">drawHorizontal</a>, <a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html#drawVertical(java.awt.Graphics2D)">drawVertical</a>, <a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html#getTicksAboveOrRight()">getTicksAboveOrRight</a>, <a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html#getTicksBelowOrLeft()">getTicksBelowOrLeft</a></code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods_inherited_from_class_edu.rit.numeric.plot.impl.Axis">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class edu.rit.numeric.plot.impl.<a href="../../../../../edu/rit/numeric/plot/impl/Axis.html" title="class in edu.rit.numeric.plot.impl">Axis</a></h3>
|
|
<code><a href="../../../../../edu/rit/numeric/plot/impl/Axis.html#getLength()">getLength</a>, <a href="../../../../../edu/rit/numeric/plot/impl/Axis.html#getPaint()">getPaint</a>, <a href="../../../../../edu/rit/numeric/plot/impl/Axis.html#getStroke()">getStroke</a></code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
|
|
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></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="LinearAxis(double, double, int, int, double, double)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>LinearAxis</h4>
|
|
<pre>public LinearAxis(double theStart,
|
|
double theEnd,
|
|
int theMajorDivisionCount,
|
|
int theMinorDivisionCount,
|
|
double theCrossing,
|
|
double theLength)</pre>
|
|
<div class="block">Construct a new linear axis. The axis is drawn with the default stroke
|
|
(solid, width=1) and paint (black). There are no tick marks.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theStart</code> - Starting value for this axis.</dd><dd><code>theEnd</code> - Ending value for this axis. It can be greater than or less than
|
|
<TT>theStart</TT>.</dd><dd><code>theMajorDivisionCount</code> - Number of major divisions for this axis.</dd><dd><code>theMinorDivisionCount</code> - Number of minor divisions <I>per major division</I> for this axis.</dd><dd><code>theCrossing</code> - Point at which the perpendicular axis crosses this axis.</dd><dd><code>theLength</code> - Length of this axis on the display.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - (unchecked exception) Thrown if <TT>theStart</TT> equals
|
|
<TT>theEnd</TT>. Thrown if <TT>theMajorDivisionCount</TT> is less
|
|
than 1. Thrown if <TT>theMinorDivisionCount</TT> is less than 1.
|
|
Thrown if <TT>theCrossing</TT> does not fall between
|
|
<TT>theStart</TT> and <TT>theEnd</TT> inclusive. Thrown if
|
|
<TT>theLength</TT> is less than or equal to 0.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="LinearAxis(double, double, int, int, double, double, java.awt.Stroke, java.awt.Paint)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>LinearAxis</h4>
|
|
<pre>public LinearAxis(double theStart,
|
|
double theEnd,
|
|
int theMajorDivisionCount,
|
|
int theMinorDivisionCount,
|
|
double theCrossing,
|
|
double theLength,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Stroke.html?is-external=true" title="class or interface in java.awt">Stroke</a> theStroke,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Paint.html?is-external=true" title="class or interface in java.awt">Paint</a> thePaint)</pre>
|
|
<div class="block">Construct a new linear axis. The axis is drawn with the given stroke and
|
|
paint. There are no tick marks.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theStart</code> - Starting value for this axis.</dd><dd><code>theEnd</code> - Ending value for this axis. It can be greater than or less than
|
|
<TT>theStart</TT>.</dd><dd><code>theMajorDivisionCount</code> - Number of major divisions for this axis.</dd><dd><code>theMinorDivisionCount</code> - Number of minor divisions <I>per major division</I> for this axis.</dd><dd><code>theCrossing</code> - Point at which the perpendicular axis crosses this axis.</dd><dd><code>theLength</code> - Length of this axis on the display.</dd><dd><code>theStroke</code> - Stroke for drawing this axis on the display.</dd><dd><code>thePaint</code> - Paint for drawing this axis on the display.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - (unchecked exception) Thrown if <TT>theStroke</TT> is null or
|
|
<TT>thePaint</TT> is null.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - (unchecked exception) Thrown if <TT>theStart</TT> equals
|
|
<TT>theEnd</TT>. Thrown if <TT>theMajorDivisionCount</TT> is less
|
|
than 1. Thrown if <TT>theMinorDivisionCount</TT> is less than 1.
|
|
Thrown if <TT>theCrossing</TT> does not fall between
|
|
<TT>theStart</TT> and <TT>theEnd</TT> inclusive. Thrown if
|
|
<TT>theLength</TT> is less than or equal to 0.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="LinearAxis(double, double, int, int, double, double, edu.rit.numeric.plot.impl.Ticks, edu.rit.numeric.plot.impl.Ticks)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>LinearAxis</h4>
|
|
<pre>public LinearAxis(double theStart,
|
|
double theEnd,
|
|
int theMajorDivisionCount,
|
|
int theMinorDivisionCount,
|
|
double theCrossing,
|
|
double theLength,
|
|
<a href="../../../../../edu/rit/numeric/plot/impl/Ticks.html" title="class in edu.rit.numeric.plot.impl">Ticks</a> theTicksBelowOrLeft,
|
|
<a href="../../../../../edu/rit/numeric/plot/impl/Ticks.html" title="class in edu.rit.numeric.plot.impl">Ticks</a> theTicksAboveOrRight)</pre>
|
|
<div class="block">Construct a new linear axis. The axis is drawn with the default stroke
|
|
(solid, width=1) and paint (black). There are tick marks on either or
|
|
both sides of the axis.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theStart</code> - Starting value for this axis.</dd><dd><code>theEnd</code> - Ending value for this axis. It can be greater than or less than
|
|
<TT>theStart</TT>.</dd><dd><code>theMajorDivisionCount</code> - Number of major divisions for this axis.</dd><dd><code>theMinorDivisionCount</code> - Number of minor divisions <I>per major division</I> for this axis.</dd><dd><code>theCrossing</code> - Point at which the perpendicular axis crosses this axis.</dd><dd><code>theLength</code> - Length of this axis on the display.</dd><dd><code>theTicksBelowOrLeft</code> - Ticks to draw below or to the left of the axis (for a horizontal or
|
|
vertical axis, respectively). If null, no ticks are drawn below or to
|
|
the left.</dd><dd><code>theTicksAboveOrRight</code> - Ticks to draw above or to the right of the axis (for a horizontal or
|
|
vertical axis, respectively). If null, no ticks are drawn above or to
|
|
the right.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - (unchecked exception) Thrown if <TT>theStart</TT> equals
|
|
<TT>theEnd</TT>. Thrown if <TT>theMajorDivisionCount</TT> is less
|
|
than 1. Thrown if <TT>theMinorDivisionCount</TT> is less than 1.
|
|
Thrown if <TT>theCrossing</TT> does not fall between
|
|
<TT>theStart</TT> and <TT>theEnd</TT> inclusive. Thrown if
|
|
<TT>theLength</TT> is less than or equal to 0.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="LinearAxis(double, double, int, int, double, double, java.awt.Stroke, java.awt.Paint, edu.rit.numeric.plot.impl.Ticks, edu.rit.numeric.plot.impl.Ticks)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>LinearAxis</h4>
|
|
<pre>public LinearAxis(double theStart,
|
|
double theEnd,
|
|
int theMajorDivisionCount,
|
|
int theMinorDivisionCount,
|
|
double theCrossing,
|
|
double theLength,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Stroke.html?is-external=true" title="class or interface in java.awt">Stroke</a> theStroke,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/awt/Paint.html?is-external=true" title="class or interface in java.awt">Paint</a> thePaint,
|
|
<a href="../../../../../edu/rit/numeric/plot/impl/Ticks.html" title="class in edu.rit.numeric.plot.impl">Ticks</a> theTicksBelowOrLeft,
|
|
<a href="../../../../../edu/rit/numeric/plot/impl/Ticks.html" title="class in edu.rit.numeric.plot.impl">Ticks</a> theTicksAboveOrRight)</pre>
|
|
<div class="block">Construct a new linear axis. The axis is drawn with the given stroke and
|
|
paint. There are tick marks on either or both sides of the axis.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>theStart</code> - Starting value for this axis.</dd><dd><code>theEnd</code> - Ending value for this axis. It can be greater than or less than
|
|
<TT>theStart</TT>.</dd><dd><code>theMajorDivisionCount</code> - Number of major divisions for this axis.</dd><dd><code>theMinorDivisionCount</code> - Number of minor divisions <I>per major division</I> for this axis.</dd><dd><code>theCrossing</code> - Point at which the perpendicular axis crosses this axis.</dd><dd><code>theLength</code> - Length of this axis on the display.</dd><dd><code>theStroke</code> - Stroke for drawing this axis on the display.</dd><dd><code>thePaint</code> - Paint for drawing this axis on the display.</dd><dd><code>theTicksBelowOrLeft</code> - Ticks to draw below or to the left of the axis (for a horizontal or
|
|
vertical axis, respectively). If null, no ticks are drawn below or to
|
|
the left.</dd><dd><code>theTicksAboveOrRight</code> - Ticks to draw above or to the right of the axis (for a horizontal or
|
|
vertical axis, respectively). If null, no ticks are drawn above or to
|
|
the right.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - (unchecked exception) Thrown if <TT>theStroke</TT> is null or
|
|
<TT>thePaint</TT> is null.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - (unchecked exception) Thrown if <TT>theStart</TT> equals
|
|
<TT>theEnd</TT>. Thrown if <TT>theMajorDivisionCount</TT> is less
|
|
than 1. Thrown if <TT>theMinorDivisionCount</TT> is less than 1.
|
|
Thrown if <TT>theCrossing</TT> does not fall between
|
|
<TT>theStart</TT> and <TT>theEnd</TT> inclusive. Thrown if
|
|
<TT>theLength</TT> is less than or equal to 0.</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="getStart()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getStart</h4>
|
|
<pre>public double getStart()</pre>
|
|
<div class="block">Returns the starting value of this axis. The starting value is the value
|
|
at the left or bottom end of the axis for a horizontal or vertical
|
|
orientation, respectively.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html#getStart()">getStart</a></code> in class <code><a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html" title="class in edu.rit.numeric.plot.impl">NumericalAxis</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getEnd()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getEnd</h4>
|
|
<pre>public double getEnd()</pre>
|
|
<div class="block">Returns the ending value of this axis. The ending value is the value at
|
|
the right or top end of the axis for a horizontal or vertical
|
|
orientation, respectively. Note that the ending value may be greater than
|
|
or less than the starting value.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html#getEnd()">getEnd</a></code> in class <code><a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html" title="class in edu.rit.numeric.plot.impl">NumericalAxis</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="includesValue(double)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>includesValue</h4>
|
|
<pre>public boolean includesValue(double value)</pre>
|
|
<div class="block">Returns true if the given value falls within the bounds of this axis,
|
|
false otherwise.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html#includesValue(double)">includesValue</a></code> in class <code><a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html" title="class in edu.rit.numeric.plot.impl">NumericalAxis</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getDisplayDistance(double)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDisplayDistance</h4>
|
|
<pre>public double getDisplayDistance(double value)</pre>
|
|
<div class="block">Returns the distance on the display from the start of this axis to the
|
|
given value.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html#getDisplayDistance(double)">getDisplayDistance</a></code> in class <code><a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html" title="class in edu.rit.numeric.plot.impl">NumericalAxis</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMajorDivisionCount()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMajorDivisionCount</h4>
|
|
<pre>public int getMajorDivisionCount()</pre>
|
|
<div class="block">Returns the number of major divisions on this axis.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html#getMajorDivisionCount()">getMajorDivisionCount</a></code> in class <code><a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html" title="class in edu.rit.numeric.plot.impl">NumericalAxis</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMajorDivision(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMajorDivision</h4>
|
|
<pre>public double getMajorDivision(int i)</pre>
|
|
<div class="block">Returns the value of the given major division.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html#getMajorDivision(int)">getMajorDivision</a></code> in class <code><a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html" title="class in edu.rit.numeric.plot.impl">NumericalAxis</a></code></dd>
|
|
<dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - Major division index in the range 0 ..
|
|
<TT>getMajorDivisionCount()</TT>.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMinorDivisionCount()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMinorDivisionCount</h4>
|
|
<pre>public int getMinorDivisionCount()</pre>
|
|
<div class="block">Returns the number of minor divisions on this axis.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html#getMinorDivisionCount()">getMinorDivisionCount</a></code> in class <code><a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html" title="class in edu.rit.numeric.plot.impl">NumericalAxis</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMinorDivision(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMinorDivision</h4>
|
|
<pre>public double getMinorDivision(int i)</pre>
|
|
<div class="block">Returns the value of the given minor division.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html#getMinorDivision(int)">getMinorDivision</a></code> in class <code><a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html" title="class in edu.rit.numeric.plot.impl">NumericalAxis</a></code></dd>
|
|
<dt><span class="strong">Parameters:</span></dt><dd><code>i</code> - Minor division index in the range 0 ..
|
|
<TT>getMinorDivisionCount()</TT>.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getCrossing()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCrossing</h4>
|
|
<pre>public double getCrossing()</pre>
|
|
<div class="block">Returns the value of the point where the perpendicular axis crosses this
|
|
axis.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html#getCrossing()">getCrossing</a></code> in class <code><a href="../../../../../edu/rit/numeric/plot/impl/NumericalAxis.html" title="class in edu.rit.numeric.plot.impl">NumericalAxis</a></code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="autoscale(double)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>autoscale</h4>
|
|
<pre>public static double autoscale(double max)</pre>
|
|
<div class="block">Determine a pleasing scale for a linear axis. The input, <TT>max</TT>, is
|
|
the largest value to be displayed along the axis. The output is the
|
|
smallest number of the form 1x10<SUP>k</SUP>, 2x10<SUP>k</SUP>, or
|
|
5x10<SUP>k</SUP>, k an integer, that is greater than or equal to
|
|
<TT>max</TT>. This can then be used as the maximum value for the axis.
|
|
<P>
|
|
<I>Note:</I> The <TT>autoscale()</TT> method works for negative inputs.
|
|
If <TT>max</TT> < 0, then <TT>autoscale(max) = -autoscale(-max)</TT>.
|
|
<P>
|
|
<I>Note:</I> <TT>autoscale(0) = 0</TT>.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>max</code> - Maximum value to be displayed along the axis.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>Maximum value for the axis.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/LinearAxis.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="../../../../../edu/rit/numeric/plot/impl/Label.html" title="class in edu.rit.numeric.plot.impl"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../../edu/rit/numeric/plot/impl/LogarithmicAxis.html" title="class in edu.rit.numeric.plot.impl"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../index.html?edu/rit/numeric/plot/impl/LinearAxis.html" target="_top">Frames</a></li>
|
|
<li><a href="LinearAxis.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><a href="#fields_inherited_from_class_edu.rit.numeric.plot.impl.NumericalAxis">Field</a> | </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 ======= -->
|
|
<p class="legalCopy"><small><FONT SIZE="-2">Copyright © 2013–2016 by Alan Kaminsky. All rights reserved. Send comments to ark</FONT><FONT SIZE="1" COLOR="#FFFFFF">­</FONT><FONT SIZE="-2">@</FONT><FONT SIZE="1" COLOR="#FFFFFF">­</FONT><FONT SIZE="-2">cs.rit.edu.</FONT></small></p>
|
|
</body>
|
|
</html>
|