Module xaos.ui.plot

Package eu.ess.xaos.ui.plot.data

Class ErrorSeries<X,Y>

java.lang.Object

eu.ess.xaos.ui.plot.data.ErrorSeries<X,Y>

Type Parameters:

X - The X type of the series.

Y - The Y type of the series.

public class ErrorSeries<X,Y>
extends Object

Holds the values of the error bars.

Author:

natalia.milas@esss.se, claudio.rosati@esss.se

CSS Style Class Name:

chart-error-paths

Property Summary

Properties

Type	Property	Description
StringProperty	name
ObjectProperty<Node>	node

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ErrorSeries.ErrorData<X,Y>

Constructor Summary

Constructors

Constructor	Description
ErrorSeries()	Construct a empty series.
ErrorSeries(String name, ObservableList<ErrorSeries.ErrorData<X,Y>> data)	Constructs a named series and populates it with the given ObservableList data.
ErrorSeries(ObservableList<ErrorSeries.ErrorData<X,Y>> data)	Constructs the series and populates it with the given ObservableList data.

Method Summary

Modifier and Type	Method	Description
void	addErrorData(ErrorSeries.ErrorData<X,Y> value)	Adds the given value to the series.
ObservableList<ErrorSeries.ErrorData<X,Y>>	getData()
String	getName()
Node	getNode()	Returns the node to display for this series.
Integer	getSeriesRef()
StringProperty	nameProperty()
ObjectProperty<Node>	nodeProperty()
void	setData(ObservableList<ErrorSeries.ErrorData<X,Y>> data)
void	setName(String name)	Sets the series' name.
void	setNode(Node value)	Sets the node to display for this series.
void	setSeriesRef(Integer seriesRef)	Sets the series number to attach error bar.
String	toString()	Returns a string representation of this Series object.

Methods inherited from class java.lang.Object

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

Property Detail

name

public final StringProperty nameProperty

See Also:

getName(), setName(String)

node

public final ObjectProperty<Node> nodeProperty

See Also:

getNode(), setNode(Node)

Constructor Detail

ErrorSeries

public ErrorSeries()

Construct a empty series.

ErrorSeries

public ErrorSeries(ObservableList<ErrorSeries.ErrorData<X,Y>> data)

Constructs the series and populates it with the given ObservableList data.

Parameters:

data - ObservableList of ErrorSeries.ErrorData.

ErrorSeries

public ErrorSeries(String name,
                   ObservableList<ErrorSeries.ErrorData<X,Y>> data)

Constructs a named series and populates it with the given ObservableList data.

Parameters:

name - The name of the series.

data - ObservableList of ErrorSeries.ErrorData.

Method Detail

nameProperty

public final StringProperty nameProperty()

See Also:

getName(), setName(String)

getName

public final String getName()

Returns:

The series' name.

setName

public final void setName(String name)

Sets the series' name.

Parameters:

name - The new series' name.

nodeProperty

public final ObjectProperty<Node> nodeProperty()

See Also:

getNode(), setNode(Node)

getNode

public final Node getNode()

Returns the node to display for this series. This is created by the chart if it uses nodes to represent the whole series. For example line chart uses this for the line but scatter chart does not use it. This node will be set as soon as the series is added to the chart. You can then get it to add mouse listeners etc.

Returns:

The node to display for this series.

setNode

public final void setNode(Node value)

Sets the node to display for this series.

Parameters:

value - The new node to display.

See Also:

getNode()

addErrorData

public void addErrorData(ErrorSeries.ErrorData<X,Y> value)

Adds the given value to the series.

Parameters:

value - The value to be added to the series.

getData

public final ObservableList<ErrorSeries.ErrorData<X,Y>> getData()

Returns:

The displayed error data.

getSeriesRef

public Integer getSeriesRef()

Returns:

The series number to attach error bar.

setData

public final void setData(ObservableList<ErrorSeries.ErrorData<X,Y>> data)

setSeriesRef

public void setSeriesRef(Integer seriesRef)

Sets the series number to attach error bar.

Parameters:

seriesRef - The new series number.

toString

public String toString()

Returns a string representation of this Series object.

Overrides:

toString in class Object

Returns:

a string representation of this Series object.