cern.extjfx.chart.plugins

Class XValueIndicator<Y>

java.lang.Object

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

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

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

cern.extjfx.chart.plugins.XValueIndicator<Y>

Type Parameters:

Y - type of Y values

public class XValueIndicator<Y>
extends AbstractSingleValueIndicator<Number,Y>

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

Style Classes (from least to most specific):

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

where [index] corresponds to the index (zero based) of this indicator instance added to the XYChartPane. For example class x-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
XValueIndicator(double value) Creates a new instance of the indicator.
XValueIndicator(double value, String text) Creates a new instance of the indicator.

Method Summary

Modifier and Type	Method and Description
protected ValueAxis<?>	getValueAxis(XYChartPane<Number,Y> 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

XValueIndicator

public XValueIndicator(double value)

Creates a new instance of the indicator.

Parameters:

value - a X value to be indicated

XValueIndicator

public XValueIndicator(double value,
                       String text)

Creates a new instance of the indicator.

Parameters:

value - a X value to be indicated

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

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<Number,Y>

getValueAxis

protected ValueAxis<?> getValueAxis(XYChartPane<Number,Y> chartPane)

Description copied from class: AbstractValueIndicator

Returns the ValueAxis that this indicator is associated with.

Specified by:

getValueAxis in class AbstractValueIndicator<Number,Y>

Parameters:

chartPane - chart pane containing the associated axis

Returns:

associated ValueAxis