com.vaadin.flow.component.charts.model.
Class Node
- java.lang.Object
-
- com.vaadin.flow.component.charts.model.AbstractConfigurationObject
-
- com.vaadin.flow.component.charts.model.Node
-
All Implemented Interfaces:
public class Node extends AbstractConfigurationObject
A collection of options for the individual nodes. The nodes in an org chart are auto-generated instances of Highcharts.Point, but options can be applied here and linked by the id.
See Also:
-
-
Constructor Summary
Constructors Constructor and Description Node()
Default constructor.
Node(String id)
Node(String id, String name)
Node(String id, String name, String title)
-
Method Summary
All Methods Modifier and Type Method and Description boolean
equals(Object o)
Color
getColor()
Number
getColorIndex()
Number
getColumn()
DataLabels
getDataLabels()
String
getDescription()
String
getId()
String
getImage()
NodeLayout
getLayout()
Number
getLevel()
String
getName()
String
getOffset()
String
getTitle()
int
hashCode()
void
setColor(Color color)
The color of the auto generated node.
void
setColorIndex(Number colorIndex)
The color index of the auto generated node, especially for use in styled mode.
void
setColumn(Number column)
An optional column index of where to place the node.
void
setDataLabels(DataLabels dataLabels)
Individual data label for each node.
void
setDescription(String description)
The job description for the node card, will be inserted by the default dataLabel.nodeFormatter.
void
setId(String id)
The id of the auto-generated node, referring to the from or to setting of the link.
void
setImage(String image)
An image for the node card, will be inserted by the default dataLabel.nodeFormatter.
void
setLayout(NodeLayout layout)
Layout for the node's children.
void
setLevel(Number level)
An optional level index of where to place the node.
void
setName(String name)
The name to display for the node in data labels and tooltips.
void
setOffset(String offset)
In a horizontal layout, the vertical offset of a node in terms of weight.
void
setTitle(String title)
The job title for the node card, will be inserted by the default dataLabel.nodeFormatter.
-
-
-
Constructor Detail
-
Node
public Node()
Default constructor.
-
Node
public Node(String id)
Parameters:
id
- seesetId(String)
-
Node
public Node(String id, String name)
Parameters:
id
- seesetId(String)
name
- seesetName(String)
-
Node
public Node(String id, String name, String title)
Parameters:
id
- seesetId(String)
name
- seesetName(String)
title
- seesetTitle(String)
-
-
Method Detail
-
getColor
public Color getColor()
See Also:
-
setColor
public void setColor(Color color)
The color of the auto generated node.
-
getColorIndex
public Number getColorIndex()
See Also:
-
setColorIndex
public void setColorIndex(Number colorIndex)
The color index of the auto generated node, especially for use in styled mode.
-
getColumn
public Number getColumn()
See Also:
-
setColumn
public void setColumn(Number column)
An optional column index of where to place the node. The default behaviour is to place it next to the preceding node. Note that this option name is counter intuitive in inverted charts, like for example an organization chart rendered top down. In this case the "columns" are horizontal.
-
getDataLabels
public DataLabels getDataLabels()
See Also:
-
setDataLabels
public void setDataLabels(DataLabels dataLabels)
Individual data label for each node.
-
getDescription
public String getDescription()
See Also:
-
setDescription
public void setDescription(String description)
The job description for the node card, will be inserted by the default dataLabel.nodeFormatter.
-
getId
public String getId()
See Also:
-
setId
public void setId(String id)
The id of the auto-generated node, referring to the from or to setting of the link.
-
getImage
public String getImage()
See Also:
-
setImage
public void setImage(String image)
An image for the node card, will be inserted by the default dataLabel.nodeFormatter.
-
getLayout
public NodeLayout getLayout()
See Also:
-
setLayout
public void setLayout(NodeLayout layout)
Layout for the node's children. If hanging, this node's children will hang below their parent, allowing a tighter packing of nodes in the diagram
-
getLevel
public Number getLevel()
See Also:
-
setLevel
public void setLevel(Number level)
An optional level index of where to place the node. The default behaviour is to place it next to the preceding node. Alias of nodes.column, but in inverted sankeys and org charts, the levels are laid out as rows.
-
getName
public String getName()
See Also:
-
setName
public void setName(String name)
The name to display for the node in data labels and tooltips. Use this when the name is different from the id. Where the id must be unique for each node, this is not necessary for the name
-
getOffset
public String getOffset()
See Also:
-
setOffset
public void setOffset(String offset)
In a horizontal layout, the vertical offset of a node in terms of weight. Positive values shift the node downwards, negative shift it upwards. In a vertical layout, like organization chart, the offset is horizontal. If a percentage string is given, the node is offset by the percentage of the node size plus nodePadding. Defaults to 0.
-
getTitle
public String getTitle()
See Also:
-
setTitle
public void setTitle(String title)
The job title for the node card, will be inserted by the default dataLabel.nodeFormatter.
-
-