cern.extjfx.chart.plugins

Class YValueIndicator<X>

java.lang.Object

cern.extjfx.chart.XYChartPlugin<X,Y>

cern.extjfx.chart.plugins.AbstractValueIndicator<X,Y>

cern.extjfx.chart.plugins.AbstractSingleValueIndicator<X,Number>

cern.extjfx.chart.plugins.YValueIndicator<X>

Type Parameters:

X - type of X values of the XYChartPane that the plug-in will be applied to

public class YValueIndicator<X>
extends AbstractSingleValueIndicator<X,Number>

A horizontal line drawn on the plot area, indicating specified Y value, with an optional text label describing the value.

Style Classes (from least to most specific):

• Label: value-indicator-label, y-value-indicator-label, y-value-indicator-label[index]
• Line: value-indicator-line, y-value-indicator-line, y-value-indicator-line[index]

where [index] corresponds to the index (zero based) of this indicator instance added to the XYChartPane. For example class y-value-indicator-label1 can be used to style label of the second instance of this indicator added to the chart pane.

Author:

mhrabia

Property Summary

Properties inherited from class cern.extjfx.chart.plugins.AbstractSingleValueIndicator

labelPositionProperty, valueProperty

Properties inherited from class cern.extjfx.chart.plugins.AbstractValueIndicator

labelHorizontalAnchorProperty, labelVerticalAnchorProperty, textProperty

Properties inherited from class cern.extjfx.chart.XYChartPlugin

chartPaneProperty

Field Summary

Fields inherited from class cern.extjfx.chart.plugins.AbstractSingleValueIndicator

line

Fields inherited from class cern.extjfx.chart.plugins.AbstractValueIndicator

label

Constructor Summary

Constructors

Constructor and Description
YValueIndicator(double value) Creates a new instance indicating given Y value of the base chart.
YValueIndicator(double value, String text) Creates a new instance indicating given Y value of the base chart, with the specified label.
YValueIndicator(double value, String text, ValueAxis<Number> yAxis) Creates a new instance indicating given Y value belonging to the specified yAxis, with the specified label.
YValueIndicator(double value, ValueAxis<Number> yAxis) Creates a new instance indicating given Y value belonging to the specified yAxis.

Method Summary

Modifier and Type	Method and Description
protected ValueAxis<Number>	getValueAxis(XYChartPane<X,Number> chartPane) Returns the ValueAxis that this indicator is associated with.
void	layoutChildren() Optional method that allows the plug-in to react in case the size of the XYChartPane that it belongs to has changed.

Methods inherited from class cern.extjfx.chart.plugins.AbstractSingleValueIndicator

getLabelPosition, getValue, labelPositionProperty, layoutLine, setLabelPosition, setValue, valueProperty

Methods inherited from class cern.extjfx.chart.plugins.AbstractValueIndicator

getLabelHorizontalAnchor, getLabelVerticalAnchor, getText, labelHorizontalAnchorProperty, labelVerticalAnchorProperty, layoutLabel, setLabelHorizontalAnchor, setLabelVerticalAnchor, setText, textProperty

Methods inherited from class cern.extjfx.chart.XYChartPlugin

chartPaneProperty, getChartChildren, getChartPane, getCharts, getLocationInPlotArea, registerMouseEventHandler, setChartPane, toDataPoint, toDisplayPoint

Methods inherited from class java.lang.Object

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

Constructor Detail

YValueIndicator

public YValueIndicator(double value)

Creates a new instance indicating given Y value of the base chart.

Parameters:

value - a value to be marked

YValueIndicator

public YValueIndicator(double value,
                       String text)

Creates a new instance indicating given Y value of the base chart, with the specified label.

Parameters:

value - a value to be marked

text - the text to be shown by the label. Value of AbstractValueIndicator.textProperty().

YValueIndicator

public YValueIndicator(double value,
                       ValueAxis<Number> yAxis)

Creates a new instance indicating given Y value belonging to the specified yAxis.

Parameters:

value - a value to be marked

yAxis - Y-axis on which the value will be marked

YValueIndicator

public YValueIndicator(double value,
                       String text,
                       ValueAxis<Number> yAxis)

Creates a new instance indicating given Y value belonging to the specified yAxis, with the specified label.

Parameters:

value - a value to be marked

text - the text to be shown by the label. Value of AbstractValueIndicator.textProperty().

yAxis - Y-axis on which the value will be marked

Method Detail

layoutChildren

public void layoutChildren()

Description copied from class: XYChartPlugin

Optional method that allows the plug-in to react in case the size of the XYChartPane that it belongs to has changed.

Overrides:

layoutChildren in class XYChartPlugin<X,Number>

getValueAxis

protected ValueAxis<Number> getValueAxis(XYChartPane<X,Number> chartPane)

Description copied from class: AbstractValueIndicator

Returns the ValueAxis that this indicator is associated with.

Specified by:

getValueAxis in class AbstractValueIndicator<X,Number>

Parameters:

chartPane - chart pane containing the associated axis

Returns:

associated ValueAxis