eu.fthevenet.util.javafx.charts

Class XYChartCrosshair<X,Y>

java.lang.Object

eu.fthevenet.util.javafx.charts.XYChartCrosshair<X,Y>

public class XYChartCrosshair<X,Y>
extends java.lang.Object

Draws a crosshair on top of an XYChart and handles selection of a portion of the chart view.

Author:

Frederic Thevenet

Property Summary

Type	Property and Description
javafx.beans.property.Property<X>	currentXValue
javafx.beans.property.BooleanProperty	horizontalMarkerVisible Gets the boolean property that tracks the visibility of the horizontal marker of the crosshair
javafx.beans.property.BooleanProperty	verticalMarkerVisible Gets the boolean property that tracks the visibility of the vertical marker of the crosshair

Constructor Summary

Constructors

Constructor and Description
XYChartCrosshair(java.util.LinkedHashMap<javafx.scene.chart.XYChart<X,Y>,java.util.function.Function<Y,java.lang.String>> charts, javafx.scene.layout.Pane parent, java.util.function.Function<X,java.lang.String> xValuesFormatter) Initializes a new instance of the XYChartCrosshair class.

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.Property<X>	currentXValueProperty()
X	getCurrentXValue() Gets the value of the property currentXValue.
Y	getCurrentYValue(javafx.scene.chart.XYChart<X,Y> chart)
javafx.beans.property.BooleanProperty	horizontalMarkerVisibleProperty() Gets the boolean property that tracks the visibility of the horizontal marker of the crosshair
boolean	isHorizontalMarkerVisible() Returns true if the horizontal marker is visible, false otherwise
boolean	isVerticalMarkerVisible() Returns true if the vertical marker is visible, false otherwise
void	onSelectionDone(java.util.function.Consumer<java.util.Map<javafx.scene.chart.XYChart<X,Y>,XYChartSelection<X,Y>>> action) Sets the action to be triggered when selection is complete
void	setHorizontalMarkerVisible(boolean horizontalMarkerVisible) Sets the visibility of the horizontal marker
void	setVerticalMarkerVisible(boolean verticalMarkerVisible) Sets the visibility of the vertical marker
javafx.beans.property.BooleanProperty	verticalMarkerVisibleProperty() Gets the boolean property that tracks the visibility of the vertical marker of the crosshair

Methods inherited from class java.lang.Object

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

Property Detail

verticalMarkerVisible

public javafx.beans.property.BooleanProperty verticalMarkerVisibleProperty

Gets the boolean property that tracks the visibility of the vertical marker of the crosshair

See Also:

isVerticalMarkerVisible(), setVerticalMarkerVisible(boolean)

horizontalMarkerVisible

public javafx.beans.property.BooleanProperty horizontalMarkerVisibleProperty

Gets the boolean property that tracks the visibility of the horizontal marker of the crosshair

See Also:

isHorizontalMarkerVisible(), setHorizontalMarkerVisible(boolean)

currentXValue

public javafx.beans.property.Property<X> currentXValueProperty

See Also:

getCurrentXValue()

Constructor Detail

XYChartCrosshair

public XYChartCrosshair(java.util.LinkedHashMap<javafx.scene.chart.XYChart<X,Y>,java.util.function.Function<Y,java.lang.String>> charts,
                        javafx.scene.layout.Pane parent,
                        java.util.function.Function<X,java.lang.String> xValuesFormatter)

Initializes a new instance of the XYChartCrosshair class.

Parameters:

charts - a map of the XYChart to attach and their formatting function of the Y values.

parent - the parent node of the chart

xValuesFormatter - a function used to format the display of X values as strings

Method Detail

verticalMarkerVisibleProperty

public javafx.beans.property.BooleanProperty verticalMarkerVisibleProperty()

Gets the boolean property that tracks the visibility of the vertical marker of the crosshair

See Also:

isVerticalMarkerVisible(), setVerticalMarkerVisible(boolean)

horizontalMarkerVisibleProperty

public javafx.beans.property.BooleanProperty horizontalMarkerVisibleProperty()

Gets the boolean property that tracks the visibility of the horizontal marker of the crosshair

See Also:

isHorizontalMarkerVisible(), setHorizontalMarkerVisible(boolean)

isVerticalMarkerVisible

public boolean isVerticalMarkerVisible()

Returns true if the vertical marker is visible, false otherwise

Returns:

true if the vertical marker is visible, false otherwise

isHorizontalMarkerVisible

public boolean isHorizontalMarkerVisible()

Returns true if the horizontal marker is visible, false otherwise

Returns:

true if the horizontal marker is visible, false otherwise

setVerticalMarkerVisible

public void setVerticalMarkerVisible(boolean verticalMarkerVisible)

Sets the visibility of the vertical marker

Parameters:

verticalMarkerVisible - the visibility of the vertical marker

setHorizontalMarkerVisible

public void setHorizontalMarkerVisible(boolean horizontalMarkerVisible)

Sets the visibility of the horizontal marker

Parameters:

horizontalMarkerVisible - the visibility of the horizontal marker

onSelectionDone

public void onSelectionDone(java.util.function.Consumer<java.util.Map<javafx.scene.chart.XYChart<X,Y>,XYChartSelection<X,Y>>> action)

Sets the action to be triggered when selection is complete

Parameters:

action - the action to be triggered when selection is complete

getCurrentYValue

public Y getCurrentYValue(javafx.scene.chart.XYChart<X,Y> chart)

getCurrentXValue

public X getCurrentXValue()

Gets the value of the property currentXValue.

currentXValueProperty

public javafx.beans.property.Property<X> currentXValueProperty()

See Also:

getCurrentXValue()