documentationfor yFiles for HTML 3.0.0.1

Clear Area Layout

This chapter describes the major API changes to the ClearAreaLayout introduced with yFiles for HTML 3.0 and how to migrate from the older version.

Renamed, Moved, and Removed Classes and Members

Renamed, moved, and removed API members related to ClearAreaLayout (classes are bold)
yFiles for HTML 2.6 yFiles for HTML 3.0 Remarks
ClearAreaLayoutclass name unchanged
Members of class ClearAreaLayout
considerEdgeLabelsedgeLabelPlacementThe enum now allows you to choose between considering the edge labels and the GenericLabeling algorithm.
considerNodeLabelsnodeLabelPlacementThe enum now allows you to choose between considering the node labels and the GenericLabeling algorithm.
edgeRoutingStrategyedgeRoutingStyle
maximumDurationstopDurationThe algorithm tries to stop within the given time, but it is not guaranteed to do so. The property was renamed to better reflect this intent.
configureEdgeRouterremovedThe callback method has been removed. Use property edgeRouter to apply a custom edge routing configuration.
ClearAreaLayoutDataClearAreaLayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>
Properties in class ClearAreaLayoutData
abortHandlerremovedA LayoutAbortController is exposed by the LayoutExecutor; see Section Maximum Duration and Aborting of Algorithms for more details.
nodeHalosnodeMargins
partitionGridDatalayoutGridData
sourcePortCandidatesports.sourcePortCandidatesMoved to sub-data ports. PortCandidates and PortConstraints are now combined in one concept; see migration chapter about Ports.
sourcePortConstraints
sourcePortGroupIdsports.sourcePortGroupIdsMoved to sub-data ports.
targetPortCandidatesports.targetPortCandidatesMoved to sub-data ports. PortCandidates and PortConstraints are now combined in one concept; see migration chapter about Ports.
targetPortConstraints
targetPortGroupIdsports.targetPortGroupIdsMoved to sub-data ports.
PartialLayoutEdgeRoutingStrategyPartialLayoutRoutingStyleThe enum that is the return type of property edgeRoutingStyle has been renamed.

Changed Default Values and Behavior Changes

The value CUSTOMIZED of enum ComponentAssignmentStrategy has been removed. Custom components are now automatically used if defined with componentIds.