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

Class DataSeriesItemTimeline

java.lang.Object

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

com.vaadin.flow.component.charts.model.AbstractSeriesItem

com.vaadin.flow.component.charts.model.DataSeriesItem

com.vaadin.flow.component.charts.model.DataSeriesItemTimeline

All Implemented Interfaces:

Serializable

public class DataSeriesItemTimeline
extends DataSeriesItem

DataSeriesItem that can hold also Label and Description values. Used in e.g. timeline series.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DataSeriesItemTimeline()
DataSeriesItemTimeline(Number x, String name, String label, String description)	Constructs an item with X, Name, Label and Description values
DataSeriesItemTimeline(String name, String label, String description)	Constructs an item with Name, Label and Description values
DataSeriesItemTimeline(Instant x, String name, String label, String description)	Constructs an item with X, Name, Label and Description values

Method Summary

Modifier and Type	Method	Description
String	getLabel()
void	setDescription(String description)	The description of event.
void	setLabel(String label)	The label of event.

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

getCursor, getDataLabels, getDescription, getDial, getHigh, getLow, isCustomized, isSelected, makeCustomized, setColor, setCursor, setDataLabels, setDial, setHigh, setId, setLegendIndex, setLow, setMarker, setName, setSelected, setSliced

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

getClassName, getColor, getColorIndex, getId, getLegendIndex, getMarker, getName, getSliced, getX, getY, setClassName, setColorIndex, setX, setX, setX, setY

Methods inherited from class java.lang.Object

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

Constructor Details

DataSeriesItemTimeline

public DataSeriesItemTimeline()

DataSeriesItemTimeline

public DataSeriesItemTimeline(String name,
 String label,
 String description)

Constructs an item with Name, Label and Description values

Parameters:

name -

label -

description -

DataSeriesItemTimeline

public DataSeriesItemTimeline(Number x,
 String name,
 String label,
 String description)

Constructs an item with X, Name, Label and Description values

Parameters:

x -

name -

label -

description -

DataSeriesItemTimeline

public DataSeriesItemTimeline(Instant x,
 String name,
 String label,
 String description)

Constructs an item with X, Name, Label and Description values

Parameters:

x -

name -

label -

description -

Method Details

getLabel

public String getLabel()

See Also:

• setLabel(String)

setLabel

public void setLabel(String label)

The label of event.

setDescription

public void setDescription(String description)

The description of event. This description will be shown in tooltip.

Defaults to: undefined

Overrides:

setDescription in class DataSeriesItem