de.gsi.chart.plugins

Class ChartOverlay

java.lang.Object

de.gsi.chart.plugins.ChartPlugin

de.gsi.chart.plugins.ChartOverlay

public class ChartOverlay
extends ChartPlugin

Plugin that overlays chart pane or chart's plot area with given node i.e. the bounds of the node are set to cover the indicated area.

Typically the node would be a an instance of Pane containing child nodes. The example below shows how to add a Label to the chart pane, located in the left top corner of the plot area:

 XYChartPane<Number, Number> chartPane = ...;

 Label label = new Label("Info about chart data");
 AnchorPane.setTopAnchor(label, 5.0);
 AnchorPane.setLeftAnchor(label, 5.0);
 AnchorPane anchorPane = new AnchorPane(label);
 // Pass any mouse events to the underlying chart
 anchorPane.setMouseTransparent(true);

 chartPane.getPlugins().add(new ChartOverlay<>(OverlayArea.PLOT_AREA, anchorPane));
 

Author:

Grzegorz Kruk

Property Summary

Type	Property and Description
ObjectProperty<Node>	node The node to be overlaid on top of the overlay area.
ObjectProperty<ChartOverlay.OverlayArea>	overlayArea Specifies the ChartOverlay.OverlayArea to be covered by the node.

Properties inherited from class de.gsi.chart.plugins.ChartPlugin

addButtonsToToolBarProperty, chartProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChartOverlay.OverlayArea Defines possible areas to be overlaid.

Constructor Summary

Constructors

Constructor and Description
ChartOverlay(ChartOverlay.OverlayArea area) Creates a new, empty ChartOverlay, initialized to overlay the specified area.
ChartOverlay(ChartOverlay.OverlayArea area, Node node) Creates a new ChartOverlay, initialized to overlay the specified area with given node.

Method Summary

Modifier and Type	Method and Description
Node	getNode() Returns the value of the nodeProperty().
ChartOverlay.OverlayArea	getOverlayArea() Returns the value of the overlayAreaProperty().
void	layoutChildren() Optional method that allows the plug-in to react in case the size of the chart that it belongs to has changed.
ObjectProperty<Node>	nodeProperty() The node to be overlaid on top of the overlay area.
ObjectProperty<ChartOverlay.OverlayArea>	overlayAreaProperty() Specifies the ChartOverlay.OverlayArea to be covered by the node.
void	setNode(Node newNode) Sets the value of the nodeProperty().
void	setOverlayArea(ChartOverlay.OverlayArea area) Sets the value of the overlayAreaProperty().

Methods inherited from class de.gsi.chart.plugins.ChartPlugin

addButtonsToToolBarProperty, chartProperty, getChart, getChartChildren, getLocationInPlotArea, isAddButtonsToToolBar, registerInputEventHandler, setAddButtonsToToolBar, setChart, toDataPoint, toDisplayPoint

Methods inherited from class java.lang.Object

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

Property Detail

node

public final ObjectProperty<Node> nodeProperty

The node to be overlaid on top of the overlay area.

See Also:

getNode(), setNode(Node)

overlayArea

public final ObjectProperty<ChartOverlay.OverlayArea> overlayAreaProperty

Specifies the ChartOverlay.OverlayArea to be covered by the node.

See Also:

getOverlayArea(), setOverlayArea(OverlayArea)

Constructor Detail

ChartOverlay

public ChartOverlay(ChartOverlay.OverlayArea area)

Creates a new, empty ChartOverlay, initialized to overlay the specified area.

Parameters:

area - value of overlayAreaProperty()

ChartOverlay

public ChartOverlay(ChartOverlay.OverlayArea area,
                    Node node)

Creates a new ChartOverlay, initialized to overlay the specified area with given node.

Parameters:

area - value of overlayAreaProperty()

node - value of the nodeProperty()

Method Detail

getNode

public final Node getNode()

Returns the value of the nodeProperty().

Returns:

the node to be overlaid

getOverlayArea

public final ChartOverlay.OverlayArea getOverlayArea()

Returns the value of the overlayAreaProperty().

Returns:

the overlay area to be covered by the node

layoutChildren

public void layoutChildren()

Description copied from class: ChartPlugin

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

Overrides:

layoutChildren in class ChartPlugin

nodeProperty

public final ObjectProperty<Node> nodeProperty()

The node to be overlaid on top of the overlay area.

See Also:

getNode(), setNode(Node)

overlayAreaProperty

public final ObjectProperty<ChartOverlay.OverlayArea> overlayAreaProperty()

Specifies the ChartOverlay.OverlayArea to be covered by the node.

See Also:

getOverlayArea(), setOverlayArea(OverlayArea)

setNode

public final void setNode(Node newNode)

Sets the value of the nodeProperty().

Parameters:

newNode - the node to overlaid

setOverlayArea

public final void setOverlayArea(ChartOverlay.OverlayArea area)

Sets the value of the overlayAreaProperty().

Parameters:

area - the area to be covered