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

java.lang.Object
- com.yworks.yfiles.layout.LayoutData
- - com.yworks.yfiles.layout.hierarchic.HierarchicLayoutData

public class HierarchicLayoutData
extends LayoutData

Specifies custom data for the HierarchicLayout.

Constructor Summary

Constructors
Constructor and Description

HierarchicLayoutData()

Constructors
Constructor and Description
`HierarchicLayoutData()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`apply(LayoutGraphAdapter adapter, ILayoutAlgorithm layout, CopiedLayoutGraph layoutGraph)` Applies this layout data to the specified `layoutGraphAdapter`.
`AbortHandler`	`getAbortHandler()` Gets the AbortHandler used during the layout.
`ItemMapping<IEdge,YPointPath>`	`getAlternativeEdgePath()` Gets a mapping from edges to alternative paths for edges connecting to groups, group content or folder nodes.
`ItemMapping<INode,YRectangle>`	`getAlternativeGroupBounds()` Gets a mapping from group/folder nodes to alternative bounds for these nodes.
`ItemCollection<INode>`	`getBfsLayererCoreNodes()` Gets the collection of core nodes used by the `BFSLayerer`.
`ItemMapping<IEdge,Integer>`	`getConstraintIncrementalLayererAdditionalEdgeWeights()` Gets the mapping from edges to an additional weight used by the `ConstraintIncrementalLayerer`.
`ItemMapping<IEdge,Integer>`	`getCriticalEdgePriorities()` Gets a mapping from edges to their priority to be a 'critical' edge.
`ItemMapping<IEdge,Double>`	`getEdgeDirectedness()` Gets the mapping from edges to their directedness.
`ItemMapping<IEdge,EdgeLayoutDescriptor>`	`getEdgeLayoutDescriptors()` Gets the mapping of edges to their `EdgeLayoutDescriptor`.
`ItemMapping<IEdge,Double>`	`getEdgeThickness()` Gets the mapping from edges to their thickness.
`ItemCollection<INode>`	`getFolderNodes()` Gets the collection of folder nodes used for recursive edge styles in incremental mode.
`ItemMapping<INode,Integer>`	`getGivenLayersLayererIds()` Gets the mapping from nodes to their layer index when using the `GivenLayersLayerer`.
`IncrementalHintItemMapping`	`getIncrementalHints()` Gets a mapping from nodes and edges to their incrementally hints.
`ILayerConstraintFactory`	`getLayerConstraintFactory()` Gets the factory to specify layer constraints.
`IMapper<INode,Integer>`	`getLayerIndices()` Gets a mapper from nodes to the index of their layer.
`ItemMapping<INode,NodeHalo>`	`getNodeHalos()` Gets the mapping from nodes to their `NodeHalo`.
`ItemMapping<INode,NodeLayoutDescriptor>`	`getNodeLayoutDescriptors()` Gets the mapping of nodes to their `NodeLayoutDescriptor`.
`ItemMapping<INode,PortCandidateSet>`	`getNodePortCandidateSets()` Gets a mapping from nodes to their `PortCandidateSet`.
`PartitionGridData`	`getPartitionGridData()` Gets the partition grid layout data.
`SelfLoopCalculatorData`	`getSelfLoopCalculatorData()` Gets the layout data for the `SelfLoopCalculator`.
`ISequenceConstraintFactory`	`getSequenceConstraintFactory()` Gets the factory to specify sequence constraints.
`IMapper<INode,Integer>`	`getSequenceIndices()` Gets a mapper from nodes to the sequence index in their layer.
`ItemMapping<IEdge,Object>`	`getSourceGroupIds()` Gets a mapping from edges to an object representing their source edge group.
`ItemMapping<IEdge,Collection<PortCandidate>>`	`getSourcePortCandidates()` Gets a mapping from edges to a collection of their source port `candidates`.
`ItemMapping<IEdge,PortConstraint>`	`getSourcePortConstraints()` Gets a mapping from edges to their source `PortConstraint`.
`ItemMapping<IEdge,Object>`	`getSourcePortGroupIds()` Gets a mapping from edges to an object representing their source port group.
`ItemMapping<IEdge,Object>`	`getTargetGroupIds()` Gets a mapping from edges to an object representing their target edge group.
`ItemMapping<IEdge,Collection<PortCandidate>>`	`getTargetPortCandidates()` Gets a mapping from edges to a collection of their target port `candidates`.
`ItemMapping<IEdge,PortConstraint>`	`getTargetPortConstraints()` Gets a mapping from edges to their target `PortConstraint`.
`ItemMapping<IEdge,Object>`	`getTargetPortGroupIds()` Gets a mapping from edges to an object representing their target port group.
`void`	`setAbortHandler(AbortHandler value)` Sets the AbortHandler used during the layout.
`void`	`setAlternativeEdgePath(ItemMapping<IEdge,YPointPath> value)` Sets a mapping from edges to alternative paths for edges connecting to groups, group content or folder nodes.
`void`	`setAlternativeGroupBounds(ItemMapping<INode,YRectangle> value)` Sets a mapping from group/folder nodes to alternative bounds for these nodes.
`void`	`setBfsLayererCoreNodes(ItemCollection<INode> value)` Sets the collection of core nodes used by the `BFSLayerer`.
`void`	`setConstraintIncrementalLayererAdditionalEdgeWeights(ItemMapping<IEdge,Integer> value)` Sets the mapping from edges to an additional weight used by the `ConstraintIncrementalLayerer`.
`void`	`setCriticalEdgePriorities(ItemMapping<IEdge,Integer> value)` Sets a mapping from edges to their priority to be a 'critical' edge.
`void`	`setEdgeDirectedness(ItemMapping<IEdge,Double> value)` Sets the mapping from edges to their directedness.
`void`	`setEdgeLayoutDescriptors(ItemMapping<IEdge,EdgeLayoutDescriptor> value)` Sets the mapping of edges to their `EdgeLayoutDescriptor`.
`void`	`setEdgeThickness(ItemMapping<IEdge,Double> value)` Sets the mapping from edges to their thickness.
`void`	`setFolderNodes(ItemCollection<INode> value)` Sets the collection of folder nodes used for recursive edge styles in incremental mode.
`void`	`setGivenLayersLayererIds(ItemMapping<INode,Integer> value)` Sets the mapping from nodes to their layer index when using the `GivenLayersLayerer`.
`void`	`setIncrementalHints(IncrementalHintItemMapping value)` Sets a mapping from nodes and edges to their incrementally hints.
`void`	`setLayerConstraintFactory(ILayerConstraintFactory value)` Sets the factory to specify layer constraints.
`void`	`setLayerIndices(IMapper<INode,Integer> value)` Sets a mapper from nodes to the index of their layer.
`void`	`setNodeHalos(ItemMapping<INode,NodeHalo> value)` Sets the mapping from nodes to their `NodeHalo`.
`void`	`setNodeLayoutDescriptors(ItemMapping<INode,NodeLayoutDescriptor> value)` Sets the mapping of nodes to their `NodeLayoutDescriptor`.
`void`	`setNodePortCandidateSets(ItemMapping<INode,PortCandidateSet> value)` Sets a mapping from nodes to their `PortCandidateSet`.
`void`	`setPartitionGridData(PartitionGridData value)` Sets the partition grid layout data.
`void`	`setSelfLoopCalculatorData(SelfLoopCalculatorData value)` Sets the layout data for the `SelfLoopCalculator`.
`void`	`setSequenceConstraintFactory(ISequenceConstraintFactory value)` Sets the factory to specify sequence constraints.
`void`	`setSequenceIndices(IMapper<INode,Integer> value)` Sets a mapper from nodes to the sequence index in their layer.
`void`	`setSourceGroupIds(ItemMapping<IEdge,Object> value)` Sets a mapping from edges to an object representing their source edge group.
`void`	`setSourcePortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value)` Sets a mapping from edges to a collection of their source port `candidates`.
`void`	`setSourcePortConstraints(ItemMapping<IEdge,PortConstraint> value)` Sets a mapping from edges to their source `PortConstraint`.
`void`	`setSourcePortGroupIds(ItemMapping<IEdge,Object> value)` Sets a mapping from edges to an object representing their source port group.
`void`	`setTargetGroupIds(ItemMapping<IEdge,Object> value)` Sets a mapping from edges to an object representing their target edge group.
`void`	`setTargetPortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value)` Sets a mapping from edges to a collection of their target port `candidates`.
`void`	`setTargetPortConstraints(ItemMapping<IEdge,PortConstraint> value)` Sets a mapping from edges to their target `PortConstraint`.
`void`	`setTargetPortGroupIds(ItemMapping<IEdge,Object> value)` Sets a mapping from edges to an object representing their target port group.

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

- Constructor Detail
  - HierarchicLayoutData
```
public HierarchicLayoutData()
```
- Method Detail
  - apply
```
public void apply(LayoutGraphAdapter adapter,
                  ILayoutAlgorithm layout,
                  CopiedLayoutGraph layoutGraph)
```
    Description copied from class: LayoutData
    
    Applies this layout data to the specified layoutGraphAdapter.
    
    Specified by:
    
    apply in class LayoutData
    
    Parameters:
    
    adapter - The adapter to add the layout data to.
    
    layout - The layout that shall use this layout data.
    
    layoutGraph - The layout graph used for the layout calculation.
  - getAbortHandler
```
public final AbortHandler getAbortHandler()
```
    Gets the AbortHandler used during the layout.
    
    Returns:
    
    The AbortHandler.
    
    See Also:
    
    AbortHandler.ABORT_HANDLER_DPKEY, setAbortHandler(AbortHandler)
  - getAlternativeEdgePath
```
public final ItemMapping<IEdge,YPointPath> getAlternativeEdgePath()
```
    Gets a mapping from edges to alternative paths for edges connecting to groups, group content or folder nodes.
    
    Returns:
    
    The AlternativeEdgePath.
    
    See Also:
    
    HierarchicLayout.ALTERNATIVE_EDGE_PATH_DPKEY, setAlternativeEdgePath(ItemMapping)
  - getAlternativeGroupBounds
```
public final ItemMapping<INode,YRectangle> getAlternativeGroupBounds()
```
    Gets a mapping from group/folder nodes to alternative bounds for these nodes.
    
    Returns:
    
    The AlternativeGroupBounds.
    
    See Also:
    
    HierarchicLayout.ALTERNATIVE_GROUP_BOUNDS_DPKEY, setAlternativeGroupBounds(ItemMapping)
  - getBfsLayererCoreNodes
```
public final ItemCollection<INode> getBfsLayererCoreNodes()
```
    Gets the collection of core nodes used by the BFSLayerer.
    The BFSLayerer is used when FromScratchLayeringStrategy is set to LayeringStrategy.BFS.
    
    Returns:
    
    The BfsLayererCoreNodes.
    
    See Also:
    
    BFSLayerer.CORE_NODES_DPKEY, setBfsLayererCoreNodes(ItemCollection)
  - getConstraintIncrementalLayererAdditionalEdgeWeights
```
public final ItemMapping<IEdge,Integer> getConstraintIncrementalLayererAdditionalEdgeWeights()
```
    Gets the mapping from edges to an additional weight used by the ConstraintIncrementalLayerer.
    The Layerer tries to keep edges with higher weights short.
    
    Returns:
    
    The ConstraintIncrementalLayererAdditionalEdgeWeights.
    
    See Also:
    
    ConstraintIncrementalLayerer.ADDITIONAL_EDGE_WEIGHT_DPKEY, setConstraintIncrementalLayererAdditionalEdgeWeights(ItemMapping)
  - getCriticalEdgePriorities
```
public final ItemMapping<IEdge,Integer> getCriticalEdgePriorities()
```
    Gets a mapping from edges to their priority to be a 'critical' edge.
    The layout tries to vertically align each node pair that is connected by a critical edge (integer value > 0).
    
    Returns:
    
    The CriticalEdgePriorities.
    
    See Also:
    
    HierarchicLayout.CRITICAL_EDGE_PRIORITY_DPKEY, setCriticalEdgePriorities(ItemMapping)
  - getEdgeDirectedness
```
public final ItemMapping<IEdge,Double> getEdgeDirectedness()
```
    Gets the mapping from edges to their directedness.
    Generally, the hierarchic layout algorithm assigns nodes to layers such that most of the edges point in the main layout direction. The directedness of an edge specifies whether it should comply with this strategy. More precisely, a value of 1 means that the edge should fully comply, a value of -1 that it should comply inversely (the edge should point against the main layout direction), and a value of 0 means that the direction doesn't matter at all and the endpoints of the edges may be placed at the same layer. If there are conflicting preferences, edges with higher absolute values are more likely to point in the desired direction.
    
    Returns:
    
    The EdgeDirectedness.
    
    See Also:
    
    HierarchicLayout.EDGE_DIRECTEDNESS_DPKEY, setEdgeDirectedness(ItemMapping)
  - getEdgeLayoutDescriptors
```
public final ItemMapping<IEdge,EdgeLayoutDescriptor> getEdgeLayoutDescriptors()
```
    Gets the mapping of edges to their EdgeLayoutDescriptor.
    If an edge is mapped to null, the default descriptor is used.
    
    Returns:
    
    The EdgeLayoutDescriptors.
    
    See Also:
    
    HierarchicLayoutCore.EDGE_LAYOUT_DESCRIPTOR_DPKEY, setEdgeLayoutDescriptors(ItemMapping)
  - getEdgeThickness
```
public final ItemMapping<IEdge,Double> getEdgeThickness()
```
    Gets the mapping from edges to their thickness.
    The specified non-negative thickness is considered when calculating minimum distances so that there are no overlaps between edges and other graph elements. By default, each edge has thickness 0.
    
    Returns:
    
    The EdgeThickness.
    
    See Also:
    
    HierarchicLayout.EDGE_THICKNESS_DPKEY, setEdgeThickness(ItemMapping)
  - getFolderNodes
```
public final ItemCollection<INode> getFolderNodes()
```
    Gets the collection of folder nodes used for recursive edge styles in incremental mode.
    
    Returns:
    
    The FolderNodes.
    
    See Also:
    
    HierarchicLayout.FOLDER_NODES_DPKEY, setFolderNodes(ItemCollection)
  - getGivenLayersLayererIds
```
public final ItemMapping<INode,Integer> getGivenLayersLayererIds()
```
    Gets the mapping from nodes to their layer index when using the GivenLayersLayerer.
    The GivenLayersLayerer is used when FromScratchLayeringStrategy is set to LayeringStrategy.USER_DEFINED.
    
    Returns:
    
    The GivenLayersLayererIds.
    
    See Also:
    
    GivenLayersLayerer.LAYER_ID_DPKEY, setGivenLayersLayererIds(ItemMapping)
  - getIncrementalHints
```
public final IncrementalHintItemMapping getIncrementalHints()
```
    Gets a mapping from nodes and edges to their incrementally hints.
    
    Returns:
    
    The IncrementalHints.
    
    See Also:
    
    HierarchicLayout.INCREMENTAL_HINTS_DPKEY, setIncrementalHints(IncrementalHintItemMapping)
  - getLayerConstraintFactory
```
public final ILayerConstraintFactory getLayerConstraintFactory()
```
    Gets the factory to specify layer constraints.
    
    Returns:
    
    The LayerConstraintFactory.
    
    See Also:
    
    HierarchicLayout.createLayerConstraintFactory(com.yworks.yfiles.algorithms.Graph), ILayerConstraintFactory, setLayerConstraintFactory(ILayerConstraintFactory)
  - getLayerIndices
```
public final IMapper<INode,Integer> getLayerIndices()
```
    Gets a mapper from nodes to the index of their layer.
    If this property is set, the mapper is filled by the layout with the layer information.
    
    Returns:
    
    The LayerIndices.
    
    See Also:
    
    HierarchicLayout.LAYER_INDEX_DPKEY, setLayerIndices(IMapper)
  - getNodeHalos
```
public final ItemMapping<INode,NodeHalo> getNodeHalos()
```
    Gets the mapping from nodes to their NodeHalo.
    
    Returns:
    
    The NodeHalos.
    
    See Also:
    
    NodeHalo.NODE_HALO_DPKEY, setNodeHalos(ItemMapping)
  - getNodeLayoutDescriptors
```
public final ItemMapping<INode,NodeLayoutDescriptor> getNodeLayoutDescriptors()
```
    Gets the mapping of nodes to their NodeLayoutDescriptor.
    If a node is mapped to null, the default descriptor is used.
    
    Returns:
    
    The NodeLayoutDescriptors.
    
    See Also:
    
    HierarchicLayoutCore.NODE_LAYOUT_DESCRIPTOR_DPKEY, setNodeLayoutDescriptors(ItemMapping)
  - getNodePortCandidateSets
```
public final ItemMapping<INode,PortCandidateSet> getNodePortCandidateSets()
```
    Gets a mapping from nodes to their PortCandidateSet.
    
    Returns:
    
    The NodePortCandidateSets.
    
    See Also:
    
    PortCandidateSet.NODE_PORT_CANDIDATE_SET_DPKEY, setNodePortCandidateSets(ItemMapping)
  - getPartitionGridData
```
public final PartitionGridData getPartitionGridData()
```
    Gets the partition grid layout data.
    
    Returns:
    
    The PartitionGridData.
    
    See Also:
    
    setPartitionGridData(PartitionGridData)
  - getSelfLoopCalculatorData
```
public final SelfLoopCalculatorData getSelfLoopCalculatorData()
```
    Gets the layout data for the SelfLoopCalculator.
    
    Returns:
    
    The SelfLoopCalculatorData.
    
    See Also:
    
    setSelfLoopCalculatorData(SelfLoopCalculatorData)
  - getSequenceConstraintFactory
```
public final ISequenceConstraintFactory getSequenceConstraintFactory()
```
    Gets the factory to specify sequence constraints.
    
    Returns:
    
    The SequenceConstraintFactory.
    
    See Also:
    
    HierarchicLayout.createSequenceConstraintFactory(com.yworks.yfiles.layout.LayoutGraph), ISequenceConstraintFactory, setSequenceConstraintFactory(ISequenceConstraintFactory)
  - getSequenceIndices
```
public final IMapper<INode,Integer> getSequenceIndices()
```
    Gets a mapper from nodes to the sequence index in their layer.
    If this property is set, the mapper is filled by the layout with the sequence information.
    
    Returns:
    
    The SequenceIndices.
    
    See Also:
    
    HierarchicLayout.SEQUENCE_INDEX_DPKEY, setSequenceIndices(IMapper)
  - getSourceGroupIds
```
public final ItemMapping<IEdge,Object> getSourceGroupIds()
```
    Gets a mapping from edges to an object representing their source edge group.
    
    Returns:
    
    The SourceGroupIds.
    
    See Also:
    
    PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, setSourceGroupIds(ItemMapping)
  - getSourcePortCandidates
```
public final ItemMapping<IEdge,Collection<PortCandidate>> getSourcePortCandidates()
```
    Gets a mapping from edges to a collection of their source port candidates.
    
    Returns:
    
    The SourcePortCandidates.
    
    See Also:
    
    PortCandidate.SOURCE_PORT_CANDIDATE_COLLECTION_DPKEY, setSourcePortCandidates(ItemMapping)
  - getSourcePortConstraints
```
public final ItemMapping<IEdge,PortConstraint> getSourcePortConstraints()
```
    Gets a mapping from edges to their source PortConstraint.
    
    Returns:
    
    The SourcePortConstraints.
    
    See Also:
    
    PortConstraintKeys.SOURCE_PORT_CONSTRAINT_DPKEY, setSourcePortConstraints(ItemMapping)
  - getSourcePortGroupIds
```
public final ItemMapping<IEdge,Object> getSourcePortGroupIds()
```
    Gets a mapping from edges to an object representing their source port group.
    
    Returns:
    
    The SourcePortGroupIds.
    
    See Also:
    
    PortConstraintKeys.SOURCE_PORT_GROUP_ID_DPKEY, setSourcePortGroupIds(ItemMapping)
  - getTargetGroupIds
```
public final ItemMapping<IEdge,Object> getTargetGroupIds()
```
    Gets a mapping from edges to an object representing their target edge group.
    
    Returns:
    
    The TargetGroupIds.
    
    See Also:
    
    PortConstraintKeys.TARGET_GROUP_ID_DPKEY, setTargetGroupIds(ItemMapping)
  - getTargetPortCandidates
```
public final ItemMapping<IEdge,Collection<PortCandidate>> getTargetPortCandidates()
```
    Gets a mapping from edges to a collection of their target port candidates.
    
    Returns:
    
    The TargetPortCandidates.
    
    See Also:
    
    PortCandidate.TARGET_PORT_CANDIDATE_COLLECTION_DPKEY, setTargetPortCandidates(ItemMapping)
  - getTargetPortConstraints
```
public final ItemMapping<IEdge,PortConstraint> getTargetPortConstraints()
```
    Gets a mapping from edges to their target PortConstraint.
    
    Returns:
    
    The TargetPortConstraints.
    
    See Also:
    
    PortConstraintKeys.TARGET_PORT_CONSTRAINT_DPKEY, setTargetPortConstraints(ItemMapping)
  - getTargetPortGroupIds
```
public final ItemMapping<IEdge,Object> getTargetPortGroupIds()
```
    Gets a mapping from edges to an object representing their target port group.
    
    Returns:
    
    The TargetPortGroupIds.
    
    See Also:
    
    PortConstraintKeys.TARGET_PORT_GROUP_ID_DPKEY, setTargetPortGroupIds(ItemMapping)
  - setAbortHandler
```
public final void setAbortHandler(AbortHandler value)
```
    Sets the AbortHandler used during the layout.
    
    Parameters:
    
    value - The AbortHandler to set.
    
    See Also:
    
    AbortHandler.ABORT_HANDLER_DPKEY, getAbortHandler()
  - setAlternativeEdgePath
```
public final void setAlternativeEdgePath(ItemMapping<IEdge,YPointPath> value)
```
    Sets a mapping from edges to alternative paths for edges connecting to groups, group content or folder nodes.
    
    Parameters:
    
    value - The AlternativeEdgePath to set.
    
    See Also:
    
    HierarchicLayout.ALTERNATIVE_EDGE_PATH_DPKEY, getAlternativeEdgePath()
  - setAlternativeGroupBounds
```
public final void setAlternativeGroupBounds(ItemMapping<INode,YRectangle> value)
```
    Sets a mapping from group/folder nodes to alternative bounds for these nodes.
    
    Parameters:
    
    value - The AlternativeGroupBounds to set.
    
    See Also:
    
    HierarchicLayout.ALTERNATIVE_GROUP_BOUNDS_DPKEY, getAlternativeGroupBounds()
  - setBfsLayererCoreNodes
```
public final void setBfsLayererCoreNodes(ItemCollection<INode> value)
```
    Sets the collection of core nodes used by the BFSLayerer.
    The BFSLayerer is used when FromScratchLayeringStrategy is set to LayeringStrategy.BFS.
    
    Parameters:
    
    value - The BfsLayererCoreNodes to set.
    
    See Also:
    
    BFSLayerer.CORE_NODES_DPKEY, getBfsLayererCoreNodes()
  - setConstraintIncrementalLayererAdditionalEdgeWeights
```
public final void setConstraintIncrementalLayererAdditionalEdgeWeights(ItemMapping<IEdge,Integer> value)
```
    Sets the mapping from edges to an additional weight used by the ConstraintIncrementalLayerer.
    The Layerer tries to keep edges with higher weights short.
    
    Parameters:
    
    value - The ConstraintIncrementalLayererAdditionalEdgeWeights to set.
    
    See Also:
    
    ConstraintIncrementalLayerer.ADDITIONAL_EDGE_WEIGHT_DPKEY, getConstraintIncrementalLayererAdditionalEdgeWeights()
  - setCriticalEdgePriorities
```
public final void setCriticalEdgePriorities(ItemMapping<IEdge,Integer> value)
```
    Sets a mapping from edges to their priority to be a 'critical' edge.
    The layout tries to vertically align each node pair that is connected by a critical edge (integer value > 0).
    
    Parameters:
    
    value - The CriticalEdgePriorities to set.
    
    See Also:
    
    HierarchicLayout.CRITICAL_EDGE_PRIORITY_DPKEY, getCriticalEdgePriorities()
  - setEdgeDirectedness
```
public final void setEdgeDirectedness(ItemMapping<IEdge,Double> value)
```
    Sets the mapping from edges to their directedness.
    Generally, the hierarchic layout algorithm assigns nodes to layers such that most of the edges point in the main layout direction. The directedness of an edge specifies whether it should comply with this strategy. More precisely, a value of 1 means that the edge should fully comply, a value of -1 that it should comply inversely (the edge should point against the main layout direction), and a value of 0 means that the direction doesn't matter at all and the endpoints of the edges may be placed at the same layer. If there are conflicting preferences, edges with higher absolute values are more likely to point in the desired direction.
    
    Parameters:
    
    value - The EdgeDirectedness to set.
    
    See Also:
    
    HierarchicLayout.EDGE_DIRECTEDNESS_DPKEY, getEdgeDirectedness()
  - setEdgeLayoutDescriptors
```
public final void setEdgeLayoutDescriptors(ItemMapping<IEdge,EdgeLayoutDescriptor> value)
```
    Sets the mapping of edges to their EdgeLayoutDescriptor.
    If an edge is mapped to null, the default descriptor is used.
    
    Parameters:
    
    value - The EdgeLayoutDescriptors to set.
    
    See Also:
    
    HierarchicLayoutCore.EDGE_LAYOUT_DESCRIPTOR_DPKEY, getEdgeLayoutDescriptors()
  - setEdgeThickness
```
public final void setEdgeThickness(ItemMapping<IEdge,Double> value)
```
    Sets the mapping from edges to their thickness.
    The specified non-negative thickness is considered when calculating minimum distances so that there are no overlaps between edges and other graph elements. By default, each edge has thickness 0.
    
    Parameters:
    
    value - The EdgeThickness to set.
    
    See Also:
    
    HierarchicLayout.EDGE_THICKNESS_DPKEY, getEdgeThickness()
  - setFolderNodes
```
public final void setFolderNodes(ItemCollection<INode> value)
```
    Sets the collection of folder nodes used for recursive edge styles in incremental mode.
    
    Parameters:
    
    value - The FolderNodes to set.
    
    See Also:
    
    HierarchicLayout.FOLDER_NODES_DPKEY, getFolderNodes()
  - setGivenLayersLayererIds
```
public final void setGivenLayersLayererIds(ItemMapping<INode,Integer> value)
```
    Sets the mapping from nodes to their layer index when using the GivenLayersLayerer.
    The GivenLayersLayerer is used when FromScratchLayeringStrategy is set to LayeringStrategy.USER_DEFINED.
    
    Parameters:
    
    value - The GivenLayersLayererIds to set.
    
    See Also:
    
    GivenLayersLayerer.LAYER_ID_DPKEY, getGivenLayersLayererIds()
  - setIncrementalHints
```
public final void setIncrementalHints(IncrementalHintItemMapping value)
```
    Sets a mapping from nodes and edges to their incrementally hints.
    
    Parameters:
    
    value - The IncrementalHints to set.
    
    See Also:
    
    HierarchicLayout.INCREMENTAL_HINTS_DPKEY, getIncrementalHints()
  - setLayerConstraintFactory
```
public final void setLayerConstraintFactory(ILayerConstraintFactory value)
```
    Sets the factory to specify layer constraints.
    
    Parameters:
    
    value - The LayerConstraintFactory to set.
    
    See Also:
    
    HierarchicLayout.createLayerConstraintFactory(com.yworks.yfiles.algorithms.Graph), ILayerConstraintFactory, getLayerConstraintFactory()
  - setLayerIndices
```
public final void setLayerIndices(IMapper<INode,Integer> value)
```
    Sets a mapper from nodes to the index of their layer.
    If this property is set, the mapper is filled by the layout with the layer information.
    
    Parameters:
    
    value - The LayerIndices to set.
    
    See Also:
    
    HierarchicLayout.LAYER_INDEX_DPKEY, getLayerIndices()
  - setNodeHalos
```
public final void setNodeHalos(ItemMapping<INode,NodeHalo> value)
```
    Sets the mapping from nodes to their NodeHalo.
    
    Parameters:
    
    value - The NodeHalos to set.
    
    See Also:
    
    NodeHalo.NODE_HALO_DPKEY, getNodeHalos()
  - setNodeLayoutDescriptors
```
public final void setNodeLayoutDescriptors(ItemMapping<INode,NodeLayoutDescriptor> value)
```
    Sets the mapping of nodes to their NodeLayoutDescriptor.
    If a node is mapped to null, the default descriptor is used.
    
    Parameters:
    
    value - The NodeLayoutDescriptors to set.
    
    See Also:
    
    HierarchicLayoutCore.NODE_LAYOUT_DESCRIPTOR_DPKEY, getNodeLayoutDescriptors()
  - setNodePortCandidateSets
```
public final void setNodePortCandidateSets(ItemMapping<INode,PortCandidateSet> value)
```
    Sets a mapping from nodes to their PortCandidateSet.
    
    Parameters:
    
    value - The NodePortCandidateSets to set.
    
    See Also:
    
    PortCandidateSet.NODE_PORT_CANDIDATE_SET_DPKEY, getNodePortCandidateSets()
  - setPartitionGridData
```
public final void setPartitionGridData(PartitionGridData value)
```
    Sets the partition grid layout data.
    
    Parameters:
    
    value - The PartitionGridData to set.
    
    See Also:
    
    getPartitionGridData()
  - setSelfLoopCalculatorData
```
public final void setSelfLoopCalculatorData(SelfLoopCalculatorData value)
```
    Sets the layout data for the SelfLoopCalculator.
    
    Parameters:
    
    value - The SelfLoopCalculatorData to set.
    
    See Also:
    
    getSelfLoopCalculatorData()
  - setSequenceConstraintFactory
```
public final void setSequenceConstraintFactory(ISequenceConstraintFactory value)
```
    Sets the factory to specify sequence constraints.
    
    Parameters:
    
    value - The SequenceConstraintFactory to set.
    
    See Also:
    
    HierarchicLayout.createSequenceConstraintFactory(com.yworks.yfiles.layout.LayoutGraph), ISequenceConstraintFactory, getSequenceConstraintFactory()
  - setSequenceIndices
```
public final void setSequenceIndices(IMapper<INode,Integer> value)
```
    Sets a mapper from nodes to the sequence index in their layer.
    If this property is set, the mapper is filled by the layout with the sequence information.
    
    Parameters:
    
    value - The SequenceIndices to set.
    
    See Also:
    
    HierarchicLayout.SEQUENCE_INDEX_DPKEY, getSequenceIndices()
  - setSourceGroupIds
```
public final void setSourceGroupIds(ItemMapping<IEdge,Object> value)
```
    Sets a mapping from edges to an object representing their source edge group.
    
    Parameters:
    
    value - The SourceGroupIds to set.
    
    See Also:
    
    PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, getSourceGroupIds()
  - setSourcePortCandidates
```
public final void setSourcePortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value)
```
    Sets a mapping from edges to a collection of their source port candidates.
    
    Parameters:
    
    value - The SourcePortCandidates to set.
    
    See Also:
    
    PortCandidate.SOURCE_PORT_CANDIDATE_COLLECTION_DPKEY, getSourcePortCandidates()
  - setSourcePortConstraints
```
public final void setSourcePortConstraints(ItemMapping<IEdge,PortConstraint> value)
```
    Sets a mapping from edges to their source PortConstraint.
    
    Parameters:
    
    value - The SourcePortConstraints to set.
    
    See Also:
    
    PortConstraintKeys.SOURCE_PORT_CONSTRAINT_DPKEY, getSourcePortConstraints()
  - setSourcePortGroupIds
```
public final void setSourcePortGroupIds(ItemMapping<IEdge,Object> value)
```
    Sets a mapping from edges to an object representing their source port group.
    
    Parameters:
    
    value - The SourcePortGroupIds to set.
    
    See Also:
    
    PortConstraintKeys.SOURCE_PORT_GROUP_ID_DPKEY, getSourcePortGroupIds()
  - setTargetGroupIds
```
public final void setTargetGroupIds(ItemMapping<IEdge,Object> value)
```
    Sets a mapping from edges to an object representing their target edge group.
    
    Parameters:
    
    value - The TargetGroupIds to set.
    
    See Also:
    
    PortConstraintKeys.TARGET_GROUP_ID_DPKEY, getTargetGroupIds()
  - setTargetPortCandidates
```
public final void setTargetPortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value)
```
    Sets a mapping from edges to a collection of their target port candidates.
    
    Parameters:
    
    value - The TargetPortCandidates to set.
    
    See Also:
    
    PortCandidate.TARGET_PORT_CANDIDATE_COLLECTION_DPKEY, getTargetPortCandidates()
  - setTargetPortConstraints
```
public final void setTargetPortConstraints(ItemMapping<IEdge,PortConstraint> value)
```
    Sets a mapping from edges to their target PortConstraint.
    
    Parameters:
    
    value - The TargetPortConstraints to set.
    
    See Also:
    
    PortConstraintKeys.TARGET_PORT_CONSTRAINT_DPKEY, getTargetPortConstraints()
  - setTargetPortGroupIds
```
public final void setTargetPortGroupIds(ItemMapping<IEdge,Object> value)
```
    Sets a mapping from edges to an object representing their target port group.
    
    Parameters:
    
    value - The TargetPortGroupIds to set.
    
    See Also:
    
    PortConstraintKeys.TARGET_PORT_GROUP_ID_DPKEY, getTargetPortGroupIds()

Class HierarchicLayoutData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HierarchicLayoutData

Method Detail

apply

getAbortHandler

getAlternativeEdgePath

getAlternativeGroupBounds

getBfsLayererCoreNodes

getConstraintIncrementalLayererAdditionalEdgeWeights

getCriticalEdgePriorities

getEdgeDirectedness

getEdgeLayoutDescriptors

getEdgeThickness

getFolderNodes

getGivenLayersLayererIds

getIncrementalHints

getLayerConstraintFactory

getLayerIndices

getNodeHalos

getNodeLayoutDescriptors

getNodePortCandidateSets

getPartitionGridData

getSelfLoopCalculatorData

getSequenceConstraintFactory

getSequenceIndices

getSourceGroupIds

getSourcePortCandidates

getSourcePortConstraints

getSourcePortGroupIds

getTargetGroupIds

getTargetPortCandidates

getTargetPortConstraints

getTargetPortGroupIds

setAbortHandler

setAlternativeEdgePath

setAlternativeGroupBounds

setBfsLayererCoreNodes

setConstraintIncrementalLayererAdditionalEdgeWeights

setCriticalEdgePriorities

setEdgeDirectedness

setEdgeLayoutDescriptors

setEdgeThickness

setFolderNodes

setGivenLayersLayererIds

setIncrementalHints

setLayerConstraintFactory

setLayerIndices

setNodeHalos

setNodeLayoutDescriptors

setNodePortCandidateSets

setPartitionGridData

setSelfLoopCalculatorData

setSequenceConstraintFactory

setSequenceIndices

setSourceGroupIds

setSourcePortCandidates

setSourcePortConstraints

setSourcePortGroupIds

setTargetGroupIds

setTargetPortCandidates

setTargetPortConstraints

setTargetPortGroupIds