Package net.pricefx.common.apibuilder.chart

Class TrendLine<S extends AbstractChartSeries<?,?>>

Object

ObjectIdentity

BacklinkBuilder<S>

TrendLine<S>

Type Parameters:

S - the type of the series this trend line belongs to

public class TrendLine<S extends AbstractChartSeries<?,?>>
extends BacklinkBuilder<S>

Builder for a trend line overlay on a chart series, obtained from AbstractChartSeries.withTrendLine() rather than instantiated directly.

Field Summary

Fields inherited from class BacklinkBuilder

METHOD_BACK

Fields inherited from class ObjectIdentity

classId, idGenerator, instanceId, invocations, m, NONE, parentObjectIdentity

Constructor Summary

Constructors

Constructor	Description
TrendLine(S backLink, String instanceId, String classId)

Method Summary

Modifier and Type	Method	Description
TrendLine<S>	setColor(AuxLineColor color)	Sets this trend line's color.
TrendLine<S>	setHideDataLabels(Boolean hideDataLabels)	Hides this trend line's data labels (the value shown on or next to each point).
TrendLine<S>	setLabel(String label)	Sets this trend line's display label, shown in the chart's legend.
TrendLine<S>	setRegressionType(String regressionType)	Sets the regression model this trend line fits to the series' data: a linear relationship (y = a + bx) or an exponential one (y = a * e^bx) between the dependent variable y and the independent variable x.
TrendLine<S>	setShowInLegend(Boolean showInLegend)	Sets whether this trend line appears in the chart's legend.

Methods inherited from class BacklinkBuilder

back, getParent

Methods inherited from class ObjectIdentity

addInvocation, addInvocation, addInvocationInternal, getClassId

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TrendLine

public TrendLine(S backLink,
 String instanceId,
 String classId)

Method Details

setLabel

public TrendLine<S> setLabel(String label)

Sets this trend line's display label, shown in the chart's legend.

Parameters:

label - the label to display for this trend line

Returns:

this trend line, for chaining further configuration

setRegressionType

public TrendLine<S> setRegressionType(String regressionType)

Sets the regression model this trend line fits to the series' data: a linear relationship (y = a + bx) or an exponential one (y = a * e^bx) between the dependent variable y and the independent variable x.

Parameters:

regressionType - "linear" or "exponential"

Returns:

this trend line, for chaining further configuration

setShowInLegend

public TrendLine<S> setShowInLegend(Boolean showInLegend)

Sets whether this trend line appears in the chart's legend.

Parameters:

showInLegend - true to show it in the legend; false or null to hide it

Returns:

this trend line, for chaining further configuration

setHideDataLabels

public TrendLine<S> setHideDataLabels(Boolean hideDataLabels)

Hides this trend line's data labels (the value shown on or next to each point).

Parameters:

hideDataLabels - true to hide the labels; false or null to show them

Returns:

this trend line, for chaining further configuration

setColor

public TrendLine<S> setColor(AuxLineColor color)

Sets this trend line's color.

Parameters:

color - the color to render this trend line in

Returns:

this trend line, for chaining further configuration