jfreechart-commit

|-------------------------|  x0                       x1 -
+ Here, the range bounds are at the axis extremities. -With cyclic axis, however, the time is split in +With cyclic axis, however, the time is split in "cycles", or "time frames", or the same duration : the period. -A cycle axis cannot by definition handle a larger interval -than the period :
x1 - x0 >= period
. Thus, at most a full +A cycle axis cannot by definition handle a larger interval +than the period :
x1 - x0 >= period
. Thus, at most a full period can be represented with such an axis. -The cycle bound is the number between x0 and x1 which marks +The cycle bound is the number between x0 and x1 which marks the beginning of new time frame:
|---------------------|----------------------------| @@ -98,11 +98,11 @@  <---previous cycle---><-------current cycle-------->
-It is actually a multiple of the period, plus optionally +It is actually a multiple of the period, plus optionally a start offset:
cb = n * period + offset
* Note that this has no effect on visual appearance, as the cycle bound is - * mapped successively for both axis ends. Use this function for correct - * results in translateValueToJava2D. - * - * @return true if the cycle bound is mapped to the last - * cycle, false if it is bound to the current cycle + * mapped successively for both axis ends. Use this function for correct + * results in translateValueToJava2D. + * + * @return true if the cycle bound is mapped to the last + * cycle, false if it is bound to the current cycle * (default) */ public boolean isBoundMappedToLastCycle() { return this.boundMappedToLastCycle; } - + /** - * The cycle bound can be associated either with the current or with the - * last cycle. It's up to the user's choice to decide which, as this is - * just a convention. By default, the cycle bound is mapped to the current - * cycle. + * The cycle bound can be associated either with the current or with the + * last cycle. It's up to the user's choice to decide which, as this is + * just a convention. By default, the cycle bound is mapped to the current + * cycle. *

*

cb = n * period + offset

- * + * * @return The current offset. - * + * * @see #getCycleBound() */ public double getOffset() { return this.offset; } - + /** - * The cycle bound is a multiple of the period, plus optionally a start + * The cycle bound is a multiple of the period, plus optionally a start * offset. *

*

cb = n * period + offset

- * + * * @param offset The offset to set. * - * @see #getCycleBound() + * @see #getCycleBound() */ public void setOffset(double offset) { this.offset = offset; } - + /** - * The cycle bound is a multiple of the period, plus optionally a start + * The cycle bound is a multiple of the period, plus optionally a start * offset. *

*

cb = n * period + offset

- * + * * @return The current period. - * + * * @see #getCycleBound() */ public double getPeriod() { return this.period; } - + /** - * The cycle bound is a multiple of the period, plus optionally a start + * The cycle bound is a multiple of the period, plus optionally a start * offset. *

*

cb = n * period + offset

@@ -349,8 +349,8 @@ } /** - * Increases or decreases the axis range by the specified percentage about - * the specified anchor value and sends an {@link AxisChangeEvent} to all + * Increases or decreases the axis range by the specified percentage about + * the specified anchor value and sends an {@link AxisChangeEvent} to all * registered listeners. *