Package net.pricefx.common.apibuilder.chart

Class AuxLine<C extends AbstractChartBuilder<C>>

Object

ObjectIdentity

BacklinkBuilder<C>

AuxLine<C>

public class AuxLine<C extends AbstractChartBuilder<C>>
extends BacklinkBuilder<C>

Builder for an auxiliary reference line on a chart, obtained from AbstractChartBuilder.addAuxLine() rather than instantiated directly. An auxiliary line is independent of the chart's data series and is typically used to mark a fixed reference value, for example a percentile threshold or a target. Choose its shape with withLine() (a straight line), withSteppedLine() (a piecewise line through explicit points), or withVerticalLine() (a single vertical line at a fixed X value); the three are alternatives, not meant to be combined on the same auxiliary line.

See Also:

• AbstractChartBuilder.addAuxLine()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuxLine.Line<C extends ObjectIdentity>	A straight AuxLine shape, y = yIntercept + steepness * x, obtained from withLine() rather than instantiated directly.
static class	AuxLine.SteppedLine<C extends ObjectIdentity>	A piecewise AuxLine shape defined by explicit (X, Y) points, obtained from withSteppedLine() rather than instantiated directly.
static class	AuxLine.VerticalLine<C extends ObjectIdentity>	A single vertical AuxLine shape at a fixed X axis value, obtained from withVerticalLine() 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
AuxLine(C backLink, String instanceId, String classId)

Method Summary

Modifier and Type	Method	Description
AuxLine<C>	setColor(AuxLineColor color)	Sets this auxiliary line's color.
AuxLine<C>	setHideDataLabels(Boolean hideDataLabels)	Hides this auxiliary line's data labels.
AuxLine<C>	setLabel(String label)	Sets this auxiliary line's label, shown in the chart's legend and tooltips, for example "65th Percentile".
AuxLine<C>	setShowInLegend(Boolean showInLegend)	Shows or hides this auxiliary line in the chart's legend.
AuxLine.Line<AuxLine<C>>	withLine()	Shapes this auxiliary line as a straight line, y = yIntercept + steepness * x.
AuxLine.SteppedLine<AuxLine<C>>	withSteppedLine()	Shapes this auxiliary line as a piecewise line through explicit points.
AuxLine.VerticalLine<AuxLine<C>>	withVerticalLine()	Shapes this auxiliary line as a single vertical line at a fixed X axis value.

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

AuxLine

public AuxLine(C backLink,
 String instanceId,
 String classId)

Method Details

setLabel

public AuxLine<C> setLabel(String label)

Sets this auxiliary line's label, shown in the chart's legend and tooltips, for example "65th Percentile".

Parameters:

label - the label to display for this auxiliary line

Returns:

this auxiliary line, for chaining further configuration

setShowInLegend

public AuxLine<C> setShowInLegend(Boolean showInLegend)

Shows or hides this auxiliary line in the chart's legend.

Parameters:

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

Returns:

this auxiliary line, for chaining further configuration

setHideDataLabels

public AuxLine<C> setHideDataLabels(Boolean hideDataLabels)

Hides this auxiliary line's data labels.

Parameters:

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

Returns:

this auxiliary line, for chaining further configuration

withLine

public AuxLine.Line<AuxLine<C>> withLine()

Shapes this auxiliary line as a straight line, y = yIntercept + steepness * x. Call AuxLine.Line.setYIntercept(String) and AuxLine.Line.setSteepness(String) on the returned builder.

Returns:

a new AuxLine.Line builder for this auxiliary line. Never null.

See Also:

• withSteppedLine()
• withVerticalLine()

withSteppedLine

public AuxLine.SteppedLine<AuxLine<C>> withSteppedLine()

Shapes this auxiliary line as a piecewise line through explicit points. Call AuxLine.SteppedLine.addStep(String, String) once per point.

Returns:

a new AuxLine.SteppedLine builder for this auxiliary line. Never null.

See Also:

• withLine()
• withVerticalLine()

withVerticalLine

public AuxLine.VerticalLine<AuxLine<C>> withVerticalLine()

Shapes this auxiliary line as a single vertical line at a fixed X axis value. Call AuxLine.VerticalLine.setXValue(String) on the returned builder.

Returns:

a new AuxLine.VerticalLine builder for this auxiliary line. Never null.

See Also:

• withLine()
• withSteppedLine()

setColor

public AuxLine<C> setColor(AuxLineColor color)

Sets this auxiliary line's color.

Parameters:

color - the color to render this auxiliary line in

Returns:

this auxiliary line, for chaining further configuration