documentationfor yFiles for HTML 3.0.0.1

Multi-Page Layout

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

Renamed, Moved, and Removed Classes and Members

The following table lists the renamed, moved, and removed classes and members of the major classes of the MultiPageLayout.

Renamed, moved, and removed members of classes related to the MultiPageLayout (classes are bold)
yFiles for HTML 2.6 yFiles for HTML 3.0 Remarks
MultiPageLayoutclass name unchanged
Members in class MultiPageLayout
calculateLayoutremovedInstead, apply the layout like any other and get the result from the layoutCallback.
createProxyReferenceNodesuseProxyReferenceNodes
edgeBundleModeMaskmultiEdgeConnectorPolicy
groupingModegroupingPolicy
labelinggenericLabelingThe new read-only property is of type GenericLabeling
labelingEnabled
layoutCallbackname unchangedIs no longer an instance of the removed yFiles interface ILayoutCallback, but a callback function with a MultiPageLayoutResult as parameter
maximumDurationstopDurationThe algorithm tries to stop within the given time, but it is not guaranteed to do so. The property was renamed to better signal this intent.
MultiPageLayoutDataMultiPageLayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>
Properties in class MultiPageLayoutData
abortHandlerremovedA LayoutAbortController is added by the LayoutExecutor; see Section Maximum Duration and Aborting of Algorithms for more details.
edgeIds, edgeLabelIds, nodeIds, nodeLabelIdsremovedManually mapping IDs is no longer required. The data class assigns them automatically, and original items can be accessed by new methods like, for example, getOriginalItem.
edgeBundlesmultiEdgeConnectorIds
EdgeBundleModesMultiEdgeConnectorPolicy
IElementFactoryMultiPageElementFactory
DefaultElementFactoryMultiPageElementFactory
IElementInfoManagerremovedInformation about items can be queried using methods of MultiPageLayoutContext class which is accessed from property context.
LayoutContextMultiPageLayoutContext
ILayoutCallbackinterface removed
GroupingModeMultiPageGroupingPolicy
MultiPageLayoutResulttype name unchanged
Properties in class MultiPageLayoutResult
getPageremovedReplaced by new property pageGraphs.
pageCount