com.vaadin.flow.component.charts.model

Class AbstractSeriesItem

java.lang.Object

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

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DataSeriesItem, TreeSeriesItem

public class AbstractSeriesItem
extends AbstractConfigurationObject

Abstract superclass for chart series items

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractSeriesItem()

Method Summary

Modifier and Type	Method and Description
String	getClassName() Returns the class name of the item
Number	getColorIndex() Returns the colorIndex of the item.
String	getId() Returns the id of the item.
Number	getLegendIndex() Returns the index of the legend.
Marker	getMarker() Returns the marker of the item.
String	getName() Returns the name of the item.
boolean	getSliced() Checks whether or not the item is sliced.
Number	getX() Returns the X-value of the item.
Number	getY() Returns the Y-value of the item.
void	setClassName(String className) An additional, individual class name for the data point's graphic representation.
void	setColorIndex(Number colorIndex) A specific color index to use for the point, so its graphic representations are given the class name highcharts-color-{n}.
void	setId(String id) Sets the ID for the point.
void	setLegendIndex(Number legendIndex) Sets the sequential index of the pie slice in the legend.
void	setMarker(Marker marker) Sets the marker of this data series item
void	setName(String name) Sets the name of the data item as shown in the legend, tooltip, dataLabel etc.
void	setSliced(boolean sliced) Sets whether to display a slice offset from the center.
void	setX(Date date) Deprecated. as of 4.0. Use setX(Instant)
void	setX(Instant instant) Sets the given instant as the x value.
void	setX(Number x) Sets the X value of this data item.
void	setY(Number y) Sets the Y value of this data item.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSeriesItem

public AbstractSeriesItem()

Method Detail

getName

public String getName()

Returns the name of the item.

Returns:

The name of the data item or null if not defined.

See Also:

setName(String)

setName

public void setName(String name)

Sets the name of the data item as shown in the legend, tooltip, dataLabel etc. Defaults to "".

Parameters:

name - Name of the item.

getY

public Number getY()

Returns the Y-value of the item.

Returns:

The Y value of this data item.

See Also:

setY(Number)

setY

public void setY(Number y)

Sets the Y value of this data item. Defaults to null.

Parameters:

y - Y-value of the item.

getX

public Number getX()

Returns the X-value of the item.

Returns:

The X value of this data item.

See Also:

setX(Number)

setX

public void setX(Number x)

Sets the X value of this data item. Defaults to null.

Parameters:

x - X-value of the item.

setX

public void setX(Instant instant)

Sets the given instant as the x value.

Parameters:

instant - Instant to set.

setX

@Deprecated
public void setX(Date date)

Deprecated. as of 4.0. Use setX(Instant)

getSliced

public boolean getSliced()

Checks whether or not the item is sliced. Makes sense only in pie charts.

Returns:

true when this data item is displayed offset from the center in a pie chart, false otherwise.

See Also:

setSliced(boolean)

setSliced

public void setSliced(boolean sliced)

Sets whether to display a slice offset from the center. Defaults to false. Note: This applies to pie charts only.

Parameters:

sliced - When true, this item should be displayed with a small offset from the centre of the pie chart; when false, this item will be rendered normally.

getColorIndex

public Number getColorIndex()

Returns the colorIndex of the item.

Returns:

The colorIndex of the item.

See Also:

setColorIndex(Number)

setColorIndex

public void setColorIndex(Number colorIndex)

A specific color index to use for the point, so its graphic representations are given the class name highcharts-color-{n}.

Parameters:

colorIndex - Color of the item.

getLegendIndex

public Number getLegendIndex()

Returns the index of the legend. Applicable only to pie charts.

Returns:

The index of the legend or null if not defined. Only applicable for pie charts.

See Also:

setLegendIndex(Number)

setLegendIndex

public void setLegendIndex(Number legendIndex)

Sets the sequential index of the pie slice in the legend. Defaults to undefined. Note This applies to pie charts only.

Parameters:

legendIndex - Index in the legend.

setMarker

public void setMarker(Marker marker)

Sets the marker of this data series item

Parameters:

marker - Marker of the item.

getMarker

public Marker getMarker()

Returns the marker of the item.

Returns:

The marker of this data series item. If none is specified a new Marker will be created.

See Also:

setMarker(Marker)

getId

public String getId()

Returns the id of the item.

Returns:

The ID of the item.

See Also:

setId(String)

setId

public void setId(String id)

Sets the ID for the point. This can be used after rendering to get a reference to the point object. Defaults to null.

Parameters:

id - New id.

getClassName

public String getClassName()

Returns the class name of the item

Returns:

The class name of the item

See Also:

setClassName(String)

setClassName

public void setClassName(String className)

An additional, individual class name for the data point's graphic representation.

Parameters:

className - new class name of the item