Class NodeSeriesItem
- All Implemented Interfaces:
Serializable
NodeSeries
. Represents a link between the from and to
nodes.- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetColor()
getFrom()
getId()
getName()
getTo()
void
setClassName
(String className) An additional, individual class name for the data point's graphic representation.void
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 namehighcharts-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
void
An id for the point.void
setLabelrank
(Number labelrank) The rank for this point's data label in case of collision.void
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
void
The weight of the link.
-
Constructor Details
-
NodeSeriesItem
public NodeSeriesItem()Default constructor. -
NodeSeriesItem
- Parameters:
from
- seesetFrom(Node)
to
- seesetTo(Node)
-
-
Method Details
-
getFrom
- See Also:
-
setFrom
- Parameters:
from
- The node that the link runs from.
-
getTo
- See Also:
-
setTo
- Parameters:
to
- The node that the link runs to.
-
getClassName
- See Also:
-
setClassName
An additional, individual class name for the data point's graphic representation.
-
getColor
- See Also:
-
setColor
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
- See Also:
-
setColorIndex
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
- See Also:
-
setDataLabels
Individual data label for each point. The options are the same as the ones for plotOptions.series.dataLabels.
-
getDescription
- See Also:
-
setDescription
A description of the point to add to the screen reader information about the point.
-
getId
- See Also:
-
setId
An id for the point. This can be used after render time to get a pointer to the point object through
chart.get()
. -
getLabelrank
- See Also:
-
setLabelrank
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
- See Also:
-
setName
The name of the point as shown in the legend, tooltip, dataLabels, etc.
-
getOutgoing
- See Also:
-
setOutgoing
Whether the link goes out of the system.
-
getSelected
- See Also:
-
setSelected
Whether the data point is selected initially.
-
getWeight
- See Also:
-
setWeight
The weight of the link.
-