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:
public class NodeSeriesItem extends AbstractConfigurationObject
Data for the
NodeSeries
. Represents a link between the from and to nodes.See Also:
-
-
Constructor Summary
Constructors Constructor Description NodeSeriesItem()
Default constructor.
NodeSeriesItem(Node from, Node to)
-
Method Summary
All Methods Modifier and Type Method 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.
-
-
-
Constructor Detail
-
NodeSeriesItem
public NodeSeriesItem()
Default constructor.
-
NodeSeriesItem
public NodeSeriesItem(Node from, Node to)
Parameters:
from
- seesetFrom(Node)
to
- seesetTo(Node)
-
-
Method Detail
-
getFrom
public Node getFrom()
See Also:
-
setFrom
public void setFrom(Node from)
Parameters:
from
- The node that the link runs from.
-
getTo
public Node getTo()
See Also:
-
setTo
public void setTo(Node to)
Parameters:
to
- The node that the link runs to.
-
getClassName
public String getClassName()
See Also:
-
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
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 thefillOpacity
to 1.
-
getColorIndex
public Number getColorIndex()
See Also:
-
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 thefill
attribute, so the change in class name won't have a visual effect by default.
-
getDataLabels
public DataLabels getDataLabels()
See Also:
-
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
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
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
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
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
public void setOutgoing(Boolean outgoing)
Whether the link goes out of the system.
-
getSelected
public Boolean getSelected()
See Also:
-
setSelected
public void setSelected(Boolean selected)
Whether the data point is selected initially.
-
getWeight
public Number getWeight()
See Also:
-
setWeight
public void setWeight(Number weight)
The weight of the link.
-
-