Package com.vaadin.flow.component.charts.model

Class DataProviderSeries<T>

java.lang.Object

com.vaadin.flow.component.charts.model.AbstractConfigurationObject

com.vaadin.flow.component.charts.model.AbstractSeries

com.vaadin.flow.component.charts.model.DataProviderSeries<T>

All Implemented Interfaces:

Series, Serializable

public class DataProviderSeries<T>
extends AbstractSeries

A series which is based on data from a DataProvider.

You must use setY(SerializableFunction) to define which part of the data bean to use as y values.

Note that even if you use a lazy loading DataProvider, this series will work in an eager fashion and load all the data from the provider at once.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLOSE_PROPERTY
static final String	HIGH_PROPERTY
static final String	LOW_PROPERTY
static final String	OPEN_PROPERTY
static final String	X_ATTRIBUTE
static final String	Y_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
DataProviderSeries(DataProvider<T,?> dataProvider)	Creates a new series using data from the given data provider.
DataProviderSeries(DataProvider<T,?> dataProvider, SerializableFunction<T,Object> callBack)	Creates a new series using data from the given data provider and y values.

Method Summary

Modifier and Type	Method	Description
Set<String>	getChartAttributes()	Returns a set of chart attributes(keys).
DataProvider<T,?>	getDataProvider()	Returns the underlying data provider.
List<Map<String,Optional<Object>>>	getValues()	Returns a list mappings between chart attributes(keys) and values.
boolean	isAutomaticChartUpdateEnabled()	Returns true if the chart is updated automatically when a DataChangeEvent is emitted by the data provider.
void	setAutomaticChartUpdateEnabled(boolean automaticChartUpdateEnabled)	Sets if the chart should be updated automatically when a DataChangeEvent is emitted by the data provider.
void	setClose(SerializableFunction<T,Object> callBack)	Sets the function used for retrieving close values from the bean provided by the data provider.
void	setHigh(SerializableFunction<T,Object> callBack)	Sets the function used for retrieving high values from the bean provided by the data provider.
void	setLow(SerializableFunction<T,Object> callBack)	Sets the function used for retrieving low values from the bean provided by the data provider.
void	setOpen(SerializableFunction<T,Object> callBack)	Sets the function used for retrieving open values from the bean provided by the data provider.
void	setPointName(SerializableFunction<T,Object> callBack)	Sets the function used for retrieving name values from the bean provided by the data provider.
void	setProperty(String propertyName, SerializableFunction<T,Object> callBack)	Sets the function used for retrieving the value for the given property name from the given data provider.
void	setX(SerializableFunction<T,Object> callBack)	Sets the function used for retrieving x values from the bean provided by the data provider.
void	setY(SerializableFunction<T,Object> callBack)	Sets the function used for retrieving y values from the bean provided by the data provider.

Methods inherited from class com.vaadin.flow.component.charts.model.AbstractSeries

getColorAxis, getConfiguration, getId, getName, getPlotOptions, getStack, getxAxis, getyAxis, isVisible, setColorAxis, setConfiguration, setId, setName, setPlotOptions, setStack, setVisible, setVisible, setxAxis, setyAxis, setyAxis, updateSeries

Methods inherited from class java.lang.Object

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

Field Details

X_ATTRIBUTE

public static final String X_ATTRIBUTE

See Also:

• Constant Field Values

Y_ATTRIBUTE

public static final String Y_ATTRIBUTE

See Also:

• Constant Field Values

HIGH_PROPERTY

public static final String HIGH_PROPERTY

See Also:

• Constant Field Values

LOW_PROPERTY

public static final String LOW_PROPERTY

See Also:

• Constant Field Values

OPEN_PROPERTY

public static final String OPEN_PROPERTY

See Also:

• Constant Field Values

CLOSE_PROPERTY

public static final String CLOSE_PROPERTY

See Also:

• Constant Field Values

Constructor Details

DataProviderSeries

public DataProviderSeries(DataProvider<T,?> dataProvider)

Creates a new series using data from the given data provider.

Many chart types such as ChartType.BAR, ChartType.LINE, ChartType.AREA etc use y values to define the data points to show in the chart. For these chart types you should use either DataProviderSeries(DataProvider, SerializableFunction) or setY(SerializableFunction) to define the function (lambda) which extracts the values from the bean in the provider.

Other chart types such as ChartType.ERRORBAR do not require y values but instead high and low values. Functions for extracting these are set using setHigh(SerializableFunction) and setLow(SerializableFunction) respectively.

Parameters:

dataProvider - the data provider which contains the data

DataProviderSeries

public DataProviderSeries(DataProvider<T,?> dataProvider,
 SerializableFunction<T,Object> callBack)

Creates a new series using data from the given data provider and y values.

Parameters:

dataProvider - the data provider which contains the data

callBack - the function which retrieves the y values

Method Details

setProperty

public void setProperty(String propertyName,
 SerializableFunction<T,Object> callBack)

Sets the function used for retrieving the value for the given property name from the given data provider.

Parameters:

propertyName - the property name

callBack - the function which retrieves the value for the property

setX

public void setX(SerializableFunction<T,Object> callBack)

Sets the function used for retrieving x values from the bean provided by the data provider.

How exactly the values are used depends on the used chart type.

Parameters:

callBack - the function which retrieves the values

setY

public void setY(SerializableFunction<T,Object> callBack)

Sets the function used for retrieving y values from the bean provided by the data provider.

How exactly the values are used depends on the used chart type.

Parameters:

callBack - the function which retrieves the values

setPointName

public void setPointName(SerializableFunction<T,Object> callBack)

Sets the function used for retrieving name values from the bean provided by the data provider.

How exactly the values are used depends on the used chart type.

Parameters:

callBack - the function which retrieves the values

setLow

public void setLow(SerializableFunction<T,Object> callBack)

Sets the function used for retrieving low values from the bean provided by the data provider.

How exactly the values are used depends on the used chart type.

Parameters:

callBack - the function which retrieves the values

setHigh

public void setHigh(SerializableFunction<T,Object> callBack)

Sets the function used for retrieving high values from the bean provided by the data provider.

How exactly the values are used depends on the used chart type.

Parameters:

callBack - the function which retrieves the values

setOpen

public void setOpen(SerializableFunction<T,Object> callBack)

Sets the function used for retrieving open values from the bean provided by the data provider.

How exactly the values are used depends on the used chart type.

Parameters:

callBack - the function which retrieves the values

setClose

public void setClose(SerializableFunction<T,Object> callBack)

Sets the function used for retrieving close values from the bean provided by the data provider.

How exactly the values are used depends on the used chart type.

Parameters:

callBack - the function which retrieves the values

getDataProvider

public DataProvider<T,?> getDataProvider()

Returns the underlying data provider.

Returns:

the underlying data provider.

getValues

public List<Map<String,Optional<Object>>> getValues()

Returns a list mappings between chart attributes(keys) and values. For example: x->1, x->2, y->2, y->3 for linear chart

Returns:

getChartAttributes

public Set<String> getChartAttributes()

Returns a set of chart attributes(keys).

Returns:

isAutomaticChartUpdateEnabled

public boolean isAutomaticChartUpdateEnabled()

Returns true if the chart is updated automatically when a DataChangeEvent is emitted by the data provider. Default is true.

Returns:

setAutomaticChartUpdateEnabled

public void setAutomaticChartUpdateEnabled(boolean automaticChartUpdateEnabled)

Sets if the chart should be updated automatically when a DataChangeEvent is emitted by the data provider. Default is true.

Parameters:

automaticChartUpdateEnabled - True sets the chart updating to enabled, false disables it.