Package org.faceless.graph2

Class TrendSeries

java.lang.Object

org.faceless.graph2.Series

org.faceless.graph2.AbstractLineSeries

org.faceless.graph2.FunctionLineSeries

org.faceless.graph2.TrendSeries

public class TrendSeries
extends FunctionLineSeries

A TrendSeries can be used to plot a trend-line based on a LineSeries, or on a series of data points. It is used exactly the same way as a SplineSeries

Since:

2.4.7

See Also:

LineSeries, SplineSeries

Constructor Summary

Constructors

Constructor	Description
TrendSeries(String name)	Create a new TrendSeries

Method Summary

Modifier and Type	Method	Description
void	complete()	Complete the function.
double	func(double x)	Given an X value, return the equivalent Y value of this function.
void	set(double x, double y)	Set a value on the graph.

Methods inherited from class org.faceless.graph2.FunctionLineSeries

createFunctionSeries, getLineSeries, setLineSeries, setSteps

Methods inherited from class org.faceless.graph2.AbstractLineSeries

setDepth

Methods inherited from class org.faceless.graph2.Series

addBox, addLine, addMarker, getName, outputToSeries, outputToSeriesFunction, setStyle, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TrendSeries

public TrendSeries(String name)

Create a new TrendSeries

Parameters:

name - the name of the Series

Method Detail

set

public void set(double x,
                double y)

Set a value on the graph. The x parameter specifies the horizontal position on the graph, and the y parameter specifies the vertical position. Both must be real numbers.

Parameters:

x - the X co-ordinate of the sample

y - the Y co-ordinate of the sample

complete

public void complete()

Description copied from class: FunctionLineSeries

Complete the function. This method is called after all the data points are available to the graph, and can be overridden to calculate the function based on the points in the graph. It is called automatically by the library - subclasses overriding this method must always call super.complete() first.

Overrides:

complete in class FunctionLineSeries

func

public double func(double x)

Description copied from class: FunctionLineSeries

Given an X value, return the equivalent Y value of this function. The returned value may be Double.NaN or infinite, and either of those values will result in a gap in the line.

Specified by:

func in class FunctionLineSeries

Parameters:

x - the X-value of the function - guaranteed not to be NaN or Infinite

Returns:

y the corresponding Y value