NodeLayoutDescriptor (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.layout.hierarchic.NodeLayoutDescriptor

```
public class NodeLayoutDescriptor
extends Object
```
This class is used by HierarchicLayoutCore during the various phases to provide the drawing details of the nodes of the graph.
A NodeLayoutDescriptor instance can be specified individually for single nodes using a IDataProvider that returns a NodeLayoutDescriptor instance for each node of the graph, or null if no NodeLayoutDescriptor is bound to an edge. The IDataProvider is registered with the graph with key HierarchicLayoutCore.NODE_LAYOUT_DESCRIPTOR_DPKEY.

This class is designed as a class to allow future additions of new getter methods.

Not all of these values will be used for all kinds of edges and any kind of algorithm.

See Also:

HierarchicLayoutCore.NODE_LAYOUT_DESCRIPTOR_DPKEY, EdgeLayoutDescriptor

Constructor Summary

Constructors
Constructor and Description

NodeLayoutDescriptor()
Creates a new instance of a NodeLayoutDescriptor with the default values.

Constructors
Constructor and Description
`NodeLayoutDescriptor()` Creates a new instance of a `NodeLayoutDescriptor` with the default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`YPoint`	`getGridReference()` Gets a reference point relative to the center of the node which will be placed on a grid coordinate.
`double`	`getLayerAlignment()` Gets the alignment of the `node` of this `NodeLayoutDescriptor` instance within its layer.
`double`	`getMinimumDistance()` Gets the preferred minimum distance to obstacles.
`double`	`getMinimumLayerHeight()` Gets the minimum height of the layer to which this node is assigned.
`NodeLabelMode`	`getNodeLabelMode()` Gets the mode that determines how node labels are handled by the algorithm during the layout.
`PortAssignmentMode`	`getPortAssignment()` Gets the assignment strategy which distributes the ports along the node borders.
`double`	`getPortBorderGapRatio(int side)` Returns the port border gap ratio for the port distribution at a given side of the node.
`void`	`setGridReference(YPoint value)` Sets a reference point relative to the center of the node which will be placed on a grid coordinate.
`void`	`setLayerAlignment(double value)` Sets the alignment of the `node` of this `NodeLayoutDescriptor` instance within its layer.
`void`	`setMinimumDistance(double value)` Sets the preferred minimum distance to obstacles.
`void`	`setMinimumLayerHeight(double value)` Sets the minimum height of the layer to which this node is assigned.
`void`	`setNodeLabelMode(NodeLabelMode value)` Sets the mode that determines how node labels are handled by the algorithm during the layout.
`void`	`setPortAssignment(PortAssignmentMode value)` Sets the assignment strategy which distributes the ports along the node borders.
`void`	`setPortBorderGapRatio(int side, double ratio)` Specifies the port border gap ratio for the port distribution at a given side of the node.
`void`	`setPortBorderGapRatios(double value)` Sets the port border gap ratio for the port distribution on all sides of the node.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NodeLayoutDescriptor
```
public NodeLayoutDescriptor()
```
    Creates a new instance of a NodeLayoutDescriptor with the default values.
- Method Detail
  - getGridReference
```
public YPoint getGridReference()
```
    Gets a reference point relative to the center of the node which will be placed on a grid coordinate.
    
    The grid reference point will only be considered if there actually is a grid.
    
    Default Value:
    The default value is YPoint.ORIGIN. The reference point is YPoint.ORIGIN and the center of the node is placed on the grid.
    
    Returns:
    
    the reference point for grid placement
    
    See Also:
    
    setGridReference(YPoint)
  - getLayerAlignment
```
public double getLayerAlignment()
```
    Gets the alignment of the node of this NodeLayoutDescriptor instance within its layer.
    - A value of 0.0d corresponds to top-alignment.
    - A value of 0.5d corresponds to center-alignment.
    - A value of 1.0d corresponds to bottom-alignment.
    This value should be within [0,1] interval.
    Throws:
    
    IllegalArgumentException - if the alignment is not within [0.0d .. 1.0d]
    
    Default Value:
    The default value is 0.5d. Nodes are center-aligned within their corresponding layers.
    
    Returns:
    
    a value from [0,1] interval
    
    See Also:
    
    setLayerAlignment(double)
  - getMinimumDistance
```
public double getMinimumDistance()
```
    Gets the preferred minimum distance to obstacles.
    The minimum distance should be greater than 0.
    
    Throws:
    
    IllegalArgumentException - if the minimum length is negative
    
    Default Value:
    The default value is 5.0d.
    
    Returns:
    
    the minimum distance to obstacles
    
    See Also:
    
    setMinimumDistance(double)
  - getMinimumLayerHeight
```
public double getMinimumLayerHeight()
```
    Gets the minimum height of the layer to which this node is assigned.
    Values should be greater than 0.
    
    Throws:
    
    IllegalArgumentException - if the minimum height is negative
    
    This feature will have an effect if different layerAlignments are present.
    
    Default Value:
    The default value is 0.0d.
    
    Returns:
    
    a non-negative minimum height
    
    See Also:
    
    setMinimumLayerHeight(double)
  - getNodeLabelMode
```
public NodeLabelMode getNodeLabelMode()
```
    Gets the mode that determines how node labels are handled by the algorithm during the layout.
    
    Throws:
    
    IllegalArgumentException - if the constant is unknown.
    
    To enable this feature, information about the layout of the node labels must be provided. If HierarchicLayout is used for the layout, method NodeLabelConsiderationEnabled should be set to true. Otherwise, one has to assure that e.g., via an instance of LabelLayoutTranslator, the algorithm receives the appropriate information.
    
    Default Value:
    The default value is NodeLabelMode.CONSIDER_FOR_DRAWING. Node labels will be considered for node placement and routing, but not for self-loops.
    
    Returns:
    
    one of the predefined constants
    
    See Also:
    
    HierarchicLayout.setNodeLabelConsiderationEnabled(boolean), setNodeLabelMode(NodeLabelMode)
  - getPortAssignment
```
public PortAssignmentMode getPortAssignment()
```
    Gets the assignment strategy which distributes the ports along the node borders.
    
    Port assignments PortAssignmentMode.DEFAULT, PortAssignmentMode.ON_GRID and PortAssignmentMode.ON_SUBGRID are currently only supported in DefaultPortAllocator. A custom implementation of IPortAllocator will have to handle these assignments itself or will replace them with its own behavior.
    
    Default Value:
    The default value is PortAssignmentMode.DEFAULT. Ports are distributed evenly along the border of the node.
    
    Returns:
    
    one of the predefined port assignment strategies
    
    See Also:
    
    setPortAssignment(PortAssignmentMode)
  - getPortBorderGapRatio
```
public double getPortBorderGapRatio(int side)
```
    Returns the port border gap ratio for the port distribution at a given side of the node.
    This ratio determines the gap between a corner of the node and the first assigned port.
    
    The ratio should be greater than 0.
    
    A value of 0.0d results in ports being placed directly on the corner of the node (if there is more than one port).
    
    A value of 0.5d results in ports being distributed along the side of the node so that the distance between the corner of the node and the first port is half as wide as the distance between two adjacent ports.
    
    A value of Double.POSITIVE_INFINITY results in all ports being centered at the side in one point.
    
    Parameters:
    
    side - the zero-based clockwise side index for top-to-bottom layouts (i.e., top is 0)
    
    Returns:
    
    the border gap ratio of a given side
    
    See Also:
    
    setPortBorderGapRatios(double), setPortBorderGapRatio(int, double)
  - setGridReference
```
public void setGridReference(YPoint value)
```
    Sets a reference point relative to the center of the node which will be placed on a grid coordinate.
    
    The grid reference point will only be considered if there actually is a grid.
    
    Default Value:
    The default value is YPoint.ORIGIN. The reference point is YPoint.ORIGIN and the center of the node is placed on the grid.
    
    Parameters:
    
    value - the reference point for grid placement
    
    See Also:
    
    getGridReference()
  - setLayerAlignment
```
public void setLayerAlignment(double value)
```
    Sets the alignment of the node of this NodeLayoutDescriptor instance within its layer.
    - A value of 0.0d corresponds to top-alignment.
    - A value of 0.5d corresponds to center-alignment.
    - A value of 1.0d corresponds to bottom-alignment.
    This value should be within [0,1] interval.
    Throws:
    
    IllegalArgumentException - if the alignment is not within [0.0d .. 1.0d]
    
    Default Value:
    The default value is 0.5d. Nodes are center-aligned within their corresponding layers.
    
    Parameters:
    
    value - a value from [0,1] interval
    
    See Also:
    
    getLayerAlignment()
  - setMinimumDistance
```
public void setMinimumDistance(double value)
```
    Sets the preferred minimum distance to obstacles.
    The minimum distance should be greater than 0.
    
    Throws:
    
    IllegalArgumentException - if the minimum length is negative
    
    Default Value:
    The default value is 5.0d.
    
    Parameters:
    
    value - the minimum distance to obstacles
    
    See Also:
    
    getMinimumDistance()
  - setMinimumLayerHeight
```
public void setMinimumLayerHeight(double value)
```
    Sets the minimum height of the layer to which this node is assigned.
    Values should be greater than 0.
    
    Throws:
    
    IllegalArgumentException - if the minimum height is negative
    
    This feature will have an effect if different layerAlignments are present.
    
    Default Value:
    The default value is 0.0d.
    
    Parameters:
    
    value - a non-negative minimum height
    
    See Also:
    
    getMinimumLayerHeight()
  - setNodeLabelMode
```
public void setNodeLabelMode(NodeLabelMode value)
```
    Sets the mode that determines how node labels are handled by the algorithm during the layout.
    
    Throws:
    
    IllegalArgumentException - if the constant is unknown.
    
    To enable this feature, information about the layout of the node labels must be provided. If HierarchicLayout is used for the layout, method NodeLabelConsiderationEnabled should be set to true. Otherwise, one has to assure that e.g., via an instance of LabelLayoutTranslator, the algorithm receives the appropriate information.
    
    Default Value:
    The default value is NodeLabelMode.CONSIDER_FOR_DRAWING. Node labels will be considered for node placement and routing, but not for self-loops.
    
    Parameters:
    
    value - one of the predefined constants
    
    See Also:
    
    HierarchicLayout.setNodeLabelConsiderationEnabled(boolean), getNodeLabelMode()
  - setPortAssignment
```
public void setPortAssignment(PortAssignmentMode value)
```
    Sets the assignment strategy which distributes the ports along the node borders.
    
    Port assignments PortAssignmentMode.DEFAULT, PortAssignmentMode.ON_GRID and PortAssignmentMode.ON_SUBGRID are currently only supported in DefaultPortAllocator. A custom implementation of IPortAllocator will have to handle these assignments itself or will replace them with its own behavior.
    
    Default Value:
    The default value is PortAssignmentMode.DEFAULT. Ports are distributed evenly along the border of the node.
    
    Parameters:
    
    value - one of the predefined port assignment strategies
    
    See Also:
    
    getPortAssignment()
  - setPortBorderGapRatio
```
public void setPortBorderGapRatio(int side,
                                  double ratio)
```
    Specifies the port border gap ratio for the port distribution at a given side of the node.
    This ratio determines the gap between a corner of the node and the first assigned port.
    
    The ratio should be greater than 0.
    
    A value of 0.0d results in ports being placed directly on the corner of the node (if there is more than one port).
    
    A value of 0.5d results in ports being distributed along the side of the node so that the distance between the corner of the node and the first port is half as wide as the distance between two adjacent ports.
    
    A value of Double.POSITIVE_INFINITY results in all ports being centered at the side in one point.
    
    Throws:
    
    IllegalArgumentException - if the given ratio is negative
    
    Default Value:
    The default value is 0.5d. Ports are distributed along the sides of the node.
    
    Parameters:
    
    side - the zero-based clockwise side index for top-to-bottom layouts (i.e., top is 0)
    
    ratio - the given ratio
    
    See Also:
    
    setPortBorderGapRatios(double)
  - setPortBorderGapRatios
```
public void setPortBorderGapRatios(double value)
```
    Sets the port border gap ratio for the port distribution on all sides of the node.
    This ratio determines the gap between a corner of the node and the first assigned port.
    
    The ratio should be greater than 0.
    
    A value of 0.0d results in ports being placed directly on the corner of the node (if there is more than one port).
    
    A value of 0.5d results in ports being distributed along the side of the node so that the distance between the corner of the node and the first port is half as wide as the distance between two adjacent ports.
    
    A value of Double.POSITIVE_INFINITY results in all ports being centered at the side in one point.
    
    Throws:
    
    IllegalArgumentException - if the given ratio is negative
    
    Default Value:
    The default value is 0.5d. Ports are distributed along the sides of the node.
    
    Parameters:
    
    value - the given ratio
    
    See Also:
    
    setPortBorderGapRatio(int, double)

Class NodeLayoutDescriptor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NodeLayoutDescriptor

Method Detail

getGridReference

getLayerAlignment

getMinimumDistance

getMinimumLayerHeight

getNodeLabelMode

getPortAssignment

getPortBorderGapRatio

setGridReference

setLayerAlignment

setMinimumDistance

setMinimumLayerHeight

setNodeLabelMode

setPortAssignment

setPortBorderGapRatio

setPortBorderGapRatios