javafx.scene.chart

Class XYChart.Data<X,Y>

java.lang.Object

javafx.scene.chart.XYChart.Data<X,Y>

Enclosing class:

XYChart<X,Y>

public static final class XYChart.Data<X,Y>
extends java.lang.Object

A single data item with data for 2 axis charts

Since:

JavaFX 2.0

Property Summary

Type	Property and Description
(package private) <any>	currentExtraValue The current displayed data extra value.
(package private) <any>	currentX The current displayed data value plotted on the X axis.
(package private) <any>	currentY The current displayed data value plotted on the Y axis.
<any>	extraValue The generic data value to be plotted in any way the chart needs.
<any>	node The node to display for this data item.
<any>	XValue The generic data value to be plotted on the X axis.
<any>	YValue The generic data value to be plotted on the Y axis.

Field Summary

Fields

Modifier and Type	Field and Description
private <any>	currentExtraValue The current displayed data extra value.
private <any>	currentX The current displayed data value plotted on the X axis.
private <any>	currentY The current displayed data value plotted on the Y axis.
private <any>	extraValue The generic data value to be plotted in any way the chart needs.
private <any>	node The node to display for this data item.
private XYChart.Series<X,Y>	series The series this data belongs to
private boolean	setToRemove
private <any>	xValue The generic data value to be plotted on the X axis
private <any>	yValue The generic data value to be plotted on the Y axis

Constructor Summary

Constructors

Constructor and Description
Data() Creates an empty XYChart.Data object.
Data(X xValue, Y yValue) Creates an instance of XYChart.Data object and initializes the X,Y data values.
Data(X xValue, Y yValue, java.lang.Object extraValue) Creates an instance of XYChart.Data object and initializes the X,Y data values and extraValue.

Method Summary

Modifier and Type	Method and Description
(package private) <any>	currentExtraValueProperty() The current displayed data extra value.
(package private) <any>	currentXProperty() The current displayed data value plotted on the X axis.
(package private) <any>	currentYProperty() The current displayed data value plotted on the Y axis.
<any>	extraValueProperty() The generic data value to be plotted in any way the chart needs.
(package private) java.lang.Object	getCurrentExtraValue()
(package private) X	getCurrentX()
(package private) Y	getCurrentY()
java.lang.Object	getExtraValue() Gets the value of the property extraValue.
Node	getNode() Gets the value of the property node.
X	getXValue() Gets the generic data value to be plotted on the X axis.
Y	getYValue() Gets the generic data value to be plotted on the Y axis.
<any>	nodeProperty() The node to display for this data item.
(package private) void	setCurrentExtraValue(java.lang.Object value)
(package private) void	setCurrentX(X value)
(package private) void	setCurrentY(Y value)
void	setExtraValue(java.lang.Object value) Sets the value of the property extraValue.
void	setNode(Node value) Sets the value of the property node.
(package private) void	setSeries(XYChart.Series<X,Y> series)
void	setXValue(X value) Sets the generic data value to be plotted on the X axis.
void	setYValue(Y value) Sets the generic data value to be plotted on the Y axis.
java.lang.String	toString() Returns a string representation of this Data object.
<any>	XValueProperty() The generic data value to be plotted on the X axis.
<any>	YValueProperty() The generic data value to be plotted on the Y axis.

Methods inherited from class java.lang.Object

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

Property Detail

XValue

public final <any> XValueProperty

The generic data value to be plotted on the X axis.

See Also:

getXValue(), setXValue(X)

YValue

public final <any> YValueProperty

The generic data value to be plotted on the Y axis.

See Also:

getYValue(), setYValue(Y)

extraValue

public final <any> extraValueProperty

The generic data value to be plotted in any way the chart needs. For example used as the radius for BubbleChart.

See Also:

getExtraValue(), setExtraValue(Object)

node

public final <any> nodeProperty

The node to display for this data item. You can either create your own node and set it on the data item before you add the item to the chart. Otherwise the chart will create a node for you that has the default representation for the chart type. This node will be set as soon as the data is added to the chart. You can then get it to add mouse listeners etc. Charts will do their best to position and size the node appropriately, for example on a Line or Scatter chart this node will be positioned centered on the data values position. For a bar chart this is positioned and resized as the bar for this data item.

See Also:

getNode(), setNode(Node)

currentX

final <any> currentXProperty

The current displayed data value plotted on the X axis. This may be the same as xValue or different. It is used by XYChart to animate the xValue from the old value to the new value. This is what you should plot in any custom XYChart implementations. Some XYChart chart implementations such as LineChart also use this to animate when data is added or removed.

currentY

final <any> currentYProperty

The current displayed data value plotted on the Y axis. This may be the same as yValue or different. It is used by XYChart to animate the yValue from the old value to the new value. This is what you should plot in any custom XYChart implementations. Some XYChart chart implementations such as LineChart also use this to animate when data is added or removed.

currentExtraValue

final <any> currentExtraValueProperty

The current displayed data extra value. This may be the same as extraValue or different. It is used by XYChart to animate the extraValue from the old value to the new value. This is what you should plot in any custom XYChart implementations.

Field Detail

setToRemove

private boolean setToRemove

series

private XYChart.Series<X,Y> series

The series this data belongs to

xValue

private <any> xValue

The generic data value to be plotted on the X axis

yValue

private <any> yValue

The generic data value to be plotted on the Y axis

extraValue

private <any> extraValue

The generic data value to be plotted in any way the chart needs. For example used as the radius for BubbleChart.

node

private <any> node

The node to display for this data item. You can either create your own node and set it on the data item before you add the item to the chart. Otherwise the chart will create a node for you that has the default representation for the chart type. This node will be set as soon as the data is added to the chart. You can then get it to add mouse listeners etc. Charts will do their best to position and size the node appropriately, for example on a Line or Scatter chart this node will be positioned centered on the data values position. For a bar chart this is positioned and resized as the bar for this data item.

currentX

private <any> currentX

The current displayed data value plotted on the X axis. This may be the same as xValue or different. It is used by XYChart to animate the xValue from the old value to the new value. This is what you should plot in any custom XYChart implementations. Some XYChart chart implementations such as LineChart also use this to animate when data is added or removed.

currentY

private <any> currentY

The current displayed data value plotted on the Y axis. This may be the same as yValue or different. It is used by XYChart to animate the yValue from the old value to the new value. This is what you should plot in any custom XYChart implementations. Some XYChart chart implementations such as LineChart also use this to animate when data is added or removed.

currentExtraValue

private <any> currentExtraValue

The current displayed data extra value. This may be the same as extraValue or different. It is used by XYChart to animate the extraValue from the old value to the new value. This is what you should plot in any custom XYChart implementations.

Constructor Detail

Data

public Data()

Creates an empty XYChart.Data object.

Data

public Data(X xValue,
            Y yValue)

Creates an instance of XYChart.Data object and initializes the X,Y data values.

Parameters:

xValue - The X axis data value

yValue - The Y axis data value

Data

public Data(X xValue,
            Y yValue,
            java.lang.Object extraValue)

Creates an instance of XYChart.Data object and initializes the X,Y data values and extraValue.

Parameters:

xValue - The X axis data value.

yValue - The Y axis data value.

extraValue - Chart extra value.

Method Detail

setSeries

void setSeries(XYChart.Series<X,Y> series)

getXValue

public final X getXValue()

Gets the generic data value to be plotted on the X axis.

Returns:

the generic data value to be plotted on the X axis.

setXValue

public final void setXValue(X value)

Sets the generic data value to be plotted on the X axis.

Parameters:

value - the generic data value to be plotted on the X axis.

XValueProperty

public final <any> XValueProperty()

The generic data value to be plotted on the X axis.

See Also:

getXValue(), setXValue(X)

getYValue

public final Y getYValue()

Gets the generic data value to be plotted on the Y axis.

Returns:

the generic data value to be plotted on the Y axis.

setYValue

public final void setYValue(Y value)

Sets the generic data value to be plotted on the Y axis.

Parameters:

value - the generic data value to be plotted on the Y axis.

YValueProperty

public final <any> YValueProperty()

The generic data value to be plotted on the Y axis.

See Also:

getYValue(), setYValue(Y)

getExtraValue

public final java.lang.Object getExtraValue()

Gets the value of the property extraValue.

setExtraValue

public final void setExtraValue(java.lang.Object value)

Sets the value of the property extraValue.

extraValueProperty

public final <any> extraValueProperty()

The generic data value to be plotted in any way the chart needs. For example used as the radius for BubbleChart.

See Also:

getExtraValue(), setExtraValue(Object)

getNode

public final Node getNode()

Gets the value of the property node.

setNode

public final void setNode(Node value)

Sets the value of the property node.

nodeProperty

public final <any> nodeProperty()

The node to display for this data item. You can either create your own node and set it on the data item before you add the item to the chart. Otherwise the chart will create a node for you that has the default representation for the chart type. This node will be set as soon as the data is added to the chart. You can then get it to add mouse listeners etc. Charts will do their best to position and size the node appropriately, for example on a Line or Scatter chart this node will be positioned centered on the data values position. For a bar chart this is positioned and resized as the bar for this data item.

See Also:

getNode(), setNode(Node)

getCurrentX

final X getCurrentX()

setCurrentX

final void setCurrentX(X value)

currentXProperty

final <any> currentXProperty()

The current displayed data value plotted on the X axis. This may be the same as xValue or different. It is used by XYChart to animate the xValue from the old value to the new value. This is what you should plot in any custom XYChart implementations. Some XYChart chart implementations such as LineChart also use this to animate when data is added or removed.

getCurrentY

final Y getCurrentY()

setCurrentY

final void setCurrentY(Y value)

currentYProperty

final <any> currentYProperty()

The current displayed data value plotted on the Y axis. This may be the same as yValue or different. It is used by XYChart to animate the yValue from the old value to the new value. This is what you should plot in any custom XYChart implementations. Some XYChart chart implementations such as LineChart also use this to animate when data is added or removed.

getCurrentExtraValue

final java.lang.Object getCurrentExtraValue()

setCurrentExtraValue

final void setCurrentExtraValue(java.lang.Object value)

currentExtraValueProperty

final <any> currentExtraValueProperty()

The current displayed data extra value. This may be the same as extraValue or different. It is used by XYChart to animate the extraValue from the old value to the new value. This is what you should plot in any custom XYChart implementations.

toString

public java.lang.String toString()

Returns a string representation of this Data object.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this Data object.