com.vaadin.flow.component.charts.model

Class NodeSeriesItem

java.lang.Object

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

com.vaadin.flow.component.charts.model.NodeSeriesItem

All Implemented Interfaces:

Serializable

public class NodeSeriesItem
extends AbstractConfigurationObject

Data for the NodeSeries. Represents a link between the from and to nodes.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NodeSeriesItem() Default constructor.
NodeSeriesItem(Node from, Node to)

Method Summary

Modifier and Type	Method and Description
String	getClassName()
Color	getColor()
Number	getColorIndex()
DataLabels	getDataLabels()
String	getDescription()
Node	getFrom()
String	getId()
Number	getLabelrank()
String	getName()
Boolean	getOutgoing()
Boolean	getSelected()
Node	getTo()
Number	getWeight()
void	setClassName(String className) An additional, individual class name for the data point's graphic representation.
void	setColor(Color color) The color for the individual link.
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	setDataLabels(DataLabels dataLabels) Individual data label for each point.
void	setDescription(String description) A description of the point to add to the screen reader information about the point.
void	setFrom(Node from)
void	setId(String id) An id for the point.
void	setLabelrank(Number labelrank) The rank for this point's data label in case of collision.
void	setName(String name) The name of the point as shown in the legend, tooltip, dataLabels, etc.
void	setOutgoing(Boolean outgoing) Whether the link goes out of the system.
void	setSelected(Boolean selected) Whether the data point is selected initially.
void	setTo(Node to)
void	setWeight(Number weight) The weight of the link.

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeSeriesItem

public NodeSeriesItem()

Default constructor.

NodeSeriesItem

public NodeSeriesItem(Node from,
                      Node to)

Parameters:

from - see setFrom(Node)

to - see setTo(Node)

Method Detail

getFrom

public Node getFrom()

See Also:

setFrom(Node)

setFrom

public void setFrom(Node from)

Parameters:

from - The node that the link runs from.

getTo

public Node getTo()

See Also:

setTo(Node)

setTo

public void setTo(Node to)

Parameters:

to - The node that the link runs to.

getClassName

public String getClassName()

See Also:

setClassName(String)

setClassName

public void setClassName(String className)

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

getColor

public Color getColor()

See Also:

setColor(Color)

setColor

public void setColor(Color color)

The color for the individual link. By default, the link color is the same as the node it extends from. The series.fillOpacity option also applies to the points, so when setting a specific link color, consider setting the fillOpacity to 1.

getColorIndex

public Number getColorIndex()

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}. In styled mode this will change the color of the graphic. In non-styled mode, the color by is set by the fill attribute, so the change in class name won't have a visual effect by default.

getDataLabels

public DataLabels getDataLabels()

See Also:

setDataLabels(DataLabels)

setDataLabels

public void setDataLabels(DataLabels dataLabels)

Individual data label for each point. The options are the same as the ones for plotOptions.series.dataLabels.

getDescription

public String getDescription()

See Also:

setDescription(String)

setDescription

public void setDescription(String description)

A description of the point to add to the screen reader information about the point.

getId

public String getId()

See Also:

setId(String)

setId

public void setId(String id)

An id for the point. This can be used after render time to get a pointer to the point object through chart.get().

getLabelrank

public Number getLabelrank()

See Also:

setLabelrank(Number)

setLabelrank

public void setLabelrank(Number labelrank)

The rank for this point's data label in case of collision. If two data labels are about to overlap, only the one with the highest labelrank will be drawn.

getName

public String getName()

See Also:

setName(String)

setName

public void setName(String name)

The name of the point as shown in the legend, tooltip, dataLabels, etc.

getOutgoing

public Boolean getOutgoing()

See Also:

setOutgoing(Boolean)

setOutgoing

public void setOutgoing(Boolean outgoing)

Whether the link goes out of the system.

getSelected

public Boolean getSelected()

See Also:

setSelected(Boolean)

setSelected

public void setSelected(Boolean selected)

Whether the data point is selected initially.

getWeight

public Number getWeight()

See Also:

setWeight(Number)

setWeight

public void setWeight(Number weight)

The weight of the link.