cern.extjfx.chart.plugins

Class YRangeIndicator<X>

java.lang.Object

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

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

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

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

Type Parameters:

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

public class YRangeIndicator<X>
extends AbstractRangeValueIndicator<X,Number>

A rectangle drawn on the plot area, covering specified range of Y values, with an optional text label describing the range.

Style Classes (from least to most specific):

• Label: range-indicator-label, y-range-indicator-label, y-range-indicator-label[index]
• Rectangle: range-indicator-rect, y-range-indicator-rect, y-range-indicator-rect[index]

where [index] corresponds to the index (zero based) of this indicator instance added to the XYChartPane. For example class y-range-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.AbstractRangeValueIndicator

labelHorizontalPositionProperty, labelVerticalPositionProperty, lowerBoundProperty, upperBoundProperty

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.AbstractRangeValueIndicator

rectangle

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

label

Constructor Summary

Constructors

Constructor and Description
YRangeIndicator(double lowerBound, double upperBound) Creates a new instance that indicates given Y range of the base chart.
YRangeIndicator(double lowerBound, double upperBound, String text) Creates a new instance that indicates given Y range of the base chart.
YRangeIndicator(double lowerBound, double upperBound, ValueAxis<Number> yAxis) Creates a new instance that indicates given Y range of the specified Y axis.

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.AbstractRangeValueIndicator

getLabelHorizontalPosition, getLabelVerticalPosition, getLowerBound, getUpperBound, labelHorizontalPositionProperty, labelVerticalPositionProperty, layout, lowerBoundProperty, setLabelHorizontalPosition, setLabelVerticalPosition, setLowerBound, setUpperBound, upperBoundProperty

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

YRangeIndicator

public YRangeIndicator(double lowerBound,
                       double upperBound)

Creates a new instance that indicates given Y range of the base chart.

Parameters:

lowerBound - lower bound (min value) of the range

upperBound - upper bound (max value) of the range

YRangeIndicator

public YRangeIndicator(double lowerBound,
                       double upperBound,
                       String text)

Creates a new instance that indicates given Y range of the base chart.

Parameters:

lowerBound - lower bound (min value) of the range

upperBound - upper bound (max value) of the range

text - the indicator's label's text

YRangeIndicator

public YRangeIndicator(double lowerBound,
                       double upperBound,
                       ValueAxis<Number> yAxis)

Creates a new instance that indicates given Y range of the specified Y axis.

Parameters:

lowerBound - lower bound (min value) of the range

upperBound - upper bound (max value) of the range

yAxis - Y-axis whose values should be indicated

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