We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
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:
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:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDataProviderSeries(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 TypeMethodDescriptionReturns a set of chart attributes(keys).
DataProvider<T,?> Returns the underlying data provider.
Returns a list mappings between chart attributes(keys) and values.
booleanReturns true if the chart is updated automatically when a DataChangeEvent is emitted by the data provider.
voidsetAutomaticChartUpdateEnabled(boolean automaticChartUpdateEnabled) Sets if the chart should be updated automatically when a DataChangeEvent is emitted by the data provider.
voidsetClose(SerializableFunction<T, Object> callBack) Sets the function used for retrieving
closevalues from the bean provided by the data provider.voidsetHigh(SerializableFunction<T, Object> callBack) Sets the function used for retrieving
highvalues from the bean provided by the data provider.voidsetLow(SerializableFunction<T, Object> callBack) Sets the function used for retrieving
lowvalues from the bean provided by the data provider.voidsetOpen(SerializableFunction<T, Object> callBack) Sets the function used for retrieving
openvalues from the bean provided by the data provider.voidsetPointName(SerializableFunction<T, Object> callBack) Sets the function used for retrieving
namevalues from the bean provided by the data provider.voidsetProperty(String propertyName, SerializableFunction<T, Object> callBack) Sets the function used for retrieving the value for the given property name from the given data provider.
voidsetX(SerializableFunction<T, Object> callBack) Sets the function used for retrieving
xvalues from the bean provided by the data provider.voidsetY(SerializableFunction<T, Object> callBack) Sets the function used for retrieving
yvalues 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
-
Field Details
-
X_ATTRIBUTE
See Also:
-
Y_ATTRIBUTE
See Also:
-
HIGH_PROPERTY
See Also:
-
LOW_PROPERTY
See Also:
-
OPEN_PROPERTY
See Also:
-
CLOSE_PROPERTY
See Also:
-
-
Constructor Details
-
DataProviderSeries
Creates a new series using data from the given data provider.
Many chart types such as
ChartType.BAR,ChartType.LINE,ChartType.AREAetc useyvalues to define the data points to show in the chart. For these chart types you should use eitherDataProviderSeries(DataProvider, SerializableFunction)orsetY(SerializableFunction)to define the function (lambda) which extracts the values from the bean in the provider.Other chart types such as
ChartType.ERRORBARdo not requireyvalues but insteadhighandlowvalues. Functions for extracting these are set usingsetHigh(SerializableFunction)andsetLow(SerializableFunction)respectively.Parameters:
dataProvider- the data provider which contains the data -
DataProviderSeries
Creates a new series using data from the given data provider and y values.
Parameters:
dataProvider- the data provider which contains the datacallBack- the function which retrieves the y values
-
-
Method Details
-
setProperty
Sets the function used for retrieving the value for the given property name from the given data provider.
Parameters:
propertyName- the property namecallBack- the function which retrieves the value for the property -
setX
Sets the function used for retrieving
xvalues 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
Sets the function used for retrieving
yvalues 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
Sets the function used for retrieving
namevalues 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
Sets the function used for retrieving
lowvalues 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
Sets the function used for retrieving
highvalues 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
Sets the function used for retrieving
openvalues 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
Sets the function used for retrieving
closevalues 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
Returns the underlying data provider.
Returns:
the underlying data provider.
-
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
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.
-