yFiles.NET (WinForms)Changelog
yFiles.NET 6.0
This version brings a major overhaul of many parts of the API, resulting in a lot of incompatible changes. We have designed many functions to be simpler, more intuitive and more consistent and removed technical debt.
In addition, this release contains numerous new features, improvements, and bug fixes to all parts of the library.
For a tour of this release's highlights, have a look at the article about yFiles.NET 6.0.
If you are updating from an older version of yFiles.NET, have a look at the list of incompatible changes and at the more detailed description in the Migration Guide.
Major new Feature: Support for Touch and Stylus Input
yFiles.NET now supports touch and stylus devices.
Touch input is now available across all built-in input modes. Numerous new properties enable full customization of input modes for mouse, stylus, and touch interactions.
The new versatile Pointer events replace the previous Mouse2D events. Pointer events support mouse, touch, and stylus inputs, providing generic properties such as event type (e.g., Up or Down) and location, as well as specific details like stylus pressure and touch size.
New Features, Improvements, and Bug Fixes
Categories: General Graph Controls Rendering Selection, Focus, Highlight Styles Interaction Label Editing Snapping Clipboard Folding View-Layout-Bridge Layout Hierarchical Layout Tree Layout Orthogonal Layout Edge Router Labeling Organic Layout Radial Tree Layout Series-parallel Layout Partial Layout Tabular Layout Component Layout Algorithms Analysis Geometry
General
New Features and Improvements
- The yFiles library now consists of one single assembly.
-
All uses of the
IListEnumerable<T>interface have been replaced by theIReadOnlyList<T>interface. This means that standard collections such asList<T>can now be used there. Accordingly, theListEnumerableExtensionsandListEnumerable<T>classes have been removed. -
The lookup API has been restructured. In particular, the
LookupDecoratorclass is now easier to use, but most use cases are covered without having to access the low-level lookup architecture. - The assemblies now are strong-named as factory default.
-
The new
LicenseConfigclass offers a way to set the yFiles license data in code (as opposed to having to embed a resource file in the application).
Graph
New Features and Improvements
-
CompositeLabelModelnow cannot only combine label models but also individual label model parameters or a mix of both kinds. Furthermore, it supports assigning a profit value to a parameter or model that can be used when placing labels during an automatic layout. -
The new
CompositeLabelModel.AddParametermethod wraps a given parameter of one of the composed label models. -
The new
IGraph.GetEdgesBetweenmethod returns all edges between two ports or port owners. -
The methods of
IGraphnow check consistently whether given geometric arguments are neither infinite norNaN. -
The rotation direction of
OrientedRectangle,NodeLabel,EdgeLabelandFreeEdgeLabelModelis now clockwise to be consistent with the other models. - The default placement for new edge labels is now on the middle of the edge path instead of on the first edge segment.
-
The label models
ExteriorLabelModel,InteriorLabelModel, andInteriorStretchLabelModelhave been renamed toExteriorNodeLabelModel,InteriorNodeLabelModel, andStretchNodeLabelModel, respectively, to make it clear that only nodes are supported as label owner for these models. -
The implementations of
ILabelModelParameterandIPortLocationModelParameterused by theILabelModelandIPortLocationModelclasses are now public and provide all properties necessary to recreate them on the models. Consequently, the staticLabelModelParameterSerializerandPortLocationModelParameterSerializerclasses, which could be used to retrieve those properties and recreate the parameter, have been removed. -
The
ILabelModelparameter of theILabelModelParameterFinder.FindBestParameterandILabelModelParameterProvider.GetParametersmethods has been removed as it was only very rarely required. -
The
GraphCopierAPI has been enhanced to offer improved clarity and functionality.-
The
GraphCopierhas been optimized since its support for theGraphClipboardhas been removed. -
The
GraphCopier.Copymethod now uses anIEnumerableof items to define the subset to copy.
-
The
-
The
SimpleNode,SimpleEdge,SimpleBend,SimpleLabel, andSimplePortclasses now provide a convenienceLookupDecoratorinstance through theGetDecoratormethod. -
The
ILabelModel.CreateDefaultParametermethod and most of its implementations have been removed as it was often unclear what βdefaultβ meant. Most label models already had a correspondingCreate*Parametermethod. For the remaining models, theGroupNodeLabelModel.CreateTabParametermethod and theFreeNodeLabelModel.CenterandFreePortLabelModel.Centerfields have been added. -
The structural properties on graph items now are never
null. This affectsIEdge.SourcePort,IEdge.TargetPort,ILabel.Owner,IPort.Owner, andIBend.Owner. -
The
IGraph.GroupNodesmethod now has optional parameters that specify theStyleandTagof the newly created group. -
The static parameter fields of
FreeNodePortLocationModelhave been renamed analogue to the static parameter fields inInteriorNodeLabelModel. -
FilteredGraphWrappernow supports changing the node and edge predicates after creation. -
The
PropertyChangedevent on theUndoEngineclass is now also emitted if the token is changed.
Bug Fixes
-
Fixed
ILabelOwner.Labels.ContainsandIPortOwner.Ports.Containsimplementations. Previously, these methods returned true for all labels/ports in the owner's graph instead of only for labels/ports belonging to the owner. -
Fixed a bug in
EdgeSegmentLabelModelandEdgePathLabelModelwhich caused a gap in supported positions close to the source and target node. -
Fixed
EdgeSegmentLabelModelandSmartEdgeLabelModellabel placement at source and target nodes when using indices less than 0 or greater than the number of bends in the edge. -
The
EdgeSegmentLabelModelclass now calculates valid label locations for selfloop paths with one port at the side of the node. -
The
EdgeSegmentLabelModelclass now calculates valid label locations for paths with duplicate bends, i.e., paths in which two or more consecutive bends have the same location. -
GraphClipboard'sParentNodeDetectionnow can useParentNodeDetectionModes.Noneas fallback if no valid parent is found for modesParentNodeDetectionModes.SelectionorParentNodeDetectionModes.PreviousParent.
Controls
New Features and Improvements
-
yFiles now offers theming. Therefore, a new
Themeclass has been added.- The new class provides the following properties to determine the overall visual appearance:
-
*
PrimaryBrush,SecondaryBrush, andBackgroundBrushwhich determine the color of vaious decorations like selection decoration or handles. -
*
Scale: which determines the size if handles and port candidates. -
*
IndicatorOffsetandHandleOffset: which determines an offset for decorations to their decorated elements. -
*
Variant: which determines some aspects of the overall appearance, e.g. whether handles should be drawn as circles or squares. -
The theme can be set for a
CanvasControlorGraphControlusing theThemeproperty.
-
CanvasControlandGraphControlnow have a new scroll bar design, as well as new behavior if eitherHorizontalScrollBarPolicyorVerticalScrollBarPolicyis set toAsNeeded. The new style is similar to system scrollbars in many operating systems, overlays the content and gets out of the way when not needed or interacted with. If this behavior is wanted when customizing the control template, the newDynamicScrollBarclass can be used. -
ViewportLimiternow also works with isometric projections and offers options to use theCanvasControl.ContentBoundsfor the limiting. It now offers the possibility to specify margins in the view coordinate system around the specified bounds, and bounds can be given as a list of convex polygon points.CanvasControlnow also notifies the viewport limiter when the size of theContentBoundsor the size of theCanvasControlchanges. -
The new
CanvasControl.HorizontalScrollEventRecognizerproperty allows customizing switching from vertical to horizontal scrolling. -
The
ICanvasContext.CanvasControlproperty (and consequentlyIRenderContextandIInputModeContext) is now guaranteed to have a non-nullvalue. -
All predefined
EventRecognizerconstants can now be found in the same class,EventRecognizers, which improves discoverability. In addition, their names now follow the platform conventions, i.e. they are formulated in the present tense and use the same wording as corresponding input events.
Similarly, the events onCanvasControlwhich are related to input devices now have the same consistent names. -
The
CanvasControl.ContentRectproperty is now namedContentBoundsto make its purpose more clear. TheUpdateContentRectmethod has been renamed likewise. -
It is now possible to have more than one
BridgeManager. This allows you to have different types of bridges on different types of edges. -
GraphControlnow usesGraphViewerInputModeas the defaultInputModefor basic graph exploration.
Bug Fixes
- Fixed an issue where a sequential animation would break when the preferred duration was set to zero.
-
Fixed
GraphOverviewControlrendering issues withHighDPIdisplays in conjunction with display scaling. -
Changing
CanvasControl.Zoomproperty value no longer changes the viewport center, if the control's Projection and Scale are set to non-default values.
Rendering
New Features and Improvements
-
The new
ObjectRendererBaseclass allows conveniently implementing theIObjectRendererinterface. -
New classes formalize the data passed as
RenderTagto implementations ofIObjectRenderer.-
The new
PortCandidateRenderTagclass will be passed as render tag for port candidates. -
The new
MarqueeRenderTagclass will be passed as render tag for the marquee rectangle renderer of theMarqueeSelectionInputModeclass. -
The new
LassoRenderTagclass will be passed as render tag for the lasso path renderer of theLassoSelectionInputModeclass. The newLassoPathStateenum defines the current state of the lasso selection path in this class. -
The new
LabelCandidateRenderTagclass will be passed as render tag to the label candidate renderer of theLabelPositionHandler.
-
The new
-
The new
VoidObjectRenderer.Instanceconstant provides a singleton renderer that renders nothing. -
Added properties
IntermediateToWorldTransformandViewToWorldTransformtoIRenderContext. - Hatch brushes are scaled on high-resolution displays.
Selection, Focus, Highlight
New Features and Improvements
-
The new
Domainproperty on theHighlightIndicatorManagerclass matches theDomainproperty on theSelectionIndicatorManagerclass and allows automatic removal of highlights no longer present in the domain. -
FocusIndicatorManagersupports a new policy that will only show the keyboard focus indicator, when the user is actually using the keyboard to manipulate the focus.
Styles
New Features and Improvements
-
New styles that are based on the composition design pattern make it easier to combine existing styles into a single
item visualization. These styles are available for all graph items via the
CompositeNodeStyle,CompositeEdgeStyle,CompositeLabelStyle, andCompositePortStyleclasses. -
Similarly, new styles that are based on the delegation design pattern make it easier to implement custom styles that
extend an existing style. For this, derive your style implementation from the
DelegatingNodeStyle,DelegatingEdgeStyle,DelegatingLabelStyle, orDelegatingPortStyleclass. -
The new
ShapePortStyleclass displays ports as geometric shapes and supports the same shapes as theShapeNodeStyleclass. -
The
Arrowclass now supports more types and features. In particular:-
There are three new shapes that are similar to what is available in common drawing apps:
ArrowType.Chevron,ArrowType.Deltoid, andArrowType.Kite. - The width and height can now be scaled independently from each other.
-
An arrow can now specify whether the end of the edge the arrow belongs to should be cropped at the port or at
the boundary of the port's owner. This alleviates the need to use
PortDecorator.EdgePathCropperfor this.
-
There are three new shapes that are similar to what is available in common drawing apps:
-
The new
PathEdgeStyleBaseclass simplifies using a complexGeneralPathas the edge path of a style. Subclasses only have to create the path while the style already handles the visualization, including placing arrows and bridges. Several callback methods can be overridden to customize the behavior. -
The
ShapeNodeStyleclass now supports more shapes, namelyPentagon,OctagonStanding,TrianglePointingLeft, andTrianglePointingRight. These shapes are also available asTextWrappingShape. -
Node shapes that are stars or arbitrary polygons are now easy to implement with new factory methods of the
GeneralPathNodeStyleclass. -
LabelStylenow trims text (and shows ellipsis) when text wrapping and text trimming is used with rectangle shapes. Previously,DefaultLabelStyleused Forms' native support for trimming and wrapping for rectangle shapes which could lead to clipped text. -
LabelStylenow trims large text at words, with an ellipsis by default. -
LabelSTylenow only includes entire lines in its bounds by default. -
The
IconLabelStylenow has a default icon size of 24x24 instead of empty, such that the icon is always visible. -
The new
GetLassoTestablemethod of the interfacesINodeStyleRenderer,IEdgeStyleRenderer,ILabelStyleRenderer, andIPortStyleRendereris similar to the existingGetMarqueeTestablemethod, so marquee and lasso selection do no longer differ in the ways the testable is retrieved. -
The
CollapsibleNodeStyleDecoratorclass positions and styles the button now closer to whatGroupNodeStyledoes to achieve a more modern look. -
Group nodes and nodes with
GroupNodeStylenow have more useful default port candidates. Either four candidates, one in each cardinal direction, for group nodes withGroupNodeStyle. Or a single central port for folder nodes with aGroupNodeStyle. -
ShapeNodeStylenow considers the pen thickness when rendering rectangle, round rectangle and ellipse shapes, i.e. the pen is rendered half inside and half outside the node bounds, like for the other shapes.
Bug Fixes
-
The intersection calculation for
RectangleNodeStylehas been corrected for some previously failing edge cases that resulted in edges ending in mid-air or disappearing. -
The selection, highlighting and focus visualization of edges using
BridgeEdgeStyleorArcEdgeStyleno longer disappears too early if the edge path is only partially in the viewport. -
The following node styles now consider the pen thickness in the visibility test:
ShapeNodeStyle,ArrowNodeStyle,GeneralPathNodeStyle,GroupNodeStyle, andRectangleNodeStyle. -
LabelStyle'sGetPreferredSizenow correctly calculates the preferred height for label text consisting of multiple lines of text when some kind of text trimming is used. Previously, the more lines of text there were, the higher the chance was for some lines being cut off, because the calculated height was to small.
Interaction
New Features and Improvements
-
The
MoveInputModeclass now also handles moving labels, thus theMoveLabelInputModehas been removed. -
The new
PointerLongPressevent is available for all pointer input types and replaces the previous touch-specific long press API. -
The new
PointerLongRestevent is raised when the pointer stays still for a configurable amount of time during a move or drag gesture. -
All events of an
IInputModewhich report creation of, changes to, or deletion of model items now have arguments of typeInputModeItemEventArgsorInputModeItemChangedEventArgs. This type provides the affected item and theIInputModeContextfor the involved input mode. -
The keys to modify the gestures of various input modes have been adjusted to better match those of other often used
applications:
-
To temporarily disable snapping during edge creation, moving, or resizing items, the
Altkey can now be pressed instead of theCtrlkey. -
When resizing a node using its reshape handles, the
Ctrlkey instead of theAltkey can be pressed to keep the center of the reshaped node. -
To reparent a node to another parent during a drag gesture, the
Ctrlkey has to be pressed instead of theShiftkey.
-
To temporarily disable snapping during edge creation, moving, or resizing items, the
- Elements can now be moved without selecting them first.
-
The new
CreateEdgeInputMode.MinimumSelfLoopBendCountproperty allows for specifying the number of bends an edge must at least have before it can be created as selfloop. -
The new
CreateEdgeInputMode.ShowStartPortCandidateDelayproperty allows for specifying a delay after which start port candidates are displayed when the user hovers over a start port candidate owner. -
The new
GraphEditorInputMode.MovableUnselectedItemsproperty allows for defining items which can be moved without selecting them first. TheMovableUnselectedItemsPredicateproperty can be used for closer specification. -
The
CanvasControl's event system is now based on thePointerEventAPI instead of mouse and touch events. This enables to support stylus devices and allows for handling different input devices in a more uniform way. -
The new
CreateEdgeInputMode.EdgeDirectionReversedevent and the newCreateEdgeInputMode.OnEdgeDirectionReversedmethod are triggered when the direction of the edge creation changed during edge creation. -
The event
ItemsCopiedonGraphViewerInputModeand the eventsItemsCopied,ItemsCut,ItemsPasted,ItemsDuplicated, andDeletedSelectiononGraphEditorInputModenow useItemsEventArgsproviding the items that are the subjects of the events. -
The new
GraphEditorInputMode.SetNodeLocationmethod uses theIPositionHandlerof a node to change its location, and this way also adjusts the attached orthogonal edges and the position of child nodes if the given node is a group node. - Reconnecting edges to other nodes is now allowed per default.
-
The
IHitTesterinterface has been changed to support faster hit testing. The generic type has been removed. Instead, aGraphItemTypesparameter has been added that is used to reduce hit tests to the specified item types. -
The new
HandleType.Voidenum value makes a handle invisible and excludes it from hit testing. -
The new
GraphEditorInputMode.CreationSelectableItemsproperty allows you to specifyGraphItemTypeswhich should be selected after creation. -
Moving items interactively now supports constraining the move gesture to an octilinear direction. This constraint is
used when pressing the
Shiftkey while dragging the items. -
Marquee and lasso selection have been enhanced to support multiple selection policies. While the default gestures
replaces the selection, pressing the
Ctrl,Shift, orAltmodifier during the gestures extends, subtracts or toggles the current selection with the elements in the marquee or lasse area. -
Edge creation now supports constraining the current edge segment to use an octilinear direction. This constraint is
used when pressing the
Shiftkey while dragging the pointer. -
The
PointerEventArgs.Handledproperty has been added that can be used to set and detect if another listener already handled the event. -
A
SnapResult.Penproperty has been added that can be used to suggest a custom pen to theSnapResult.ObjectRenderer. -
The
IncreaseZoomandDecreaseZoomcommands now also supportPointandPointFas parameter. -
Renamed
GraphEditorInputModeHandleClickHandlermethod toHandleClickListenerto match the name of theIClickListenerinterface. -
If a
Wheelevent is handled by code, the default behavior (zoom/scroll) will be cancelled. -
Commands handled by
yFiles.NETcan now be executed on aGraphControlusing corresponding constants from the Command enum.GraphControlprovides methods such asExecuteCommandandCanExecuteCommand, along with theCanExecuteCommandChangedevent, for this purpose. This presents an additional execution pathway while retaining the ability to use the original commands as usual. -
KeyboardInputMode's methodsAddCommandBinding,AddRecognizerBinding, andAddKeyBindingnow return a token which can be used to remove that binding. -
The
IInputModeAPI has been updated for clarity: theInputModeproperty has been removed from the interface. Instead, most implementations now offer the protectedParentInputModeContextproperty to clearly indicate its role as the input mode's parent context. Most input modes can create a context which can be passed to dependents via the protectedCreateInputModeContextmethod. The created context has the input mode set as the parent input mode. The newInputModeContextclass may be used by implementations to conveniently create new contexts. -
When using the
GraphViewerInputMode, the viewport can now be moved by either dragging with the left or middle mouse button. -
When using the
GraphEditorInputMode, the viewport can now be moved by either dragging with the middle mouse button or by dragging with the left mouse button when pressing theCtrlorSpacekey. -
Several default keyboard shortcuts have been adjusted to more widely used ones:
-
Ctrl+0orAlt+0sets the zoom to 100%. -
Alt+1fits the content in the view. -
Alt+2brings the selection into the view. -
Alt+3brings the current item into the view. -
Ctrl+Plusincreases the zoom value. -
Ctrl+Minusdecreases the zoom value. -
Alt+Leftcollapses a selected group node. -
Alt+Rightexpands a selected folder node. -
Alt+Upexits the current folder node. -
Alt+Downenters the current folder node. -
Alt+Shift+LeftorAlt+Shift+Righttoggles the expansion state of a selected group or folder node.
-
-
The new
Command.ZoomToSelectionzooms to the bounding box around all selected items. It can be triggered by the keyboard short cutAlt+2. -
Lowered the
MoveViewportInputMode.Priorityto105to make viewport panning withCTRLorSPACEmodifiers easier in dense graphs. -
The new
DropInputMode.AcceptDragmethod is called onDragEnteredevents and determines if the mode will handle subsequent drag and drop events. Previously, this was the responsibility of theDropInputMode.AdjustEffectmethod . Now,AdjustEffectonly changes the drag/drop effect of the given event args as its name implies. - Edge creation can now be cancelled by ending the gesture over the source node.
-
Edge creation is canceled if the
GraphControlloses the focus. -
GraphViewerInputMode's andGraphEditorInputMode'sClickHitTestOrdernow reflects the z-Order of the elements. By enablingSkipHitLabels(the default) elements behind labels can still be prioritized over the labels. -
LabelDropInputModenow consults theIEditLabelHelperof possible drop targets when dragging and dropping labels. -
Command handling has been improved: The previous
ICommand, inspired by WPF's commands, has been replaced with an enumeration of primary input gestures calledCommand.GraphControlnow manages the execution of commands:-
GraphControl.ExecuteCommandruns the specified command with an optional parameter. -
GraphControl.CanExecuteCommandindicates whether the specified command can be executed. -
The
CanExecuteCommandChangedevent is triggered when the executable state of a command has changed.
-
-
OverviewInputModenow uses theCanvasControl'sMouseWheelZoomEventRecognizerto determine if the used performed a zoom gesture. -
GraphEditorInputModenow allows for starting label editing just by starting to type. TheAllowEditLabelOnTypingproperty can be used to configure this setting, which is turned on, by default. - The default gesture for label editing has been updated to also trigger when the user hits the `Enter` key.
-
The
ClickInputMode.Clickedevent is now raised also for double-clicks and multi-clicks. Clicking multiple times in the same location increments theClickEventArgs.ClickCountby one for each click. -
The
HandleIsHitandGetClosestHitHandlemethods ofHandleInputModenow have an additional parameter which specifies thePointerTypeof the related user gesture. -
MoveViewportInputModenow gracefully handles concurrent programmatic viewport modifications. - Starting edge-creation from a child node inside a group node now does not immediately snap to the parent when moving over the group nodes content. Instead, it only snaps to the closest port when hovering the tab or stroke.
-
The sub-input modes of
GraphViewerInputModeandGraphEditorInputModecan now be replaced while the input mode is installed. -
The new
GraphViewerInputMode.HitTesterproperty works in the same way as theGraphEditorInputMode.HitTesterproperty. -
The
GraphEditorInputMode.DuplicateSelectionmethod now also dispatchesMultiSelectionStartedandMultiSelectionFinishedevents. -
NavigationInputModenow interprets the direction of arrow keys in view coordinates by default. Previously the default settings could lead to surprising behavior when combined with aProjectiononGraphControl. -
The
GraphInputMode.FindItemsmethod now considers the actual z-order of the hit items. -
The
GraphInputMode.ItemClickedevent and the cyclic selection now consider the actual z-order of the hit items at the cursor location. Bends and invisible ports are now properly taken into account and hit before their owners. -
The rendering order of visuals created by an
InputModenow corresponds to the input mode'sPriority. In other words, visualizations of input modes with a smaller priority value (= higher priority) are drawn on top. -
The
GraphEditorInputMode.OrthogonalEdgeEditingContextproperty is now set and enabled per default and may not benullanymore. Edges can be individually configured to be edited orthogonally by providing an apropriateIOrthogonalEdgeHelperin their lookup.-
For edges using a
PolylineEdgeStyle, the style's newOrthogonalEditingproperty can be set so such a helper is automatically provided. -
To disable orthogonal editing for all edges, the
Enabledproperty of theOrthogonalEdgeEditingContextcan be set to false. -
To enable orthogonal edge editing for all edges that don't explicitly forbid this, the
OrthogonalEdgeEditingContext.FallbackEdgeHelperProviderproperty can be set to a helper supporting orthogonal edge editing.
-
For edges using a
-
The
HandleTypesenums has been refactored to a non-flaggableHandleTypeenum, and the values have been adjusted to those used in the library as well as some custom variants for individual use. -
Custom
IHandleimplementations can use the newIHandle.Tagproperty for various purposes, including custom handle visualizations. yFiles does not use the property and initializes it withnull, but decorating handles forwards any values unmodified. -
The static member
GraphClipboard.DefaultGraphClipboardhas been added and is used per default asGraphControl.Clipboard. This way copy&paste operations work between multipleGraphControlinstances without the need to set a sharedGraphClipboardinstance first. -
The parent node detection of
GraphClipboardhas been streamlined. -
The protected
Should-methods of the input modes have been removed and replaced by predicate properties. This simplifies adjusting the behavior without the need to subclass the input modes. -
Toggling the item selection via
Ctrl+Spacenow prefers toggling the selection state ofGraphControl.CurrentItemover deselecting a single selected item. -
The items reported by the
HandleInputMode.AffectedItemsproperty now include edges that were modified with the height handle ofBezierEdgeStyleandArcEdgeStyle. -
New overloads of the
CreateEdgeInputMode.StartEdgeCreationmethod can be used to start interactive edge creation from a node or port, respectively. -
The modifier for using the
ILabelModelParameterFinderduring label movement can now be changed with theLabelPositionHandler.UseParameterFinderRecognizerproperty. - Improved keyboard navigation for graph items.
-
The
MoveInputModeandMoveUnselectedInputModeproperties ofGraphEditorInputModehave been renamed toMoveSelectedItemsInputModeandMoveUnselectedItemsInputModeto better describe what they are used for. Associated properties and methods have been renamed accordingly. - Dragging a selected edge doesn't move all its bends anymore which often screwed up the first and last edge segment.
-
The
MouseHoverInputModehas been renamed toToolTipInputModeto better reflect its function.
Bug Fixes
-
Fixed a possible exception upon
ClickInputModeinstallation if theDoubleClickTimewas set to 0. -
Fixed a bug in
TextEditorInputModewhich prevented setting a customTextBoxvia property. - Sporadic errors during pinch zoom have been corrected.
-
Toggling the selection of an item using the keyboard now always toggles the selection of the focused item.
Previously, if exactly one other item was selected when toggling, that item was deselected, making it virtually
impossible to select multiple individual items using the keyboard.
To fix this, the behavior ofGraphCommands.ToggleItemSelectionhas been adjusted accordingly, and the behavior theGraphCommands.SelectItemandGraphCommands.DeselectItemhas also been changed accordingly. -
NavigationInputModenow reliably brings items selected with keyboard navigation into the view. Previously this only worked for nodes. - Fixed an issue where keyboard navigation would stop working when two items were positioned at the same location.
-
The
GraphInputMode.FindItemsoverload without thecontextparameter did not find items correctly. -
Several members of
EditLabelInputModecould not be overwritten by mistake. TheInstall,Uninstall,TryStop, andCancelmethods and theEnabledproperty can now be overwritten. -
GraphInputMode.FindItemsmethod: when the filter includes both edges and bends, the edge will no longer be ignored if any of its bends are hit. -
GraphInputMode.FindItemsmethod: when usingGraphItemTypes.All, bends will not be ignored. Furthermore, the interfacesIBendSelectionTesterandIPortSelectionTesterare properly queried. -
GraphInputMode.FindItemsmethod: Ports with a style are no longer reported twice. -
When moving the viewport in a
GraphControlthat has a projection, the inertia now works in the right direction. -
Fixed that the
MarqueeSelectandLassoSelectmethods ofGraphEditorInputModeandGraphViewerInputModewere called with a wrong input mode context. - Fixed occasionally missing auto-scrolling on viewport bounds for touch devices.
- Key presses are no longer propagated to the canvas's parent control if an input mode requests the keyboard.
Label Editing
New Features and Improvements
-
The API related to label editing has been enhanced by introducing a new
EditLabelInputMode, which is now a subordinate mode ofGraphEditorInputMode. The new input mode consolidates the methods, properties, and events necessary for customizing label editing. The key methods,AddLabelandEditLabel, remain accessible throughGraphEditorInputMode. - The text editor will now stay open by default if label text validation fails.
-
Each
ILabelandILabelOwnernow includes a default implementation ofIEditLabelHelperin itsLookup. TheIEditLabelHelperinterface has been updated to offer greater control over the label editing process. -
The API related to label editing has been removed from
TableEditorInputMode, except for the key methodsAddLabelandEditLabel. Label editing is now handled throughGraphEditorInputMode'sEditLabelInputMode.
Snapping
New Features and Improvements
- The snapping feature has been refactored and enhanced to support more use cases. Previously, items could only snap to points or orthogonal lines. Now lines with any orientation and circle segments can be defined as references where items can snap to. Furthermore:
-
Snapping to circles, grids, and specific node sizes has been refactored to work analogue to the snapping to a
SnapLine, soSnapCircle,SnapGrid, andSnapSizeinstances are created and are available for theSnapResultproviders. -
Label snapping is now also handled by the
GraphSnapContext, so theLabelSnapContexthas been removed. Configuration options have been moved fromLabelSnapContexttoGraphSnapContext. -
Additional improvements:
-
The new
GraphSnapContext.AffectedItemsproperty provides the items for whichSnapResultsshall be collected. -
The configuration options of
GraphSnapContextare now easier to use and more concise. -
The new protected methods
CollectGridSnapReferencesandCollectSameSizeSnapReferencesofGraphSnapContextcan be overridden to customize theSnapGridandSnapSizeinstances items can snap to. -
The new
SnapReferenceclass is now the base class ofSnapLine, and the newSnapGrid,SnapSize, andSnapCircleclasses. The newSnapReference.SnappableItemsproperty describes which item types may snap to this reference. - Snap references of all types can be styled with CSS classes.
-
The new
OrthogonalSnapLine.Croppableproperty is used to decide which snap lines to crop ifGraphSnapContext.CropSnapLinesis {}true{}. -
The new properties
Reference,Item, andItemAnchorof theSnapResultclass can be used by theIObjectRendererfor the visualization of theSnapResult. -
New methods of
ReshapeRectangleContextsimplify the calculation of the bounds for a specified pointer delta or theSnapConstraintnecessary to result in a specified width, height or side location.
-
The new
Clipboard
New Features and Improvements
GraphClipboard and GraphEditorInputMode with
Element in their name that actually referred to model items were renamed to
Item to clarify their usage.
GraphClipboard.Paste method now accepts an optional pasteLocation
parameter specifying the center of the bounds of the pasted items.
GraphClipboard now use GraphClipboardEventArgs that provide the current IGraphClipboardContext and the Items.
GraphControl that has a projection, the inertia now
works in the right direction.
GraphClipboard's Cut, Copy, Paste, and Duplicate methods now use an IEnumerable to determine
the subgraph to copy.
GraphClipboard now uses an optimized ClipboardGraphCopier for its clipboard operations instead of the general GraphCopier.
Bug Fixes
- In certain rare cases, the insertion of edges could end up in an endless loop. This has now been fixed.
Folding
New Features and Improvements
- The process of configuring edges at folder nodes has been simplified, resulting in a significant reduction in the number of configuration calls for merged edges.
- The default implementation for folder nodes and folding edge converters has been enhanced, providing more powerful capabilities for synchronizing and initializing various aspects with granularity.
- Collapsed group nodes (folder nodes) can now have different tags from their expanded form (group nodes).
-
Changes made to view states (folder nodes, folding edges) can now be reflected back to the master items. New
methods,
UpdateGroupNodeStateandUpdateMasterEdges, have been added toIFolderNodeConverterandIFoldingEdgeConverter, respectively, for handling these updates.
Bug Fixes
-
Setting the source or target port of an edge to a port at another edge does no longer lead to an exception if the
edge is represented in a managed view (
IFoldingView). Instead, the edge is now removed from the view. - Fixed a bug which could cause an edge in a folding view to be created at different ports as those which were given as parameters. This could lead to unexpected connections during interactive edge creation in rare cases.
-
Fixed a bug that could lead to an exception when duplicating a port on the
GraphClipboardif it is duplicated. - Fixed a bug which caused changing the ports on an edge whose source or target node is collapsed being reverted after subsequent collapsing and expanding.
-
Label changes on folder nodes are no longer reverted by
FolderNodeConverterif labels are copied between master and view node.
View-Layout-Bridge
New Features and Improvements
-
LayoutExecutorcan now automatically create port constraints for edges at ports that use aCompositePortLocationModel. For all parameters added to aCompositePortLocationModel, a fixed port candidate is created. The cost, capacity, andPortSideof this candidate can be specified when adding the parameter to the model. -
With the new
ItemMapping.Dictionaryproperty, a dictionary can be used to specify anItemMapping. -
The
LayoutExecutor.TableLayoutConfiguratorfeature now uses more flexible placements for nodes that don't belong to any table node.
Bug Fixes
-
The
LayoutExecutorandLayoutGraphAdapterclasses now correctly assign port group IDs to edges that connect to the same port. Previously, in some cases involving ports with a single incoming and outgoing edge, the port group IDs were omitted, which could cause incorrect layout results (such as diagonal segments instead of orthogonal ones).
Layout
New Features and Improvements
-
LayoutPortCandidates now have aMatchingId. When finding matchingLayoutPortCandidates at nodes and for edges, twoLayoutPortCandidates can only match if theirMatchingIdproperties are equal. -
The
LayoutAnchoringStageclass (previously calledFixNodeLayoutStage) now allows using not only nodes but also edges and labels to anchor the graph's position.-
The new
NodeAnchoringPolicies,EdgeAnchoringPolicies,NodeLabelAnchoringPoliciesandEdgeLabelAnchoringPoliciesproperties specify which part of the items should be used to calculate the anchor point. -
The new
LayoutExecutor.AnchoredItemsproperty specifies the graph items used to anchor the graph's position.
-
The new
-
The
ComponentLayouthas now the ability to specify which layout to apply to individual components usingComponentLayoutData.ComponentLayoutsproperty. Additionally, edges between components can be routed using a router set viaComponentLayout.InterEdgeRouter. -
It is now possible to specify multiple layout grids for a graph (previously called
PartitionGrid). This is made possible by the newLayoutGridCellDescriptor.LayoutGridproperty. This way it is no more required to set the global layout grid with theLayoutGridData.Gridproperty. If a node is to be placed in a grid but not in a specific cell, this can now be achieved using the newLayoutGrid.CreateDynamicCellDescriptormethod. Be aware that many layout algorithms likeHierarchicalLayoutdon't support multiple layout grids. -
The
LayoutDataclasses are now generic and can be used for items of aLayoutGraph, too. Of course, it's still possible to useLayoutDatawithIGraphitems.-
LayoutDatainstances when used withIGraphtypically needINode,IEdge,ILabel, andILabelas their type arguments. -
LayoutDatainstances when used withLayoutGraphtypically need Node, Edge,NodeLabel, andEdgeLabelas their type arguments. -
Instances of
LayoutDataclasses can be created via factory extension methods on the layout algorithm themselves, for example,HierarchicalLayout.CreateLayoutData. Depending on the type of graph that is provided as the argument, the correct data instance will be created.
-
-
The API around the
LayoutGraphclass has received a major rework. TheLayoutGraphis the only remaining graph implementation for the layout analysis part. ClassesGraph(previously used for graph analysis, only) andCopiedLayoutGraphhave been removed and functionality was moved toLayoutGraph.-
The API has been made more similar to the API of the
IGraphwith respect to creation, modification and access to nodes, edges and labels. -
Low-level data types like
NodeListandEdgeListhave been removed as well as cursor for iteration over the elements. -
Properties
NodeCountandEdgeCounthave been removed. Query the size of theNodesandEdgesproperties instead. -
Layout information about items must no longer be queried from the graph instance (e.g. previously with methods
like
LayoutGraph.GetLayout). It is now accessible on the items itself and is also mutable, seeNode.Layoutproperty. -
The edge path information is no defined by properties on the edge, most importantly these are
SourcePortLocation,TargetPortLocationandBends. -
Labels of nodes and edges are now accessed via a property on the respective owning item. To add labels, use
LayoutGraph.AddLabelmethod. The complicatedILabelLayoutFactorythat covered that use case in the past has been removed. -
Hiding items is no longer possible via the graph itself. To do so, use the helper
LayoutGraphHiderclass. -
The
Graph.ContainsEdgemethod has been removed in favor ofLayoutGraph.GetEdgesBetween. The same holds for theNode.GetEdgeToandNode.GetEdgeFrommethods. -
Convenience properties like
Node.Neighborshave been removed. Instead, query all edges (using the Edges property) and filter the required adjacent nodes manually. -
To copy a
LayoutGraphinstance, the newLayoutGraph.CreateCopymethod has been added. -
If a
LayoutGraphwithout coordinate/path information is needed (to optimize memory performance), it can be created using the factoryLayoutGraph.CreateStructureGraphmethod.
-
The API has been made more similar to the API of the
-
LayoutExecutornow supports arranging graphs without aGraphControl. -
The thread started when
LayoutExecutor.RunInThreadistrueis now a background thread and thus long-running layout calculations no longer block the process from exiting. -
The new
LayoutGraph.GetEdgesBetweenmethod returns all edges between two nodes. -
The
PortPlacementStagenow computes cost-minimal matchings between port candidates at nodes and edges. -
Most layouts now support port grouping and port candidates at nodes and edges. These features are implemented
through a post-processing step using the
PortPlacementStage, rather than being natively integrated into the layouts. As a result, the quality may be poor.
Bug Fixes
-
The
CurveFittingStagenow correctly respects the maximum error. Previously, it sometimes produced curves that violated the maximum error. -
The
LineSegment.GetIntersectionmethod no longer produces incorrect results when the specified epsilon is zero. Previously, there were some edge cases where the algorithm failed to detect an intersection and returnednullinstead. -
Added the protected
ParallelEdgeRouter.HideMultiEdgesmethod, which is required to meaningfully overwrite the existing protectedParallelEdgeRouter.FindAndHideMultiEdgesmethod. -
The
PortPlacementStagenow correctly considers port candidates together with port groups.
Hierarchical Layout
New Features and Improvements
-
The
HierarchicalLayoutclass now supports defining minimum distances between the ports. They can be specified per node side using theHierarchicalLayoutNodeDescriptor.MinimumPortDistanceproperty. The node size is increased if necessary in order to accommodate the minimum distances. -
The Hierarchical Layout class now supports aligning the ports of edges incident to the same node, that is, the ports
are placed at the same x- or y-coordinate. This can be particularly useful to visualize paths in a graph. Which
ports to align is specified by the new properties
PortData.SourcePortAlignmentIdsandPortData.TargetPortAlignmentIdsaccessible viaHierarchicalLayoutData.Ports. -
The
HierarchicalLayoutnow produces fewer bends for multi-edges with labels when integrated edge labeling is enabled. -
The
HierarchicalLayoutclass now produces better results for graphs with tabular groups where all children have a fixed user-specified order. - The routes of self-loops now consider both node and edge labels preventing overlaps if possible.
- The ports of edges with free ports are no longer placed at the same location as fixed ports, which previously could happen if multiple edges had the same fixed port.
-
The
HierarchicalLayoutno longer produces overlapping edge segments if there are grouped edges with different thicknesses values. Previously, the user had to ensure that all these edges use the same thickness. -
In barycenter mode the
HierarchicalLayoutnow enforces a more symmetric placement of the nodes that are part of chains or height-2 trees.
Bug Fixes
-
The
HierarchicalLayoutclass no longer produces an error when using a non-zero grid distance in combination with incremental mode's exact coordinate hints. -
The
HierarchicalLayoutclass no longer assigns superfluous space to group nodes if there are grouped edges. -
The
HierarchicalLayoutalgorithm now correctly handles node and edge labels with width or height set to negative values. Previously, large negative values may have caused exceptions. -
The
HierarchicalLayoutclass now always places aligned ports correctly in from-sketch mode. -
Instances of
LayerConstraintDataandSequenceConstraintDatathat are configured with comparables can now be reused for multiple layout calculations. -
The
HierarchicalLayoutclass no longer produces an error for labeled graphs with port alignment constraints when the integrated edge label placement is enabled. -
The
HierarchicalLayoutclass no longer produces superfluous crossings between backloops or same-layer edges in the first or last layer. -
The
HierarchicalLayoutnow properly handles self-loop edges when the edge is at a group node and furthermore edge/port grouped with the same ID on both sides. Previously, it was not routed correctly or that it was removed from theLayoutGraphinstance when running the layout algorithm directly on the graph instance without using a copy. -
The
HierarchicalLayoutclass no longer swaps the position of fixed nodes in incremental layout mode with user-specified sequence constraints. -
The
HierarchicalLayoutclass no longer produces superfluous crossings for some graphs with group nodes in incremental layout mode. - Edges between two subcomponents now correctly consider fixed any-side port candidates.
-
The
HierarchicalLayoutclass no longer produces very long edge segments for some input graphs containing groups with node halos and polyline edge routing. -
The
HierarchicalLayoutclass no longer throws an exception for graphs with bus structures if the algorithm runs in incremental mode and the group transposition feature is enabled. -
The
HierarchicalLayoutclass no longer produces intertwined edge routes with many superfluous crossings and bends for some cases with sequence constraintsPlaceAtHeadorPlaceAtTail. The problem mainly occurred with graphs with groups orPartitionGridand incompatible sequence constraints.
Tree Layout
New Features and Improvements
-
Added the new
TreeLayout.FromSketchModeproperty to consider the initial coordinates of the graph elements. This has an effect only if the used subtree placers implementIFromSketchSubtreePlacer. -
Added the
TreeLayoutData.MultiParentDescriptorsproperty that allows to specify style information for multi-parent structures. -
The
TreeReductionStageDataclass now offersNonTreeEdgesResultproperty. It allows to conveniently query the set of edges that the stage actually selected as non-tree edges. -
The
TreeLayoutnow considers minimum last segment lengths no matter on which side the port shall be placed. -
The
AspectRatioSubtreePlacernow supports minimum first and last segment lengths. -
The
SingleLayerSubtreePlacersupports placing the subtree root centered with respect to the ports at its children with the new enum valueSingleLayerSubtreePlacerRootAlignment.CenterOfPorts. -
All subtree placers that used
Tree.RootAlignmentsupport placing the subtree root centered above the ports with the new valueCenterOfPorts. -
The
LeftRightSubtreePlacernow supports minimum segment length, which can be set with the propertiesMinimumFirstSegmentLengthandMinimumLastSegmentLength. -
The
AspectRatioSubtreePlacernow supports multiple variants how to place the root node with respect to its children, which can be set using the propertiesChildArrangementandRootPlacement. -
Added properties of
TreeReductionStageDatadirectly to theLayoutDataof tree layouts, includingRadialLayoutData,AspectRatioTreeLayoutData,RadialTreeLayoutData, andTreeLayoutData.
Bug Fixes
-
The
TreeLayoutclass no longer ignores the initial locations for some subtree placers if theFromSketchModeproperty is enabled. -
The Tree Layout now automatically places edge labels of the parallel edges handled by its
ParallelEdgeRouterinstance, when integrated edge labeling is enabled. -
The
TreeLayoutclass no longer produces broken edge routes for some input graphs with multi-parent structures. -
The
AspectRatioSubtreePlacerclass no longer ignores the specifiedAspectRatioSubtreePlacer.ChildAlignmentPolicyfor some specific setups (e.g., if all children are leaves and have the same size).
Orthogonal Layout
New Features and Improvements
-
The newly added
OrthogonalLayout.QualityTimeRatioproperty allows controlling the layout quality by automatically enabling/disabling additional optimization steps. -
The
OrthogonalLayoutalgorithm now supports specifying edges that should be routed against the main layout orientation in addition to the option to route with the main layout orientation. SeeOrthogonalLayoutData.EdgeOrientationproperty.
Bug Fixes
-
The Orthogonal Layout now automatically places edge labels of the parallel edges handled by its
ParallelEdgeRouterinstance, when integrated edge labeling is enabled.
Edge Router
New Features and Improvements
- The quality of edge routing for buses is improved.
-
If
EdgeRouteris run with the buses feature and a limited duration, it now splits the available time amongst buses, meaning that it will not get "stuck" on a single bus, which could otherwise impact the quality of the remaining buses and non-bus edge routings.
Bug Fixes
-
The
EdgeRouternow prefers to use fixed port candidates that are not overlapped by other nodes. -
The
EdgeRouterclass no longer produces uncovered buses. Previously, there were some rare cases where the specified bus edges didn't constitute a bus. - When routing edges to and from fixed ports in the interior of group nodes, other nodes in the group are not ignored anymore, so that the edge does not overlap them if possible.
Labeling
Bug Fixes
-
The
GenericLabelingalgorithm now correctly considers the case where model parameters of aCompositeLabelModelhave different weight values. Higher weights are preferred. -
The
EdgeLabelCandidates.BuildCandidatesmethod does no longer returnnullfor some setups with free edge label models. Instead it returns an emptyIEnumerablenow. -
The
GenericLabelingclass now produces less node-label overlaps.
Organic Layout
New Features and Improvements
-
The performance for the
OrganicLayouthas been substantially improved for large graphs without group nodes. The improvement is triggered if no special constraints are defined and no shape recognition is enabled. -
The
OrganicLayoutnow supports different styles for group substructures, which are set via theGroupSubstructureStyleproperty.
Bug Fixes
-
The Organic Layout now automatically places edge labels of the parallel edges handled by its
ParallelEdgeRouterinstance, when integrated edge labeling is enabled. -
The
OrganicLayoutclass no longer ignores the preferred edge length in incremental layout mode with a single affected element. - Fixed an issue that may have automatically disabled the component layout when using constraint-based features.
Radial Tree Layout
New Features and Improvements
-
Added data key
OutEdgeComparisonDataKeytoRadialTreeLayoutclass (formerlyBalloonLayout).
Series-parallel Layout
Bug Fixes
-
The Series Parallel Layout now automatically places edge labels of the parallel edges handled by its
ParallelEdgeRouterinstance, when integrated edge labeling is enabled.
Partial Layout
New Features and Improvements
-
PartialLayoutnow supports specifying inversely directed edges in addition to undirected and directed edges.
Bug Fixes
-
PartialLayoutScopeDatawill no longer mark any edges as affected when only nodes are specified to be in scope, nor mark any nodes as affected when only edges are specified to be in scope.
Tabular Layout
New Features and Improvements
-
The new
TabularLayoutData.LayoutGridDataproperty makes it easy to query the cell to which a node was assigned to by theTabularLayoutclass after applying it.
Bug Fixes
-
The layout algorithms do no longer throw an Exception when a
LayoutGridincluding a mapping from nodes toLayoutGridCellDescriptorsis defined and if algorithmTabularLayoutwas executed before withLayoutModeAutoSizeorFromSketch. In these modes theTabularLayoutautomatically assigns cells to nodes so that any mapping defined prior will be ignored now.
Component Layout
New Features and Improvements
-
ComponentLayoutnow supportsNodeMargins(formerlyNodeHalos) for eachComponentArrangementStyleother thanNoneandKeepCenters.
Algorithms
New Features and Improvements
-
The
LongestPathalgorithm now uses double values instead of integers for edge traversal costs. This improves thePaths,LayoutGraphAlgorithms, andLongestPathclasses. -
The
LayoutGraphAlgorithms.FindCycleEdgesmethod has been improved and now requires fewer edges to be reversed. In addition, a new, even better but slower heuristic can be enabled with a new optional parameter.
Bug Fixes
-
The
Intersectionsclass does not disposeFilteredGraphWrapperinstances that it is given with no subgraph nodes or edges specified anymore. Previously, this caused the graph instance to become defunct, resulting in various operations running intonullfields and properties, generating exceptions that were non-trivial to understand. -
IntersectionsResultno longer includes intersections that have no actual intersection points. This issue occurred when two graph elements were within a small epsilon distance of each other.
Analysis
New Features and Improvements
-
The
KShortestPathsclass has a new implementation of the k-shortest path algorithm that allows for the exclusion of non-simple paths (i.e., paths with repeating vertices). Previously, these paths could not be excluded. The new implementation is used by default and can be disabled with theSimplePathsparameter. -
For usage with a
LayoutGraph, the algorithm is also available via theLayoutGraphAlgorithms.KShortestPathsmethod.
Geometry
New Features and Improvements
-
The new
GeneralPath.AreaOrPathContainsmethod tests if the path fuzzily contains a point and can be used for hit-testing aGeneralPath. -
All methods on the
GeneralPathclass that accept points now have overloads forIPointandPointD, and all methods that accept rectangles now have overloads forIRectangleandRectD. -
There are now methods on
RectDandPointDto calculate the distance between points and rectangles. -
The
GeneralPath.GetProjectionmethod is now faster for paths with Bezier segments. -
The
IRectangleinterface no longer implementsIPoint. As a consequence, it is no longer possible to inadvertently use rectangles as parameters for methods that expect a point. You can still easily get the top-left corner of a rectangle with itsGetTopLeftmethod. Similarly,IMutableRectangleno longer implementsIMutablePoint.
Bug Fixes
-
Fixed a potential
NullReferenceExceptioninGeneralPath.Render. -
The
GeneralPath.PathMayIntersectClipmethod has been corrected for paths with multiple segments, at least one of which is a cubic segment. -
The
SizeD.Areaproperty now returns 0 for empty sizes. This is consistent with the behavior of theRectD.Areaproperty.
Incompatible Changes
Categories: General Graph Controls Rendering Selection, Focus, Highlight Styles Interaction Snapping Clipboard Folding Lookup GraphML View-Layout-Bridge Layout Layout Data Hierarchical Layout Tree Layout Orthogonal Layout Edge Router Labeling Organic Layout Interactive Organic Layout Circular Layout Radial Layout Radial Tree Layout Radial Group Layout Series-parallel Layout Compact Disk Layout Multi-page Layout Partial Layout Tabular Layout Component Layout Tree Map Layout Recursive Group Layout Layout Grid Other Layouts Algorithms Analysis Collections Geometry
General
Incompatible API Changes
- The minimum required .NET versions for yFiles are .NET Framework 4.6.2 and .NET 6.0, respectively.
- The minimum supported .NET versions for the Layout package are now .NET Standard 2.1 and .NET Framework 4.6.2.
- The (up to three) assembly files of the yFiles library are now combined into one single file.
-
The following classes are now sealed:
BorderLineSegment,LayoutGridCellDescriptor,LabelScopeData,ItemCollection,ItemMapping,FreePortLabelModel, andFreeNodeLabelModel. They either already had an internal constructor or do not offer any meaningful members for overriding. -
Removed the
Defaultprefix from the names of the following types:DefaultEdgePathCropper,DefaultFoldingEdgeConverter,DefaultFolderNodeConverter,DefaultLabelStyle,DefaultObservableCollection,DefaultPortCandidate, andDefaultSelectionModel. -
Removed
DefaultLabelModelParameterFinder. -
Removed the protected
IgnoreModifierKeyRepeatsproperty fromCanvasControl. -
Removed the
StripeSelectionclass. Instead, use the instance returned by theTableEditorInputMode.StripeSelectionproperty. -
Consistently use names
PaddingandMarginsin member names:-
Renamed the
TextEditorInputMode.TextBoxPaddingproperty toTextBoxMargins. -
Renamed the
IndicatorLabelStyleDecorator.Paddingproperty toMargins. -
Renamed the
IndicatorNodeStyleDecorator.Paddingproperty toMargins. -
Renamed the
GraphEditorInputMode.ContentRectMarginsproperty toContentMargins. -
Renamed the
OverviewInputMode.Marginsproperty toContentMargins. -
Renamed the
ViewportAnimation.TargetBoundsproperty toTarget. -
Renamed the
ViewportAnimation.TargetViewMarginsproperty toTargetMargins. -
Renamed the
StripeLabelModel.UseActualInsetsproperty toUseTotalPadding. -
Renamed the
StretchStripeLabelModel.UseActualInsetsproperty toUseTotalPadding. -
Renamed the
IStripe.GetActualInsetsmethod toGetTotalPadding. -
Renamed the
GroupNodeStyle.ContentAreaInsetsproperty toContentAreaPadding. -
Renamed
Insetsproperties of allILabelModelimplementations toMargins. -
Replace name part
Insetsof other types and members withPadding.
-
Renamed the
-
Removed the
BridgeManager.ClipMarginproperty. -
Sealed the following classes which have no inheritors:
-
all classes in the
yWorks.Algorithmsnamespace. -
all classes extending the
EventArgsclass. -
all implementations of the
ILabelModelandIObjectRendererinterfaces.
-
all classes in the
-
Enum values that followed the
North,East,South,Westnaming convention have been renamed to follow aTop,Right,Bottom,Leftnaming convention. In particular, the values of the following enums have been renamed:HandlePositions,EdgeSegmentDirection,LabelModels.Position,LabelModels.Position,LabelModels.Position,LabelModels.Position, andLabelModels.Position,. -
The
IReadOnlyList<T>interface replaces theIListEnumerable<T>interface, which has been removed along with its related classesListEnumerable<T>andListEnumerableExtensions. -
Renamed the
PortSideenum toPortSides. -
For consistency reasons, the property
WeakDictionaryMapper.Emptyis now calledIsEmpty. -
Renamed the
CreateEdgeInputMode.AllowSelfloopsproperty toAllowSelfLoops. -
Renamed the
GraphEditorInputMode.SelectNodeAndSelfloopBendsmethod toSelectNodeAndSelfLoopBends. -
Renamed the
GraphEditorInputMode.AutoSelectSelfloopBendsproperty toAutoSelectSelfLoopBends. -
Renamed the
IEdge.IsSelfloopmethod toIEdge.IsSelfLoop.
Graph
Incompatible API Changes
-
The
ILookupinterface and its extension methods have been moved to theyWorks.Utilsnamespace. -
The
IMapperinterface, the Mappers,DictionaryMapper, andWeakDictionaryMapperclasses have been moved to theyWorks.Utilsnamespace. -
The
GraphClipboard.IsDummymethod has been renamed toIsHelper. -
Method
GroupingSupport.GetPathToRoothas been renamed toGetAncestorsand returns anIReadOnlyListinstead of anIList. -
The
ownerparameter of theITable.CreateRow,CreateColumn, andSetParentmethods has been renamed toparent. -
The structural properties of graph items (
IEdge.SourcePort,IEdge.TargetPort,ILabel.Owner,IPort.Owner,IBend.Owner) now throw exceptions if accessed for items that are no longer in the graph. If it is unknown whether the item is still in the graph, please test the item withHasOwnerorHasSourceAndTargetPortfirst before accessing these properties. -
IEdge'sGetSourceNodeandGetTargetNodemethods now throw exceptions if called for an edge that is no longer in the graph or if the owner of the edge's source or target port is not a node. -
The classes
DelegateUndoUnitandCompositeUndoUnithave been removed. The new factory methodsUndoUnits.FromDelegateandUndoUnits.Combinecan be used instead. -
The
UndoUnitBaseclass has been removed. Subclasses now have to implement theIUndoUnitinterface instead. -
GenericPortLocationModelhas been renamed toCompositePortLocationModeland doesn't implementIEnumerableanymore. Instead, theParametersproperty can be used to iterate the parameter. -
The
SegmentRatioPortLocationModelclass is now namedEdgeSegmentPortLocationModel, similar toEdgeSegmentLabelModel. -
The
CreateFromSourceandCreateFromTargetmethods of theSegmentRatioPortLocationModelandBendAnchoredPortLocationModelare now namedCreateParameterFromSourceandCreateParameterFromTarget. -
The
ITagOwnerinterface is now in theyWorks.Utilsnamespace. -
Removed the
TableAnimationclass. Use the factoryAnimations.CreateTableAnimationmethod as a replacement. -
The
GraphItemTypes.NotContainsmethod was removed, use theContainsmethod instead. -
The
FreeEdgeLabelModel.CreateEdgeAnchoredmethod has been renamed toCreateParameter. -
The
FreeNodeLabelModel.CreateDefaultParametermethod has been removed and replaced by the newFreeNodeLabelModel.Centerfield. -
The
FreeNodeLabelModel.CreateCanonicalParametermethod has been renamed toCreateParameter. -
The
FreePortLabelModel.CreateDefaultParametermethod has been removed and replaced by the newFreePortLabelModel.Centerfield. -
Changes to the
GraphCopierclass:-
The methods
CopyNodeStyle,CopyEdgeStyle,CopyPortStyle,CopyLabelStyle,GetOrCreateCopy,CopyLabelLayoutParameter, andCopyPortLocationParameterhave been made protected. -
The methods
CopyNode,CopyGroupNode, andCopyEdgehave been renamed toCreateNode,CreateGroupNode, andCreateEdgeto clarify their role. -
The
Cloneproperty has been renamed toCloneTypes. -
The
Copymethod now uses anIEnumerableof items instead of a filter predicate to define the subset to copy.
-
The methods
-
The
ILabelModel.CreateDefaultParametermethod has been removed. Instead suitable other Create*Parameter methods of the concrete label model implementations should be used. -
The
GenericLabelModelclass has been removed. Its functionality has been integrated into theCompositeLabelModel, which can be used instead. -
The
CompositeLabelModel.LabelModelsproperty has been removed. Instead of adding label models to this list, the newAddModelmethod has to be called. -
The
ILabelModelparameter of theILabelModelParameterFinder.FindBestParameterandILabelModelParameterProvider.GetParametersmethods has been removed. -
The static
LabelModelParameterSerializerandPortLocationModelParameterSerializerclasses have been removed. These classes could be used to retrieve the properties of label model parameters and port location model parameters and are not necessary anymore as the parameter classes are now public. -
The
ILabelModelParameter.Supportsmethod has been removed. Instead, theILabelModel.GetGeometrymethod may now throw an exception if the label and label model parameter don't match. -
The
IPortLocationModelParameter.Supportsmethod has been removed. Instead, theIPortLocationModel.GetLocationmethod may now throw an exception if the port and port location model parameter don't match. -
The
UndoEngine.Tokenproperty replaces theUndoEngine.GetTokenmethod. -
The static parameter fields of
FreeNodePortLocationModelhave been renamed analogue to the static parameter fields inInteriorNodeLabelModel. -
The
IMapperRegistryinterface, theMapperRegistryclass, and theIGraph.MapperRegistryproperty have been removed. To store additional information for graph items, either use the item's Tag property or keep a dictionary alongside the graph.
To configure layout settings for individual items, useLayoutDatainstead. -
The label models
ExteriorLabelModel,InteriorLabelModel, andInteriorStretchLabelModelhave been renamed toExteriorNodeLabelModel,InteriorNodeLabelModel, andStretchNodeLabelModel, respectively,.
Incompatible Behavior Changes
-
The arrow of the default edge style is now
ArrowType.Triangle. -
The default lookup for
INodedoesn't return anIMutableRectangleanymore, the default lookup forIBenddoesn't return anIMutablePointanymore, and the default lookup forILabeldoesn't return anIMutableSizeanymore. -
The rotation direction of
OrientedRectangle,NodeLabel,EdgeLabelandFreeEdgeLabelModelis now clockwise to be consistent with the other models. -
The default value for the
Paddingproperties ofExteriorNodeLabelModel,InteriorNodeLabelModel,StretchNodeLabelModel, andStretchStripeLabelModelhave been changed from empty insets to insets with value 2 on each side. This way the label bounds per default don't touch the bounds of their owner anymore. -
The default value for the
Distanceproperties of theEdgePathLabelModelandEdgeSegmentLabelModelwhen using their default constructors have been changed from 0 to 2. This way the label bounds per default don't touch the edge path of their owner anymore when anEdgeSideother thanOnEdgeis used. -
The
EdgeSegmentPortLocationModel.CreateParameterFromTargetmethod now interprets the parameter ratio from the target to the source side. -
The default edge label model parameter is now created from an
EdgeSegmentLabelModelusing itsCreateParameterFromCentermethod instead ofCreateParameterFromSource.
Controls
Incompatible API Changes
-
The XAML namespace for yFiles WPF has changed and is now
http://www.yworks.com/xml/yfiles-wpf/4.0/XAML. -
GridVisualCreatorhas been renamed toGridRenderer. -
The new
CanvasControl.RenderTreeproperty now encapsulates all low-level render object related API which was previously available directly onCanvasControl.-
This includes the default render tree groups (
RootGroup,BackgroundGroup,ForegroundGroup,ContentGroup,SelectionGroup,FocusGroup,HighlightGroup,InputModeGroup), the helper methods relating to render tree elements (HitElementsAt,IsHit,GetVisual,GetVisualCreator,GetCanvasObjects(nowGetElements),GetBounds). -
Furthermore, some functionality previously available on
ICanvasObject(Group)has been moved toRenderTreeas well, such as creating new elements or groups, changing the parent group or removing a render tree element.
-
This includes the default render tree groups (
-
Renamed the
CanvasControl.AutoDragproperty toAutoScrollOnBounds. -
Renamed the
CanvasControl.AutoDragInsetsproperty toAutoScrollPadding. -
Renamed the
ViewportChanges.AutoDragfield toAutoScrollOnBounds. -
Removed the
DragSize,DragTimeandDoubleClickSizeproperties of theCanvasControlclass. -
Renamed commands
MoveFocusBackandMoveFocusForwardtoMoveFocusLeftandMoveFocusRight. -
Renamed
HighlightIndicatorManager.SelectionModeltoItems. -
Renamed
SelectionIndicatorManager.SelectionModeltoItems. -
Renamed
SelectionIndicatorManager.ModeltoDomain. -
Renamed
Canvasword components in properties and method parameter names toCanvasControl. -
The
GraphModelManagerconstructor no longer hascanvasControlandcontentGroupparameters. Also, theContentGroupproperty can no longer be set directly. Instead, theInstallmethod now sets bothCanvasControlandContentGroup. -
Removed the events
AutoDragChanged,AutoDragInsetsChanged,MouseWheelScrollFactorChanged,MouseWheelZoomFactorChanged, andProjectionChangedof theCanvasControlclass. -
The
ICanvasObject.Groupproperty has been renamed toParent. -
The predefined
EventRecognizerconstants of theMouseEventRecognizers,KeyEventRecognizers, andTouchEventRecognizersclasses have been moved to theEventRecognizersclass. In addition, some rarely used constants have been removed. -
The events on
CanvasControlwhich are related to input devices and the correspondingEventRecognizerconstants have neem renamed to conform to platform conventions. -
Renamed the coordinate transformation methods to also include the source coordinate system in their names:
-
Renamed
CanvasControl.ToViewCoordinatestoWorldToViewCoordinates. -
Renamed
CanvasControl.ToWorldCoordinatestoViewToWorldCoordinates. -
Renamed
IRenderContext.ToViewCoordinatestoWorldToViewCoordinates.
-
Renamed
-
Removed the
AnimateScrollCommandsproperty andCanvasControl.AnimateScrollCommandsPropertyfield. ChangeAnimatedViewportChangesproperty instead. -
ViewportLimiter.LimitViewportnow uses a signature that works with the new typeViewportDescriptorand respects the newViewportLimitingModeenum. -
ViewportLimiter.HonorBothDimensionsis now calledViewportLimiter.StrictBoundsContainmentand the default value changed to false. -
The default
InputModeinGraphControlis no longernullbut is now set toGraphViewerInputMode.
Incompatible Behavior Changes
-
For new
GraphModelManagerinstances, theInstallmethod has to be called either directly or indirectly by assigning theGraphModelManagerto theGraphControl.GraphModelManagerproperty.
Rendering
Incompatible API Changes
-
Added properties
IntermediateToWorldTransformandViewToWorldTransformtoIRenderContext. -
The
ICanvasObjectDescriptorinterface has been renamed toIObjectRendererand itsIsDirtymethod has been removed. -
The
ICanvasObjectinterface has been renamed toIRenderTreeElementand itsUserObjectproperty has been renamed toTag. ItsDescriptorproperty has been replaced with propertyRendererof typeIObjectRenderer. -
The
ICanvasObjectGroupinterface has been renamed toIRenderTreeGroup. -
The
ICanvasObjectInstallerinterface has been removed. -
The singletons of the
CanvasObjectDescriptorsclass are no longer necessary, and thus, this class has been removed. There is now aVoidObjectRenderer.Instancesingleton. -
The
IFocusIndicatorInstaller,IHighlightIndicatorInstaller, andISelectionIndicatorInstallerinterfaces have been renamed toIFocusRenderer,IHighlightRenderer, andISelectionRendererrespectively and now inherit fromIObjectRendererinstead ofICanvasObjectInstaller. Classes implementing these interfaces have been changed accordingly (EdgeStyleDecorationInstaller,LabelStyleDecorationInstaller,NodeStyleDecorationInstaller, andPortStyleDecorationInstallerhave been renamed toEdgeStyleIndicatorRenderer,LabelStyleIndicatorRenderer,NodeStyleIndicatorRenderer, andPortStyleIndicatorRendererrespectively). -
The
GetInstallermethods on theModelManager,FocusIndicatorManager,HighlightIndicatorManager,SelectionIndicatorManager,GraphFocusIndicatorManager,GraphHighlightIndicatorManager, andGraphSelectionIndicatorManagerclasses are now calledGetRendererand returnIObjectRenderer. Similarly, theGetCanvasObjectGroupmethods of these classes have been renamed toGetRenderTreeGroup. -
The members of class
GraphModelManagerhave been adjusted to reflect theICanvasObjectDescriptorandICanvasObjectrenamings. More precisely,DefaultEdgeDescriptor,DefaultLabelDescriptor,DefaultNodeDescriptor,DefaultPortDescriptor,EdgeDescriptor,EdgeLabelDescriptor,NodeDescriptor,NodeLabelDescriptor,PortDescriptor,PortLabelDescriptor,ProvideUserObjectOnMainCanvasObject,GetCanvasObject,GetCanvasObjectGroup,GetCanvasObjectGroup,GetCanvasObjectGroup,GetCanvasObjectGroup, andGetMainCanvasObjecthave been renamed toDefaultEdgeRenderer,DefaultLabelRenderer,DefaultNodeRenderer,DefaultPortRenderer,EdgeRenderer,EdgeLabelRenderer,NodeRenderer,NodeLabelRenderer,PortRenderer,PortLabelRenderer,ProvideRenderTagOnMainRenderTreeElement,GetRenderTreeElement,GetRenderTreeGroup,GetRenderTreeGroup,GetRenderTreeGroup,GetRenderTreeGroup, andGetMainRenderTreeElementrespectively. -
The members of class
ItemModelManagerhave been adjusted to reflect theICanvasObjectDescriptorandICanvasObjectrenamings. More precisely,CanvasObjectGroup,Descriptor,GetCanvasObject,GetCanvasObjectGroup, andGetDescriptorhave been renamed toRenderTreeGroup,Renderer,GetRenderTreeElement,GetRenderTreeGroup, andGetRendererrespectively. -
The
RectangleIndicatorInstaller,OrientedRectangleIndicatorInstaller, andPointSelectionIndicatorInstallerclasses have been removed. -
The
IStripeInputVisualizationHelperinterface is now calledIStripeInputRendererand extendsIObjectRenderer, theDefaultStripeInputVisualizationHelperclass has been removed. -
The
StripeDecorator.InputVisualizationDecoratorproperty has been renamed toInputRenderer. -
The
DefaultPortCandidateDescriptorclass is now calledPortCandidateRenderer. The class no longer has theCandidateDrawingValidNonFocusedKey,CandidateDrawingValidFocusedKey,CandidateDrawingInvalidNonFocusedKey, andCandidateDrawingInvalidFocusedKeystatic properties. -
The new
PortCandidateRendererproperty on theCreateEdgeInputModeclass replaces theCandidateDescriptorandClosestCandidateDescriptorproperties. -
The new public property
PortCandidateRendereron thePortRelocationHandleclass replaces theCreatePortCandidateDescriptorandCreateCurrentPortCandidateDescriptorprotected methods. -
The new public property
PortCandidateRendereron thePortRelocationHandleProviderallows customizing the renderer for the port candidates. -
The new
ViewportRectangleRendererproperty on theOverviewInputModeclass allows customizing the renderer for the viewport rectangle. It replaces theTemplateproperty and theViewportTemplateKeystatic property. -
The new
MarqueeSelectionInputMode.MarqueeRendererproperty replaces theTemplateproperty andMarqueeRectangleTemplateKeystatic property. -
The new
LassoSelectionInputMode.LassoRendererproperty replaces theFinishRegionTemplateandFinishRegionHighlightTemplateproperties and theFinishRegionTemplateKeyandFinishRegionHighlightTemplateKeystatic properties. Also, theLassoPenKeyandLassoFillKeystatic properties have been removed. -
The new
CandidateRendererproperty on theLabelPositionHandlerclass replaces theCandidateTemplateandHighlightTemplateproperties and theCandidateTemplateKeyandHighlightTemplateKeystatic properties. -
The
GetCanvasObjectandGetCanvasObjectsmethods of classCanvasControlhave been renamed toGetRenderTreeElementand have been moved to theGraphModelManagerclass. -
The
CreateSnapResultCanvasObjectDescriptormethod of classSnapContexthas been renamed toCreateSnapResultRenderer. -
The
GraphVisualCreatorproperty of classGraphOverviewControlis now calledGraphOverviewRendererand of typeIObjectRenderer.
Selection, Focus, Highlight
Incompatible API Changes
-
The
IndicatorEdgeStyleDecorator,IndicatorLabelStyleDecorator,IndicatorNodeStyleDecorator, andIndicatorPortStyleDecoratorclasses were removed. Use theEdgeStyleIndicatorRendereretc. classes instead. -
The
GraphFocusIndicatorManager,GraphHighlightIndicatorManager, andGraphSelectionIndicatorManagerclasses were removed. Use theFocusIndicatorManageretc. classes and their default instances on theGraphControlclass instead and register instances of theEdgeStyleIndicatorRendereretc. classes to the item lookups via the graph decorator. -
The
AddSelectionandRemoveSelectionmethods on theSelectionIndicatorManagerclass were removed. Instead, modify theItemsproperty directly. -
HighlightIndicatorManagernow by default uses the newGraphControl.Highlightscollection. Adding, removing, and clearing highlights should now be done via theGraphControl.Highlightsproperty. -
The
ISelectionModelinterface has been removed and usages have been replaced byIObservableCollection. Thus, selecting an element works by callingICollection.Add, deselecting works by callingICollection.Remove, and checking the selection state is done viaICollection.Contains. -
The
ItemSelectionChangedEventArgshave been replaced by usages ofItemEventArgsand there are now two separate events for adding/selecting and removing/deselecting elements from the collections. TheItemSelectionChangedEventArgstype has been removed. -
The default implementations of
IGraphSelectionandIStripeSelectionhave been removed from the public API. -
Class
FocusIndicatorManagerno longer implementsINotifyPropertyChanged. -
Replaced event
FocusIndicatorManager.PropertyChangedwith eventFocusedItemChanged. -
Renamed Method
FocusIndicatorManager.OnPropertyChangedtoOnFocusedItemChangedand changed signature. -
FocusIndicatorManager.ShowFocusPolicychanged its default to the newWhenUsingKeyboard. The old policy calledOnlyWhenFocusedis now calledWhenFocused.
Styles
Incompatible API Changes
-
Methods
CreateVisualandUpdateVisualof classesNodeStyleBase,EdgeStyleBase,LabelStyleBase,PortStyleBaseandStripeStyleBaseare no more abstract but virtual. Added Paint method to these classes as a simpler alternative to the two methods. -
The following classes have been removed:
VoidEdgeStyleRenderer,VoidLabelStyleRenderer,VoidNodeStyleRenderer,VoidPortStyleRendererandVoidStripeStyleRenderer. Instances of these classes can be retrieved from the Renderer property of the corresponding void style implementations. -
The
IArrowinterface now requires theCropAtPortproperty to be provided by implementations. For backward compatibility return false in simple subclasses. -
The class
Arrowis now immutable and comes with separate scale factors for arrow length and width. The default arrow was renamed toArrowType.Stealth, circle arrow toArrowType.Ellipse, and simple arrow toArrowType.Open. The short arrow type was removed. -
Class
TableNodeStyleno longer implementsINotifyPropertyChanged. -
Renamed some values of
TextWrappingShapeandShapeNodeShape:-
Triangle2 is now
TrianglePointingDown. -
Hexagon2 is now
HexagonStanding.
-
Triangle2 is now
-
Removed the following values from
ShapeNodeShape:ShearedRectangle,ShearedRectangle2, Trapez, Trapez2,FatArrow, andFatArrow2.-
Use the
ArrowNodeStylefor more flexible visualizations of these geometries.
-
Use the
-
Renamed
Star5Upto Star5, removed old (down pointing) Star5.-
Use the factory methods on
GeneralPathNodeStylefor stars and polygons with an arbitrary number of points/edges and configurable rotation angle.
-
Use the factory methods on
-
Removed the following values from
TextWrappingShape:ShearedRectangle,ShearedRectangle2, Trapez, and Trapez2. -
Most item style implementations have become sealed, and their renderers have been removed from the API. Instead of
subclassing the styles or their renderers, custom style implementations should use delegation instead. For this the
new
DelegatingNodeStyleandCompositeNodeStylestyle variants may be used. - The item style constructors taking a custom renderer implementation have been removed. Instead, a custom style should be implemented that may delegate to one of the library styles.
-
The
TableNodeStyle.CopyBackgroundStylemethod has been removed. TheClonemethod doesn't deep copy the background style but just uses it for the clone as well, which also was the previous default behavior. -
The
Wrappedproperty ofCollapsibleNodeStyleDecorator,IndicatorNodeStyleDecorator,IndicatorEdgeStyleDecorator,IndicatorLabelStyleDecorator,IndicatorPortStyleDecorator,ShadowNodeStyleDecorator, andIconLabelStylehas been renamed toWrappedStyle. -
The deprecated styles
BevelNodeStyle,PanelNodeStyleandShinyPlateNodeStylehave been removed. -
The default
StringFormatinLabelStylenow usesStringTrimming.EllipsisWord. Before, it wasCharacter. It also usesStringFormatFlags.LineLimitas defaultFormatFlags. Before, no flag was set.
Interaction
Incompatible API Changes
-
CanvasControl'sLastEventLocationproperty has been removed. UseLastPointerEvent.Locationinstead. -
CanvasControl'sLastInputEventproperty has been renamed toLastPointerEventto better reflect its type. -
The
ResourceKeyandComponentResourceKeyclasses have been removed. Their usages have been replaced, often using properties of type Pen orIObjectRenderer. -
The
PortRelocationHandle.GhostVisualizationPenKeyhas been replaced by aGhostVisualizationPenproperty. -
The
SnapLine.SnapLinePenKeyhas been replaced by aSnapContext.SnapResultPenproperty. -
The
MoveLabelInputModeclass and its corresponding property onGraphEditorInputModehave been removed. Label movement is now handled directly byMoveInputMode. Most customizations related tolabelmovement (as opposed to the move gesture in general) can now be done onLabelPositionHandler, instead. -
The commands previously defined on
GraphControlandCanvasControlare now located in class \GraphCommands. The suffix \Commandhas been dropped from their names. -
KeyboardInputMode'sAddHandleroverloads have been renamed toAddRecognizerBindingandAddKeyBindingto clarify their usage. TheAddCommandmethod has been renamed toAddCommandBindingto match the new naming. -
KeyboardInputMode'sRemoveCommandandRemoveHandlermethods have been removed. Instead, the add methods now return a binding token which provides aRemovemethod to remove that binding. -
Replaced
Dummyin names with a more descriptive term. In particular:-
In
CreateEdgeInputMode,DummyEdge,DummyEdgeGraph,DummyTargetNode,,DummyTargetNodePort,UpdateDummyEdgeSourcePort,UpdateDummyEdgeTargetPort,GetDummyEdgeSnapLines, andCreateDummyBendhave been renamed toPreviewEdge,PreviewGraph,PreviewEndNode,PreviewEndNodePort,UpdatePreviewEdgeStartPort,UpdatePreviewEdgeEndPort,GetPreviewEdgeSnapLines, andCreatePreviewBend. -
The
Visualization.Dummyenum value has been renamed toVisualization.Placeholder. -
In
PortRelocationHandle,CreateDummyEdgehas been renamed toCreatePreviewEdge.
-
In
-
The
NavigationInputMode.FindNearestItemmethod now gets thestartItemas a parameter instead of the location of it, and this item is also included in theitemsToCheckparameter. Implementations may use the newGetReferenceLocationmethod to find the starting location and should make sure not to return thestartItemitself. -
The
textProviderparameter forToolTipInputMode's constructor has been removed. An event handler for theQueryToolTipevent can be registered instead. -
The return value of the
DropInputMode.AdjustEffectmethod has been changed from bool to void. This method no longer determines if the mode will handle drag or drop events but only changes the drag/drop effect of given event args as its name implies. TheDropInputMode.AcceptDragmethod now determines if the mode will handle drag and drop events. -
CreateEdgeInputMode's methods have been renamed:-
GetClosestSourceCandidatetoSelectClosestStartCandidate. -
GetClosestCandidatetoSelectClosestCandidate. -
GetClosestTargetCandidatetoSelectClosestEndCandidate.
-
-
CreateEdgeInputMode.StartPortCandidateHitRadiusnow is defined in view coordinates. -
The event
GraphEditorInputMode.LabelTextChangedhas been changed toLabelEditedto reflect the broader scope of changes allowed during label editing. Similarly,GraphEditorInputMode.OnLabelTextChangedis now namedOnLabelEdited. -
Most methods, properties, and events related to label editing have been moved from
GraphEditorInputModetoEditLabelInputMode:AutoRemoveEmptyLabels,HideLabelDuringEditing,TextEditorInputMode,TextEditorInputModeConfigurator,CreateLabel,CreateLabelCore,EditLabelCore,OpenTextEditor,LabelDeleted,LabelTextEditingStarted,LabelTextEditingCanceled, andValidateLabelText. The eventsLabelEditingandLabelAddinghave been moved toEditLabelInputModeand renamed toQueryLabelEditingandQueryLabelAdding, respectively, to clarify their purpose. -
Most methods, properties, and events related to label editing have been moved from
TableEditorInputModetoEditLabelInputMode:AutoRemoveEmptyLabels,HideLabelDuringEditing,TextEditorInputMode,TextEditorInputModeConfigurator,CreateLabel,CreateLabelCore,EditLabelCore,OpenTextEditor,LabelDeleted,LabelTextEditingStarted,LabelTextEditingCanceled, andValidateLabelText. The eventsLabelEditingandLabelAddinghave been moved toEditLabelInputModeand renamed toQueryLabelEditingandQueryLabelAdding, respectively, to clarify their purpose. -
Removed callback methods which only raised the related events from classes
CanvasControlandGraphControl, e.g.,OnZoomChanged. Use the corresponding events instead, e.g.,ZoomChanged. -
Removed the factory methods for the sub-input modes from
GraphInputMode,GraphViewerInputMode,GraphEditorInputMode,TableEditorInputMode, andTextEditorInputMode(e.g.CreateKeyboardInputMode). Set custom instances using the properties, instead. -
Removed the factory methods for the
ToolTipandTextBoxproperties on classesToolTipInputModeandTextEditorInputMode, respectively. Set custom instances using the properties, instead. -
Removed the methods
GetBounds,GetVisual,GetVisualCreator, andIsHitfromCanvasControlclass. Use the respective methods ofRenderTreeclass instead. -
The
ICommandinterface and its implementations have been replaced with the enumCommand. -
Constants of
ICommandhave been replaced with equally named constants of enumCommand. -
The methods
CanExecuteandExecuteand itsCanExecuteChangedevent inICommandhave been replaced withCanvasControl'sCanExecuteCommandandExecuteCommandmethods and theCanExecuteCommandChangedevent, respectively. -
Custom commands can no longer be created. As an alternative, register handlers on
KeyboardInputMode. -
Renamed
DoubleClickPolicytoClickReportingPolicy. -
Renamed
ClickInputMode.DoubleClickPolicytoClickReportingPolicy. -
Renamed
DoubleClickPolicy.InitialSingleAndDoubleClicktoClickReportingPolicy.Instant. -
Renamed
DoubleClickPolicy.DoubleClickOnlytoWaitForDoubleClick. -
Removed
DoubleClickPolicy.BothSingleClicksAndDoubleClick. -
Changed the default of
ClickInputMode.ClickReportingPolicytoClickReportingPolicy.Instant. -
Removed the
PreventNextDoubleClickmethod fromClickInputModeclass. Use theCancelmethod instead. -
Replaced
Mouse2DEventArgsandTouch2DEventArgswithPointerEventArgs. -
Integrated
TapInputModeintoClickInputMode. Touch input now also firesClickedevents. -
Removed all
ClickInputModeevents except forClicked. Click buttons and click count can be obtained from theClickEventArgs. -
Removed the events
ItemTapped,ItemDoubleTapped, andCanvasTappedfromGraphInputModein favor of checking thePointerTypeon the corresponding Click event. -
The
HandleIsHitTouchandGetClosestHitHandleTouchmethods ofHandleInputModehave been removed in favor of the methodsHandleIsHitandGetClosestHitHandle, which now handle all types of pointer devices. -
The
InputModeContextproperty has been removed from theIInputModeinterface. In input mode implementations, the property has been renamed toParentInputModeand changed to protected access to prevent incorrect usage. -
Renamed "Source" to "Start" and "Target" to "End" in the following members of
CreateEdgeInputModeclass:-
Renamed
ResolveSourcePortCandidatestoResolveStartPortCandidates. -
Renamed
ResolveTargetPortCandidatestoResolveEndPortCandidates. -
Renamed
SourcePortCandidateChangedtoStartPortCandidateChanged. -
Renamed
TargetPortCandidateChangedtoEndPortCandidateChanged. -
Renamed
SourcePortCandidatetoStartPortCandidate. -
Renamed
TargetPortCandidatetoEndPortCandidate. -
Renamed
SnapToTargetCandidatetoSnapToEndCandidate. -
Renamed
CancelGestureOnInvalidTargettoCancelGestureOnInvalidEnd. -
Renamed
SourceNodeDraggingFinishedRecognizertoStartPortOwnerDraggingFinishedRecognizer. -
Renamed
SourceNodeDraggingCursortoStartPortOwnerDraggingCursor. -
Renamed
ShowSourcePortCandidatesHitTestabletoShowStartPortCandidatesHitTestable. -
Renamed
OnSourcePortCandidateChangedtoOnStartPortCandidateChanged. -
Renamed
OnTargetPortCandidateChangedtoOnEndPortCandidateChanged. -
Renamed
SourcePortCandidateChangedtoStartPortCandidateChanged. -
Renamed
TargetPortCandidateChangedtoEndPortCandidateChanged. -
Renamed
GetSourcetoGetStartPortOwner. -
Renamed
GetTargettoGetEndPortOwner. -
Renamed
GetSourcePortCandidateProvidertoGetStartPortCandidateProvider. -
Renamed
GetTargetPortCandidateProvidertoGetEndPortCandidateProvider. -
Renamed
GetSourcePortCandidatestoGetStartPortCandidates. -
Renamed
GetTargetPortCandidatestoGetEndPortCandidates. -
Renamed
GetSourcePortCandidate(PointD)toGetStartPortCandidate. -
Renamed
GetSourcePortCandidate(IEnumerable<,IPortCandidate>PointD, bool) toSelectStartPortCandidate. -
Renamed
GetClosestCandidatetoSelectClosestCandidate. -
Renamed
GetClosestSourceCandidatetoSelectClosestStartCandidate. -
Renamed
GetClosestTargetCandidatetoSelectClosestEndCandidate. -
Renamed
SourcePortCandidateHitRadiustoStartPortCandidateHitRadius. -
Renamed
UpdateTargetLocationtoUpdateEndLocation. -
Renamed
ShowTargetHighlighttoShowEndHighlight. -
Renamed
UpdateTargetHighlighttoUpdateEndHighlight. -
Renamed
DummyTargetNodetoPreviewEndNode. -
Renamed
DummyTargetNodePorttoPreviewEndNodePort.
-
Renamed
-
Renamed
ShowPortCandidates.SourcetoStartandShowPortCandidates.TargettoEnd. -
Removed
CreateEdgeInputMode.CreateDummyEdgeGraph,CreateEdgeInputMode.CreateDummyEdge,CreateEdgeInputMode.CreateDummyTargetNode,CreateEdgeInputMode.CreateDummyTargetNodePort,CreateEdgeInputMode.DummySourceNodePort,CreateEdgeInputMode.UpdateDummyEdgeSourcePort, andCreateEdgeInputMode.UpdateDummyEdgeTargetPort. -
Events which involve item changes triggered by input modes are now of type
InputModeItemEventArgsinstead ofItemEventArgs. These are the events:-
CreateBendInputMode:BendCreated. -
CreateEdgeInputMode:StartPortCandidateChanged,EndPortCandidateChanged,EdgeCreated,PortAdded,EdgeCreationStarted. -
GraphEditorInputMode:LabelEdited,LabelAdded,NodeCreated,PortAdded. -
ItemDropInputModeand inheritors:ItemCreated. -
NavigationInputMode:GroupCollapsing,GroupCollapsed,GroupExpanding,GroupExpanded,GroupEntering,GroupEntered,GroupExiting,GroupExited. -
TableEditorInputMode:DeletedItem. -
EditLabelInputMode:LabelAdded,LabelEditingStarted,LabelEditingCanceled,LabelEdited. -
StripeDropInputMode:StripeCreated.
-
-
Events which involve item deletion or structural changes triggered by input modes are now of type
InputModeItemChangedEventArgs:-
GraphEditorInputMode.DeletedItem:InputModeItemChangedEventArgsinstead ofItemDeletedEventArgs. -
GraphEditorInputMode.EdgePortsChanged:InputModeItemChangedEventArgsinstead ofEdgeEventArgs. -
GraphEditorInputMode.NodeReparented:InputModeItemChangedEventArgsinstead ofNodeEventArgs. -
EditLabelInputMode.LabelDeleted:InputModeItemChangedEventArgsinstead ofLabelEventArgs.
-
-
Removed the
PortRelocationHandle.CreateDummyEdgeVisualCreatormethod. To change the preview edge's style overwritePortRelocationHandle.CreatePreviewEdgeinstead. -
Renamed
GraphInputMode.ShouldSelectItemtoShouldSelect. -
The event
DeletedSelectionofGraphEditorInputModenow usesItemsEventArgsinstead ofSelectionEventArgs. -
The static fields
AllNodeCandidatesandAllNodeAndEdgeCandidatesonEdgeReconnectionPortCandidateProvidershave been replaced by the factory methodsFromAllNodeCandidatesandFromAllNodeAndEdgeCandidates. The implementations now provide a port candidate for the unchanged port of the edge when collecting the port candidates from theIPortCandidateProviderinstances of the nodes and edges. -
The generic type of the
IHitTesterinterface has been removed. Instead, a parameter of typeGraphItemTypeshas been added to itsEnumerateHitsmethod. -
The
HandleTypesenums has been refactored to a non-flaggableHandleTypeenum, and the values have been adjusted. -
A
Tagproperty has been added to theIHandleinterface. yFiles does not use the property and initializes it withnull, but decorating handles forward any values unmodified. -
The protected virtual
CreateEdgeCreationInputModeContextmethod on theCreateEdgeInputModeclass has been removed. Use or override theCreateInputModeContextmethod, instead. -
The protected
Should-methods of the input modes have been removed and replaced by predicate properties. -
The
LassoSelectionEventArgs.SelectionPathproperty has been renamed to Path. -
The core
MarqueeSelectandLassoSelectmethods ofGraphEditorInputModeandGraphViewerInputMode, that take an enumerable and predicate, have been removed while the otherMarqueeSelectandLassoSelectmethod got an additional parameter of typeSelectionPolicy. -
The
LabelPositionHandler.SetPositionmethod has been removed. -
The
LabelPositionHandler.UseFinderproperty has been removed. Use the newUseParameterFinderRecognizerproperty instead. -
The
LabelPositionHandler.UseParameterFindermethod has been renamed toShouldUseParameterFinder. -
The
ToolTipQueryEventArgsclass is now namedQueryToolTipEventArgsto properly match the corresponding event's name. -
The
LabelPositionHandler.UseFinderproperty has been removed. -
Method
GetBendsInPathhas been added to theIBendSelectionTesterinterface and is used to check for bends that should be lasso selected. -
Method
GetPortsInPathhas been added to theIPortSelectionTesterinterface and is used to check for ports that should be lasso selected. -
DiscardInvalidItemsinItemHoverInputModehas been renamed toIgnoreInvalidItems, and its behavior was reversed. -
The
DoStartEdgeCreationmethod on theCreateEdgeInputModeclass is now calledStartEdgeCreation. -
The
DoStartDragmethod on theMoveInputModeclass is now calledStartDrag. -
The
BeginDraggingmethod on theHandleInputModeclass is now calledStartDrag. -
The
AddLabelmethod onGraphEditorInputModeis now calledStartLabelAddition. -
The
EditLabelmethod onGraphEditorInputModeis now calledStartLabelEditing. -
The
MouseHoverInputModeclass has been renamed toToolTipInputMode. -
The
GraphInputMode.MouseHoverInputModeproperty has been renamed toToolTipInputMode.
Incompatible Behavior Changes
-
The default lookup of labels now returns an
IPositionHandlerimplementation. -
The
LabelDropInputMode.IsValidLabelOwnermethod now only accepts instances ofFreeLabelModelor that thedraggedLabel's owner type matches the owner type e.g.INode,IEdge, orIPort. -
The
DropInputMode.AdjustEffectmethod no longer determines if the mode will handle drag or drop events but only change the drag/drop effect of given event args as its name implies. TheDropInputMode.AcceptDragmethod now determines if the mode will handle drag and drop events. - Unselected items can be moved by default.
- Edge creation: by default, start port candidates are shown when hovering over a node.
-
GraphViewerInputMode/GraphEditorInputMode: theClickHitTestOrderdefault value has been changed toGraphItemTypes.Allwhich means that the default order is the Z-Order but with a prioritization for elements behind labels. -
GraphViewerInputMode: TheMoveViewportInputMode's priority has been changed to 190. -
GraphEditorInputMode: The sub input mode's priorities have been changed to the following order:WaitInputMode,KeyboardInputMode,HandleInputMode,ClickInputMode,CreateEdgeInputMode,MoveSelectedItemsInputMode,MoveUnselectedItemsInputMode,CreateBendInputMode,MoveViewportInputMode,LassoSelectionInputMode,MarqueeSelectionInputMode,ItemHoverInputMode,NavigationInputMode,ContextMenuInputMode,NodeDropInputMode,LabelDropInputMode,PortDropInputMode,ToolTipInputMode,EditLabelInputMode. -
In
CreateEdgeInputModeit was previously possible to define a fallback forGetPortOwnerifIHitTesterwas removed. This option for defining a fallback is removed and always returnsnull. -
Improved the
CreateBendInputModebehavior: Previously, dragging an existing bend triggered theBendCreatedevent, causing confusion and limiting event handling for new bend creation. This has been adjusted to ensure the event only fires when a new bend is created interactively. -
Refined the event sequence of
CreateEdgeInputModeto ensure consistency and symmetry between gesture cancellation and completion. -
Reorganized the sequence to include
EdgeCreationStartedonly after the start node dragging has finished and the end port candidate is determined. -
Adjusted the timing of the end port candidate update, which now occurs just before
GestureFinishing, allowing users to apply final updates to the end port. -
Ensured the following event order for gestures:
-
GestureStarting,GestureStarted. -
Cancellation path:
GestureCanceling,GestureCanceled. -
Completion path:
EdgeCreationStarted,GestureFinishing,EdgeCreated,GestureFinished.
-
-
The
EdgeCreationStartedandEdgeCreatedevents provide now arguments of typeItemEventArgs<.IEdge> -
NavigationInputModenow interprets the direction of arrow keys in view coordinates by default. -
Edges can now be reconnected to other nodes per default. The old behavior can be restored by decorating the edge
lookup with the provider returned by
EdgeReconnectionPortCandidateProviders.FromSourceAndTarget. -
The default value of
EnableSnappingRecognizerinCreateEdgeInputMode,HandleInputMode, andMoveInputModehas been changed fromCtrlUptoAltUp. -
The default value of
DisableSnappingRecognizerinCreateEdgeInputMode,HandleInputMode, andMoveInputModehas been changed fromCtrlDowntoAltDown. -
The default value of
CenterReshapeRecognizerinNodeReshapeHandleProviderandReshapeHandlerHandlehas been changed fromAltIsDowntoCtrlIsDown. -
The default value of
ReparentNodeHandler.ReparentRecognizerhas been changed fromShiftIsDowntoCtrlIsDown. -
The
GraphInputMode.FindItemsmethod now considers the actual z-order of the hit items. -
Orthogonal edge editing now has to be enabled for each edge that should be edited orthogonally instead of enabling
it for all edges by setting the
GraphEditorInputMode.OrthogonalEdgeEditingContextproperty. This can be done by enabling thePolylineEdgeStyle.OrthogonalEditingproperties of the styles, by setting an apropriateFallbackEdgeHelperProvideron the usedOrthogonalEdgeEditingContextor by providing anIOrthogonalEdgeHelperin the edges' lookup. -
The
MultiSelectionRecognizerofGraphEditorInputModeandGraphViewerInputModeare not used anymore for marquee and lasso selection. Instead,MarqueeSelectionInputModeandLassoSelectionInputModehave their own modifiers for different selection policies. -
Changed the default of
TextEditorInputMode.TextBoxPlacementPolicytoTextBoxPlacementPolicy.MoveTextBox. -
CanvasControl.UpdateContentBoundsnow only considers the items in theRenderTree.ContentGroupinstead of theRootGroupwhen calculating the new bounds. -
The default value of
CreateEdgeInputMode.PortCandidateResolutionRecognizerhas been changed fromShiftIsDowntoCtrlIsDown. -
The default value of the
CreateEdgeInputMode.EnforceBendCreationRecognizerhas been changed formCtrlIsDowntoAltIsDown. -
The default edge lookup doesn't provide an
IPositionHandleranymore so dragging a selected edge doesn't move all its bends. -
GraphEditorInputMode'sMoveUnselectedItemsInputModenow only moves unselected items. Previously it also moved selected items despite its name. -
The default value of
TextEditorInputMode.AutoCommitOnFocusLostis nowtrue. This means that the text of an edited label is commited instead of discarded when the text box loses the focus e.g. by clicking on the canvas. - During edge creation, bends are now created when pressing a mouse button instead of releasing it. This way, when starting edge creation by dragging the mouse from a node, no bend is created on the first mouse button release, which was an often unwanted behavior.
-
The default values of the
NodeReshapeHandleProvider.RatioReshapeRecognizerproperty andReshapeHandlerHandlehas been changed tonull. If no custom recognizer is set,ReshapeHandlerHandleuses the newHandleInputMode.IsDirectionalConstrainedmethod instead if aHandleInputModeis found in theIInputModeContext. -
GraphEditorInputMode.AllowGroupingOperationsis now true by default.
Snapping
Incompatible API Changes
-
LabelSnapContexthas been removed, and label snapping is now handled byGraphSnapContext:-
The
GraphEditorInputMode.LabelSnapContextproperty and theGraphEditorInputMode.OnLabelSnapContextChangedmethod have been removed. -
The
CollectLabelSnapLineEventArgsclass has been removed. -
Configuration properties of
LabelSnapContexthave been moved toGraphSnapContextand renamed. -
The
ILabelSnapContextHelperinterface and theLabelSnapContextHelperclass have been removed. Instead, theILabelSnapResultProviderinterface and the classesLabelSnapResultProviderandLabelSnapReferenceProviderhave been added. -
The
LabelDecorator.LabelSnapContextHelperDecoratorproperty has been replaced by the propertiesSnapReferenceProviderandSnapResultProvider.
-
The
-
CollectGraphSnapLinesEventArgshas been renamed toCollectSnapReferencesEventArgs. Its methodsAddFixedNodeSnapLine,AddFixedSegmentSnapLine,AddPortSnapLine, andAddAdditionalSnapLinehave been removed and replaced by the singleAddSnapReferencemethod. -
GraphSnapContexthas been refactored, and the following members have changed:-
The properties
SnapNodesToSnapLines,SnapBendsToSnapLines,SnapSegmentsToSnapLines,SnapBendAdjacentSegments,SnapPortAdjacentSegments,SnapEdgeLabels,SnapNodeLabels, andSnapPortLabelshave been replaced by the new propertiesSnappableItemsandGridSnappableItems. -
The
CollectVisibleNodePairsmethod now takes theCollectSnapReferencesEventArgsthe snap references shall be added to. -
The methods
FindSameWidthEntriesandFindSameHeightEntrieshave been removed. Instead, theSnapSizereferences describing to which size items can snap are provided by theSnapReferencesproperty. Similarly, theFixedNodeSnapLines,FixedSegmentSnapLines,FixedPortSnapLines, andAdditionalSnapLinesproperties have been removed. TheSnapReferencesproperty should be used instead.
-
The properties
-
The
SnapLine.ResourceKeyproperty has been removed along with most of the staticResourceKeymembers used for snapping. Instead, aVisualizationTypeproperty of the enum typeSnapReferenceVisualizationTypeis used to describe which visualization should be used for theSnapLine. -
Most subclasses of
SnapLinehave been removed as they only provided properties used for the visualization that are now available onSnapResult. -
The
SnapTypesenum used bySnapResulthas been replaced by the newSnapConstraintclass that supports finding common snap locations forSnapResultswith different constraints. -
The
SnapandIsSnappedmethods ofSnapResulthave been removed. Instead, aConstraintproperty of typeSnapConstrainthas been added that is used to merge possibleSnapResultsand check if a location is valid for a givenSnapResult. -
The
SnapResult.GetVisualCreatormethod has been removed and is replaced by the newObjectRendererproperty. -
The factory methods of
SnapResultshave been adjusted:-
CreatePointSnapResulthas been renamed toCreateSnapResult. -
CreateSnapLineSnapResulthas been renamed toCreateLineSnapResult. -
CreateLabelSnapResulthas been removed.
-
-
The methods of the snap result providers have been adjusted to support the new
SnapReferenceAPI. Most methods now take one instance of aSnapReferencesubclass likeSnapLineorSnapGrid. -
The classes
SnapState,ArrowContainer, andArrowControlhave been removed. -
The type of the
SnapContextproperties of all input modes has been changed fromSnapContexttoGraphSnapContext. -
Most classes and members that had
SnapLinein their name have been renamed to includeSnapReferenceinstead. -
The
ReshapeRectangleContext.InitialBoundsproperty has been renamed toInitialLayout. -
The
GraphEditorInputMode.SnapContextproperty is now set per default and may not benull. It is disabled per default. -
Renamed the
GraphSnapContext.NodeToNodeDistanceproperty toNodeDistance. -
Renamed the
GraphSnapContext.EdgeToEdgeDistanceproperty toEdgeDistance.
Clipboard
Incompatible API Changes
-
IClipboardHelper's methodsCut,Copy, andPastehave been renamed toOnCut,OnCopied, andOnPasted. -
IClipboardHelper's methodsCutandCopydon't return anobjectanymore and theobjectparameter ofPasteandShouldPastehas been removed. ForCut/CopyandPastethe sameIClipboardHelpermethod is now used so any state that should be transfered can be stored in a custom implementation. -
IClipboardHelperhas new methodsShouldDuplicateandOnDuplicatedwhich have to be implemented, now. -
GraphClipboard`s methodsGetMementoandGetClipboardHelperhave been removed. -
GraphClipboard's protectedCopyandPastemethods now take the newClipboardOperationContextas parameter instead of thesourceGraphsandfilterpredicates. -
The methods
CreateClipboardGraph,CreateToClipboardCopier,CreateFromClipboardCopier,CreateDuplicateCopier, andCreateDefaultClipboardIdProviderfromGraphClipboardthat were used to lazily initialize the corresponding properties have been removed. -
GraphClipboard.Pastenow takes an enumerable ofIModelItemastargetOwnersparameter instead of atargetFilterpredicate. -
GraphClipboard.IsFoldingStateElementis now an instance method and doesn't have an owner parameter anymore. -
ElementCopiedCallbackhas been renamed toItemCopiedCallback. -
GraphViewerInputMode'sElementsCopiedevent has been renamed toItemsCopied. -
GraphEditorInputMode'sElementsCopied,ElementsCut,ElementsCopied,ElementsPastedandElementsDuplicatedevents were renamed toItemsCopied, etc. -
On
GraphClipboard, theElementsCut,-Cutting,-Copying,-Copied,-Pasting,-Pasted,-Duplicating, and-Duplicatedevents were renamed toItemsinstead ofElementsand use the newGraphClipboardEventArgs. Also, theOnElementCut,-Copied-, and-Pastedmethods were renamed to start withOnItemand take an additionalClipboardOperationContextas a parameter. -
GraphClipboard.RemoveElementshas been renamed toRemoveItems. -
GraphClipboard.IsFoldingStateElementhas been renamed toIsFoldingStateItem. -
GraphClipboard.CreateContextnow takes an additionalIInputModeContextparameter that should be returned in the new contexts lookup. -
The
GraphClipboard.ClipboardGraphproperty is now read-only. -
The parameters of
GraphClipboard'sCopymethod have been rearranged so default values for optional parameters could be added. -
For consistency reasons, the property
GraphClipboard.Emptyis now calledIsEmpty. -
GraphControlinstances now use a sharedGraphClipboardper default. To revert to the previous behavior, a newGraphClipboardinstance can be set on eachGraphControl. -
GraphClipboard'sCut,Copy,Paste, andDuplicatemethods now use anIEnumerableinstead of a filter predicate to determine the subgraph to copy. -
GraphClipboard'sCreate*Filtermethods have been removed. -
The
GraphClipboardnow usesClipboardGraphCopierinstances for itsToClipboardCopier,FromClipboardCopier, andDuplicateCopier. -
The
Graph.ParentNodeDetectionModeshas been reduced to contain only the mainly used options. The optionRoothas been renamed toNone, and the optionsAllowSelfandForceas well as theModeMaskandModifierMaskhave been removed. TheGetTargetNodemethod can be overridden if the reduced modes are not suitable and may call the newFindParentByPreviousParentmethod to simulate the oldForcesetting. -
GraphClipboard`sGetTargetmethods now take an additionalClipboardOperationContextparameter, and theGetTargetoverload for nodes also takes apasteLocationas an additional parameter. -
The
GraphClipboard.PasteDeltaproperty has been renamed toPasteOffset. It is now modified by theGraphClipboard'sCut,Copy,Paste, andDuplicatemethods instead of the corresponding methods onGraphEditorInputMode. -
The
GraphEditorInputMode.PasteDeltaproperty has been removed and replaced by the newGraphClipboard.PasteOffsetIncrementproperty. -
The values
LabelModelParameterandPortLocationModelParameterhave been removed from theCloneTypesenum as those parameter are typically immutable, so cloning them has no effect.
Folding
Incompatible API Changes
-
Interface
IFolderNodeConverterhas a newUpdateGroupNodeStatemethod. -
Interface
IFoldingEdgeConverterhas a newUpdateMasterEdgesmethod. -
FolderNodeConverternow relies onFolderNodeDefaultsto configure initialization and update of states. -
FoldingEdgeConverterandMergingFoldingEdgeConverternow rely onFoldingEdgeDefaultsto configure initialization and update of states. -
The
FoldingLabelOwnerState.Removemethod(. -
FoldingLabelState) was renamed toRemoveLabeland theFoldingLabelState.RemoveBendmethod(FoldingBendState) was renamed toRemoveBend.
Incompatible Behavior Changes
-
Tags are not automatically the same on group and folder nodes or master and folding edges (master and view states).
Instead, they have to be synchronized using the
IFolderNodeConverterandIFoldingEdgeConverterimplementations. The default implementations already synchronize the tags. -
In the graph of a folding view, the
CreateGroupmethod now always creates a group even if theisExpandedpredicate specified in theFoldingManager.CreateFoldingViewmethod specifies otherwise. Create the group on the master graph if you want the predicate to be respected.
Lookup
Incompatible API Changes
-
Renamed
LookupDecorator.SetImplementationtoAddConstant. -
Renamed
LookupDecorator.SetFactorytoAddFactory. -
Renamed
LookupDecorator.SetImplementationWrappertoAddWrapperFactory. -
Renamed
LookupDecorator.HideImplementationto Hide. -
Renamed lookup decorators in general by removing the
Decoratorsuffix. For example,graphDecorator.EdgeDecorator.PositionHandlerDecorator.HideImplementationis nowgraphDecorator.Edges.PositionHandler.Hide. -
Removed
LookupDecorator.NullIsFallback. Instead, use the predicate of theAddFactorymethod or return the original instance in theAddWrapperFactorymethod. -
Removed
LookupDecorator.DecorateNulls. Instead, implement the desired behavior inAddWrapperFactory. -
Removed the
SimpleNode.LookupImplementationproperty,SimpleEdge,SimpleBend,SimpleLabelandSimplePort. Instead, use the newGetDecoratormethod to adjust the item's lookup. -
The
SimpleNode,SimpleEdge,SimpleBend,SimpleLabelandSimplePortclasses are now sealed, and theirLookupmethod is no longer virtual. To adjust the item's lookup, use theGetDecoratormethod. -
Removed
CanvasControl.InputModeContextLookupandCanvasControl.InputModeContextLookupChain. Instead, use the newGetInputModeContextDecoratorFormethod to decorate the input mode context lookup. -
The
EdgeDecorator.GetDecoratorFormethod,NodeDecorator, etc. no longer has thenullIsFallbackanddecorateNullparameters. -
The
nodeparameter of the methods in the interfacesIGroupPaddingProvider,INodeSizeConstraintProvider, andIGroupBoundsCalculatorhas been removed. -
The
edgeparameter of the methods in the interfacesIEdgePortHandleProvider,IBendCreator, andIOrthogonalEdgeHelperhas been removed. -
The
labelparameter of the methods in the interfacesILabelModelParameterProvider, andILabelModelParameterFinderhas been removed. -
The model item parameter in
ISnapReferenceProvider.AddSnapReferenceshas been removed. -
The
ILabelModelParameterparameter ofILabelModel.GetContexthas been removed andILabelModeldoesn't extendILookupanymore. Instead, the lookup returned byGetContextshould be used for all lookup calls. -
The
IPortLocationModelParameterparameter ofIPortLocationModel.GetContexthas been removed andIPortLocationModeldoesn't extendILookupanymore. Instead, the lookup returned byGetContextshould be used for all lookup calls. -
The
OrthogonalEdgeEditingContext.GetOrthogonalEdgeHelpermethod has been replaced by theFallbackEdgeHelperProviderandOrthogonalEdgeHelperProviderproperties. -
The
INodeInsetsProviderinterface was renamed toIGroupPaddingProvider. -
The methods
SetLookupImplementationandGetLookuphave been removed fromDefaultGraph. Instead theLookupmethod should be overridden if the default lookup behavior should be replaced. -
The methods
SetLookupandGetLookuphave been removed fromGraphWrapperBase. Instead, theLookupmethod should be overridden if the default lookup behavior should be replaced.
GraphML
Incompatible API Changes
-
The methods
GraphMLIOHandler.AddInputMapperFutureandGraphMLIOHandler.AddInputHandlerFactoryhave been removed, together with their support classes. -
The
AddRegistryInputMapperandAddRegistryOutputMappermethods have been removed fromGraphMLIOHandler, since theMapperRegistryhas been removed. To read or write additional per-item data, use theAddInputMapperorAddOutputMappermethods, instead.
View-Layout-Bridge
Incompatible API Changes
-
The properties
LayoutExecutor.SelectionModelandLayoutGraphAdapter.SelectionModelhave been removed, meaning that selected items of theIGraphare no longer automatically marked in theLayoutGraphvia keys like the formerLayoutKeys.AffectedNodesDpKey. If the selected items should be marked for a specific key of layout algorithms, then these items can always be provided via the specificLayoutDataproperty of the layout algorithms. -
Removed the
ContextItemMappingclass. -
Renamed the
LayoutExtensions.MorphLayoutmethod toApplyLayoutAnimated. -
Renamed the
LayoutExecutor.Durationproperty toAnimationDuration. -
Renamed the
LayoutExecutor.CreateMorphAnimationmethod toCreateLayoutAnimation. -
The
LayoutGraphAdapter.PortDummyNodeDpKeyconstant has been renamed toPortHelperNodeDataKey. -
Renamed
ItemMapping.DelegatetoMapperFunction. -
Renamed
ItemCollection.DelegatetoPredicate. -
Removed key
LayoutGraphAdapter.OriginalTagDpKey. Use the Tag property of the layout items instead to get the original tag associated to the originalIGraphitems. -
Renamed the
LayoutExecutor.Durationproperty toAnimationDuration. -
Replaced
LayoutExecutor.LabelPreferredPlacementPolicywithItemMappingLayoutExecutor.LabelPlacementPolicies. -
Renamed Enum
LabelPreferredPlacementPolicytoLabelPlacementPolicy. -
Removed value
FromDescriptor.PreferredPlacementDescriptors are now automatically considered when specified throughLayoutDatas.-
Renamed value
FromModeltoPreferModel. -
Renamed value
FromParametertoPreferParameter. -
Added value
KeepParameter, which suppresses the write-back of label positions to the view graph.
-
Renamed value
-
Replaced
LayoutGraphAdapter.LabelPreferredPlacementPolicywithItemMappingLayoutGraphAdapter.LabelPlacementPolicies. -
Changed property
PortAdjustmentPolicyofLayoutExecutorclass to anItemMappingPortAdjustmentPolicieswhich allows for different values for each port. The default isPortAdjustmentPolicy.Lengthen. -
Changed property
PortAdjustmentPolicyofLayoutGraphAdapterclass to anItemMappingPortAdjustmentPolicieswhich allows for different values for each port. The default isPortAdjustmentPolicy.Lengthen. -
LayoutExecutor.AutomaticEdgeGroupinghas been removed. Edges at the same port are now always automatically port grouped unless port groups have been defined explicitly. -
LayoutGraphAdapter.AutomaticEdgeGroupinghas been removed. Edges at the same port are now always automatically port grouped unless port groups have been defined explicitly. -
The
TableLayoutConfigurator.PrepareandLayoutExecutor.PrepareTableLayoutmethods now return aPartitionGridDatainstance. -
Boolean
LayoutExecutor.FixPortsproperty is replaced by anItemMappingPortPlacementPolicies, that allows to specify a policy for the handling of each individual port.
Incompatible Behavior Changes
-
The
LayoutGraphAdapterclass does no longer offer a method to create a layout graph several times but is now meant to create exactly one layout graph copy which can be accessed via theLayoutGraphproperty and initialized with methodLayoutGraphAdapter.Initialize. After initialization, changing properties of theLayoutGraphAdapterhas no effect anymore. - Edges at the same port are now always automatically port grouped unless port groups have been defined explicitly.
Layout
Incompatible API Changes
-
Replaced usages of the
IComparerinterface withComparisonfunction delegates. -
Removed the
IDataProviderinterface and refactored the whole way data is registered with aLayoutGraphinstance. The replacement ofIDataProvideris the genericIMapperinterface. It allows setting and getting data via an indexer.-
Removed the methods
Graph.AddDataProviderandRemoveDataProvider. Data is now registered and removed using the methods on the newLayoutGraphContextclass (e.g.AddItemData,AddData,Remove). -
Removed the
Graph.DataProviderKeysproperty.
-
Removed the methods
-
Removed the class
Maps. -
The nested
Segmentclass ofBorderLineis now the unnestedBorderLineSegmentclass, and some of its members have been changed:-
Renamed
GrowtoEnlarge,AddOffsettoAddPositionOffset,MintoMinPositionandMaxtoMaxPosition. -
Removed the
BorderLine.AdoptValuesmethod. -
Converted
BorderLine.FirstSegment,BorderLine.LastSegment,BorderLine.Segment.PrevandBorderLine.Segment.Nextfrom methods to read-only properties, and renamedPrevto Previous. -
Removed
BorderLine.PrevandBorderLine.Next. Use methodsBorderLineSegment.PreviousandBorderLineSegment.Nextinstead.
-
Renamed
-
The
MultiStageLayoutclass has been removed from the API. TheHierarchicalLayout(formerlyHierarchicLayout),OrganicLayout,OrthogonalLayout,TreeLayout,RadialTreeLayout(formerlyBalloonLayout),SeriesParallelLayout,RadialLayout,CompactDiskLayout, andRadialGroupLayout(formerlyCactusGroupLayout) classes now directly implementILayoutAlgorithm. These classes offer a newLayoutStagesproperty that allows to access the mutable stack ofILayoutStageinstances associated with the respective algorithm. In addition, the offer different new properties to directly access frequently used stages. -
The read/write properties
MinimumSizeGroupBoundsCalculator.MinimumNodeSizeDpKeyandInsetsGroupBoundsCalculator.GroupNodeInsetsDpKeyhave been removed. The bounds calculator classes now always use the values defined via the keysLayoutKeys.MinimumGroupNodeSizeDataKeyandLayoutKeys.GroupNodePaddingDataKey. Using theIGraphAPI, the insets and minimum sizes are registered automatically, so that this change has no effect. -
The read/write properties
SubgraphLayout.AffectedNodesDpKeyandSubgraphLayout.AffectedEdgesDpKeyhave been removed. They were replaced by static read-only keysSubgraphLayoutStage.SubgraphNodesDataKeyandSubgraphLayoutStage.SubgraphEdgesDataKey. -
PortConstraints andPortCandidates have been unified and renamed toLayoutPortCandidate. -
PortDirectionsandPortSidehave been unified asPortSides, and the enum values of the sides have been renamed. -
PortCandidateSets have been replaced byNodePortCandidates, and collections ofPortCandidates for edges have been replaced byEdgePortCandidates. -
The port-related settings in the
LayoutDataclasses have been combined into a sub-LayoutDataPorts. -
The keys in
PortConstraintKeyshave been moved toLayoutKeys. -
The
SequentialLayout.Layoutsproperty is now a read-onlyList. The<ILayoutAlgorithm>AppendLayout,AppendLayouts, andRemoveAllmethods have been removed as their functionality is now handled by the list methods. -
Replaced properties
XOffsetandYOffsetof thePortCandidateclass by a single propertyOffsetof typePointD. -
Renamed
Graph.ReInsertNodeandReInsertEdgetoLayoutGraph.Reinsert. -
From
LayoutGraphHider, theFireGraphEventsandGraphproperties, and theHideEdges,HideSelfLoops,SimplifyGraph, andHideMultipleEdgesmethods have been removed. Also, all methods to hide and unhide various collections of nodes or edges have been replaced byHideandUnhidemethods that get anIEnumerableofNodeorEdge. -
The classes
SelfLoopRouterandParallelEdgeRouterhave been moved from theyWorks.Layoutnamespace to theyWorks.Layout.Routernamespace. -
Removed the
NodeHaloclass. Halos are now specified asInsetsDand called node margins. in the correspondingLayoutData(e.g.HierarchicalLayoutData.NodeMargins).-
The properties previously named
NodeHaloshave been renamed toNodeMarginsfor the following classes:AlignmentStageData,CircularLayoutData,CompactDiskLayoutData,ComponentLayoutData,RadialGroupLayoutData,RecursiveGroupLayoutData,HierarchicalLayoutData(formerlyHierarchicLayoutData),GenericLabelingData(formerlyLabelingData),OrganicLayoutData,OrthogonalLayoutData,ClearAreaLayoutData,FillAreaLayoutData,PartialLayoutData,RadialLayoutData,CurveRoutingStageData,TabularLayoutData,EdgeRouterData,RadialTreeLayoutData(formerlyBalloonLayoutData),TreeLayoutData. -
Renamed
AsIsLayerer.NodeHalotoFromSketchLayerAssigner.NodeMargin. -
Renamed
TemporaryGroupDescriptor.Haloto Margins. -
Renamed
NodeHalo.NodeHaloDpKeytoLayoutKeys.NodeMarginDataKey.
-
The properties previously named
-
Renamed
LayoutExecutor.TargetBoundsInsetstoTargetBoundsPadding. -
Renamed
GroupingKeys.GroupNodeInsetsDpKeytoGroupNodePaddingDataKeyand moved the key toLayoutKeys. -
Renamed
GroupingKeys.MinimumNodeSizeDpKeytoLayoutKeys.MinimumGroupNodeSizeDataKey. -
Renamed
InsetsGroupBoundsCalculator.DefaultInsetstoGroupBoundsCalculator.DefaultPaddingandInsetsGroupBoundsCalculator.ConsiderNodeHalostoGroupBoundsCalculator.ConsiderNodeMargins. -
Renamed
TemporaryGroupDescriptor.Insetsto Padding. -
The
FamilyTreeLayoutclass has been removed. -
Removed the
LayoutGraphUtilitiesclass. The newEdge.ResetPathmethod replacesLayoutGraphUtilities.ResetPathmethod. The newParallelEdgeRouter.RouteEdgesParallelmethod replacesLayoutGraphUtilities.RouteEdgesParallelmethod. -
Methods
LayoutGraphUtilities.GetBoundingBoxwere combined to one more general, moved toLayoutGraphclass and made an instance method. -
Renamed
AbortHandlertoLayoutAbortController. -
The
MaximumDurationproperty is renamed toStopDurationin all public API usages. -
StopDurationsthat were of type long are now of typeTimeSpan. -
StopDurationsnow affect pre-and post-processing steps defined directly on the layout algorithms, as opposed to only the core algorithm. -
The
LayoutAbortController(formerlyAbortHandler) is no longer available as a property onLayoutDataclasses but only on theLayoutExecutor. -
Static methods on
LayoutAbortController(formerlyAbortHandler) likeGetFromGraphhave been removed since the handler instance can easily be accessed via theLayoutGraphContextwhen working withLayoutGraph. -
The default values of properties
LayoutAbortController.StopDurationandLayoutAbortController.CancelDurationhas been changed fromTimeSpan.ZerotoTimeSpan.MaxValue. Previously,Zerowas interpreted as unlimited time, which is not the case anymore. -
The default value of the algorithm properties
RankAssignment.MaximumDurationandNodeAggregation.MaximumDuration(now calledStopDuration) has been changed fromTimeSpan.ZerotoTimeSpan.MaxValue. Zero is no longer interpreted as an unrestricted running time but is the shortest possible time. -
Renamed
BorderLine.CreateMintoCreateMinimum. -
Renamed
BorderLine.CreateMaxtoCreateMaximum. -
Removed the
YPointPathclass. Instead of this class an array or more generally anIEnumerableof typePointD[] is now used in API members.-
Changed value to of
HierarchicLayout.AlternativeEdgePathDpKey,ClearAreaLayout.ExpandedNodeOriginalEdgePathDpKeyandGivenCoordinatesStage.EdgePathDpKeytoIEnumerable<.PointD> -
Changed
BusDescriptorpropertiesBusPointsandComputedBusPointsto typePointD[].
-
Changed value to of
-
Updated the constructor of
DpKeyBaseand subclasses to accept a single string parameter 'ID' for unique identification.-
Removed properties
DpKeyBase.DeclaringTypeandDpKeyBase.Name. -
Made
DpKeyBaseclass abstract.
-
Removed properties
-
Renamed
GraphLayoutLineWrappertoLineWrappingStage. -
Renamed
HideGroupsStagetoGroupHidingStage. -
Renamed
TemporaryGroupNodeInsertionStagetoTemporaryGroupInsertionStageand the respective data class fromTemporaryGroupNodeInsertionDatatoTemporaryGroupInsertionData. -
Renamed
BorderLineSideto Side, moved to namespace Layout and renamed its values:NorthtoSide.Top,EasttoSide.Right,SouthtoSide.Bottom, andWesttoSide.Left. -
Moved
BorderLineandBorderLineSegmentto namespace Layout. -
The methods
PortCalculator.CalculatePortsandPortCalculator.EqualsEpshave been removed. -
The following methods have been removed from the
ReverseEdgesStage:ReverseEdgesStage.FindReversedTreeEdges,ReverseEdgesStage.ReverseEdgeandReverseEdgesStage.ReverseEdges. -
The
HandleNaNCoordinatesStagehas been removed. -
LayoutMultiplexerhas been removed. The features ofComponentLayout(ComponentLayoutDataKey) orRecursiveGroupLayout(GroupNodeLayoutDataKey) can be used instead. -
Merged
MinimumSizeGroupBoundsCalculatorandInsetsGroupBoundsCalculatorinto the newGroupBoundsCalculatorclass. -
Renamed
MirrorModestoMirroredOrientationsandOrientationLayout.MirrorModetoMirroredOrientations. -
The API names to define routing styles throughout the layout algorithms have been streamlined and made more
consistent. Properties on layout algorithms have all been renamed to
EdgeRoutingStyleand those on edge-specific classes have been renamed toRoutingStyle.-
The
Polyline.EdgeRoutingStyleenum has been renamed toRouter.RoutingStyle. -
The
Tree.EdgeRoutingStyleenum has been renamed toSingleLayerSubtreePlacerRoutingStyle. -
The
LayeredRoutingStyleenum has been renamed toLevelAlignedSubtreePlacerRoutingStyle. -
The
Radial.EdgeRoutingStrategyenum has been renamed toRadial.RoutingStyle. -
The
Partial.EdgeRoutingStrategyenum has been renamed toPartial.RoutingStyle. -
The
Hierarchic.EdgeRoutingStyleenum has been renamed toHierarchical.RoutingStylewhile the oldRoutingStyleclass has been renamed toRoutingStyleDescriptor.
-
The
-
Removed the
GraphTransformerclass; use factory methods fromLayoutTransformationsclass instead to create stages that apply transformation operations on aLayoutGraph. -
The
CopiedLayoutGraphclass was removed from the API. To create a copy of a layout graph, the new factoryLayoutGraph.CreateCopymethod may be used. -
LayoutGraphHider: Method names have been standardized for consistency. Collection parameters and return values are now of typeIEnumerable. Methods with non-nullable parameters will now throw an exception if passednullvalues. -
Renamed
EdgeBundlingStagetoBundledEdgeRouter. -
The classes
FixPortLocationStageandFixPortLocationStageDatahave been removed from the library. To correct the port locations after applying a layout use thePortPlacementStageclass. -
PortPlacementStage.PathCorrectionhas been replaced byPortPlacementStage.RouteCorrectionPolicyof enum typeRouteCorrectionPolicy. -
The utility
PortConstraintConfiguratorclass has been removed. -
The classes
ChannelEdgeRouter,OrthogonalPatternEdgeRouterandOrthogonalSegmentDistributionStagehave been removed from the library. Their functionality is superseded by theEdgeRouterrouting algorithm.-
To configure the
EdgeRouterto generate a style that is similar to the removedChannelEdgeRouter, set theStopDurationproperty to zero and use the predefined penalty configurationEdgeRouterCosts.LowQuality. It is however not compatible with advanced features like integrated edge label placement.
-
To configure the
-
Removed
NormalizeGraphElementOrderStage. UseNodeComparisonandEdgeComparisonofLayoutExecutorinstead. -
The
SnapOuterPortsToNodeBorderStageclass has been removed. -
The
CompositeLayoutStageclass has been removed. If a complex composition of layout stages is required, the newLayoutStageStackclass can be used instead. To get anILayoutAlgorithmthat is then applied likeCompositeLayoutStagewas before,LayoutStageStack.LinkCoreLayoutsmethod must be called. -
The
BufferedLayoutclass has been removed. To apply a layout algorithm on a copy of aLayoutGraphinstance useLayoutGraph.CreateCopymethod to get a copy, then apply the layout on it and, finally, write back the result usingLayoutGraphCopyData.CommitLayoutToOriginalGraph. -
The
AbortHandler.CheckFailedproperty has been removed. To achieve the same functionality, theLayoutAbortController(new name of theAbortHandler) can be subclassed, overriding itsCheckmethod which allows to detect calls to that method. -
The
OrientationLayoutclass has been renamed toOrientationStage.-
Furthermore, the following methods have been removed from that class:
IsOrientationMirrored, Transform,PrepareTransform,CompleteTransform,CreateOrientedNodeHalo,CreateOrientedInsetsandCreateOrientedNodeSize.
-
Furthermore, the following methods have been removed from that class:
-
The port-related properties of the layout data classes (
SourcePortGroupIds,TargetPortGroupIds,SourcePortCandidates,TargetPortCandidates) have been moved to a sub-data accessible via the propertyPorts. -
Removed public methods
HideGroupNodesandUnhideGroupNodesofGroupHidingStage. -
Removed
LayoutKeys.NodeIdDpKeyandLayoutKeys.EdgeIdDpKey. -
The
GraphDpKeyclass was replaced byValueDataKey. -
The
TemporaryGroupDescriptorused byTemporaryGroupInsertionStageclass to define temporary group nodes now does not allow that propertiesInsets,MinimumSizeandMargins(formerlyHalo) arenullanymore. Previously this was the default which is nowInsetsD.Empty,SizeD.EmptyandInsetsD.Empty, meaning that the behavior does not change. -
Removed
SplitEdgeStage. -
Removed the classes
PartitionLayoutandPartitionLayoutData. -
Renamed
BendConvertertoBendSubstitutionStage. -
GraphPartitionManageris removed,LayoutGraphHiderprovides the same functionality. -
PortCalculator,IIntersectionCalculator, andIntersectionCalculatorKeyshave been removed. Instead, theLayoutExecutor.PortAdjustmentPolicyproperty should be set to a suitable value. -
The
OrientationLayout.HorizontalOrientationproperty has been removed. To check for a horizontal orientation, check if Orientation property equalsLayoutOrientation.LeftToRightorLayoutOrientation.RightToLeft. -
Renamed
GivenCoordinatesStagetoGivenCoordinatesLayout. -
Renamed
GivenCoordinatesStageDatatoGivenCoordinatesLayoutData. -
Removed the look-up keys
GroupingKeys.GroupDpKey,GroupingKeys.NodeIdDpKeyandGroupingKeys.ParentNodeIdDpKeywhich were necessary to define grouping information forLayoutGraphinstances. This can now be achieved via the helperLayoutGraphGroupingclass or directly via instance methods such asLayoutGraph.SetIsGroupNode. -
The public constructors of
ItemMappingandItemCollectionhave been removed. Instead the instances returned by theLayoutDataproperties should be used to configure theLayoutData. -
The optional
ItemMappingparameter ofGenericLayoutData.AddItemMappinghas been removed. -
The optional
ItemCollectionparameter ofGenericLayoutData.AddItemCollectionhas been removed. -
Renamed the
SubgraphLayoutclass toSubgraphLayoutStageand renamed the respective layout data class fromSubgraphLayoutDatatoSubgraphLayoutStageData. - Methods and and properties with "BoundingBox" in their name have been renamed to include "Bounds" instead.
Incompatible Behavior Changes
-
Method
LayoutGraph.ReverseEdgenow reverses the edge path too. To exchange only source and target of an edge useLayoutGraph.ChangeEdgemethod.
Layout Data
Incompatible API Changes
-
The value type of properties
HierarchicalLayoutData.LayerIndicesResult,HierarchicalLayoutData.SequenceIndicesResult,HierarchicalLayoutData.GivenLayersIndices,RadialLayoutData.LayerIdsandCircularLayoutData.CircleIdsResulthas been changed from number to a nullable number value. Null as value means that nothing was published for an item. -
The value type of the keys
HierarchicalLayout.LayerIndexResultDataKey,HierarchicalLayout.SequenceIndexResultDataKey,GivenLayersAssigner.LayerIndexDataKey,RadialLayout.LayerIdDataKeyandCircularLayout.CircleIdResultDataKeyhas been changed from number to a nullable number value. Null as value means that the nothing was published for an item. -
Properties of type
ItemMappinginLayoutDataclasses are now named using plural consistently. -
The type
SingleItem<was removed. Affected properties useTItem>ItemCollection<instead.TItem>
Hierarchical Layout
Incompatible API Changes
-
Renamed all types, methods, properties, and namespaces containing "hierarchic" to "hierarchical" including
HierarchicLayout, which is renamed toHierarchicalLayout. -
IPortConstraintOptimizerhas been renamed toIPortCandidateSelector, and its methods have been renamed fromOptimizeAfterLayeringandOptimizeAfterSequencingtoSelectAfterLayeringandIPortCandidateSelector.SelectAfterSequencing. -
PortConstraintOptimizerBasehas been removed. -
PortCandidateOptimizerhas been renamed toPortCandidateSelectorand its properties have been renamed:BackLoopPenaltytoBackLoopCost,CrossingPenaltytoCrossingCost, andOverUsagePenaltytoOverUsageCost. -
Renamed the
DefaultDrawingDistanceCalculator.NodeToNodeDistanceproperty toDrawingDistanceCalculator.NodeDistance. -
Renamed the
DefaultDrawingDistanceCalculator.EdgeToEdgeDistanceproperty toDrawingDistanceCalculator.EdgeDistance. -
Renamed the
HierarchicLayout.NodeToNodeDistanceproperty toNodeDistance. -
Renamed the
HierarchicLayout.EdgeToEdgeDistanceproperty toEdgeDistance. -
Renamed "Layerer" to "LayerAssigner" in the following types and members;
-
Renamed
ILayerertoILayerAssigner. -
Moved
HierarchicLayout.FixedElementsLayerertoHierarchicalLayoutCoreand renamed toFixedElementsLayerAssigner. -
Moved
HierarchicLayout.FromScratchLayerertoHierarchicalLayoutCoreand renamed toFromScratchLayerAssigner. -
Renamed
WeightedLayerertoWeightedLayerAssigner. -
Renamed
ConstraintIncrementalLayerertoConstraintIncrementalLayerAssigner. -
Renamed
MultiComponentLayerertoMultiComponentLayerAssigner. -
Renamed
MultiComponentLayerer.SingleComponentLayerertoSingleComponentLayerAssigner. -
Renamed
AspectRatioComponentLayerer.SingleComponentLayerertoSingleComponentLayerAssigner. -
Renamed
TopologicalLayerertoTopologicalLayerAssigner. -
Renamed
AspectRatioComponentLayerertoAspectRatioComponentLayerAssigner. -
Renamed
BFSLayerertoBfsLayerAssigner. -
Renamed
GivenLayersLayerertoGivenLayersAssigner. -
Renamed
HierarchicLayoutCore.CreateIncrementalLayerertoCreateIncrementalLayerAssigner. -
Renamed
HierarchicLayoutData.BfsLayererCoreNodestoBfsLayerAssignerCoreNodes. -
Renamed
AsIsLayerertoFromSketchLayerAssigner.
-
Renamed
-
Renamed
GivenLayersLayerer.LayerIdDpKeytoLayerIndexDataKey. -
Renamed
HierarchicLayoutData.GivenLayersLayererIdstoGivenLayersIndices. -
Removed
HierarchicLayoutData.ConstraintIncrementalLayererAdditionalEdgeWeights. -
Renamed
AsIsSequencertoFromSketchSequencer. -
Renamed
LayerTypetoHierarchicalLayoutLayerType. -
Renamed
DefaultLayerSequencertoDefaultSequencer. -
Methods
ConstraintIncrementalLayerer.CheckConstraints,GivenLayersLayerer.Normalizehave been removed. -
The protected callback methods
GetLayerAlignmentandAssignNodesToSublayerhave been removed from theCoordinateAssignerclass (formerly calledSimplexNodePlacer). Furthermore, itsGetMinDistancemethod has been renamed toGetMinimumDistance. -
The
IDrawingDistanceCalculator.GetMinDistancemethod has been renamed toGetMinimumDistance. -
HierarchicalLayout.GridSpacing: made grid spacing behavior consistent across all layouts by throwing an exception for negative values. -
Renamed
Hierarchic.NodeDataTypetoHierarchicalLayoutNodeTypeand its valueNormaltoHierarchicalLayoutNodeType.Regular. -
Renamed
Hierarchic.EdgeDataTypetoHierarchicalLayoutEdgeTypeand its valueNormaltoHierarchicalLayoutEdgeType.Regular. -
Renamed
LayerType.NormaltoHierarchicalLayoutLayerType.Regular. -
Renamed
MergingPolicytoLayerMergingPolicy. -
Renamed
RankingPolicytoLayerRerankingPolicyandTopologicalLayerer.RankingPolicytoRerankingPolicy. -
Renamed
WeightHeuristictoSequencerWeightHeuristic. -
Names containing
PortBorderGapwere renamed to now containBorderToPortGapRatio. -
Renamed
EdgeLayoutDescriptortoHierarchicalLayoutEdgeDescriptor. -
Renamed
HierarchicLayout.EdgeLayoutDescriptortoDefaultEdgeDescriptor. -
Renamed and moved
HierarchicLayoutCore.EdgeLayoutDescriptorDpKeytoHierarchicalLayout.EdgeDescriptorDataKey. -
Renamed
HierarchicLayoutData.EdgeLayoutDescriptorstoEdgeDescriptors. -
Renamed
NodeLayoutDescriptortoHierarchicalLayoutNodeDescriptor. -
Renamed
HierarchicLayout.NodeLayoutDescriptortoDefaultNodeDescriptor. -
Renamed and moved
HierarchicLayoutCore.NodeLayoutDescriptorDpKeytoHierarchicalLayout.NodeDescriptorDataKey. -
Renamed
HierarchicLayoutData.NodeLayoutDescriptorstoNodeDescriptors. -
Replaced
INodeDatainterface withHierarchicalLayoutNodeContextclass.-
Renamed
INodeData.GroupIdtoHierarchicalLayoutNodeContext.EdgeGroupId. -
Removed the
INodeData.ParentGroupNodeproperty.
-
Renamed
-
Replaced
IEdgeDatainterface withHierarchicalLayoutEdgeContextclass.-
IEdgeData.Typeis read-only on the newHierarchicalLayoutEdgeContext. -
The following
IEdgeDataproperties now offer read and write access on the newHierarchicalLayoutEdgeContext:SourceGroup,TargetGroup,SourcePortGroup,TargetPortGroup,SourcePortCandidates,TargetPortCandidates,Thickness,CrossingCost,CriticalEdgePriority,SourcePortAlignment,TargetPortAlignment. -
Renamed
IEdgeData.SourcePortConstraintandTargetPortConstrainttoSelectedSourcePortCandidateandSelectedTargetPortCandidaterespectively. Bot properties now offer read and write access. -
Removed the
IEdgeData.Groupproperty.
-
-
Replaced
ILayerinterface withHierarchicalLayoutLayerclass. -
Renamed the
ILayer.Listproperty toHierarchicalLayoutLayerclass.Nodes. -
Replaced
ILayersinterface with a list ofHierarchicalLayoutLayerinstances accessible viaHierarchicalLayoutContext.Layersproperty.-
Methods
HierarchicalLayoutContext.InsertLayerandRemoveLayerare replacements for theILayers.InsertandILayers.Removemethods.
-
Methods
-
Replaced
IItemFactoryinterface withItemFactoryclass. Several of the factory methods have also been removed or renamed.-
CreateDummyEdgehas been renamed toCreateHelperEdge. -
CreateProxyNodehas been renamed toCreateSideProxyNodeandDestroyProxyNodetoDestroySideProxyNode. -
CreateSameLayerProxyhas been renamed toCreateSameLayerProxyEdgeandDestroySameLayerProxytoDestroySameLayerProxyEdge. -
SetTemporaryEdgeGroupshas been renamed toCreateGroupedEdgeContext. -
SetTemporaryCriticalEdgePriorityhas been removed. -
SetTemporaryCrossingCosthas been removed. -
SetTemporaryEdgeThicknesshas been removed. -
SetTemporaryPortConstrainthas been removed.
-
-
EdgeDataType.RedirectedGroupEdgehas been removed. -
Separated
HierarchicLayout.IncrementalHintsDpKeyinIncrementalNodeHintsDataKeyandIncrementalEdgeHintsDataKey. -
Separated enum
IncrementalHintinIncrementalNodeHintfor nodes andIncrementalEdgeHintfor edges. -
Separated
HierarchicLayoutData.IncrementalHintsinHierarchicalLayoutData.IncrementalNodesandHierarchicalLayoutData.IncrementalEdges.IncrementalNodesnow only allows for specifying the nodes that should be inserted incrementally during the layering phase. Additional options for incremental node insertion can be specified usingGenericLayoutData. -
Removed
GroupCompactionStrategy. -
Renamed
SimplexNodePlacer.GroupCompactionStrategytoGroupCompactionand changed its type to boolean. -
The
DefaultDrawingDistanceCalculator.OptimizeSwimlaneDistancesproperty has been removed. The behavior does not change and is the same as the old default where the property was disabled. OverrideDrawingDistanceCalculator.GetMinimumDistancemethod and assign zero to nodes that are in different rows/columns to get the same behavior as when previously enabling the property. -
Property
SimplexNodePlacer.SwimLaneCrossingWeighthas been renamed toLayoutGridCrossingWeight. Note that the class has been renamed toCoordinateAssigner. -
The
TypeBasedDrawingDistanceCalculatorclass has been removed. -
The classes
ILayeredComponentsMergerandDefaultLayeredComponentsMergerhave been removed. The functionality is integrated into theMultiComponentLayerer, which now offers a newMergingPolicyproperty and protected methodMergefor the case that a custom merging approach is required. -
The
HierarchicLayout.OrthogonalRoutingproperty has been removed. To specify orthogonal or other routing styles, the routing style on theHierarchicalLayoutEdgeDescriptormust be used instead. -
Renamed
IPortAllocatortoIHierarchicalLayoutPortAssigner. -
Renamed
DefaultPortAllocatortoHierarchicalLayoutPortAssigner. -
Properties
HierarchicLayout.RecursiveGroupLayeringandHierarchicLayout.CompactGroupsare combined intoHierarchicalLayout.GroupLayeringPolicy. -
BusDescriptoris renamed toGridComponentDescriptor. -
HierarchicLayout.BusDescriptorDpKeyis renamed toGridComponentDescriptorDataKey. -
HierarchicLayoutData.Busesis renamed toGridComponents. -
HierarchicLayoutData.BusRootOffsetsis renamed toGridComponentRootOffsets. -
NodeDataType.BusStructureDummyis renamed toGridComponentBusNode. -
Renamed
SimplexNodePlacer.BarycenterModetoSymmetryOptimizationStrategyand changed its type toSymmetryOptimizationStrategy. It now supports performing strong, weak and no additional symmetry optimization. -
Refactored the enum
HierarchicLayout.LayoutModeproperty into a booleanFromSketchModeproperty and removed theLayoutModeenum. -
The
ICandidateMatcherinterface has been removed. For an advanced customization of the port selection consider implementing a customIPortCandidateSelector. -
Moved
HierarchicLayout.StopAfterLayering/Sequencing toHierarchicalLayoutCore. -
The
ILayoutDataProviderinterface is removed and its functionality is moved toHierarchicalLayoutContext. -
The
ILayersinterface is moved to theHierarchicalLayoutContext, and methods that acceptedILayersas a parameter instead acceptHierarchicalLayoutContextnow. -
The
IItemFactoryinterface is moved to theHierarchicalLayoutContext, and methods that acceptedIItemFactoryas a parameter instead acceptHierarchicalLayoutContextnow. -
The obsolete extension methods
CreateLayerConstraintFactoryandCreateSequenceConstraintFactoryhave been removed fromHierarchicLayout. To specify layer and sequence constraints, useLayoutDatainstead. -
LayerConstraintDatano longer inherits fromLayoutData. -
SequenceConstraintDatano longer inherits fromLayoutData. -
NodeLayoutDescriptor.NodeLabelModewas removed. If node labels shall be considered by the layout algorithm, they are now considered during all phases. In particular, self-loops do not overlap node labels anymore. -
The
NodeLabelModeenum was removed. -
The
NodeLayoutDescriptorclass of theHierarchicLayoutalgorithm, which was renamed toHierarchicalLayoutNodeDescriptor, does no longer allow to specify the border-to-port gap ratios individually for each node side. TheBorderToPortGapRatioproperty now defines the value for all four node sides. -
Property
HierarchicLayoutData.SelfLoopCalculatorDatawas removed. Settings like minimum lengths for self-loop edges are specified via theHierarchicalLayoutEdgeDescriptorclass like for normal edges. -
The
SelfLoopCalculatorandSelfLoopCalculatorDataclasses was removed from the API. -
In the sub-data
SequenceConstraintDataof theHierarchicalLayoutDataPlaceBeforeandPlaceAfterwere replaced byPlaceInOrder. -
In the sub-data
LayerConstraintDataof theHierarchicalLayoutDataPlaceAboveandPlaceBelowwere replaced byPlaceInOrder. -
The
INodePlacerinterface of the hierarchic layout has been renamed toICoordinateAssigner. Its implementation has been renamed fromSimplexNodePlacertoCoordinateAssigner. -
The
HierarchicLayout.SeparateLayersproperty has been moved toCoordinateAssigner.SeparateLayers, since it has always only worked when using that implementation. -
The
IEdgeReverserinterface and theHierarchicLayoutCore.CreateEdgeReversermethod have been removed. -
The
GroupTranspositionproperty has been removed fromDefaultLayerSequencerclass. The Transposition property should now be used for groups too. -
The
HierarchicLayoutCoreclass is not a standalone layout algorithm anymore but now offers only access to more advanced features of theHierarchicLayoutclass.-
All public data keys were moved to the
HierarchicLayoutclass. - The protected API of both classes was reduced, but still even highly advanced customization are possible.
-
All public data keys were moved to the
-
The protected methods
DefaultPortAllocator.GetPortBorderGap,DefaultPortAllocator.GetPortBorderGapRatio, andDefaultPortAllocator.GetPortDistanceDeltawere removed. -
Removed members
HierarchicLayout.CreateLayerConstraintFactory,HierarchicLayoutData.LayerConstraintFactory,HierarchicLayout.CreateSequenceConstraintFactoryandHierarchicLayoutData.SequenceConstraintFactory. The factories are no longer required to define layering and sequence constraints.-
The recommended way is to use properties
HierarchicLayoutData.LayerConstraintsandHierarchicLayoutData.SequenceConstraints. -
For expert uses cases (e.g. algorithm customization), the low-level helper classes
LayoutGraphLayerConstraintsandLayoutGraphSequenceConstraintswere added.
-
The recommended way is to use properties
-
Removed the keys
HierarchicLayout.LayerConstraintsMementoDpKeyandHierarchicLayout.SequenceConstraintsMementoDpKey. -
Class
TopLevelGroupToSwimlaneStagehas been removed from the library.
Incompatible Behavior Changes
-
The
HierarchicalLayoutnow considers node labels by default. -
The
HierarchicalLayoutnow places edge labels by default using an integrated labeling algorithm. -
Changed the default edge routing style of the
HierarchicalLayoutclass from Polyline to Orthogonal.
Tree Layout
Incompatible API Changes
-
Renamed
TreeLayout.MultiParentAllowedtoAllowMultiParent. -
Renamed
TreeReductionStage.MultiParentAllowedtoAllowMultiParent. -
Renamed "NodePlacer" to "SubtreePlacer" in the following types and members:
-
Renamed the
DefaultNodePlacerclass toSingleLayerSubtreePlacer. -
Renamed the
DelegatingNodePlacerclass toSingleSplitSubtreePlacer. -
Renamed the
DoubleLineNodePlacerclass toDoubleLayerSubtreePlacer. -
Renamed the
FreeNodePlacerclass toFixedSubtreePlacer. -
Renamed the
GridNodePlacerclass toMultiLayerSubtreePlacer. -
Renamed the
GroupedNodePlacerclass toMultiSplitSubtreePlacer. The class now considers port grouping (useTreeLayoutData.Ports) to define how child nodes are split. -
Renamed the
LayeredNodePlacerclass toLevelAlignedSubtreePlacer. -
Renamed the
TreeLayout.DefaultNodePlacerproperty toDefaultSubtreePlacer. -
Renamed the
TreeLayoutData.DelegatingNodePlacerPrimaryNodesproperty toSingleSplitSubtreePlacerPrimaryNodes. -
Renamed the
TreeLayoutData.GridNodePlacerRowIndicesproperty toMultiLayerSubtreePlacerLayerIndices.
-
Renamed the
-
Renamed
ConnectorDirectiontoSubtreeConnectorDirection, and the valuesNorthtoSubtreeConnectorDirection.Up,EasttoSubtreeConnectorDirection.Right,SouthtoSubtreeConnectorDirection.Down, andWesttoSubtreeConnectorDirection.Left. -
Renamed the values of
ParentConnectorDirection:NorthtoParentConnectorDirection.Up,EasttoParentConnectorDirection.Right,SouthtoParentConnectorDirection.Down, andWesttoParentConnectorDirection.Left. -
Replaced
Tree.Matrixwith theSubtreeTransformenum and renamed constants:-
Matrix.DefaulttoSubtreeTransform.None. -
Matrix.MirHortoSubtreeTransform.FlipY. -
Matrix.MirVerttoSubtreeTransform.FlipX. -
Matrix.Rot90toSubtreeTransform.RotateLeft. -
Matrix.Rot180toSubtreeTransform.Rotate180. -
Matrix.Rot270toSubtreeTransform.RotateRight. -
Matrix.MirVertRot90toSubtreeTransform.RotateRightFlipY. -
Matrix.MirHorRot90toSubtreeTransform.RotateLeftFlipY.
-
-
Renamed
TreeLayoutData.OutEdgeComparerstoTreeLayoutData.ChildOrderand changed the types to Comparison function. -
Removed
TreeLayout.DefaultOutEdgeComparer. UseTreeLayoutData.ChildOrderinstead. Also removedNodeOrderComparerclass. -
Removed the
SimpleNodePlacerclass; useDefaultSubtreePlacerclass instead. -
Replaced
DefaultNodePlacer.ChildPlacementproperty with the newSingleLayerSubtreePlacer.Transformationproperty. The formerChildPlacement.HorizontalDownwardvalue now maps toSubtreeTransform.None,ChildPlacement.HorizontalUpwardtoSubtreeTransform.FlipY,ChildPlacement.VerticalToLefttoSubtreeTransform.RotateRight, andChildPlacement.VerticalToRighttoSubtreeTransform.RotateLeftFlipY. -
Renamed
RootAlignment.CenterOverChildrentoSubtreeRootAlignment.CenterOfChildren. -
Renamed
RootAlignment.LeadingtoSubtreeRootAlignment.Left,RootAlignment.TrailingtoSubtreeRootAlignment.Right,RootAlignment.LeadingOffsettoSubtreeRootAlignment.Leading, andRootAlignment.TrailingOffsettoSubtreeRootAlignment.Trailing. -
The
TreeComponentLayoutclass has been removed. -
Renamed
FillStyletoAspectRatioChildAlignmentPolicyandAspectRatioNodePlacer.FillStyletoChildAlignmentPolicy. -
The
AspectRatioTreeLayouthas been removed together withAspectRatioTreeLayoutData,RootPlacement, andSubtreeArrangement. Use theTreeLayoutwith theAspectRatioSubtreePlacerinstead. -
Replaced
TreeLayoutData.OutEdgeComparersproperty with new, more powerfulChildOrderproperty. -
The
TreeReductionStage.NonTreeEdgeLabelingAlgorithmproperty has been renamed toNonTreeEdgeLabeling. -
Remove methods
GetPortBorderGapandGetPortDistanceDeltafrom theDefaultPortAssignment(renamed toTreeLayoutPortAssigner) class. -
Removed the
NodePlacerBaseclass. ImplementISubtreePlacerinterface instead. -
Removed the method
PlaceSubtree(Node,ParentConnectorDirection) of former subclasses ofNodePlacerBaseclass. OverridePlaceSubtreemethod(IMapper<Node,SubtreeShape>,IMapper<Node,SubtreeShape>,LayoutGraph, Node) instead. -
Removed the
DetermineChildConnectormethod of former subclasses ofNodePlacerBaseclass. OverrideDetermineChildConnectorsmethod instead. -
Removed the methods
GetNodeShapeandGetSubtreeShapefrom former subclasses ofNodePlacerBaseclass. - Renamed all types, methods and properties containing "NodePlacer" to "SubtreePlacer".
-
The
DefaultPortAssignment.BorderGapToPortGapRatioproperty was renamed toBorderToPortGapRatio. -
Tree.PortAssignmentModevaluePortConstrainthas been removed. Port candidates are always considered if they are specified. -
Tree.PortAssignmentModevaluesDistributedEast,DistributedWest,DistributedNorth,DistributedSouthhave been replaced by valueDistributed. The side can be specified by usingTreeLayoutData.Ports. -
Tree.PortAssignmentMode.Nonehas been renamedTree.PortAssignmentMode.Center. -
TreeLayout.GetPortAssignmentcan no longer be overridden. To specifyIPortAssignmentstrategies per node,TreeLayoutData.PortAssignerscan be used. -
TreeLayout.GetNodePlacercan no longer be overridden. To specifyNodePlacerstrategies per node,TreeLayoutData.SubtreePlacerscan be used. -
The following methods of
TreeLayouthave been removed:-
ReverseEdges. -
GetRootsArray. -
GetOutEdgeComparer-TreeLayoutData.ChildOrdercan be used instead. -
CreateNodeShape-ModifyNodeShapecan be used instead to modify the shape. -
DirectTree-TreeLayoutData.TreeRootcan be used to accomplish the same result.
-
-
DefaultNodePlacer.CalculateParentConnectorhas been removed. Custom implementations can be inlined at the end ofPlaceSubtree. -
SubtreeShape.AddBoundsToShapeaccepts a singleRectDparameter instead of its deconstructed values. -
SubtreeShape.AssignValuesTohas been removed -CreateCopycan be used instead. -
The API of the node placer implementations has been simplified and improved. The
INodePlacerinterface was renamed toISubtreePlacer. - The class hierarchy of the various node placer implementations has been simplified. The rotatable base class implementation has been removed from the hierarchy.
-
Renamed
IPortAssignmenttoITreeLayoutPortAssigner. -
Renamed
DefaultPortAssignmenttoTreeLayoutPortAssigner. -
Renamed
TreeLayout.PortAssignmentDpKeytoPortAssignerDataKey. -
Renamed
TreeLayoutData.PortAssignmentstoPortAssigners. -
Renamed the property
RoutingStyle.PolylinetoSingleLayerSubtreePlacerRoutingStyle.StraightLineToChildConnector,RoutingStyle.Forkproperty toSingleLayerSubtreePlacerRoutingStyle.Orthogonal, andRoutingStyle.ForkAtRootproperty toSingleLayerSubtreePlacerRoutingStyle.OrthogonalAtRoot. -
Added
SingleLayerSubtreePlacerRoutingStyle.Polylineproperty which leads to a polyline routing style. -
The
ClassicTreeLayouthas been removed together with the enumsLeafPlacement,EdgeRoutingStyle, andPortStyle. TheTreeLayoutcan be used instead. -
The properties
TreeLayout.SourcePortConstraintDataAcceptorandTreeLayout.TargetPortConstraintDataAcceptorhave been removed. -
The properties
TreeLayout.SourceGroupDataAcceptor
andTreeLayout.TargetGroupDataAcceptorhave been removed. -
Removed the
TreeLayout.DefaultLeafPlacerproperty as well asLeafNodePlacerclass. -
DelegatingNodePlacernow implementsISubtreePlacerinstead ofIFromSketchNodePlacer. -
BusNodePlacernow implementsISubtreePlacerinstead ofIFromSketchNodePlacer. -
Renamed
IProcessortoISubtreePlacerProcessor. -
All layouts suitable for trees, such as
TreeLayout,RadialTreeLayout, now default to using theTreeReductionStageto temporarily remove non-tree edges from the graph during layout calculation. -
The
GridNodePlacer.AutomaticRowAssignmentproperty (now renamed toMultiLayerSubtreePlacer) was removed. The layers are now always automatically assigned if no layer indices are defined viaTreeLayoutData.MultiLayerSubtreePlacerLayerIndices. -
The
TreeLayout.graphfield has been removed. For customizations in theTreeLayoutthe graph is available whatsoever and can if required be queried from the node/edge items.-
Method
TreeLayout.LayoutRootnow has an additional parameter of typeLayoutGraphas its first argument.
-
Method
-
Removed the
LayeredNodePlacer.Idproperty (class was also renamed toLevelAlignedSubtreePlacer). The ID can still be provided via the constructor. Reading it later should never be necessary. -
The factory
TreeReductionStage.CreateStraightLineRoutermethod has been removed. The standalone routerStraightLineEdgeRouterclass should be used instead when straight-line edges are required.
Incompatible Behavior Changes
- Port candidates are always considered if they are specified.
-
The
TreeLayoutnow considers node labels by default. -
The
TreeLayoutnow places edge labels by default using an integrated labeling algorithm.
Orthogonal Layout
Incompatible API Changes
-
The
LayoutStyleenum (belonging to theOrthogonalLayout) has been renamed toOrthogonalLayoutMode. Furthermore, the new values are Strict (former Default),ForcedStraightLine(former Box) , and Relaxed (formerFixedMixed). The former values Uniform,FixedBox, and Mixed have been removed from the enum. -
The
OrthogonalLayoutproperties related to substructures have all been renamed to contain "substructure" in their name.ChainStyle,ChainSize,TreeStyle,TreeSize,TreeOrientation,CycleStyle,CycleSizeare now calledChainSubstructureStyle,ChainSubstructureSize,TreeSubstructureStyle,TreeSubstructureSize,TreeSubstructureOrientation,CycleSubstructureStyle,CycleSubstructureSize. -
The following properties have been removed from the
OrthogonalLayoutclass: Randomization,CrossingReduction,EdgeLengthReduction,OptimizePerceivedBendsandFaceMaximization. Use the newQualityTimeRatioproperty instead. -
Removed the
CompactOrthogonalLayoutclass. -
The
DirectedEdgesproperties ofOrthogonalLayoutDataandPartialLayoutDataare now both of typeItemMappingwith the nameEdgeOrientationand support floating-point values to also specify edges oriented against the main layout direction. -
EdgeDirectednessDpKeyon all supportingILayoutAlgorithms have been combined into a global data keyLayoutKeys.EdgeDirectednessDataKey. -
PartialLayout.DirectedEdgesDpKeyis renamed toEdgeOrientationDataKeyand now also allows specifying edges should be routed against the main layout orientation. -
Renamed
EdgeLayoutDescriptortoOrthogonalLayoutEdgeDescriptor. -
Renamed
OrthogonalLayout.EdgeLayoutDescriptortoDefaultEdgeDescriptor. -
Renamed
OrthogonalLayout.EdgeLayoutDescriptorDpKeytoEdgeDescriptorDataKey. -
Renamed
OrthogonalLayoutData.EdgeLayoutDescriptorstoEdgeDescriptors.
Incompatible Behavior Changes
-
The
OrthogonalLayoutnow considers node labels by default. -
The
OrthogonalLayoutnow places edge labels by default using an integrated labeling algorithm.
Edge Router
Incompatible API Changes
-
The
MonotonicPathRestrictionenum is now a flags enum and is calledMonotonicPathRestrictions. -
The
SelfLoopRouter.SmartSelfLoopPlacementproperty has been removed. It was enabled by default and the algorithm now always behaves like when it was enabled previously. To get all self-loops on the same node corner independently of other edges, theSelfLoopRoutercan be applied in a separate post-processing step where only self-loops are present in the graph (useSubgraphLayoutStage). -
Method
ParallelEdgeRouter.LayoutParallelEdgeswas renamed toRouteEdges. -
Renamed
ParallelEdgeRouter.RoutedParallelEdgesDpKeytoRoutedMultiEdgesResultDataKey. -
Renamed
ParallelEdgeRouter.FindAndHideParallelEdgestoFindAndHideMultiEdges. -
Renamed
ParallelEdgeRouterData.RoutedParallelEdgestoRoutedMultiEdgesResult. -
The
ParallelEdgeRouter.AbsJoinEndDistanceproperty has been renamed toAbsoluteJoinEndDistance. -
The
ParallelEdgeRouter.RelJoinEndDistanceproperty has been renamed toRelativeJoinEndDistanceFactor, and its default value now is 0. -
The
ParallelEdgeRouter.LineDistanceproperty has been renamed toEdgeDistance. -
The
SelfLoopRouter.LineDistanceproperty has been renamed toEdgeDistance. -
The
SelfLoopRouter.LayoutSelfLoopsmethod has been removed. To route the self-loop edges, theSelfLoopRouterclass should be applied to the graph. -
The
SelfLoopRouter.LayoutStyleproperty has been renamed toRoutingStyle. The respective enum type has been renamed toSelfLoopRoutingStyle. -
The
OrganicEdgeRouter.CreateNodeEnlargementStagemethod has been removed and is now replaced by the newAllowMovingNodesproperty. -
The
OrganicEdgeRouter.EdgeNodeOverlapAllowedproperty has been renamed toOrganicEdgeRouter.AllowEdgeNodeOverlaps. -
The
BusRouterclass and all API members related to it have been removed. For bus-style edge routing, useEdgeRouterinstead. -
Renamed the
CurveEdgeLayoutDescriptor.MinimumEdgeToEdgeDistanceproperty toMinimumEdgeDistance. -
Renamed the
EdgeLayoutDescriptor.MinimumEdgeToEdgeDistanceproperty (EdgeRouter) toMinimumEdgeDistance. -
Renamed the
PenaltySettings.MinimumEdgeToEdgeDistancePenaltyproperty toEdgeRouterCosts.MinimumEdgeDistanceCost. -
Renamed
Interval.MintoInterval.Minimum. -
Renamed
Interval.MaxtoInterval.Maximum. -
Renamed
OrthogonalInterval.MintoOrthogonalInterval.Minimum. -
Renamed
OrthogonalInterval.MaxtoOrthogonalInterval.Maximum. -
Replaced
EdgeRouter.EdgeComparerproperty of typeIComparerwithEdgeRouterData.EdgeProcessingComparisonof type Comparison function. -
The
EdgeRouter.IgnoreInnerNodeLabelsproperty has been removed from the API. Consideration is controlled viaEdgeRouter.NodeLabelPlacement. Inner labels of non-group are only ignored when choosing valueEdgeRouterNodeLabelPlacement.Ignore; labels of group nodes alone can be ignored when choosingEdgeRouterNodeLabelPlacement.IgnoreGroupLabels. -
The protected
EdgeRouter.CreateDefaultEdgeOrderComparermethod has been removed. UseEdgeRouterData.EdgeProcessingComparisoninstead. -
Refactored the API for customizing the
EdgeRouterclass.-
The classes/interfaces
PathSearch,PathSearchResult,CellSegmentInfo,EdgeInfo, Channel,ChannelBasedPathRouting,SegmentInfo,SegmentInfoBase,SegmentGroup,Router.Polyline.Alignment,DynamicObstacleDecomposition,IObstaclePartition,IPartition,GraphPartition,GraphPartitionExtensionAdapter,IDecompositionListener,IDynamicDecomposition,IEnterIntervalCalculatorandIGraphPartitionExtensionhave been removed. -
The
PartitionCell.CreateBorderIntervalmethod has been removed alongside with thePartitionCellBorderenum. -
The properties
EdgeCellInfo.EnterSegmentGroup,EdgeCellInfo.ExitSegmentGroupandEdgeCellInfo.CellSegmentInfoshave been removed. -
The properties
EdgeRouter.RegisteredPartitionExtensions,RegisteredPathSearchExtensionsand Partition have been removed, as well as methodsCreateObstacleDecomposition,CreatePathSearch,CreatePathSearchContext,ConfigurePathSearch,CreatePathRouting,CreateConfiguration,ConfigureGraphPartitionandCleanUpGraphPartition. -
The properties
PathSearchContext.PathSearchandPathSearchContext.PathSearchResulthave been removed. -
Added new methods
EdgeRouter.AddPathSearchExtensionandEdgeRouter.AddPartitionExtension. -
Added
PartitionExtensionclass as replacement forIGraphPartitionExtension. -
Added new
IRouterPartitioninterface as replacement ofIObstaclePartitionandIPartition. -
The Partition property has been added to
PathSearchConfigurationclass. -
The
Path.Lengthproperty has been renamed toPathSearchResult.CellEntranceCount.
-
The classes/interfaces
-
Renamed
ObstacletoRoutingObstacle. -
Renamed
PathtoPathSearchResult. -
Renamed
PathRequesttoPathSearchRequest. -
Renamed
EdgeLayoutDescriptortoEdgeRouterEdgeDescriptor. -
Renamed
CurveEdgeLayoutDescriptortoCurveRoutingEdgeDescriptor. -
Renamed
EdgeRouter.EdgeLayoutDescriptorDpKeytoEdgeDescriptorDataKey. -
Renamed
EdgeRouter.DefaultEdgeLayoutDescriptortoDefaultEdgeDescriptor. -
Renamed
EdgeRouter.GetEdgeLayoutDescriptortoGetEdgeDescriptor. -
Renamed
EdgeRouterData.EdgeLayoutDescriptorstoEdgeDescriptors. -
Renamed
PathSearchContext.CurrentEdgeLayoutDescriptortoCurrentEdgeDescriptor. -
Renamed
CurveRoutingStage.DefaultEdgeLayoutDescriptortoDefaultEdgeDescriptor. -
Renamed
CurveRoutingStage.CurveEdgeLayoutDescriptorDpKeytoEdgeDescriptorDataKey. -
Renamed
CurveRoutingStageData.EdgeLayoutDescriptorstoEdgeDescriptors. -
EdgeRouter.Gridhas been replaced byEdgeRouter.GridSpacing. -
The class
Polyline.Gridhas been removed. -
The
EdgeRouterand all its related classes have been moved from namespaceyWorks.Layout.Router.PolylinetoyWorks.Layout.Router. -
Class
PenaltySettingsandEdgeLayoutDescriptor.PenaltySettingsproperty where renamed toEdgeRouterCostsandEdgeRouterEdgeDescriptor.EdgeRouterCosts. -
The already obsolete properties
EdgeRouter.PolylineRouting,EdgeRouter.PreferredPolylineSegmentLengthandEdgeRouter.MaximumPolylineSegmentRatiohave been removed. They are replaced by respective properties on theEdgeRouterEdgeDescriptorclass. -
The
PolylineLayoutStageclass has been renamed toOctilinearRoutingStage. ItsPreferredPolylineSegmentLengthproperty has been renamed toPreferredOctilinearSegmentLength. -
The type of
IntermediateRoutingPointsproperty has been changed fromIListtoIEnumerable.
Incompatible Behavior Changes
-
The default of
ParallelEdgeRouter.RelativeJoinEndDistanceFactorhas changed from 0.1 to 0. -
The
EdgeRouternow considers node labels by default. -
The
EdgeRouternow places edge labels by default using a generic labeling algorithm.
Labeling
Incompatible API Changes
-
The
PreferredPlacementDescriptorclass has been renamed toEdgeLabelPreferredPlacement.-
The
IEdgeLabelLayout.PreferredPlacementDescriptorproperty has been removed. Instead, the preferred placement can be specified usingEdgeLabelPreferredPlacement.EdgeLabelPreferredPlacementDataKey.
-
The
-
Removed the interfaces
INodeLabelLayoutandIEdgeLabelLayout. Labels of theLayoutGraphare instead represented by typesNodeLabelandEdgeLabel. -
Removed
LayoutGraph.GetLabelLayout. Labels can instead be retrieved usingNode.LabelsandEdge.Labels. -
Removed the
ILabelLayoutFactoryclass. Labels can instead be created and removed usingLayoutGraph.AddLabelandLayoutGraph.Remove. -
Removed the interfaces
INodeLabelLayoutModel,IEdgeLabelLayoutModeland all implementations. To specify valid positions forGenericLabeling, the typesNodeLabelCandidatesandEdgeLabelCandidatesoffer methods for creating positions that correspond to the old model implementations. Candidates can be specified usingGenericLabelingData.NodeLabelCandidatesandGenericLabelingData.EdgeLabelCandidates. -
Summarized layout algorithm properties such as
ConsiderNodeLabels,ConsiderEdgeLabels,IntegratedNodeLabeling,IntegratedEdgeLabeling, andNodeLabelingPolicyas two propertiesNodeLabelPlacementandEdgeLabelPlacement. -
Removed
LabelLayoutTranslator,LabelLayoutData,LabelLayoutKeysand related classes. The behavior ofLabelLayoutDatacan be recreated usingNodeLabel.AbsolutePlacementandEdgeLabel.AbsolutePlacement. -
Removed properties
RemoveNodeOverlaps,RemoveEdgeOverlapsandEdgeGroupOverlapAllowedfromGenericLabeling. -
Introduced
GenericLabeling.QualityTimeRatioproperty providing the possibility of balancing runtime and quality. -
Added intersection information to
LabelCandidateclass, which provides means to compute profits and to mimic the behavior of the removed properties. -
Removed
MISLabelingBase.OptimizationStrategy. UseGenericLabeling.DefaultNodeLabelingCostsandGenericLabeling.DefaultEdgeLabelingCostsinstead. Additionally individual costs can now be set for each label, usingGenericLabelingData.NodeLabelingCostsandGenericLabelingData.EdgeLabelingCosts. -
Removed
LabelingBase.AutoFlipping. Automatically flipping labels right-side up is handled by the view, e.g.SmartEdgeLabelModel.AutoRotation. -
Removed the
IProfitModelinterface and propertiesLabelingBase.ProfitModelandMISLabelingBase.CustomProfitModelRatio. Custom weights for a label candidate can be set at creation of the candidate withNodeLabelCandidatesandEdgeLabelCandidates, or through a callback for each label usingGenericLabelingData.NodeLabelCandidateProcessorsandGenericLabelingData.EdgeLabelCandidateProcessors. -
Removed the classes
MISLabelingBaseandLabelingBase. -
Removed the following protected methods from
GenericLabeling:CreateEdges,AssignProfit,FoundLabelOverlap,FoundNodeOverlap,FoundEdgeOverlap,FoundHaloOverlap,FoundPartitionGridLineOverlap,FoundPartitionGridInsetOverlap,FoundPartitionGridInteriorOverlap. -
Made enums
LabelAngleOnRightSideRotationsandLabelAngleReferencesnon-flags enums. -
Removed the
LabelAngleOnRightSideOffsetsenum. -
Changed the
PreferredPlacementDescriptor.AngleOffsetOnRightSideenum property to theAddHalfRotationOnRightSidebool property. -
MISLabelingBase.ReduceAmbiguityis removed. Ambiguous label placements can instead be penalized usingLabelingCosts.AmbiguousPlacementCost. -
Removed the
GraphModelManager.LabelLayerPolicyproperty. Use the more specific propertiesNodeLabelLayerPolicy,EdgeLabelLayerPolicyandPortLabelLayerPolicyinstead. -
The
SandwichLabelModelhas been removed. It can be emulated using aCompositeLabelModelwith the top and bottom position of anExteriorNodeLabelModel. -
Renamed
LabelSideReferences.AbsoluteWithLeftInNorthtoAbsoluteWithLeftAbove. -
Renamed
LabelSideReferences.AbsoluteWithRightInNorthtoAbsoluteWithRightAbove. -
ILabelCandidateDescriptorand related interfaces have been removed. -
LayoutGraphAdapter: removedGetLabelCandidateDescriptorProviderandGetLabelCandidateDescriptor. -
Renamed
SliderModetoEdgeLabelSliderMode. -
Values of
DiscreteNodeLabelPositionshave been renamed:-
DiscreteNodeLabelPositions.Top,DiscreteNodeLabelPositions.TopLeft, ... have been renamed toTopInside,TopLeftInside, ... -
DiscreteNodeLabelPositions.North,DiscreteNodeLabelPositions.NorthWest, ... have been renamed toDiscreteNodeLabelPositions.Top,DiscreteNodeLabelPositions.TopLeft, ...
-
-
Values of
DiscreteNodeLabelPositionsenum have been renamed.-
InternalMasktoInside. -
EightPosMasktoDiscreteNodeLabelPositions.Outside. -
SidesMasktoSides. -
CornerMasktoCorners. -
Removed value
SandwichMask.
-
-
Removed
DescriptorWrapperLabelModel. -
The configuration
LabelingDataclass for theGenericLabelingalgorithm has been renamed toGenericLabelingDatato be more in line with otherLayoutDataimplementations.
Organic Layout
Incompatible API Changes
-
TreeSubstructureStyle.Balloonhas been renamed toRadialTree. -
Renamed
OrganicLayout.ClusterAsGroupSubstructureAllowedtoAllowClusterAsGroupSubstructure. -
Renamed
OrganicLayout.NodeEdgeOverlapAvoidedtoAvoidNodeEdgeOverlap. -
Renamed
OrganicLayout.NodeOverlapsAllowedtoAllowNodeOverlaps. -
The classes
OrganicRemoveOverlapsStageandShuffleLayouthave been removed from the library. To solve the task of overlap removal, theRemoveOverlapsStageclass is still available and the style previously generated byOrganicRemoveOverlapsStagecan be triggered via the policyOverlapRemovalPolicy.PreserveRelativeLocations. -
The
OrganicPartitionGridLayoutStageclass has been removed. -
The
RecursiveShuffleLayoutclass has been removed from the API. -
Renamed
GroupNodeMode.NormaltoGroupNodeHandlingPolicy.Free. -
Renamed
OrganicLayoutData.SourceGroupIdstoSubstructureSourceGroupIds.OrganicLayoutnow usesOrganicLayout.SubstructureSourceGroupIdDataKeyinstead ofLayoutKeys.SourceEdgeGroupIdDataKey. -
Renamed
OrganicLayoutData.TargetGroupIdstoSubstructureTargetGroupIds.OrganicLayoutnow usesOrganicLayout.SubstructureTargetGroupIdDataKeyinstead ofLayoutKeys.TargetEdgeGroupIdDataKey. -
Renamed the
OrganicLayout.GroupNodeModeDpKeyproperty toGroupNodeHandlingPolicyDataKey. -
The
OrganicLayoutnow configures theComponentLayoutby default, andSmartComponentLayoutwas removed. -
OrganicLayout.ConfigureComponentLayoutandDisposeComponentLayoutwere removed. To configure theComponentLayout, replace the instance of theComponentLayoutin theLayoutStageStackwith a suitably configured instance. -
Removed
ConstraintFactoryandOrganicLayout.CreateConstraintFactory. UseOrganicLayoutData.Constraintsinstead. -
OrganicConstraintData.AddFloatingBoundingBoxnow acceptsSizeDits deconstructed values. -
OrganicConstraintData.AddFloatingBoundingBoxnow acceptsRectDits deconstructed values. -
OrganicLayout.ConsiderNodeSizeswas removed. TheOrganicLayoutnow always considers node sizes. -
OrganicConstraintDatano longer inherits fromLayoutData. -
The
OutputRestrictionclass and the associated properties have been renamed toShapeConstraint. -
Removed the
ClusterNodesproperty fromOrganicLayout. It is replaced byClusteringPolicyproperty. To disable the clustering, specifyClusteringPolicy.None. To enable it choose one of the available other policies. -
Removed the
ClusteringQualityproperty fromOrganicLayout. UseQualityTimeRatioinstead. -
The
OrganicLayoutclass no longer offers valueClusteringPolicy.UserDefined. Now, cluster IDs provided by users viaOrganicLayoutData.ClusterIdsproperty or data keyOrganicLayout.ClusterIdDataKeyare always considered first. If none are defined, the specifiedOrganicLayout.ClusteringPolicyis considered. -
The
ClassicOrganicLayoutclass has been removed. It is superseded by the more powerfulOrganicLayoutalgorithm that should be used instead.
Incompatible Behavior Changes
-
The
OrganicLayoutnow considers node labels by default. -
The
OrganicLayoutnow places edge labels by default using a generic labeling algorithm. -
The default style of the
OrganicLayout'sComponentLayoutis changed toPackedCircle. -
The
OrganicLayoutnow always considers node sizes.
Interactive Organic Layout
Incompatible API Changes
-
The
InteractiveOrganicLayoutDataclass has been added. It handles the initial settings per node and edge. -
The classes
InteractiveOrganicNodeHandleandInteractiveOrganicEdgeHandlehave been added. They handle the settings per node and edge while the algorithm runs. -
The properties, getters, and setters on
InteractiveOrganicLayoutthat concern settings for individual items have been moved toInteractiveOrganicLayoutDataor the handles as appropriate. -
The
InteractiveOrganicLayout.AddStructureUpdatemethod has been removed. -
The methods
InteractiveOrganicLayout.CommitPositionsandCommitPositionsSmoothlyhave been combined as theInteractiveOrganicLayoutData.UpdateNodeCentersmethod. -
The
InteractiveOrganicLayout.OutputRestrictionproperty has been renamed toShapeConstraint. -
The
InteractiveOrganicLayout.PreferredEdgeLengthproperty has been renamed toDefaultPreferredEdgeLength. -
The
InteractiveOrganicLayout.SyncStructuremethod has been removed.
Circular Layout
Incompatible API Changes
-
Renamed the
ExteriorEdgeLayoutDescriptor.EdgeToEdgeDistanceproperty toCircularLayoutExteriorEdgeDescriptor.EdgeDistance. -
The type of the
CircularLayout.MaximumDeviationAngleproperty has been changed to double. -
Renamed
CircularLayout.LayoutStyletoCircularLayout.PartitioningPolicy. -
Renamed
Circular.LayoutStyletoCircular.PartitioningPolicy. -
Removed the enum value
LayoutStyle.CustomGroups. If custom partitions are specified usingCircularLayoutData.Partitions, they are respected by theCircularLayoutautomatically. -
The
INodeSequencerclass has been removed from the API. Use the newCircularLayoutData.NodeComparisonproperty to specify custom node orders. -
The
CircularLayout.LayoutStyleproperty has been renamed toPartitioningPolicyto better reflect the fact that it controls how nodes are partitioned. The corresponding enum has also been renamed from toPartitioningPolicy. -
Renamed
EdgeLayoutDescriptortoCircularLayoutEdgeDescriptor. -
Renamed
CircularLayout.DefaultEdgeLayoutDescriptortoEdgeDescriptor. -
Renamed
ExteriorEdgeLayoutDescriptortoCircularLayoutExteriorEdgeDescriptor. -
Renamed
CircularLayout.ExteriorEdgeLayoutDescriptortoExteriorEdgeDescriptor. -
The
SingleCycleLayouthas been removed. TheCircularLayoutwithPartitioningPolicyset toSingleCyclecan be used instead. -
CircularLayout.SingleCycleLayouthas been replaced byCircularLayout.PartitionDescriptor. -
CircularLayout.DefaultEdgeLayoutDescriptorhas been renamed toEdgeDescriptor. -
CircularLayout.BalloonLayouthas been renamed toBackboneLayout. -
Removed the enum value
EdgeRoutingPolicy.MarkedExterior. To manually select which edges should be routed externally, use theCircularLayoutData.ExteriorEdgesproperty instead.
Incompatible Behavior Changes
-
The
CircularLayoutnow considers node labels by default. -
The
CircularLayoutnow places edge labels by default using a generic labeling algorithm. -
The default style of the
CircularLayout'sComponentLayoutis changed toPackedCircle. -
PartitionDescriptor.InitialAngleis measured in degrees rather than radians.
Radial Layout
Incompatible API Changes
-
Radial.NodeInfois renamed toRadialLayoutNodePlacementResult. -
The read/write
CenterNodesDpKeyproperty from theRadialLayoutclass has been removed. It was replaced by the static read-only keyRadialLayout.CenterNodesDataKeythat must now be used instead to mark the custom center nodes. -
Renamed the
RadialLayout.MinimumNodeToNodeDistanceproperty toMinimumNodeDistance. -
Renamed the
RadialLayout.MinimumEdgeToEdgeDistanceproperty toMinimumEdgeDistance. -
Renamed
Radial.LayeringStrategytoRadialLayeringStrategy. -
Replaced
ItemMappingOutEdgeComparerswithChildOrderDataChildOrder. -
Replaced properties
RadialLayoutData.NodeComparablesandRadialLayoutData.OutEdgeComparerswith new, more powerfulChildOrderproperty. -
Removed the enum value
Radial.LayeringStrategy.UserDefined. Custom layers are now always used if defined viaRadialLayoutData.LayerIdsproperty. -
Radial.NodeInfohas been renamed toRadialLayoutNodePlacementResult. -
Removed the enum value
CenterNodesPolicy.Custom. Custom center nodes are now always used if defined viaRadialLayoutData.CenterNodesproperty.
Incompatible Behavior Changes
-
Custom layers are now always used if defined via
RadialLayoutData.LayerIdsproperty. -
The
RadialLayoutnow considers node labels by default. -
The
RadialLayoutnow places edge labels by default using a generic labeling algorithm. -
The default style of the
RadialLayout'sComponentLayoutis changed toPackedCircle. -
The
RadialLayoutNodePlacementResult.SectorStartproperty is now interpreted in clockwise direction. -
Custom center nodes are now always used if defined via
RadialLayoutData.CenterNodesproperty.
Radial Tree Layout
Incompatible API Changes
-
BalloonLayouthas been renamed toRadialTreeLayout, andBalloonLayoutDatahas been renamed toRadialTreeLayoutData. -
The following members have been removed from
BalloonLayout(nowRadialTreeLayout): The fieldgraph, theBalloonLayoutclass.NodeInfo, the methodsGetInfo,CalculateChildArrangement,CalculateAngles,DetermineRoot, andSortChildNodes, theFromSketchModeproperty (use the new enum valueFromSketchofChildOrderingPolicyinstead), and theInterleavedModeproperty (useRadialTreeLayoutData.InterleavedNodesinstead). -
The following members of
BalloonLayout(nowRadialTreeLayout) have been renamed:PreferredChildWedgehas been renamed toPreferredChildSectorAngle,PreferredRootWedgehas been renamed toPreferredRootSectorAngle, and theGetPreferredChildWedgemethod has been renamed toGetPreferredChildSectorAngle. -
The
InterleavedModeenum has been removed. -
The enum value
InterleavedMode.MarkedNodeshas been removed. To define specific parents for interleaved placed child nodes use theRadialTreeLayoutData.InterleavedNodesproperty. -
The enum value
RootNodePolicy.SelectedRoothas been removed. A custom root node is now always used if defined viaRadialTreeLayoutData.TreeRootproperty. -
The types of the following properties have been changed to double:
PreferredChildSectorAngle,PreferredRootSectorAngle,MinimumEdgeLength, andMinimumNodeDistance. -
Renamed
RootNodePolicytoRootSelectionPolicy. -
Removed
BalloonLayout.Comparer. UseRadialTreeLayoutData.ChildOrderinstead. -
Replaced layout data
OutEdgeComparerproperty withChildOrderDataChildOrder. -
Replaced
BalloonLayoutData.OutEdgeComparerproperty with new, more powerfulChildOrderproperty (class is renamed toRadialTreeLayoutData).
Incompatible Behavior Changes
- The compactness factor is now interpreted differently. Larger values result in more compact drawings. Its range has been changed to [0, 1].
-
The from-sketch option of
RadialTreeLayoutsorts like before but no longer takes precedence over orders specified with theRadialTreeLayoutDatapropertiesChildOrderorNodeTypes. -
The
RadialTreeLayoutnow considers node labels by default. -
The
RadialTreeLayoutnow places edge labels by default using an integrated labeling algorithm. -
The default style of the
RadialTreeLayout's (formerlyBalloonLayout's)ComponentLayoutis changed toPackedCircle.
Radial Group Layout
Incompatible API Changes
-
Renamed
CactusGroupLayout.GroupSizingPolicytoRadialGroupLayout.GroupSizePolicy. -
Replaced
CactusGroupLayout.NodeComparerproperty of typeIComparerwithRadialGroupLayoutData.ChildNodeComparisonof type Comparison function. -
The
CactusGroupLayouthas been renamed toRadialGroupLayout, and theCactusGroupLayoutDatahas been renamed toRadialGroupLayoutData. -
Property
PreferredRootWedgehas been renamed toPreferredRootSectorAngle.
Incompatible Behavior Changes
-
The
RadialGroupLayoutnow places edge labels by default using a generic labeling algorithm. -
The default of the
PreferredRootSectorAngleproperty has been changed from 180 to 360. -
The default style of the
RadialGroupLayout's (formerlyCactusGroupLayout's)ComponentLayoutis changed toPackedCircle.
Series-parallel Layout
Incompatible API Changes
-
Renamed the
SeriesParallelLayout.MinimumNodeToNodeDistanceproperty toMinimumNodeDistance. -
Renamed the
SeriesParallelLayout.MinimumEdgeToEdgeDistanceproperty toMinimumEdgeDistance. -
Removed
SeriesParallelLayout.DefaultOutEdgeComparer. UseSeriesParallelLayoutData.ChildOrderinstead. Also removedDefaultOutEdgeComparerclass. -
Replaced
SeriesParallelLayoutDataproperty .OutEdgeComparerswith new, more powerfulChildOrderproperty. -
The
GeneralGraphHandlingproperty was removed.SeriesParallelLayoutnow handles general graphs by default. -
The
DefaultPortAssignment.BorderGapToPortGapRatioproperty was renamed toBorderToPortGapRatio. -
Remove methods
GetPortBorderGapandGetPortDistanceDeltafrom theDefaultPortAssignmentclass. -
The
SeriesParallelLayout.NonSeriesParallelEdgeLabelingAlgorithmproperty has been renamed toNonSeriesParallelEdgeLabeling. -
Renamed
EdgeLayoutDescriptortoSeriesParallelLayoutEdgeDescriptor. -
Renamed
SeriesParallelLayout.DefaultEdgeLayoutDescriptortoDefaultEdgeDescriptor. -
Renamed
SeriesParallelLayout.EdgeLayoutDescriptorDpKeytoEdgeDescriptorDataKey. -
Renamed
SeriesParallelLayoutData.EdgeLayoutDescriptorstoEdgeDescriptors. -
Renamed the
SeriesParallelLayout.VerticalAlignmentproperty toParallelSubgraphAlignment. -
The combinations of the enums
ForkStyleandPortAssignmentModehave been integrated into thePortAssignmentModeenum, and theForkStyleenum has been removed. -
DefaultPortAssignment.ForkStylehas been removed. -
Renamed
IPortAssignmenttoISeriesParallelLayoutPortAssigner. -
Renamed
DefaultPortAssignmenttoSeriesParallelLayoutPortAssigner. -
Renamed
SeriesParallelLayout.PortAssignmentDpKeytoPortAssignerDataKey. -
Renamed
SeriesParallelLayoutData.PortAssignmentstoPortAssigners.
Incompatible Behavior Changes
-
SeriesParallelLayoutnow handles general graphs by default. -
The
SeriesParallelLayoutnow considers node labels by default. -
The
SeriesParallelLayoutnow places edge labels by default using an integrated labeling algorithm.
Compact Disk Layout
Incompatible Behavior Changes
-
The
CompactDiskLayoutnow considers node labels by default. -
The
CompactDiskLayoutnow places edge labels by default using a generic labeling algorithm.
Multi-page Layout
Incompatible API Changes
-
MultiPageLayoutResultis now an inner class ofMultiPageLayout. -
Renamed
GroupingPolicytoMultiPageGroupingPolicy. -
Renamed
Multipage.NodeTypetoMultiPageNodeTypeand its valueNormaltoMultiPageNodeType.Regular. -
Renamed
Multipage.EdgeTypetoMultiPageEdgeTypeand its valueNormaltoMultiPageEdgeType.Regular. -
The
EdgeBundleModesenum and the associated properties have been renamed toMultiEdgeConnectorPolicy. The enum values have been renamed toSeparate,ShareForSameDirectionandShare, respectively. The correspondingEdgeDataKeyhas been renamed toMultiEdgeConnectorIdDataKey(previouslyEdgeTypeDpKey). -
The
MultiPageLayout.CreateProxyReferenceNodesproperty has been renamed toUseProxyReferenceNodes. -
The
EdgeBundleModesenum has been renamed toMultiEdgeConnectorPolicyand converted from a flags enum to a regular enum. To manually select which multi-edges should be distinguished, use theMultiPageLayoutData.MultiEdgeConnectorIdsproperty. -
The properties
MultiPageLayout.EdgeBundleModeMask,MultiPageLayout.EdgeTypeDpKey, andMultiPageLayoutData.EdgeTypeshave been renamed toMultiPageLayout.MultiEdgeConnectorPolicy,MultiPageLayout.MultiEdgeConnectorIdDataKey, andMultiPageLayoutData.MultiEdgeConnectorIds. -
The public API of the
MultiPageLayoutclass has been changed.-
The
ILayoutCallbackinterface has been removed. The respectiveMultiPageLayout.LayoutCallbackproperty is now an Action delegate instead. Furthermore,MultiPageLayout.CalculateLayoutmethod has been removed, meaning the layout can and should only be started like all other algorithms (e.g. via theLayoutExecutororIGraph.ApplyLayout). -
The
IElementFactoryinterface and theDefaultElementFactoryclass have been removed. The replacement isMultiPageElementFactoryclass which can be accessed and modified usingMultiPageLayout.ElementFactoryproperty. -
The
MultiPageLayout.CreateElementFactorymethod has been removed. The factory can be get and set usingMultiPageLayout.ElementFactoryproperty. -
The
IElementInfoManagerinterface has been removed. -
The
LayoutContextclass of theMultiPageLayouthas been renamed toMultiPageLayoutContextand its properties Graph and Layout have been removed. -
The
INodeInfo,IEdgeInfo,INodeLabelInfo,IEdgeLabelInfointerfaces related toMultiPageLayouthave been removed. The data provided by them can now be retrieved via methods of theMultiPageLayoutContext(which is available also as property on theMultiPageLayoutResult). -
The callback methods
MultiPageLayout.RemoveConnectorPair,RouteRestoredEdgesandApplyIncrementalLayouthave been removed.
-
The
-
MultiPageLayoutResult.GetPageandPageCounthave been replaced byPageGraphs. -
MultiPageLayoutDatahandles the ID mapping automatically. Consequently, the explicit mappingsNodeIds,EdgeIds,NodeLabelIds, andEdgeLabelIdshave been removed. Original graph items can be obtained by callingMultiPageLayoutData.GetOriginalItem.
Partial Layout
Incompatible API Changes
-
Renamed
Partial.LayoutOrientationtoPartialLayoutOrientation. -
Removed the enum value
ComponentAssignmentStrategy.Customized. Custom components are now always used if defined withPartialLayoutData.ComponentIds,ClearAreaLayoutData.ComponentIdsorFillAreaLayoutData.ComponentIdsrespectively. -
The
PartialLayout.LayoutSubgraphmethod has been removed. -
The callback
ConfigureEdgeRoutermethod has been removed from classesPartialLayoutandClearAreaLayout. The router instance can be specified via thePartialLayout.EdgeRouterandClearAreaLayout.EdgeRouterproperties so that an additional configuration callback is not necessary.
Incompatible Behavior Changes
-
Custom components are now always used if defined with
PartialLayoutData.ComponentIds.
Tabular Layout
Incompatible API Changes
-
Replaced
TabularLayout.NodeComparerproperty of typeIComparerwithTabularLayoutData.FreeNodeComparisonof type Comparison function. -
Renamed
Tabular.LayoutPolicytoTabularLayoutMode. -
The
TabularLayoutclass now features its own data key (LayoutGridCellDescriptorResultDataKey) where it will publish cell IDs of nodes that it explicitly assigned to the cells. Previously it reused the common data keyPartitionGrid.PartitionCellIdDpKey. -
Renamed
NodeLayoutDescriptortoTabularLayoutNodeDescriptor. -
Renamed
TabularLayout.DefaultNodeLayoutDescriptortoDefaultNodeDescriptor. -
Renamed
TabularLayout.NodeLayoutDescriptorDpKeytoNodeDescriptorDataKey. -
Renamed
TabularLayoutData.NodeLayoutDescriptorstoNodeDescriptors.
Incompatible Behavior Changes
-
The
TabularLayoutnow considers node labels by default. -
The
TabularLayoutnow places edge labels by default using a generic labeling algorithm.
Component Layout
Incompatible API Changes
-
If
ComponentLayoutis used as a pre-processing step to apply a layout algorithm on multiple connected components, theStopDurationof that layout is divided appropriately over all components, instead of being applied once per component. -
The
IsolatedGroupComponentLayoutclass has been removed. -
Renamed
ComponentArrangementStyles.NonetoComponentArrangementStyle.KeepCenters. -
Removed the
ComponentArrangementproperty fromComponentLayout; use the newComponentArrangementStyle.Noneinstead to avoid arranging components. -
The
ComponentArrangementStylesenum has been renamed toComponentArrangementStyle, as it is no longer a Flags-Enum.-
Removed
ComponentArrangementStyles.Mask. -
Replaced
ComponentArrangementStyles.ModifierNoOverlapwithTryKeepCenters. -
Replaced
ComponentArrangementStyles.ModifierAsIswithComponentLayout.FromSketchMode.
-
Removed
-
Renamed
ComponentLayout.CalculateBoundstoCalculateComponentBounds. -
Renamed
ComponentLayout.SetOrigintoSetComponentLocation. -
Removed
ComponentLayout.ArrangeFieldsmethod. -
Simplified parameter lists of methods
ComponentLayout.ArrangeComponentsandComponentLayout.SetOriginto now accept instances of Component class.
Incompatible Behavior Changes
-
ComponentArrangementStyle.PackedCircleandComponentArrangementStyle.PackedRectanglenow consider the convex hulls of components to determine overlaps.
Tree Map Layout
Incompatible API Changes
-
Replaced
TreeMapLayout.NodeComparerproperty of typeIComparerwithTreeMapLayoutData.ChildNodeComparisonof type Comparison function. -
Removed the
NodeWeightComparerclass. -
Renamed
TilingPolicytoTilingStrategyandTreeMapLayout.TilingPolicytoTreeMapLayout.TilingStrategy.
Recursive Group Layout
Incompatible API Changes
-
RecursiveGroupLayout.NullLayoutis renamed toRecursiveGroupLayout.FixContentLayout. -
FixGroupLayoutStageis removed and its functionality is replaced byRecursiveGroupLayoutusingRecursiveGroupLayout.FixGroupLayoutfor all groups. -
The
RecursiveGroupLayoutclass now ignores empty group nodes by default (seeConsiderEmptyGroupsproperty). -
The signature of
IGroupBoundsCalculator.CalculateBoundsmethod was changed. The given children are now of typeIListEnumerable<Node>. -
The
GroupBoundsCalculatorimplementation now keeps the center of empty group nodes ifConsiderEmptyGroupsis enabled. -
Method
GroupBoundsCalculator.CalculateBoundsnow correctly considers the specified children. Previously, the given children were ignored and all graph elements were considered when calculating the group bounds.
Layout Grid
Incompatible API Changes
- Renamed all types, methods and properties containing "CellId" to "CellDescriptor".
-
Removed properties
OptimizeRowOrderandOptimizeColumnOrderfromPartitionGridDataclass. -
Removed the data key
PartitionGrid.PartitionGridDpKey. The keyLayoutGrid.LayoutGridCellDescriptorDataKeyis now the only data key which can be used to specify layout grids. -
Removed data key
RecursiveGroupLayout.GroupNodePartitionGridDpKey. The keyLayoutGrid.LayoutGridCellDescriptorDataKeyis now the only data key which can be used to specify layout grids. -
Renamed inset properties on classes
LayoutGridColumn(formerlyColumnDescriptor) andLayoutGridRow(formerlyRowDescriptor) to now be called padding (e.g.,LeftPaddinginstead ofLeftInset). -
The methods
PartitionGrid.PrepareOrientationChangeandPartitionGrid.FinalizeOrientationChangehave been removed. -
Removed properties
OriginalPositionandOriginalWidthfromLayoutGridColumnclass (formerlyColumnDescriptor). Use propertiesLayoutGridColumn.Position(formerlyComputedPosition) orLayoutGridColumn.Width(formerlyComputedWidth). -
Removed properties
OriginalPositionandOriginalHeightfromLayoutGridRowclass (formerlyRowDescriptor). Use propertiesLayoutGridRow.Position(formerlyComputedPosition) orLayoutGridRow.Height(formerlyComputedHeight). -
PartitionGridis renamed toLayoutGrid. This also affects the related classesPartitionGridData,GenericPartitionGridStage, andGenericPartitionGridStageData. -
Renamed
ColumnDescriptortoLayoutGridColumn&RowDescriptortoLayoutGridRow. -
Renamed
PartitionCellIdtoLayoutGridCellDescriptor. -
The
SwimlaneDescriptorclass has been removed from the API. UseLayoutGridclass (formerly calledPartitionGrid) instead, which is able to model one-dimensional and two-dimensional grids. -
The
PartitionGridLayoutStageclass has been removed. It is not necessary to manually add this stage, sinceHierarchicalLayoutcan supportLayoutGridout-of-the-box. -
Removed helper class
SwimlanesandLayout.SwimlaneRepresentative. -
Removed the
SwimlanesModeenum.
Other Layouts
Incompatible API Changes
-
Removed the
InterEdgeRoutingStyleenum. -
Renamed
CurveFittingLayoutStagetoCurveFittingStage. -
Renamed
FixNodeLayoutStagetoLayoutAnchoringStageandFixNodeLayoutDatatoLayoutAnchoringStageData. In addition:-
Renamed
FixPointPolicytoLayoutAnchoringPolicy. -
Renamed
FixNodeLayoutStage.FixedNodeDpKeytoNodeAnchoringPolicyDataKey. -
Renamed
CalculateFixPointtoCalculateAnchorPoint. -
Removed
FixNodeLayoutData.FixedNodes. Graph elements to anchor the graph on can be specified by setting the respectiveAnchoringPoliciesusingLayoutAnchoringStageData.
-
Renamed
Algorithms
Incompatible API Changes
-
Removed the Groups class. Use corresponding methods of
LayoutGraphAlgorithmsinstead. -
Renamed the Dendrogram class to
HierarchicalClusteringDendrogram. -
Renamed
ParallelEdges.FindParallelEdgestoLayoutGraphAlgorithms.FindMultiEdges. -
Renamed
Analysis.ComponenttoConnectedComponent. -
The
Algorithms.NodeAggregationclass has been renamed toLayoutGraphNodeAggregation, emphasizing that this class is intended for users working with theLayoutGraphAPI only.-
Furthermore, its member
NodeTypeDpKeyhas been removed. The replacement is keyLayoutKeys.NodeTypeDataKey. -
Also, its member
NodeCenterDpKeyhas been removed. Node centers are now directly read from theLayoutGraphinstance which must contain the coordinates of nodes if useful results should be generated.
-
Furthermore, its member
-
Removed the utility class
Sortingthat offered methods to get a sorted node array based on node degrees or another criterion. The functionality is written without this utility by first getting the array of nodes from the graph and then sorting it using standard built-in sorting utilities. -
Removed namespace
Algorithms.Util. The types are now in namespace Algorithms. -
Removed the
GraphConnectivityclass. Use corresponding methods ofLayoutGraphAlgorithmsinstead. -
Removed the
IndependentSetsclass. Use corresponding methods ofLayoutGraphAlgorithmsinstead. -
Removed the enum value
EuclideanSquaredfromDistanceMetricenum. Use enum value Euclidean instead which now calculates with squared values. -
Removed the
DistanceMetricenum ofKMeansClusteringclass. UseKMeansDistanceMetricenum instead. -
Removed the
AggregationPolicyenum ofNodeAggregationclass. UseAggregationPolicyenum instead. -
Removed the
ShortestPathsclass. Use corresponding methods ofLayoutGraphAlgorithmsclass instead (e.g.ShortestPath). - The Triangulator algorithm class has been removed.
-
Removed the
BfsDirectionenum. UseTraversalDirectioninstead. -
Removed the Intersections class. Use corresponding methods of
LayoutGraphAlgorithmsinstead. -
Removed the
IntersectionAlgorithmclass. Use corresponding methods ofLayoutGraphAlgorithmsinstead. -
Removed the Substructures class. Use corresponding methods of
LayoutGraphAlgorithmsinstead. -
Removed the Trees class. Use corresponding methods of
LayoutGraphAlgorithmsinstead. -
Removed the
NetworkFlowsclass. Use corresponding methods ofLayoutGraphAlgorithmsinstead (e.g.MaximumFlow). -
Removed the
NodeOrdersclass. Use corresponding methods ofLayoutGraphAlgorithmsinstead (e.g.TopologicalNodeOrder). -
Removed the Bipartitions class. Use corresponding methods of
LayoutGraphAlgorithmsinstead. -
Removed the Cycles class. Use corresponding methods of
LayoutGraphAlgorithmsinstead. -
Removed the
ParallelEdgesclass. Use corresponding methods ofLayoutGraphAlgorithmsinstead. -
Removed the Transitivity class. Use corresponding methods of
LayoutGraphAlgorithmsinstead. -
The
SpanningTreesclass has been removed. To compute a minimum spanning tree, useLayoutGraphAlgorithms.MinimumSpanningTreemethod. -
The
RankAssignmentsclass has been removed in favor of the singleLayoutGraphAlgorithms.SimplexRankAssignmentmethod that offers access to the rank assignment algorithm. -
The
GraphCheckerclass has been removed and most of its methods are now available onLayoutGraphAlgorithms. -
The
TreeAnalyzerclass has been removed. Use the more convenient and powerfulTreeAnalysisclass instead. -
Removed the Centrality class. Use corresponding methods of
LayoutGraphAlgorithmsinstead. -
Removed the Bfs class. Use
LayoutGraphAlgorithms.Bfsinstead. -
Removed the Dfs class. Use
LayoutGraphAlgorithms.Dfsinstead.
Analysis
Incompatible API Changes
-
Renamed
GraphStructureAnalyzer.HasMultipleEdgestoHasMultiEdges. -
Renamed
GraphStructureAnalyzer.GetMultipleEdgestoGetMultiEdges. -
Renamed
AggregationInfotoNodeAggregationInfo. -
Renamed
AggregationInfo.ParentAggregationtoParentNodeAggregation. -
Renamed
NodeAggregation.AggregationPolicytoNodeAggregationPolicy. -
Renamed
NodeAggregation.AggregationtoAggregationPolicy. -
Renamed
DistanceMetrictoKMeansDistanceMetric. -
The
NodeAggregation.NodeTypeHandlingproperty has been renamed toNodeTypePolicy. -
The
NodeTypeHandlingPolicyenum has been renamed toNodeTypePolicy. -
Renamed
Analysis.ComponenttoConnectedComponent. -
Renamed
SubstructuretoSubstructureItems. -
Replaced enum
Algorithms.LinkagewithHierarchicalClusteringLinkage.
Collections
Incompatible API Changes
-
The
YList.ElementAtmethod was removed. -
Renamed
ICursor.PrevtoICursor.Previous. -
Renamed
ListCell.SucctoListCell.Next. -
Renamed
ListCell.PredtoListCell.Previous. -
Removed the
IsEmptymethod fromYListclass. TestYList.Countproperty for 0 instead. -
Removed the methods
SuccCellandPredCellfromYListclass. Use new propertiesListCell.NextandListCell.Previousinstead. -
Removed the methods
CyclicSucc,CyclicPred,ContainsAllandRetainAllfromYListclass. -
Removed the methods Succ and Pred from
ListCellclass. Use new properties Next and Previous instead. -
Removed the Peek method from
YListclass. Use First property instead.
Geometry
Incompatible API Changes
-
The
GeomUtilitiesclass has been renamed toGeometryUtilities. - Implicit and explicit conversion operators between yFiles geometry types and the platform geometry types have been removed.
-
Renamed the
GeomUtilities.FindRayIntersectionmethod toGetSegmentRayIntersection. -
Renamed the
GeomUtilities.FindEllipseLineIntersectionmethod toGetEllipseLineIntersection. -
Moved
Geom.Collinearmethod toGeometryUtilitiesclass and renamed toAreCollinear. -
Moved
Geom.CalcConvexHullmethod toGeometryUtilitiesclass and renamed toGetConvexHull. -
Moved the
Geom.CalcIntersectionmethod toGeometryUtilitiesclass and renamed toGetLineLineIntersection. -
Removed the
Geom.Projectionmethod. UsePointD.GetProjectionOnSegmentmethod instead. -
Removed the methods
DistanceToLineSegmentof Geom class. UsePointD.DistanceToSegmentmethod instead. -
Moved
IPlaneObjectandLineSegmentto namespaceyWorks.Geometry. -
The copy constructors on the
RectD,PointD, andSizeDclasses were removed. Use theToRectD,ToPointD, orToSizeDmethods respectively instead. -
All
Intersectsmethods of theGeneralPathclass are now calledPathIntersects. -
The
MayIntersectClipmethod of theGeneralPathclass is now calledPathMayIntersectClip. -
All
AreaContainsmethods of theGeneralPathclass now have an optionalflatteningToleranceparameter. -
The
IsEmptymethod of theGeneralPathclass was removed. Use theIsVisiblemethod or theCountproperty, instead. -
The
GetBoundsoverload of theGeneralPathclass that returns the approximate bounds for BΓ©zier segments is now calledGetApproximateBounds. -
Renamed the
LineSegment.XOffsetproperty toYIntercept. -
Renamed the
LineSegment.IsInXIntervallmethod toLineSegment.IsInXIntervalandLineSegment.IsInYIntervallmethod toLineSegment.IsInYInterval. -
Made
LineSegmentclass sealed. -
The
IRectangleinterface no longer implementsIPoint. You can get the top-left corner of a rectangle with itsGetTopLeftmethod. For usages of the dynamic behavior ofIPoint, like in a customIPositionHandler, we recommend to let theIPositionHandlerimplementIPoint, too. -
The
IMutableRectangleinterface no longer implementsIMutablePoint. When working with theMutableRectangleclass, use itsLocationproperty to get a dynamic point of the location.
yFiles.NET 5.6.0.1
Bug Fixes
CanvasControl
-
Adding visuals without an explicit size directly to canvas object groups (instead of
VisualGroupinstances) now works consistently. Previously, they may sometimes never have appeared.
Graph
-
When using the
EdgeSegmentLabelModelandSmartEdgeLabelModelclasses, label placement at source and target nodes is now correct when an index is specified that is less than zero or greater than the number of bends of the edge. -
GraphClipboard'sParentNodeDetectionnow can useParentNodeDetectionModes.Noneas fallback if no valid parent is found for modesParentNodeDetectionModes.SelectionorParentNodeDetectionModes.PreviousParent. -
The
EdgeSegmentLabelModelclass now calculates valid label locations for paths with duplicate bends, i.e., paths in which two or more consecutive bends have the same location. -
The
EdgeSegmentLabelModelclass now calculates valid label locations for selfloop paths with one port at the side of the node. -
GraphClipboardnow properly respectsParentNodeDetectionmode for sub trees.
Styles
-
The intersection calculation for
RectangleNodeStylehas been corrected for some previously failed instances that caused edges to end in midair or disappear.
Interaction
-
Overloading
GraphInputMode.FindItemswithout the context parameter now finds the items correctly. -
Fixed a bug in
TextEditorInputModewhich prevented setting a customTextBoxvia property. -
TextEditorInputMode: The textbox now closes correctly when losing focus when theGraphControlis hosted directly in a Win32 window.
Folding
- Changes to ports of an edge whose source or target node is hidden are no longer reverted when the node is subsequently collapsing and expanding.
-
Fixed a bug that could lead to an exception when duplicating a port on the
GraphClipboardif it is duplicated.
Layout
-
The
TreeReductionStage,CircularLayout,EdgeBundlingStage, andRadialLayoutclasses no longer produce results with a lot of superfluous, collinear bends for bundled edges.
Hierarchical Layout
-
The
HierarchicLayoutclass no longer produces superfluous crossings for tabular group nodes with fixed children order. -
The
HierarchicalLayoutclass no longer produces superfluous crossings between backloops or same-layer edges in the first or last layer. -
The
HierarchicalLayoutclass no longer produces an error when using a non-zero grid distance in combination with incremental mode's exact coordinate hints. -
The
HierarchicalLayoutclass no longer assigns superfluous space to group nodes if there are grouped edges. -
The
HierarchicalLayoutclass no longer produces very long edge segments for some input graphs containing groups with node halos and polyline edge routing. -
The
HierarchicalLayoutclass no longer swaps the position of fixed nodes in incremental layout mode with user-specified sequence constraints. -
The
HierarchicalLayoutclass no longer throws an exception for graphs with bus structures if the algorithm runs in incremental mode and the group transposition feature is enabled. -
The
HierarchicalLayoutclass no longer produces superfluous crossings for some graphs with group nodes in incremental layout mode. -
The
HierarchicalLayoutnow properly handles self-loop edges when the edge is at a group node and furthermore edge/port grouped with the same ID on both sides. Previously, it was not routed correctly or that it was removed from theLayoutGraphinstance when running the layout algorithm directly on the graph instance without using a copy. -
The
HierarchicalLayoutclass no longer produces intertwined edge routes with many superfluous crossings and bends for some cases with sequence constraintsPlaceAtHeadorPlaceAtTail. The problem mainly occurred with graphs with groups orPartitionGridand incompatible sequence constraints. -
The
HierarchicLayoutclass no longer misplaces port labels at the connector nodes of integrated subcomponents. -
The
HierarchicLayoutalgorithm no longer requires a long runtime for some larger graphs with layering constraints when a maximum duration is specified. -
The
HierarchicLayoutclass no longer throws an exception for some invalid specifications of alternative group bounds in incremental layout mode. -
The
HierarchicLayoutalgorithm no longer requires a long runtime for some larger, grouped graphs with layering constraints and non-recursive layering. -
The
HierarchicLayoutclass no longer produces superfluous crossings for some edges with alternative paths that are incident to group nodes (seeHierarchicLayoutData.AlternativeEdgePaths).
Tree Layout
-
The
AspectRatioSubtreePlacerclass no longer ignores the specifiedAspectRatioSubtreePlacer.ChildAlignmentPolicyfor some specific setups (e.g., if all children are leaves and have the same size).
Edge Router
-
The
EdgeRouterclass no longer produces uncovered buses. Previously, there were some rare cases where the specified bus edges didn't constitute a bus. - When routing edges to and from fixed ports in the interior of group nodes, other nodes in the group are not ignored anymore, so that the edge does not overlap them if possible.
Labeling
-
The
GenericLabelingclass no longer produces bad label placements for edges with direct group content routing, i.e., edges that connect a group node with one of its descendants and are routed directly without leaving the group. -
The
GenericLabelingclass no longer produces non-optimal label placements for some rare setups of graphs with node halos.
Organic Layout
-
The
OrganicLayoutclass now supports specified minimum group node sizes with more feature combinations. Previously, the minimum group node size was sometimes violated.
Circular Layout
-
The
CircularLayoutclass no longer produces strange routes for some bundled edges.
Clear Area Layout
-
The
ClearAreaLayoutclass no longer produces violations of thePartitionGridif theClearAreaStrategyis set toLocalorLocalUniform.
Multi-page Layout
-
MultiPageLayoutalgorithm will adhere to page size specifications in rare cases that could previously cause the maximum page size to be exceeded.
Algorithms
-
The
Intersectionsclass does not disposeFilteredGraphWrapperinstances that it is given with no subgraph nodes or edges specified anymore. Previously, this caused the graph instance to become defunct, resulting in various operations running intonullfields and properties, generating exceptions that were non-trivial to understand.
yFiles.NET 5.6
This release brings exciting new major features, and many other minor new features, improvements, and bugfixes to all parts of the library.
If you are updating from an older version of yFiles.NET, have a look at the list of incompatible changes.
Major new features
- Constraint organic layout and more
-
The
OrganicLayoutclass now supports different types of constraints that restrict the placement of the graph's nodes that are specified with the newOrganicLayoutData.Constraintsproperty.In addition, organic layout now supports:
-
Integrated edge labeling, which can be enabled with the
OrganicLayout.IntegratedEdgeLabelingproperty -
Drawing edges such that they point to the main layout direction, specified with the new
OrganicLayoutData.EdgeOrientationsproperty -
Individual minimum lengths of edges that can be specified with the new
OrganicLayoutData.MinimumEdgeLengthsproperty.
-
Integrated edge labeling, which can be enabled with the
- Compact tabular layout
-
The
TabularLayoutclass now supports the calculation of node arrangements that lead to a low overall edge length. This feature can be enabled with the new propertyconsiderEdges. - New alignment layout stage
-
The new
AlignmentStageclass places the nodes of a given layout on automatically determined horizontal and/or vertical lines. This stage is particularly designed as a post-processing step that snaps suitable nodes to the same x- or y-coordinates to obtain a grid-like structure. When rearranging the initial layout, the stage moves the nodes as little as possible.The associated new
AlignmentStageDataclass allows specifying custom data considered during the layout calculation. - Improved group node style
-
The last major release brought a powerful
GroupNodeStyle, that got even more features and improvements in this release, namely:-
If
GroupNodeStyle's tab width is set to 0, the tab width does not reduce the corner radius of the style's outline anymore. However, it still forces the corner radius of the style's inner corners (i.e., the corners of the content area on the side of the style's tab) to 0. -
The new
GroupNodeStyle.MinimumContentAreaSizeproperty simplifies enforcing a minimum size for the content area a group node. -
GroupNodeStyleoffers the possibility to have its tab width grow (or shrink) depending on the preferred size of associated tab and tab background labels. -
The new
GroupNodeStyle.RenderTransparentContentAreaproperty controls whether a semi-transparent value for thecontentAreaFillproperty works as expected by showing what's behind the group node.
-
If
- Support for .NET 8.0
-
To facilitate using our library with .NET 8.0 and to improve compatibility a .NET 8.0 version of the library has been added.
New Features
Styles
-
Selection, focus, and highlight visualizations can now be easier customized with a node, edge,
label, or port style. These style instances can be set to the corresponding properties of the new
GraphSelectionIndicatorManager,GraphFocusIndicatorManager, andGraphHighlightIndicatorManagerclasses that can be set as corresponding managers on theGraphControl. This removes the need forNodeStyleDecorationInstaller, etc. -
To render items in a zoom-invariant fashion, their style can be wrapped in one of the new
IndicatorNodeStyleDecorator,IndicatorEdgeStyleDecorator,IndicatorLabelStyleDecorator, orIndicatorPortStyleDecoratorclasses. The main use case for these decorators is using item styles as selection, focus or highlight indicators.
Layout
-
The
OrganicLayoutclass now provides a feature that dynamically detects whether nodes already lie almost on a common line or circle and, if so, snaps the nodes to this line/circle. This new feature can be enabled with theChainRecognitionandCircleRecognitionproperties. -
PreferredPlacementDescriptorinstances can now be created fromILabelModelandILabelModelParameterinstances, respectively, via theirToDescriptorextension method. -
The
RadialLayoutclass now allows defining a custom order of child nodes around a local root node. The order can be individually specified for each node by using the newRadialLayoutData.OutEdgeComparersproperty. It is especially suitable for tree-like input graphs. For specifying a single global order for all nodes, for example, alphabetically, the newRadialLayoutData.NodeComparablesproperty is a more convenient option. -
The
CircularLayoutclass now offers the possibility to define star substructures. TheCircularLayout.StarSubstructureStyleproperty specifies the style of star substructures and theCircularLayout.StarSubstructureSizeproperty their minimum size (structures of smaller size are not handled as a star substructure). Furthermore, theCircularLayout.StarSubstructureTypeSeparationproperty specifies whether star substructures should be separated by the node type. -
The
CircularLayoutDataclass offers the newEdgeDirectednessproperty that influences the detection of star-substructures; seeCircularLayout.StarSubstructureStyle.
Improvements
Graph
-
EdgePathLabelModelandEdgeSegmentLabelModelhave been improved to provide better placements with edge-cases where the path is too short for the label or degenerates completely. -
GroupNodeLabelModelno longer triggers anArgumentExceptionwhen used with / set for a node that does not useGroupNodeStyle.GroupNodeLabelModelis still not intended to be used with nodes that do not useGroupNodeStyle. This restriction has been lifted to support workflows where the node style is set toGroupNodeStyleafter the label model is set toGroupNodeLabelModel. - Changing the height of an arc or bridge edge via its handle is now undoable.
View
-
The rendering order of nodes in the
GraphOverviewControlhas been improved to be more in sync with the rendering order in the correspondingGraphControl. -
GraphOverviewControlnow uses itsContentGroupinstead of theRootGroupto add the visualization of its graph content. This makes it easier to customize the overview for example by adding a background visual. -
The
LabelLayerPolicyproperty ofGraphModelManager, which defines whether labels should be rendered at their owner or in a separate layer, has been split into three separate propertiesNodeLabelLayerpolicy,EdgeLabelLayerPolicy, andPortLabelLayerPolicyto support different policies for node, edge, and port labels. -
The new
SelectionModelChangedevent ofGraphControlis raised when the model managing the selection is changed itself, not when the selected items change.
Styles
-
The
ArrowEdgeStyle's bounds now are tightly enclosing the rendered shape. Before they were too large. -
Bends in edges that use
ArcEdgeStyle,ArrowEdgeStyle, orBridgeEdgeStyleare no longer shown when selecting these edges. Additionally, marquee selection will not select these bends anymore even if they lie in the selection rectangle.
Interaction
-
The method
PortRelocationHandle.CreateDummyEdgeis now virtual and can be overridden. -
The protected property
DummySourceNodePorthas been added toCreateEdgeInputModeto simplify overridingCreateDummyEdge. -
The protected virtual method
CreateEdgeInputMode.CreateDummyBendhas been added that can be overridden to customize bends added during edge creation. -
The edge creation start gesture while dragging inside the source node can now be customized with
CreateEdgeInputMode.SourceNodeDraggingFinishedRecognizer. -
The
ItemDroppedInputMode.DragDroppedevent is now raised after the drop gesture has actually finished, in line with how similar events are raised elsewhere. -
The
MoveInputMode,MoveLabelInputMode, andHandleInputModesub-modes ofGraphEditorInputModeno longer have a pre-setSnapContext. Instead, they get theirSnapContextfrom theInputModeContext. That way, setting theSnapContextonGraphEditorInputModewill affect all sub-modes unless a customSnapContextis set to them. - The resize handle rendering order has been adapted to improve usability for small nodes.
GraphBuilder
-
The
GetUpdatedStylemethod of theNodeCreator/EdgeCreator/LabelCreatorclasses now uses the default style from the graph as fallback if the style provider is not set. -
The
LabelCreator.GetUpdatedLayoutParametermethod now uses the default layout parameter from the graph as fallback if the layout parameter provider is not set. -
The
NodeCreator,EdgeCreator, andLabelCreatorclasses can now be used without aGraphBuilder. This enables developers to apply styles and labels from a data object in cases where aGraphBuilderis not suitable for graph creation. -
A
NodeSourcenow allows for recursive definition of child nodes in a grouping hierarchy. The new methodsAddChildNodesSourceandCreateChildNodesSourceallow for defining a source to fetch child node items from a node data item. -
A
NodeSourcenow allows for implicit definition of parent nodes in a grouping hierarchy. The new methodsAddParentNodesSourceandCreateParentNodesSourceallow for defining a source to fetch a parent node item from a node data item.
GraphML
-
Improved GraphML serialization of
Color.Transparent.
Layout
-
If
AffectedLabelsare set inLabelingDatabut noDpKeyhas been provided for them, the key set asAffectedLabelsDpKeyon the labeling algorithm will be used. - For oriented rectangles the intersection test no longer allocates unnecessary memory and no longer creates unnecessary objects, which improves its allocation performance.
-
The
HierarchicLayoutclass now also considers layering constraints between elements of different grouping hierarchies if the recursive group layering is enabled (propertyHierarchicLayout.RecursiveGroupLayering). Previously, such constraints were ignored in that case. -
The
TreeLayoutclass now places the ports of edges incident to multi-parent nodes and with port constraints (excluding any-side constraints) at the nodes' border. Previously, unlike as for edges incident to other nodes, the edge ports where located at the nodes' center. -
The
RadialLayoutclass now supports node types. The types influence the ordering of nodes of the same circle such that nodes of the same type are preferably placed next to each other if this does not induce additional crossings or conflicts with other constraints. Node types can be defined via theRadialLayoutData.NodeTypesproperty.
Bugfixes
Graph
-
Fixed
NullReferenceExceptionthat occured when removing highlighted edges from their graph. - Fixed a bug where labels with an initial opening brace were not correctly serialized.
-
NinePositionsEdgeLabelModelcenter placements above and below the edge have been improved when the angle wasn't close to one of the two coordinate axes and the distance was non-zero. Previously, labels could seem to jump around when the path changed and weren't always close to the center of the path. -
GroupNodeLabelModelno longer stretches tab labels and tab background labels into the collapse/expand icon of the correspondingGroupNodeStyle. -
NavigationInputMode.ExpandGroup,EnterGroup, and theExpandGroupandEnterGroupcommands do not create empty undo units anymore if nothing has changed. -
NavigationInputMode.ExitGroupand theExitGroupcommand now create undo units if the bounds of the exited group node were adjusted. -
GroupingSupport's methodsEnlargeGroupNodeandEnlargeAllGroupNodesdo not create empty undo units anymore if nothing has changed.
View
-
CanvasControl: Animated viewport changes could lead to strange behavior if maximum or minimum zoom were set and violated by the viewport change. -
GroupNodeStyle's associatedINodeInsetsProvidernow correctly calculates insets for "small" nodes, i.e. nodes whose height (or width) is less than the style'sTabHeightproperty. - Fixed a bug which might have caused port selection visualizations to disappear in image export or printing under rare conditions.
Styles
-
With
ArcEdgeStyle, the 3 center positions of theNinePositionEdgeLabelModelare now in the right places. Previously they were often way off. -
GroupNodeStyle's collapse/expand icon can now be reliably hit in all cases. In rare cases, changing the value of one the properties that affect the icon's location were not taken into account for hit tests. -
GroupNodeStyleno longer renders a hairline in place of the tab when using aPenwithTabWidth0. -
ImageNodeStyleRenderer'sGetBoundsmethod now returns the actual image bounds instead of the node layout's bounds ifKeepAspectRatiois enabled. -
DefaultLabelStylenow adds ellipsis more reliably at the end when the text does not fit into the specified text wrapping shape. - Bezier edges no longer devolve into polyline paths under rare circumstances.
-
ArrowEdgeStylenow correctly considers its visibility with thicknesses greater than 13. -
MemoryImageNodeStyleandUriImageNodeStylenow properly respect theirKeepAspectRatioproperty for rendering, hit testing, and outline. -
The hit test for
PolylineEdgeStyle,ArcEdgeStyle,BezierEdgeStyle, andBridgeEdgeStylehas been fixed. Previously, the hit area was too large when using thicker pens.
Interaction
- The default visualization for selected ports is now displayed properly.
-
Fixed an issue where changing the
GraphControl.InputModewhile the context menu is open would lead to a crash. -
Fixed a bug in
HighlightIndicatorManagerthat could result in missing or surplus highlight visualizations when changing theGraphControl.HighlightIndicatorManager. - Self-loops no longer disappear when resizing nodes while orthogonal editing is enabled.
-
Fixed a bug in
MoveViewportInputModethat caused the inertia feature to mistakenly start moving the viewport after the mouse pointer has stopped before being released. -
Starting a
CanvasControl/GraphControlviewport animation now properly stops a runningMoveViewportInputModeinertia animation. - The direction of the first edge segment during orthogonal edge creation is now correctly determined when the source port candidate lies on the node border.
- Fixed a bug in some input modes which led to undefined behavior if the mode has been uninstalled in a handler for its own events.
GraphML
-
Fixed GraphML serialization and deserialization for certain configurations of
GroupNodeStyleandRectangleNodeStyle.
Animations
- Layout animation performance has been improved for edges with many bends.
Analysis
-
Fixed the issue of excessive memory consumption in the analysis algorithm
Pathswhen a large number of start and end nodes were set. -
The
ShortestPathsclass now correctly calculates the k-shortest paths of graphs (see methodsShortestPaths.KShortestPathsandShortestPaths.KShortestPathsCursor). Previously, in rare cases, the algorithm sometimes produces wrong results, i.e., returns paths that are not the shortest.
Layout
Hierarchic Layout
-
Rare combinations of
PortCandidatesinPortCandidateSetsno longer result in exceptions. -
For input graphs with a
PartitionGridstructure, theHierarchicLayoutclass now correctly considers the layering produced by theFromScratchLayererif it is already compatible with the specified grid structure.
Organic Layout
-
The
OrganicLayoutclass no longer produces edge overlaps when propertyChainRecognitionis enabled. - In rare cases fixed nodes could move when also a group node was fixed.
Radial Layout
-
The
RadialLayoutclass no longer throws an exception if the layout algorithm is executed too many times from the same instance.
Circular Layout
-
The
CircularLayoutclass no longer throws an exception if propertyStarSubstructureStyleis set toStarSubstructureStyle.Radialand the whole input graph is a star.
Clear Area Layout
-
The
ClearAreaLayoutclass no longer produces results where the specified area is not cleared for some input graphs when propertyClearAreaStrategyis set toPreserveShapesorPreserveShapesUniform.
Partial Layout
-
The
PartialLayoutclass does no longer yield different results in rare cases when the same instance is applied twice to the same input graph. -
The
PartialLayoutclass now correctly places disconnected components for cases where a layout orientation is specified, and the propertyComponentAssignmentStrategyis not Single. Previously, such components were sometimes placed far away from the remaining graph elements.
Edge Router
-
The
EdgeRouterclass does no longer yield different results in rare cases when the same instance is applied twice to the same input graph. -
The
EdgeRouterclass no longer produces self-crossing routes of edges with labels if propertyIntegratedEdgeLabelingis enabled. -
The
EdgeRouterclass no longer produces bad layout results for some scenarios with grouped edges and multiplePortCandidates. Previously, the algorithm selected any of them without considering the alternative options.
Orthogonal Layout
-
The
OrthogonalLayoutclass no longer throws an exception for some input graphs with tree substructures when theTreeStyleis set to a value different fromTreeLayoutStyle.None.
Demo Improvements
-
Fixed
BPMN-DIimport forLaneSetsin a Subprocess.
Incompatible Changes
Requirements
- yFiles does not support .NET Core 3.1 anymore. Minimum .NET version is 6.0 now. Minimum .NET Framework version still is 4.0. For the Layout only packages, the minimum requirements still are .NET Framework 3.5 and .NET Standard 2.0
- The Layout package, i.e. the package which provides only the layout and analysis library, now only provides libraries for .NET Framework 3.5 and .NET Standard 2.0. These are compatible with all supported .NET versions, though.
API
-
The property
GraphModelManager.LabelLayerPolicyhas been marked as deprecated and may be removed in future releases. Use the more specific propertiesNodeLabelLayerPolicy,EdgeLabelLayerPolicy, andPortLabelLayerPolicyinstead. -
HoveredItemChangedEventArgsis no longer a subclass of the unrelatedItemEventArgs. -
TreeNodeSourceandAdjacencyNodesSourceno longer inherit fromNodeSource. -
TreeBuilder.SetDataonly accepts aTreeNodesSourceand no longer aNodesSourceas a parameter.
Layout
-
CactusGroupLayout.DefaultNodeComparatorhas been renamed toDefaultNodeComparer.
Interaction
-
The
ItemDroppedInputMode.DragDroppedevent is now raised after the drop gesture has actually finished, in line with how similar events are raised elsewhere. -
Bends in edges that use
ArcEdgeStyle,ArrowEdgeStyle, orBridgeEdgeStyleare no longer shown when selecting these edges. Additionally, marquee selection will not select these bends anymore even if they lie in the selection rectangle. -
The
MoveInputMode,MoveLabelInputMode, andHandleInputModesub-modes ofGraphEditorInputModeno longer have a pre-setSnapContext. Instead, they take theSnapContextfrom theInputModeContext. That way, changing theSnapContextonGraphEditorInputModewill also affect the sub-modes.
Changes of Default Behavior
-
EdgePathLabelModelandEdgeSegmentLabelModelhave been modified to yield better results for some degenerate path cases. This leads to greater visual stability when the path is not long enough for the label or even completely invisible due to overlapping nodes. Technically, this can result in slightly different placements with the same parameter values in these edge-cases. -
Adding a label with
GroupNodeLabelModelto a node that does not useGroupNodeStyleor setting aGroupNodeLabelModel-created parameter for a label whose owner node does not useGroupNodeStyleno longer throws anArgumentExceptionclaiming "The parameter does not support this kind of label.". -
If
GroupNodeStyle's tab width is set to 0, the tab width does not reduce the corner radius of the style's outline anymore. However, it still forces the corner radius of the style's inner corners (i.e. the corners of the content area on the side of the style's tab) to 0.
Layout
-
The
EdgeRouterclass now ignores inner node labels by default, see propertyIgnoreInnerNodeLabels. Previously, this property was disabled by default.
yFiles.NET 5.5.0.1
Bugfixes
View
-
ViewportAnimationsnow are properly cleaned up onCancel. -
GroupNodeStyle's associatedINodeInsetsProvidernow correctly calculates insets for "small" nodes, i.e. nodes whose height (or width) is less than the style'sTabHeightproperty. -
Inertia in
MoveViewportInputModeno longer stops working randomly.
Graph
-
EdgePathLabelModel'sFindBestParametermethod now creates correct parameters for locations close to bends. -
NinePositionsEdgeLabelModelcenter placements above and below the edge have been improved when the angle wasn't close to one of the two coordinate axes and the distance was non-zero. Previously, labels could seem to jump around when the path changed and weren't always close to the center of the path. -
GroupNodeLabelModelno longer stretches tab labels and tab background labels into the collapse/expand icon of the correspondingGroupNodeStyle. -
NavigationInputMode.ExpandGroup,EnterGroup, and theExpandGroupandEnterGroupcommands do not create empty undo units anymore if nothing has changed. -
NavigationInputMode.ExitGroupand theExitGroupcommand now create undo units if the bounds of the exited group node were adjusted. -
GroupingSupport's methodsEnlargeGroupNodeandEnlargeAllGroupNodesdo not create empty undo units anymore if nothing has changed. -
EdgePathLabelModel,EdgeSegmentLabelModel, andSmartEdgeLabelModelFindBestParameterimplementations now create correct parameters for label boxes that overlap the edge's source or target node.
Interaction
-
Fixed an issue where changing the
GraphControl.InputModewhile the context menu is open would lead to a crash. -
Fixed a bug in
MoveViewportInputModethat caused the inertia feature to mistakenly start moving the viewport after the mouse or touch pointer has stopped before being released. -
Starting a
CanvasControl/GraphControlviewport animation now properly stops a runningMoveViewportInputModeinertia animation. - The direction of the first edge segment during orthogonal edge creation is now correctly determined when the source port candidate lies on the node border.
-
SmartEdgeLabelModelnow properly supports the original position snap line.
Styles
-
GroupNodeStyle's collapse/expand icon can now be reliably hit in all cases. In rare cases, changing the value of one the properties that affect the icon's location were not taken into account for hit tests. -
ShapeNodeStyleRenderernow always uses the protectedGetBrushandGetPenmethods for all shapes instead of falling back to the respective style properties for some shapes. -
ImageNodeStyleRenderer'sGetBoundsmethod now returns the actual image bounds instead of the node layout's bounds ifKeepAspectRatiois enabled. -
DefaultLabelStylenow adds ellipsis more reliably at the end when the text does not fit into the specified text wrapping shape.
Table
-
Fixed a bug in
StretchStripeLabelModelthat was causing incorrect handling of insets.
GraphML
-
Fixed an issue in
GraphMLIOHandler'sWriteEventswhere theDataWritingevent has been dispatched after the writing process instead of before. -
Fixed GraphML serialization and deserialization for certain
configurations of
GroupNodeStyleandRectangleNodeStyle.
GraphBuilder
-
Fixed a potential memory leak in
AdjacencyGraphBuilder. Some internal references were not cleaned up after items have been removed duringUpdateGraph. -
Fixed a bug in
GraphBuilderwhere updating an existing edge whose (new) source or target nodes cannot be resolved did not remove the edge from the graph. -
Fixed a potential memory leak in
GraphBuilder,AdjacencyGraphBuilder, andTreeBuilder. Some internal map entries for labels were not discarded after their owner nodes or edges were removed.
Layout
Edge Router
-
The
EdgeRouterclass no longer produces bad layout results for some scenarios with grouped edges and multiplePortCandidates. Previously, the algorithm selected any of them without considering the alternative options.
Circular Layout
-
A circular layout with
LayoutStyle.BccIsolatedcan no longer get into an infinite loop for inputs where a component consists only of articulation points.
Generic Labeling
-
The
GenericLabelingclass no longer produces bad label placements for edges with direct group content routing, i.e., edges that connect a group node with one of its descendants and are routed directly without leaving the group.
Hierarchical Layout
-
For input graphs with a
PartitionGridstructure, theHierarchicLayoutclass now correctly considers the layering produced by theFromScratchLayererif it is already compatible with the specified grid structure. -
The
HierarchicLayoutclass no longer throws an exception for some invalid specifications of alternative group bounds in incremental layout mode. -
The results of the
DefaultLayerSequencerclass are now deterministic by default, since it no longer aborts the calculation after 10s. For this, itsMaximumDurationvalue is now unrestricted.
Organic Layout
-
The
OrganicLayoutclass now satisfies propertyOrganicLayout.Deterministicfor more cases when the maximum duration is restricted. Note, however, that non-deterministic behavior is still possible when restricting the duration. -
The
OrganicLayoutclass no longer produces violations of the specified minimum node distance for separated radial substructures (see propertyStarSubstructureStyle.SeparatedRadial).
Orthogonal Layout
-
The
OrthogonalLayoutclass no longer generates overlaps between edge segments (of a parallel edge) and edge labels of other edges for some rare scenarios.
Single Cycle Layout
-
The
SingleCycleLayoutclass no longer produces violations of the specified minimum node distance.
Incompatible Changes
Minor
-
The value of the
DefaultLayerSequencer.MaximumDurationproperty is now unrestricted. Previously, it was restricted to 10 seconds. It is used by theHierarchicLayoutclass, which still adheres to its own maximum duration.
yFiles.NET 5.5
Major new features
- New styles for graph items
-
The
RectangleNodeStyleclass is a new node style that uses a rectangular shape whose corners are either rounded or cut diagonally. Its properties specify which corners get rounded, the corner radius, its fill, and its border stroke.The new
GroupNodeStyleclass is a node style primarily designed for collapsed and expanded group nodes. It draws a (rounded) rectangle with an optional tab or ribbon, and offers extensive configuration options for an optional icon, its various fills, and paddings.The new
ArrowNodeStyleclass draws a node as an arrow shape. The arrow can point in one of the four compass directions, and the arrow head slope, the shaft thickness, the fill, and the border stroke can be configured.Similarly, the new
ArrowEdgeStyleclass draws an edge as an arrow shape. This style always points from the source port to the target port, ignoring bends, and can be configured in the same way as the node style.The
DefaultLabelStyleclass now supports different common background shapes.The
ShapeNodeStyleclass now supports three additional shapes:Hexagon2(a six-sided polygon with tips at top and bottom),Star5Up(a five-pointed star with one tip pointing upwards), andPill(a stadium shape with the shorter sides rounded).Its new property
KeepIntrinsicAspectRatiodefines whether to keep the intrinsic aspect ratio of the shape.The new
BridgeEdgeStyleclass renders an edge as a 3-segment bridge with a given height between the edge's source and target port locations. This is especially useful to distinguish parallel multi-edges between the same pair of nodes. - Wrap text to shape
-
The text wrapping feature of
DefaultLabelStylenow wraps the text inside a given shape instead of just the rectangular label bounds. TheTextWrappingShapeenum provides the predefined shapes, and includes for example pill, ellipse, and hexagon. The newDefaultLabelStyle.TextWrappingPaddingproperty defines the padding between the chosen shape and the text.If the predefined shapes don't fit your needs, you can override the
DefaultLabelStyleRenderer.GetTextWrappingOutlinemethod to return any custom convex path asGeneralPathinstead. - Compact disk layout
-
The new
CompactDiskLayoutclass arranges a graph on a disk, packing the nodes as dense as possible. This layout is mostly suitable for graphs with small components whose loosely connected nodes should be grouped and packed in a small area.The associated new class
CompactDiskLayoutDataallows to specify custom data considered during the layout calculation. - Cactus group layout
-
The new
CactusGroupLayoutclass offers an alternative representation of hierarchically nested data. It places the children of a group along the groups circular border, resembling the structure of a cactus.The associated new class
CactusGroupLayoutDataallows to specify custom data considered during the layout calculation.The
LargeGraphsAggregationdemo has been modified to demonstrate that layout.
New Features
View
-
The new class
PortLocationModelParameterSerializerprovides static helper methods which can convert the built-inIPortLocationModelParameterimplementations into key-value pairs. It also supports creatingIPortLocationModelParameterinstances from these key-value pairs. -
Added the new property
AspectRatioto theGeneralPathNodeStylewhich defines the aspect ratio of the path. -
The new property
CanvasControl.MouseWheelZoomEventRecognizercan be used to set the modifier for distinguishing between mouse wheel scrolling and zooming. -
The new class
LabelModelParameterSerializerprovides static helper methods which can convert the built-inILabelModelParameterimplementations into key-value pairs. It also supports creatingILabelModelParameterinstances from these key-value pairs. -
The methods
GetNodesRevealedAfterExpand,GetEdgesChangedAfterExpand, andGetEdgesChangedAfterCollapsehave been added toFoldingManagerthat can be used to retrieve information about folding states that would be used when a specified group node would be expanded or collapsed.
Interaction
-
Handles can now react to mouse clicks and touch tap events. The
HandleClickmethod has been added to theIHandleinterface and is called whenHandleInputMode.ClickedRecognizerorHandleInputMode.ClickedRecognizerTouchwas triggered on a targeted handle. To customize the general handle click handling, theClickedevent can be listened to or the methodHandleInputMode.HandleClickcan be overridden.
Hierarchic Layout
-
The
HierarchicLayoutclass now supports so-called tabular group nodes. The children of such groups are arranged in a compact tabular fashion (i.e., like a single column table for layout orientation left-to-right). PropertyHierarchicLayoutData.TabularGroupsallows to mark groups as "tabular" and propertyHierarchicLayoutData.TabularGroupChildComparersto specify a custom order for the children.
Organic Layout
-
The
OrganicLayoutclass now offers the possibility to define a group substructure scope, see propertyGroupSubstructureScope. Group substructures that lie in the specified scope are treated as substructures in the layout process, i.e., the child nodes are arranged on a disk that is contained in the group node. -
In addition, the new property
ClusterAsGroupStructureAllowedallows to specify whether or not detected clusters (see propertyClusteringPolicy) are taken into account as group substructures. -
The
OrganicLayoutclass now offers two newChainSubstructureStylescalledDiskandDiskNestedthat lead to a compact disk-like layout for chains. -
The
OrganicLayoutclass now offers the possibility to define tree substructures (stars, chains, cycles and parallel structures are already supported). TheOrganicLayout.TreeSubstructureStyleproperty specifies the style of tree substructures and theOrganicLayout.TreeSubstructureSizeproperty specifies their minimum size (structures of smaller size are not handled as a tree substructure).
Radial Layout
-
The
RadialLayoutnow supports a new layering strategy that produces a circular dendrogram drawing. -
The
RadialLayoutnow supports two new edge routing styles, namely a radial polyline style and a curved style. The radial polyline style produces edge paths which consist of a series of straight and arc segments. The curved polyline style routes the edges as curved bezier paths. In the latter case, the edge paths can be also returned as control points that represent cubic bezier control points. -
The
RadialLayoutnow supports integrated node labeling i.e., the node labels are taken into consideration when determining the positions for the nodes of the graph and guarantees that labels will not overlap with other objects in the graph.
Balloon Layout
-
The
BalloonLayoutclass now supports node types. The types influence the ordering of child nodes and the subtrees rooted at them such that nodes of the same type are preferably placed next to each other. Node types are weaker than a user-specified custom order defined via a comparison function. Types can be defined via theBalloonLayoutData.NodeTypesproperty.
Circular Layout
-
The
CircularLayoutnow supports integrated node labeling i.e., the node labels are taken into consideration when determining the positions for the nodes of the graph and guarantees that labels will not overlap with other objects in the graph. -
The
CircularLayoutclass now supports curved edge routing within and between circles.
Analysis
-
Added the new
RankAssignmentanalysis algorithm class that solves the rank assignment problem on an acyclic graph using the simplex method. -
The new analysis class
Intersectionsfinds intersections and overlaps between graph items, featuring flexible configuration options to find only specific intersections. The respectiveyWorks.Layout.Intersectionsclass provides the functionality also for theLayoutGraphAPI, but offers less convenience.
Improvements
General
- yFiles now provides assemblies for .NET 7. The assemblies for .NET 5 have been removed.
- The documentation about configuring the item visualization has been improved. All styles and their configuration options are now described in a Developer's Guide chapter.
View
-
GraphClipboardnow respects thePasteDeltavalue when pasting items without owner (e.g. edges without selected source or target node). -
ModelManagerand its derived classesHighlightIndicatorManager,SelectionIndicatorManager, andFocusIndicatorManagernow haveInstallandUninstallmethods for properly allocating and freeing resources when setting or removing a manager to aCanvasControl. -
GraphModelManager: the propertiesNodeManager,EdgeManager,PortManager,EdgeLabelManager,NodeLabelManager,PortLabelManager, andProvideUserObjectOnMainCanvasObjecthave been made public.
Interaction
-
The
MoveViewportInputMode.Uninstallmethod is now virtual and can be overridden in derived classes. - The behavior of the inertia during touch inputs has been improved.
-
A
SizeConstraintProviderproperty was added toNodeReshapeHandleProviderandNodeReshapeHandlerHandlethat is queried during node resize gestures if no explicitMinimumSize,MaximumSizeorMinimumEnclosedAreais set. - Cursor property changes of active input modes are now immediately reflected in the application's mouse cursor. Previously, the application mouse cursor might have been updated only after the next mouse event.
-
The new
MoveInputMode.ValidBeginCursorproperty offers the possibility to use different cursors for signaling a valid position for beginning a move operation and actually moving items. -
The
ResizeStripeInputModeclass now offers the possibility to customize the cursors for signaling a valid position for beginning a resize operation as well as actually resizing columns or rows. -
The
ResizeStripeInputModeclass now offers properties to set an invalid end cursor for column and row resize. The invalid end cursor is shown during resize operations if the column or row in question cannot be resized to the current mouse position. -
The properties
ValidBeginRecognizerandValidBeginCursorhave been added toLassoSelectionInputMode,MarqueeSelectionInputMode, andMoveViewportInputMode. TheValidBeginRecognizercan be used to indicate whether the selection respectively move viewport gesture may begin in which case theValidBeginCursoris used. -
The property
MouseHoverInputMode.ValidHoverLocationCursorhas been added that is used when theValidHoverLocationHitTestablereturns true for a location. -
The property
ContextMenuInputMode.ValidMenuLocationCursorhas been added that is used when theValidMenuLocationHitTestablereturns true for a location. -
IReparentHandler.IsValidParentis now also called withnullas new parent during the drag gesture if no real parent node has been tested for the location. -
Keyboard navigation with
NavigationInputModenow always considers the current item to navigate from, regardless of the value of theNavigableItemsproperty. -
The
GraphClipboardnow raises the eventsElementsCutting,ElementsCopying,ElementsPasting, andElementsDuplicatingat the very beginning of theCut,Copy,Paste, andDuplicatemethods. -
GraphEditorInputModenow raises theSelectionGroupingandSelectionGroupedevents at the start and end of theGroupSelectionmethod. Similarly, theSelectionUngroupingandSelectionUngroupedevents are raised at the start and end ofUngroupSelectionmethod. -
The new
CreateEdgeInputMode.SourceNodeDraggingCursorproperty offers the possibility to customize the cursor that is shown while the mouse is still over the source node after starting the edge creation. -
Changes to
ItemHoverInputMode'sHoverCursorproperty now take effect immediately if the mouse pointer is currently hovering over an item. -
The
TextEditorInputModenow releases the mutex before dispatching theTextEditedevent. - The input modes do not perform hit tests upon automatically repeated key down events for modifier keys anymore.
Styles
-
Added a new property
KeepAspectRatiotoImageNodeStyleandMemoryImageNodeStyleto support keeping the image's aspect ration during resizes. -
Nodes rendered with the
ShapeNodeStylenow respect their actual outline shape when selected with theLassoSelectionInputMode. -
The icon for
IconLabelStyleis now rendered above the wrapped label style. This enables the icon to be rendered above the background provided byDefaultLabelStyle. -
DefaultLabelStyleRenderer.GetPreferredSizehas been made virtual. -
CollapsibleNodeStyleDecoratornow can handle rotated icons.
GraphBuilder
-
GraphBuildernow offers simplified access to a node/edge that has been created with a given ID or data item or accessing the data a node/edge has been created for via the new methodsGetNodeById,GetNodeForItem,GetDataItem(INode),GetEdgeById,GetEdgeForItem, andGetDataItem(IEdge). -
TreeBuilderandAdjacencyGraphBuildernow offer simplified access to a node that has been created with a given ID or data item or accessing the data a node/edge has been created for via the new methodsGetNodeById,GetNodeForItem,GetDataItem(INode), andGetDataItem(IEdge).
Hierarchic Layout
-
The
HierarchicLayoutclass now allows to combine theSimplexNodePlacer.StraightenEdgesandSimplexNodePlacer.BarycenterModeproperties. Previously, edge straightening was not supported in barycenter mode. -
The
HierarchicLayoutclass generates more compact results for some cases with edges between nodes of the same layer and integrated edge labeling where previously unnecessarily large distances to the label and edge were kept. -
The
HierarchicLayoutclass now places nodes without any edges as far left as possible without violating any constraints. That way they do not disturb the layout for the connected part of the graph. -
For input graphs with a
PartitionGridstructure, theHierarchicLayoutclass now correctly considers the layering produced by theFromScratchLayererif it is already compatible with the specified grid structure. Previously, for such cases, the algorithm may have calculated an entirely different layer assignment. -
The
HierarchicLayoutclass now considers the flow direction to place the ports of port groups when combined with direct group content edges. -
The
HierarchicLayoutclass comes with an improved support for subcomponent layouts (seeHierarchicLayoutData.Subcomponents). Defining subcomponents now works by assigning instances of the newSubcomponentDescriptorclass to nodes so that nodes mapped to the same descriptor instance form a component. Components that have inter-edges only to a single non-component node are now integrated directly at that node when using the new placement policiesSubcomponentPlacementPolicy.AlwaysIntegratedorSubcomponentPlacementPolicy.Automatic(and if the orientation of the sub-layout permits it). The overall results for such cases feature better edge routing quality and more compact drawings. -
The
HierarchicLayoutclass now also considers layering constraints between elements of different grouping hierarchies if the recursive group layering is enabled (propertyHierarchicLayout.RecursiveGroupLayering). Previously, such constraints were ignored in that case. -
The
HierarchicLayoutclass now uses a more compact layer placement for graphs with edge labels between layers. -
The
HierarchicLayoutclass now requires fewer bends for some inputs with grouped edges and port constraints or port candidates.
Organic Layout
-
The
OrganicLayoutclass now produces stable results for inputs with node labels and in deterministic mode, where it previously could generate a slightly different arrangement when applied twice with the same parameters. -
The
OrganicLayoutclass now allows to specify custom node clusters by setting theClusteringPolicyproperty toClusteringPolicy.UserDefined. The custom cluster IDs have to be specified by means of theOrganicLayoutData.ClusterIdsproperty.
Circular Layout
-
The
CircularLayoutclass now supports node types (seeCircularLayoutData.NodeTypes) also for the layout of the cycle partitions. Previously, the types had an influence only on the layout of a partition itself. If all nodes of a partition are of the same type, then the partition gets that type as well, so that partitions of same type are preferably placed next to each other. -
The
CircularLayoutclass has received a faster algorithm for calculating edge bundles.
Tree Layout
-
Root Alignment in
GenericTreeLayoutcan also factor in the port position to straighten out an edge. -
The
TreeLayoutclass now also supports integrated edge labeling for configurations that use aLayeredNodePlacer.
Edge Router
-
The
EdgeRouterclass now produces better results for some setups with monotonic path restrictions and edges with vertically/horizontally overlapping endpoints. -
The
EdgeRouterclass now tries to avoid routes that cross fixed external ports of other edges as well as fixed internal ports at group nodes of other edges. The new propertyPenaltySettings.PortCrossingPenaltyallows to specify the cost of such crossings. -
The
EdgeRouterclass now supports buses that include self-loops (see classBusDescriptor). Previously, self-loops were ignored.
Generic Labeling
- The generic labeling algorithm has an additional preset to avoid overlaps of labels and the partition grid.
Layout
- Improved the initialization time and memory consumption of layout animations.
-
The
TemporaryGroupNodeInsertionStageclass now automatically marks inserted group nodes with anIDataProviderregistered to the input graph with the keyInsertedGroupNodeDpKey. -
The
TemporaryGroupNodeInsertionStageclass now also supports specifying hierarchically nested temporary groups. Therefore, the newTemporaryGroupDescriptorclass has been added.
Analysis
-
The
TraversalDirectionenumeration used by theNeighborhoodandBfsalgorithms has been extended. The enum valueUndirectedhas been added that ignores the edge direction and corresponds semantically with the previous valueBoth. The semantic ofBothhas been adjusted to indeed return the union of theSuccessorand thePredecessorresults. To keep the default behavior of theNeighborhoodandBfsalgorithms, the default value of theirTraversalDirectionproperty has been changed fromBothtoUndirected. -
The
GraphStructureAnalyzerclass now supports operating on a subset of the graph. -
The new
SubgraphNodesandSubgraphEdgesproperties on theReachabilityclass allow to define a subset of nodes/edges the algorithm should operate on.
Bugfixes
View
-
Combining
HierarchicNestingPolicy.GroupNodes,LabelLayerPolicy.AtOwnerand undo no longer throws aNullReferenceException. -
Viewport animations no longer suddenly stop when the zoom level is near
CanvasControl.MinimumZoomorMaximumZoom. - Holding down a scrollbar button no longer scrolls beyond the scrollable area indicated by this scrollbar.
-
Changing the
ICanvasObject.Groupproperty no longer triggers unnecessary recreation of the visuals anymore. -
Fixed a bug in
SelectionIndicatorManagerthat didn't callRemoveSelectionwhen an item was deselected. -
Changing the
GraphControl.GraphModelManagerproperty no longer leaks memory in certain situations. -
A tooltip which is displayed at a given location by calling the
MouseHoverInputMode.Showmethod is no longer immediately hidden after each mouse move. It now respects theMouseHoverSizeproperty. -
Calling
IFoldingView.Collapseon a normal (i.e. non-group) node no longer creates anUndoUnitor a view state (which included an unexpected call toIFolderNodeConverter.InitializeFolderNodeeven though the result would never have been used). Now callingIFoldingView.Collapseon a normal node does nothing. - The automatic flipping behavior of labels now also works with projections that distort the labels.
-
Fixed potential text clipping issue with
HighDPIdisplays in conjunction with display scaling.
Graph
-
Fixed a bug in
FilteredGraphWrapper'sNodeRemovedevent where the provided old parent might have been present in the wrapped graph but not in the filtered graph. -
The
FilteredGraphWrapperclass now raises the correct events when filtering out port labels. Previously, the events contained incorrect owner information.
Interaction
-
After pasting, a closed group node within another closed group now stays closed. Previously, it
was open due to a bug in the
GraphClipboardclass. -
The
GraphEditorInputMode.AdjustContentRectmethod now only updates theCanvasControl.ContentRectproperty once per call. Previously there have been circumstances where the property would have been updated twice unnecessarily. -
The
TableEditorInputModeclass no longer changes theGraphControl.Selectionproperty unnecessarily when theGraphControl.Graphproperty is changed. -
An instance of the
HandleInputModeclass is no longercanceledif a handle is removed during its ownDragFinishedcall. This fixes some very rare exceptions under complicated circumstances. -
Multiple
DropInputModeinstances now correctly consider their respective priorities. -
UndoEngineno longer adds an empty undo unit for an aborted operation in certain rare cases. -
Setting the
CanvasControl.DoubleClickTimeto one second no longer causes an exception and setting it above one second now correctly considers the total duration, not just the fractional second part, inClickInputMode. -
The
QueryItemToolTipevent of theGraphEditorInputModeandGraphViewerInputModeis now only triggered once when hovering over a graph element instead of twice.
Styles
-
Cloning an
ITableinstance now properly clones all of the table's internal state. Previously, changing a cloned table's insets could result in the cloned table's stripes not updating their geometry. -
TableNodeStylenow allows the table background style to access the table node's tag. - The built-in styles with rounded corners now have the correct outline shape for all calculations.
- Edges with Bézier paths can now also be animated into non-Bézier paths.
-
Edge cropping now works as expected when using the
BezierEdgeStyleclass and the terminating nodes have styles that do not provide an outline in theirIShapeGeometryimplementation. -
DefaultLabelStylenow considers theNoWrapflag of theFormatFlagsof itsStringFormatproperty correctly. PreviouslyClipTextwas often used to determine the clip and wrap behavior. -
DefaultLabelStyle'sNormalizeBrushesnow properly handles rotated brushes. -
ImageIconnow considers the pixel size of the image for painting instead of the physical size. This means it is now consistent with its ownSizeproperty. -
Setting a new projection on
CanvasControlnow correctly keeps the viewport center the same.
Licensing
-
License validation no longer fails when dynamic assemblies are loaded or yFiles code is called
indirectly from dynamic methods. This could have resulted in licensing failures, e.g. when using yFiles in
ASP.NETweb services.
GraphML
-
The
keyparameter ofInputHandlerBase.SetValuemethod is now annotated correctly as nullable. The key may benullwhen the model item used as key is created after its data has been parsed.
GraphBuilder
-
Label bindings which don't provide label data (or
null) no longer add empty labels. Instead, no label will be added.
Designer
-
Setting the
GraphEditorInputModeorGraphViewerInputModein the Visual Studio Designer no longer causes an Exception in the designer.
Hierarchic Layout
-
The
SimplexNodePlacerclass used by theHierarchicLayoutno longer throws an error due to an internal overflow for very wide layouts. -
The
HierarchicLayoutclass now correctly considers the specified halos of group nodes when there is a partition grid defined. -
The
HierarchicLayoutclass no longer generates broken non-orthogonal edge segments of same-layer edges for some cases in conjunction with integrated edge labeling and edge labels placed at the ports. -
The
HierarchicLayoutclass now properly satisfiesPortCandidatesdefined for same-layer edges at nodes where other edges with (rather large) source/target port labels additionally exist. -
The
HierarchicLayoutclass now produces a correct edge grouping structure for short edges having the same source and target group ID. -
The
HierarchicLayoutclass no longer throws an exception when the edge-directedness feature (HierarchicLayoutData.EdgeDirectedness) is used in conjunction with enabled back-loop routing (HierarchicLayout.BackLoopRouting). -
The
HierarchicLayoutclass no longer creates unnecessary spacing between sub-components (seeHierarchicLayoutData.SubComponents) and other elements. This previously happened in some cases due to edge/node labels being present. In consequence, these cases are now more compact. -
The
HierarchicLayoutclass no longer produces overlaps between (large) external node labels and unrelated edges. -
The
HierarchicLayoutclass no longer produces overlaps between sub-component elements (seeHierarchicLayoutData.SubComponents) and edges that are not part of the component. -
The
HierarchicLayoutclass now correctly assigns ports to edges incident to groups if the uniform port assignment is enabled (see propertyHierarchicLayoutData.UniformPortAssignmentGroups) for some cases where it previously did not yield a uniform port distribution. -
The
HierarchicLayoutnow correctly considers thePreferredPlacementDescriptorsettings of an edge label when there are additionally edge groupings defined. Previously, it could, for example, happen that the edge label was placed on the wrong side of the edge. -
The
HierarchicLayoutclass now adheres more closely to its maximum duration and itsAbortHandler. -
The
HierarchicLayoutclass now considers thePortCandidatedirections correctly for layout orientations other thanTopToBottom. This also improves the optimization results withPortCandidateSets that allow multiple directions to connect to nodes.
Organic Layout
-
The
OrganicLayoutclass no longer produces broken routes of self-loops at group nodes if the Scope is not equal to All. -
The
OrganicLayoutclass now correctly considers the specifiedPartitionGridif substructure detection is enabled. Previously, the grid cell assignment of nodes belonging to a substructure has been ignored. -
The
OrganicLayoutclass now correctly considers fix-contents and fix-bounds groups (see enumGroupNodeMode) if the substructure detection is enabled. -
The
OrganicLayoutclass now correctly detects chain substructures if there are nodes of different types (OrganicLayoutData.NodeTypes).
Clear Area Layout
-
The
ClearAreaLayoutclass no longer produces results where the specified area is not cleared for some input graphs when propertyClearAreaStrategyis set toPreserveShapesorPreserveShapesUniform. -
The
ClearAreaLayoutclass now correctly considers the initial partition grid assignment of nodes.
Orthogonal Layout
-
The
OrthogonalLayoutclass no longer produces bad edge routes where the path is non-orthogonal and does not connect to the source node anymore for some rare cases containing parallel edges or chain substructures. -
The
OrthogonalLayoutclass now correctly considers the specified minimum group node sizes (seeGroupingKeys.MinimumNodeSizeDpKey). Previously, the minimum sizes were always enlarged by the groups' insets (seeGroupingKeys.GroupNodeInsetsDpKey). Actually, the minimum size should include the insets. -
The
OrthogonalLayoutclass now correctly handles input graphs with parallel edges if thePreferParallelRoutesproperty is enabled. Previously, such inputs have caused exceptions in some rare cases.
Edge Router
-
The
EdgeRouterclass now correctly interprets specified intermediate points (EdgeLayoutDescriptor.IntermediateRoutingPoints) as well as bus points (BusDescriptor.BusPoints) in the case when the algorithm runs inside an orientation layout with an orientation other thanTopToBottom. -
The
EdgeRouterclass now correctly considers the maximum duration and theAbortHandlerwhen the octilinear routing style is chosen. Previously, it could happen that the algorithm kept on running even though the time was up. -
The
EdgeRouterclass no longer throws an exception for some rare cases with collinear bends. -
The
EdgeRouterclass now correctly handles direct content edges that are incident to group nodes withPortCandidateSets.
Generic Labeling
-
The
GenericLabelingclass no longer produces superfluous label overlaps if one of itsRemoveNodeOverlapsorRemoveEdgeOverlapsproperties is enabled.
Layout
-
TableLayoutConfiguratornow considers the correct \OriginalPositionof the \RowDescriptorand \ColumnDescriptorwhen table insets are used. -
The
TableLayoutConfiguratorclass now treats tables without rows or columns as tables with exactly one row and column instead of throwing an exception. -
CurveRoutingStagenow correctly uses theMinimumNodeToEdgeDistancefrom the edge layout descriptor. -
EdgeRouternow indeed stops more reliably close to its maximum duration. This has been reported as improved before, but did not actually work. -
The
PolylineLayoutStageclass now correctly considers a registeredAbortHandlerinstance so that it is possible to terminate early. Previously, the stage ignored theAbortHandler. -
The
TabularLayoutclass now always uses the correct bounding box values for node labels that are considered. Previously, wrong label bounds could lead to unnecessarily large rows or columns. -
The
IsolatedGroupComponentLayoutclass no longer produces unnecessarily large group nodes if the specifiedGridSpacingis zero.
Incompatible Changes
API
-
Due to the new
InstallandUninstallmethods of theModelManagerclass, the following of its members have been changed:- The
CanvasControlconstructor parameter has been removed. Instead, you can call the newInstallmethod with theCanvasControlas parameter. Similarly, theCanvasControlconstructor parameters of the derived classes have been removed, too. - Its existing protected methods
InstallandUninstallhave been renamed toInstallItemandUninstallItem. - Its protected methods
AddandRemovehave been renamed toAddItemandRemoveItem.
- The
-
The optional
SelectionModelandModelparameters ofHighlightIndicatorManagerandSelectionIndicatorManagerhave been removed from the constructors, too. Instead, you can set the corresponding properties directly. -
The
NavigationInputMode.AdjustGroupNodeLocationmethod has now an additional parameterexpandedSizethat specifies the size of the group node when it is expanded. -
yWorks.Layout.LayoutMultiplexer: ThegetCoreLayoutmethod has been renamed toGetCoreLayout. -
yWorks.Layout.Multipage.MultiPageLayout: ThecalculateLayoutmethod has been renamed toCalculateLayout. -
yWorks.Layout.Organic.OrganicLayout: TheconfigureComponentLayoutmethod has been renamed toConfigureComponentLayout. -
The
LabelCreator.AddLabelmethod can returnnullif no label is added. -
The
LabelCreator.UpdateLabelmethod now returns a boolean value:trueif the label has been updated,falseif the label should be removed. -
The
IHandleinterface has a new methodHandleClick. This method must be implemented by custom handle implementations. -
The
WeakDictionaryMapper<K, V> now is constrained to reference types as keys. -
The
DataProviderAdapter.Definedmethod has been removed since it had no effect. -
The
NodeLabelingPolicyenum has been moved fromyWorks.Layout.TreetoyWorks.Layout. The reason is that the policy is now not only supported byBalloonLayoutbut also byCircularLayout,RadialLayoutandCactusGroupLayout. -
The type of the
EdgeCellInfo.CellSegmentInfosproperty has been changed fromYListto.CellSegmentInfo[] -
The
HierarchicLayoutData.SubComponentsproperty is replaced by the newHierarchicLayoutData.Subcomponentsproperty with a different signature. The new property uses instances of the newSubcomponentDescriptorclass to define subcomponents, and the layout algorithm responsible for a component is now specified via the newSubcomponentDescriptor.LayoutAlgorithmproperty. -
Similarly, the data provider keys
HierarchicLayout.SubComponentIdDpKeyandHierarchicLayout.SubComponentLayoutAlgorithmDpKeyare replaced by the new keyHierarchicLayout.SubcomponentDescriptorDpKeythat assigns instances of the newSubcomponentDescriptorclass to nodes. -
The
TemporaryGroupNodeInsertionData.Componentsproperty is replaced by the newTemporaryGroupsproperty of typeTemporaryGroupDescriptor, which now specifies groups and the applied recursive group layout algorithm. -
Similarly, the data provider key
TemporaryGroupNodeInsertionStage.ComponentLayoutAlgorithmDpKeywas removed and the name of the keyTemporaryGroupNodeInsertionStage.ComponentIdDpKeywas changed toTemporaryGroupDescriptorDpKey.
Styles
-
The property
DefaultLabelStyle.ClipTextdoes not influence the text wrapping behavior anymore but is only used to clip any text outside the label bounds.
Changes of Default Behavior
-
Licensing via the License Compiler now only works for .NET Framework. Previously,
using a
.licxfile in the project would still work with .NET 5 and earlier when building in Visual Studio (though not on the command line). The recommended way to embed theyFiles.NETlicense is adding the licenseXMLfile as an embedded resource, which will work reliably in all supported platforms and target frameworks. -
The semantic of the
TraversalDirection.Bothenumeration value used by theNeighborhoodandBfsalgorithms has been changed and does not ignore the direction anymore, but now returns a union of theSuccessorand thePredecessorresults instead. The old behavior can be restored by using the newTraversalDirection.Undirectedenum value. Consequently, the default value of theTraversalDirectionproperty of both theNeighborhoodand theBfsalgorithm has been changed fromBothtoUndirected. -
With the graph builder classes, label bindings which don't provide label data (or provide
null) no longer add empty labels. Instead, no label will be added. Similarly, for label sources, no label will be added for data items for which theLabelCreator.TextProviderreturnsnull. -
When starting to drag the handle of a selected item, the handle isn't replaced anymore by a new
handle instance provided for the selected item. Previously, this happened automatically, regardless of whether
necessary to support use cases where state changes should result in a different handle instance. Now, the
GraphEditorInputMode.RequeryHandlesmethod has to be called explicitly when changes are made that affect handles that are potentially already visible. Alternatively, a proxy implementation can be used that dynamically dispatches to new instances on its own when required. -
The
HandleInputModeclass doesn't initialize a handle drag as soon as the handle is pressed, anymore. Instead, it waits until theDraggedRecognizerorDraggedRecognizerTouchis triggered. When pressed, the mutex is already acquired, which discards other concurrent input modes. This can be turned off by setting theRequestMutexOnPressproperty tofalse. -
The lists returned by the
GraphPartition.GetCells,DynamicObstacleDecomposition.GetCellsandDynamicObstacleDecomposition.GetObstaclesmethods are no longer unmodifiable.
Deprecations
-
The
BevelNodeStyle,ShinyPlateNodeStyle, andPanelNodeStyleclasses and their renderers are now deprecated. Their appearance is rather outdated, and some of them are not very configurable. For group nodes, have a look at the newGroupNodeStyleclass.
Demo Improvements
Improvements
-
The
ZOrderdemo'sZOrderSupportdoes not use custom overrides ofGraphEditorInputMode,GraphModelManager, andGraphMLIOHandleranymore. That way, using theZOrderSupportclass in other applications that already use a customGraphEditorInputModeorGraphModelManageris now easier.
New Demos
-
The Arrow Node Style Demo shows the new
ArrowNodeStyleand its setting options. -
The Rectangle Node Style Demo shows the new
RectangleNodeStyleand its setting options. -
The Shape Node Style Demo shows the shapes that are available for the
ShapeNodeStyle. -
The Default Label Style Demo shows the background shapes that are now available for the
DefaultLabelStyle. - The Text Wrapping Demo shows the various options of the new text wrapping feature for labels.
- The Simple Arrow Demo shows how to implement a custom arrow.
- The Sankey demo shows how to visualize flow information in which the thickness of the edges is proportional to the flow quantity.
yFiles.NET 5.4.0.2
Improvements
Hierarchic Layout
-
The
HierarchicLayoutclass now also considers layering constraints between elements of different grouping hierarchies if the recursive group layering is enabled (propertyHierarchicLayout.RecursiveGroupLayering). Previously, such constraints were ignored in that case.
Bugfixes
Graph
-
Fixed a bug in
FilteredGraphWrapper'sNodeRemovedevent where the provided old parent might have been present in the wrapped graph but not in the filtered graph.
Interaction
-
After pasting, a closed group node within another closed group now stays closed. Previously, it
was open due to a bug in the
GraphClipboardclass.
View
-
Fixed a bug that resulted in a
NullReferenceExceptionwhenHierarchicNestingPolicy.GroupNodes,LabelLayerPolicy.AtOwnerand undo support were used together. -
Viewport animations no longer suddenly stop when the zoom level is near
CanvasControl.MinimumZoomorMaximumZoom.
Generic Labeling
-
The
GenericLabelingclass no longer produces superfluous label overlaps if one of itsRemoveNodeOverlapsorRemoveEdgeOverlapsproperties is enabled.
Orthogonal Layout
-
The
OrthogonalLayoutclass now correctly considers the specified minimum group node sizes (seeGroupingKeys.MinimumNodeSizeDpKey). Previously, the minimum sizes were always enlarged by the groups' insets (seeGroupingKeys.GroupNodeInsetsDpKey). Actually, the minimum size should include the insets.
Hierarchic Layout
-
The
SimplexNodePlacerclass used by theHierarchicLayoutno longer throws an error due to an internal overflow for very wide layouts.
Layout
-
The
TabularLayoutclass now always uses the correct bounding box values for node labels that are considered. Previously, wrong label bounds could lead to unnecessarily large rows or columns. -
The
IsolatedGroupComponentLayoutclass no longer produces unnecessarily large group nodes if the specifiedGridSpacingis zero.
yFiles.NET 5.4.0.1
Bugfixes
Interaction
-
TableEditorInputModeno longer changes theGraphControl'sSelectionproperty unnecessarily whenGraphControl'sGraphproperty is changed. -
HandleInputModeis no longer canceled if a handle is removed during its ownDragFinishedcall. This fixes some very rare exceptions under complicated circumstances. -
CreateEdgeInputModenow correctly toggles the direction of an orthogonal edge segment when the mouse is over a potential target.
Licensing
-
License validation no longer fails when dynamic assemblies are loaded or yFiles code is called
indirectly from dynamic methods. This could have resulted in licensing failures, e.g. when using yFiles in
ASP.NETweb services.
Graph
-
The
FilteredGraphWrapperclass now raises the correct events when filtering out port labels. Previously, the events contained incorrect owner information. -
The
CompositeUndoUnit.UndoNameproperty now indeed sets the undo name, not the redo name.
Styles
- The built-in styles with rounded corners now have the correct outline shape for all calculations.
- Edges with Bézier paths can now also be animated into non-Bézier paths.
-
Edge cropping now works as expected when using the
BezierEdgeStyleclass and the terminating nodes have styles that do not provide an outline in theirIShapeGeometryimplementation.
Hierarchic Layout
-
The
HierarchicLayoutclass now correctly considers the specified halos of group nodes when there is a partition grid defined. -
The
HierarchicLayoutclass no longer produces misplaced edge labels for some rare cases with grouped edges. -
The
HierarchicLayoutclass no longer generates broken non-orthogonal edge segments of same-layer edges for some cases in conjunction with integrated edge labeling and edge labels placed at the ports. -
The
HierarchicLayoutclass now correctly routes grouped edges, where previously there could be overlaps of nodes and edges in some rare cases. -
The
HierarchicLayoutclass now properly satisfiesPortCandidatesdefined for same-layer edges at nodes where other edges with (rather large) source/target port labels additionally exist. -
The
HierarchicLayoutclass now produces a correct edge grouping structure for short edges having the same source and target group ID. -
The
HierarchicLayoutclass no longer throws an exception when the edge-directedness feature (HierarchicLayoutData.EdgeDirectedness) is used in conjunction with enabled back-loop routing (HierarchicLayout.BackLoopRouting). -
The
HierarchicLayoutclass no longer creates unnecessary spacing between sub-components (seeHierarchicLayoutData.SubComponents) and other elements. This previously happened in some cases due to edge/node labels being present. In consequence, these cases are now more compact. -
The
HierarchicLayoutclass no longer produces overlaps between (large) external node labels and unrelated edges. -
The
HierarchicLayoutclass no longer produces overlaps between sub-component elements (seeHierarchicLayoutData.SubComponents) and edges that are not part of the component. -
The
HierarchicLayoutclass no longer produces superfluous port overlaps if there are edges with strong port constraints. -
The
HierarchicLayoutclass now correctly assigns ports to edges incident to groups if the uniform port assignment is enabled (see propertyHierarchicLayoutData.UniformPortAssignmentGroups) for some cases where it previously did not yield a uniform port distribution. -
The
HierarchicLayoutnow correctly considers thePreferredPlacementDescriptorsettings of an edge label when there are additionally edge groupings defined. Previously, it could, for example, happen that the edge label was placed on the wrong side of the edge.
Organic Layout
-
The
OrganicLayoutclass now correctly considers the specifiedPartitionGridif substructure detection is enabled. Previously, the grid cell assignment of nodes belonging to a substructure has been ignored. -
The
OrganicLayoutclass now produces correct results if auto-clustering is enabled (i.e., itsClusteringPolicyproperty is notNone) and theGroupNodeModeproperty is set toFixBoundsorFixContents. -
The
OrganicLayoutclass now correctly considers fix-contents and fix-bounds groups (see enumGroupNodeMode) if the substructure detection is enabled. -
The
OrganicLayoutclass now correctly handles nodes with several degree-one neighbors. Previously, such inputs could cause arrangement artifacts if theStarSubstructureStylewasNone. -
The
OrganicLayoutclass now correctly detects chain substructures if there are nodes of different types (OrganicLayoutData.NodeTypes).
Orthogonal Layout
-
The
OrthogonalLayoutclass now correctly handles input graphs with parallel edges if thePreferParallelRoutesproperty is enabled. Previously, such inputs have caused exceptions in some rare cases.
Circular Layout
-
The
CircularLayoutclass no longer crashes when applying it on a graph that contains parallel edges and both edge bundling is enabled and node types are defined. -
The
CircularLayoutclass no longer produces node overlaps if theSingleCycleLayout.MinimumNodeDistanceproperty is set to 0.
Clear Area Layout
-
The
ClearAreaLayoutclass now correctly considers the initial partition grid assignment of nodes. -
The
ClearAreaLayoutclass now correctly routes the edges if itsEdgeRoutingStrategyproperty is set toStraightline. Previously, in some rare cases, this setting could cause broken edge routes.
Partial Layout
-
The
PartialLayoutclass now correctly routes the edges if itsAllowMovingFixedElementsproperty is enabled. Previously, in some rare cases, this setting could cause broken edge routes.
Edge Router
-
The
EdgeRouterclass no longer produces artifacts if there are edges with curved routing style and labels, and the integrated edge labeling is disabled (see propertyEdgeRouter.IntegratedEdgeLabeling). -
The
EdgeRouterclass now correctly handles direct content edges that are incident to group nodes withPortCandidateSets.
Layout
-
TableLayoutConfiguratornow considers the correctOriginalPositions of theRowDescriptors andColumnDescriptors when table insets are used. -
TableLayoutConfiguratornow treats tables without rows or columns as tables with exactly one row and column instead of throwing an exception. -
EdgeRouternow correctly considers octilinear segments when using theSegmentsAsNeededorPathAsNeededRoutingPolicyenumeration value. -
The graph's
UndoEngineno longer gets corrupted after an exception in a layout algorithm has been raised and caught. -
The
TabularLayoutclass now correctly handles the case that the input graph contains only a single node. Previously, the node was not properly assigned to a partition cell and the partition cell row/column did not get correct values for its computed width, height and position.
View
-
Changing the
GraphControl.GraphModelManagerproperty no longer leaks memory in certain situations. -
The
CanvasControl.ZoomToAnimatedmethod now works correctly when aCanvasControl.Projectionis set. This has previously been reported as fixed, but was not. -
Fixed a bug in
ContextConfiguratorwhich resulted in misplaced decorations if the decorations were rendered in view coordinates and a scale value other than 1 was used. -
Fixed an
OutOfMemoryExceptionwhich could occur if nodes with a width or height < 1e-6 were rendererd.
yFiles.NET 5.4
This release brings a couple of exciting new major features and lots of other smaller new features, improvements, and bugfixes for all parts of the library.
Major New Features
- Smooth viewport animations
-
Many viewport transitions are now smoothly animated. This prominently includes scrolling and zooming with the mouse wheel, but also the various commands, such as zooming via a toolbar button, fitting the graph into the viewport, interacting with the overview, and many others. This can be turned off for individual interactions via the new
CanvasControl.AnimatedViewportChangesproperty, and customized with the new protected methodCanvasControl.GetViewportAnimationDuration. - Support Nodes of Different Types in Layout
-
Many of the yFiles layout styles now support node types. Typically, a layout places nodes of the same type closer together or in a similar way. The following layout styles support node types:
In the
HierarchicLayoutclass, types influence the ordering of nodes within their layers as a subordinate optimization criteria. More precisely, nodes of the same type are more likely to be placed next to each other if this does not violate other constraints.For the
TreeLayoutandClassicTreeLayoutclasses the types influence the ordering of child nodes and the subtrees rooted at them such that nodes of the same type are preferably placed next to each other. Node types are a weak criterion, i.e., if the ordering and placement is determined by other constraints, these are prioritized. Types can be defined via theTreeLayoutData.NodeTypesproperty.The
OrganicLayoutclass now allows to define node types via the newOrganicLayoutData.NodeTypesproperty . The types control the detection of substructures (e.g. stars, parallel structures). When types are defined, only nodes of the same type can form a substructure. For star-like and parallel substructures, it is also possible to have a single substructure with nodes of different types, see propertiesParallelSubstructureTypeSeparationandStarSubstructureTypeSeparation. The algorithm still tries to highlight the different types by choosing a suitable layout for these components (e.g., placing nodes of the same type closer together or on the same circle).The
OrthogonalLayoutclass now allows to define node types via the newOrthogonalLayoutData.NodeTypesproperty. The types control the detection of substructures, i.e., chains, cycles and trees. When types are defined, only nodes of the same type can form a substructure.The
CircularLayoutclass is now able to separate nodes that are on the same cycle with respect to their node type. For this, the newNodeTypeAwareSequencerclass can be set asNodeSequenceron theCircularLayout.SingleCycleLayout. Node types are specified via theCircularLayoutData.NodeTypesproperty.The
ComponentLayoutclass now supports node types. The types influence the arrangement and ordering of the the components such that components consisting mostly of nodes of the same type are put close to other components consisting of nodes of that type. Use theComponentLayoutData.NodeTypesproperty to define types.The node types feature is shown in the new
Node Types Demo. - Edge Routing Only if Needed
-
Optionally, the
EdgeRouter,ChannelEdgeRouterandBusRouterclasses now automatically determine whether or not a new path should be calculated for a certain edge. This is controlled via the new propertiesEdgeRouterEdgeLayoutDescriptor.RoutingPolicy,ChannelEdgeRouter.RoutingPolicyandBusRouterBusDescriptor.RoutingPolicy, respectively. The decision is based on the quality of the existing routes - edges with strict violations of the routing style or that intersect other elements will be selected for routing. Available options:-
RoutingPolicy.Always: A new route is calculated in any case. This was the previous behavior and remains the default. -
RoutingPolicy.PathAsNeeded: The algorithm determines whether a new route is needed. If an edge is selected, its current path is not considered when computing a new route. -
RoutingPolicy.SegmentsAsNeeded: The algorithm determines whether a new route is needed. If an edge is selected, its current path is preserved as much as possible. Only the required segments are changed. This is only supported by theEdgeRouterclass.
The new penalty property
PenaltySettings.SketchViolationPenaltysupported by theEdgeRouterclass defines the cost for a deviation from the original edge path if the new routing policy property is set toSegmentsAsNeeded. -
- Support for .NET 6.0
- To facilitate using our library with .NET 6.0 and to improve compatibility a .NET 6.0 version of the library has been added. Also, the demo and tutorial samples now automatically reference the highest .NET SDK which is available on the current machine.
New Features
View
-
The new
EdgePathPortLocationModelfor ports owned by edges can be used to define port locations as a ratio of the edge path length. This keeps the port location stable when bends are added onto the edge path, for example during orthogonal edge editing. -
Added a mechanism to support disposing and caching Visuals which are created by
IVisualCreator.CreateVisual:- Added methods
SetDisposeCallback,ChildVisualRemoved, andRegisterForChildrenIfNecessaryto support the registration of a callback for disposal. - Added the delegate
DisposeVisualCallbackfor this purpose.
- Added methods
Analysis
-
The new
TreeAnalysisalgorithm offers a convenient way of analyzing tree structures and querying tree-related properties (e.g. leaf nodes, parent-child relations and more).
GraphBuilder
-
The graph and tree builders now support bindings for bend locations. This is implemented by new
bend-related members of the
EdgeCreatorclass.
Algorithms
-
The new
ParallelEdges.FindParallelEdgesmethod allows to find all sets of parallel edges contained in a given graph or incident to a specific node.
Layout
-
The new
GenericLayoutDataclass is a generic implementation ofLayoutDatathat allows to pass arbitrary data to layout stages. As a consequence, theLayoutData.Apply,ItemCollection.ProvideMapperandItemMapping.ProvideMappermethods were removed. -
The new
SelfLoopRouterDataclass specifies custom data for theSelfLoopRouterclass. In more details, it allows to define which self-loop edges should be routed and which should keep their current path. -
The new
PortPlacementStageDataclass specifies custom data for thePortPlacementStageclass. In more details, it allows to define port candidates, port constraints, and node port candidate sets which are then considered by that layout stage. -
The
SubgraphLayoutclass now allows to define which edges must be included or excluded in the subgraph. Previously, only nodes could be specified. The newSubgraphLayoutDataclass offers theSubgraphNodesandSubgraphEdgesproperties to conveniently define the nodes and edges that should form the subgraph the core layout runs on. -
The
OrganicLayoutclass offers the newClusteringPolicyproperty, which allows to specify the clustering algorithm that is applied to the input graph. Three clustering algorithms are available: Louvain modularity, edge betweenness, and label propagation. Previously, the node clustering was always based on edge betweenness. By default, clustering is disabled. -
The
PartialLayoutclass offers a new propertyMoveFixedElementsto allow moving fixed elements. This often yields a better layout quality even though the preservation of the mental map declines because the fixed elements may change their position. -
The
OrganicLayoutandClassicOrganicLayoutclasses support the new scopeMainlySubsetGeometric. In addition to the actual affected nodes, this scope may to some degree move nodes that are geometrically close to an affected node. The existing scopeMainlySubsetis similar, but it does determine the closeness of other nodes by using the graph structure instead of the current geometry (i.e. location).
New Demos
-
The new
LensInputModedemo shows how to create anInputModeto show a magnifying glass effect on the canvas. -
The new
Neo4JIntegrationDemoshows how theNeo4J.Driverlibrary can be included in yFiles applications to create diagrams fromNeo4Jdatabases. -
The new
NodeTypesdemo shows how to use the node type support of the yFiles layout algorithms.
Improvements
Interaction
-
The new
HandleInputMode.QueryClosestHandleevent can be used to provide the closest handle for a certain query location. -
Tooltip contents can now be provided asynchronously. As an alternative to setting the tooltip
content directly, the
ToolTipQueryEventArgsclass also accepts aTaskthat provides the tooltip content asynchronously. -
The
HandleInputMode.BeginDraggingmethod now returns aTaskwhich indicates whether the drag of a handle has been finished or canceled. -
Validation of the text of edited labels can now be provided asynchronously. The new
LabelTextValidationEventArgs.ValidatedTextproperty accepts aTaskthat provides the validated text asynchronously. - Changing the selection state of a large number of elements is now faster.
-
The
OrthogonalEdgeEditingContext.CreateOrthogonalEdgeDragHandlermethod now accepts anIPortOwnerinstead of only anINodeas dragged item. This can be used for custom edge drag handling that should support orthogonal edge editing. -
The
ItemCopiedEventArgsclass now guarantees that itsOriginalandCopyproperties are notnull.
Graph
-
The
DefaultFolderNodeConverterandFoldingEdgeConverterBaseclasses now havePortLabelStyleandPortLabelLayoutParameterproperties to control the style and label layout parameter of copied port labels. -
The new
NodeInsetsProviderclass is anINodeInsetsProviderthat returns the same insets for each node.
View
-
The
CanvasControl.EnsureVisible,CanvasControl.FitContent, andGraphControl.FitGraphBoundsmethods now return aTaskthat completes when the view port adjustment has been finished. -
The new
InstallandUninstallmethods of theGraphModelManagerclass simplify exchanging the manager used by aGraphControl. They are called when setting/removing aGraphModelManagerasGraphControl.GraphModelManagerand should also be called when combining aGraphModelManagerwith aCanvasControl. -
The new
Animations.CreateDelaymethod creates an animation that does nothing. This is especially useful in combination with other animations that run in parallel or in sequence to create complex multi-sequence animations. The accompanying extension methodCreateDelayedAnimationfor theIAnimationinterface delays the provided animation. -
The
CanvasControl.EnsureVisiblemethod now respects margins defined by theCanvasControl.ContentMarginsproperty . Ensure visible is called for example by keyboard navigation,. -
The
Zoomcommand now respects margins defined by theCanvasControl.ContentMarginsproperty when executed with a rectangle as parameter. -
The
ZoomToCurrentItemCommandnow respects the margins defined in theCanvasControl.ContentMarginsproperty. -
Setting the various descriptor properties of the
GraphModelManagerclass no longer causes updates for every installed item if the descriptor hasn't actually changed. -
The
OverviewInputModenow renders its handle on top of the viewport rectangle instead of below it. -
The
ViewportLimiter.LimitViewportmethod now has an optional parameter that enforces theViewportLimitingPolicy.Strictpolicy. -
The
CanvasControl.EnsureVisiblemethod now has an additional parameter to specify insets to keep around what to make visible in the viewport. -
The
CanvasControl.EnsureVisiblemethod now has an additional overload to make a set of points visible in the viewport. This is mainly useful when using a Projection and trying to make something visible that is not a rectangle in world coordinates. -
All of the following features no longer block user interaction: the viewport animations for
CanvasControl.EnsureVisible, executing scroll commands when theCanvasControl.AnimateScrollCommandsproperty is enabled, and executingGraphControl.ZoomToCurrentItemCommand. -
The
CanvasControl.FitContentandGraphControl.FitGraphBoundsmethods now have an optional parameter that allows changing the viewport in an animated fashion. -
TextVisualhas a new propertyMaximumSize. Text will be clipped if a value is set and the text is larger than that value. -
The
PixelImageExporter'sSmoothingMode,TextRenderingHint, andInterpolationModeproperties now default to high quality rendering.
GraphBuilder
-
The
GraphBuilder,TreeBuilder, andAdjacencyGraphBuilderclasses no longer throw Exceptions during calls toUpdateGraphwhen the graph was modified.
Hierarchic Layout
-
The
HierarchicLayoutclass now has an improved strategy for choosing the port candidates for same-layer edges with multiple available candidates. Previously, the chosen candidate may have led to superfluous back-loops. -
The
HierarchicLayoutclass now generates shorter paths for edges that cross borders ofPartitionGridcolumns in cases where there are no other obvious constraints that require the edge to be longer. This holds for the default vertical layout orientation; for a horizontal orientation, edges that cross borders of rows are affected by this improvement. -
The
HierarchicLayoutclass now considers the edge direction when choosing a port candidate for edges with multiple candidates. This new strategy often leads to less bends.
Organic Layout
-
For the substructures in the
OrganicLayoutit is now possible to explicitly specify whether structures are allowed to be nested or not. Previously, substructures were allowed to be nested by default. New styles were added while the old styles now will not generated nested structures anymore.- Star structures offer the new styles
StarSubstructureStyle.RadialNestedandStarSubstructureStyle.CircularNested. ChainSubstructureStyle.RectangularNestedandChainSubstructureStyle.StraightLineNestedare the new styles for nested chains.CycleSubstructureStyle.CircularNestedis the new style for nested cycles.
- Star structures offer the new styles
-
The
OrganicLayoutclass now offers the possibility to define the minimum sizes of substructures (stars, chains, cycles and parallel structures). Structures of smaller size are not handled as a substructure. For each type of structure a new property was added:OrganicLayout.StarSubstructureSize,OrganicLayout.ChainSubstructureSize,OrganicLayout.CycleSubstructureSizeandOrganicLayout.ParallelSubstructureSize. -
With substructures, the
OrganicLayoutclass now often produces more compact results and comes with an improved placement of degree-one nodes. -
When specified for the
OrganicLayoutclass, the scopeMainlySubsetnow works together with more of its other features and constraints, and has a larger impact. For example, it previously had very little or no effect when a partition grid or an output restriction was defined.
Edge Routing
-
When the
EdgeRouterclass runs with a highly restricted maximum duration or is aborted via theAbortHandlerclass, i.e., the router operates in the fastest possible mode, the calculated edge routes now are of higher quality. The quality improvements mainly affect cases with fixed port locations. -
The
EdgeRouterclass now allows to explicitly define the costs for different types of edge crossings. The new propertiesPenaltySettings.AdjacentEdgeCrossingPenaltyandPenaltySettings.SelfCrossingPenaltyrelate to crossings between two adjacent edges and crossings between two line segments that belong to the same edge, respectively. Previously, all types of crossings were covered by the existingEdgeCrossingPenaltyproperty.- By default, now, crossings of adjacent edges are more expensive than normal ones and self-crossings are the most expensive.
- Furthermore, the default values of the
EdgeLengthPenaltyandGroupNodeCrossingPenaltyproperties were increased to obtain more balanced results.
-
The
EdgeRouterclass now produces more suitable routes for edges with octilinear routing style. Previously, the diagonal segments where often omitted after/before an edge's first/last segment.
Layout
-
The new
BalloonLayoutData.OutEdgeComparerproperty specifies a comparison function used to sort a nodes' outgoing edges. -
The new
LayoutGraphAdapter.OriginalTagDpKeydata provider key provides access to the object stored in thetagproperty of the original graph item from within custom layout code. -
The quality of the curved edge routing was improved with respect to various aspects and such that
it yields aesthetically nicer curves. To further configure the curve routing, the following settings were added.
CurveShortcuts: if shortcuts are allowed, curves can become smoother and more direct but may violate other constraints (e.g. edge-edge distance). Available forHierarchicLayout(RoutingStyle.CurveShortcuts),EdgeRouter(EdgeLayoutDescriptor.CurveShortcuts) andCurveRoutingStage(CurveEdgeLayoutDescriptor.CurveShortcuts).CurveUTurnSymmetry: allows to specify the symmetry preference for u-turns (180 degree turns) of curved routes. The default is zero so that results are equal to previous results. Available forHierarchicLayout(RoutingStyle.CurveUTurnSymmetry),EdgeRouter(EdgeLayoutDescriptor.CurveUTurnSymmetry) andCurveRoutingStage(CurveEdgeLayoutDescriptor.CurveUTurnSymmetry).
-
The
HierarchicLayout,EdgeRouter, andCurveRoutingStageclasses now avoid unnecessary, consecutive Bezier segments for modeling larger straight-line parts of an edge path. The resulting reduced bend count improves the user experience when working with theBezierEdgeStyle. -
The
ClassicTreeLayoutclass now features propertiesMinimumFirstSegmentLengthandMinimumLastSegmentLengththat allow to specify the minimum first and last segment length for the orthogonal routing style. -
The new
ParallelEdgeRouterData.RoutedParallelEdgesproperty returns which edges theParallelEdgeRouterclass routed and thus were hidden during the core layout. This can be useful if parallel, non-leading edges need further handling, e.g., for placing their labels.
Demo Improvements
-
The demo and tutorial projects for .
NETFramework have been updated to target the most recent .NETFrameworkSDK. -
The .
NETdemos and tutorials now automatically reference the newest .NETSDKwhich is available on the machine they are installed on.
Bugfixes
View
- The mouse event coordinates are no longer quantized to very large steps if a projection is used and the viewport is zoomed in afterwards.
-
The clipboard now doesn't copy labels or ports if they are not selected and their owner's
IClipboardHelperforbids copying the owner. -
The
ZoomToCurrentItemcommand no longer moves the current item outside the visible area in rare cases. This was caused by a problem in theViewportLimiterclass. -
Callbacks registered for removed visuals on the
CanvasObjecttree now reliably run after the visual is indeed no longer visible. -
Callbacks registered with the
IRenderContext.SetDisposeCallbackmethod now are reliably called, even when a canvas object has been explicitly removed. -
The
CanvasControl.EnsureVisiblemethod no longer ignores the limited viewport size in certain cases. -
The Scale is honored for the
VisibilityThresholdof theGridVisual. -
EmfImageExporternow properly extends the background brush into the margins.
Interaction
-
When expanding a closed group, the parent groups of the expanded group no longer become
unnecessarily large. The incorrect behavior could be observed only under certain conditions and was caused by a bug
in the
NavigationInputModeclass. - Auto dragging was not stopped in certain cases.
-
The text box shown by the
TextEditorInputModeclass is now correctly placed if theTextBoxPlacementPolicy.MoveTextBoxis set and a projection is used. -
Fixed editing self-loops with
PolylineEdgeStyleand orthogonal edge editing enabled.
Graph
-
The
ITable.StripeChangedevent now reports the correct parent when re-parenting will be undone or redone. -
A label with
EdgeSegmentLabelModelorEdgePathLabelModelnow moves steadily when the segment to which it belongs moves. -
The
FilteredGraphWrapperclass now dispatchesParentChangedevents in the correct order after predicate changes. -
All
SetFactorymethods of theNode-,Edge-,Label-,Port-, andBendDecoratorclasses now respect theNullIsFallbackproperty.
Styles
-
The parameter of type
IShapeGeometryof theDefaultEdgePathCropper.IsInsideandGetIntersectionmethods is now nullable.
Geometry
-
The
Areaproperty of an emptyRectDinstance (includingRectD.Empty) is now always zero, and no longer a negative value.
Hierarchic Layout
-
The
HierarchicLayoutclass no longer produces an infinite looping issue in the incremental layout mode for some input graphs with layer constraints that specify that a node should be placed in the topmost/bottommost layer. -
The
HierarchicLayoutclass no longer produces unnecessary edge crossings between self-loop edges at the same node in cases where a larger number of self-loops exist at a node. -
The
HierarchicLayoutclass no longer ignores edges connected to group nodes when the group node contains a bus structure (seeHierarchicLayoutData.Buses) and no other elements. Such edges were previously actually removed from the layout graph such that other stages (e.g. theComponentLayout) could have failed with an exception. -
The
HierarchicLayoutclass no longer occasionally throws an exception when enablingHierarchicLayout.CompactGroupsand in conjunction with layering constraints and/or a group node marked as incremental. -
The
HierarchicLayoutclass does no longer violate the specified minimum length for edges incident to group nodes. -
The sequencing phase of the
HierarchicLayoutclass is now faster for large graphs with sequence constraints and non-incremental layout mode.
Edge Routing
-
The
BusRouterclass now produces more suitable edge routes for rare cases that were caused by an unsuitable bus placement. -
The
EdgeRouterclass now uses the given ports for edges of a bus with fixed edges. -
The
EdgeRouterclass now correctly considers edges incident to a fixed inner port of a group node when the routing algorithm has restricted maximum duration. Previously, this setup sometimes led to strange edge routes with many superfluous bends. -
The
CurveRoutingStageclass now correctly considers the minimum distance to nodes specified as value of theCurveEdgeLayoutDescriptor.MinimumNodeToEdgeDistanceproperty. Previously, the curves could violate the distance and get too close to nodes. -
The
EdgeRouterclass no longer contains edges with self-crossings in some rare cases where it previously failed to eliminate them. -
The
EdgeRouterandCurveRoutingStageclasses no longer change the path of unaffected (fixed) edges when theCreateControlPointsproperty of their associatedEdgeLayoutDescriptorinstance (CurveEdgeLayoutDescriptorrespectively) is enabled. -
The
EdgeRouterclass now correctly supports the use case that a subset of edges is routed with the curved routing style while another subset is routed with another routing style and different settings on the associated individualEdgeLayoutDescriptorinstances. Previously, with some edges being curved, the settings of the other edges got lost and the default settings were used. -
The
OrthogonalSegmentDistributionStageclass does no longer crash when receiving input graphs with a very large edge count (greater than approximately 22000). Note that theChannelEdgeRouterclass is affected too, as the stage is by default called from within the router. -
The
EdgeRouterclass no longer has a problem that appeared with a bus containing affected as well as non-affected (fixed) edges at the same time. Previously, this could trigger an Exception or lead to the incorrect behavior that an actually affected other edge was not routed. -
The
EdgeRouterclass no longer occasionally throws an exception if the input contains bus edges defined viaBusDescriptor. -
The
BusRouterclass no longer fails to generate connected buses for cases with fixed and incremental edges on the same bus. Previously it sometimes generated a disjoint bus even though the bus IDs were equal. -
The
BusRouterclass no longer ignores edges that should be routed when a they are on a bus with fixed edges (seeBusDescriptor.Fixedproperty) and when they share both source and target port with a fixed edge. -
The
EdgeRouterclass no longer has a problem that occasionally resulted in bad edge routing artifacts if edge grouping is enabled and non-affected edges are grouped at both end points.*. -
The
ParallelEdgeRouterclass no longer throws an exception if the input has both a large number of parallel edges and a leading edge with ports on the node border. -
The
EdgeRouterclass no longer occasionally throws an exception if the input contains bus edges (defined viaBusDescriptor). -
The
OrganicEdgeRouter.KeepExistingBendsproperty now correctly obeys its definition and actually keeps the absolute coordinates of the existing bends.
Layout
-
The comparison delegates defined in
TreeLayoutData.OutEdgeComparersandSeriesParallelLayoutData.OutEdgeComparersno longer receivenullelements during runtime. -
The
SimpleProfitModelclass now computes meaningful different profits based on thePreferredPlacementDescriptorfor candidates that belong to aSliderEdgeLabelLayoutModelor aDiscreteEdgeLabelLayoutModel. Previously, the computed profit was equal for all candidates. -
Fixed a bug in
LayoutExecutorwhich caused port labels not to be placed in their calculated position after a layout animation. -
The
LayoutExecutorclass now uses the correct target bounds when a projection is set on theGraphControl. -
The
OrganicLayoutclass no longer throws an exception when running it on a graph with a partition grid, group nodes and such that the IDs of the group nodes (see provider keyGroupingKeys.NodeIdDpKey) are defined using a provider that cannot handlenullas argument to its get method. -
The
OrganicLayoutandClassicOrganicLayoutclasses no longer cause undesired layout side effects when a mapper is registered with keyRecursiveGroupLayout.GroupNodeLayoutDpKeyor when data is provided via theRecursiveGroupLayoutData.GroupNodeLayoutsproperty. Previously, the layout algorithms registered there could be applied to nodes that should actually be kept fix by the organic layout. -
The
HierarchicLayoutclass now correctly considers the specified port groups for edges (seeHierarchicLayoutData.SourcePortGroupIds). Previously, such groups were not always considered properly if there are either critical edges or propertySimplexNodePlacer.StraightenEdgesis enabled. -
The
HierarchicLayoutclass now correctly handles grouped input graphs if the node compaction is enabled (see propertySimplexNodePlacer.NodeCompaction). Previously, the algorithm sometimes produced less compact results for such inputs. -
The
HierarchicLayoutclass now adheres more closely to its maximum duration and itsAbortHandlerwhen propertySimplexNodePlacer.BendReductionis enabled. -
The
HierarchicLayoutnow considers thePortCandidatedirections correctly for layout orientations other thanTopToBottom. This also improves the optimization results withPortCandidateSetsthat allow multiple directions to connect to nodes. -
The
HierarchicLayoutnow correctly processes input graphs with sub-components (HierarchicLayoutData.SubComponents) and curved edge routing style. Previously, such setups may have a caused an exception. -
The
HierarchicLayoutclass now correctly considers the specified critical edge priorities (seeHierarchicLayoutData.CriticalEdgePriorities) if the input graph contains grouped edges. -
The
CircularLayoutclass no longer produces node label overlaps when itsPlaceChildrenOnCommonRadiusproperty is disabled. -
The
EdgeRouterclass no longer generates unnecessary detours in the routes when it is configured withMonotonicPathRestriction.Both. -
The
ClearAreaLayoutclass now correctly considers node labels. Previously, there could be results where node labels intersected with the specified area to be cleared. -
The
HierarchicLayoutclass now adheres more closely to its maximum duration and itsAbortHandler. -
The
ParallelEdgeRouterclass now produces correct parallel routes if itsJoinEndsproperty is enabled. -
Improved the reaction time of the
EdgeRouterclass when theMaximumDurationis exceeded or the algorithm should stop due toAbortHandlerfor some cases where previously the search for a path kept on running for a long time. -
The
RadialLayoutclass is now much faster if the input graph is a very large tree structure. -
The
OrganicLayoutandClassicOrganicLayoutclasses no longer produce an internal integer overflow that may lead to an early exit and, thus, poor layout results for very large input graphs. -
The
ClearAreaLayoutclass no longer throws an exception for some scenarios where the same algorithm instance was first applied to a graph withPartitionGridand later to a graph without grid. -
The
ClearAreaLayoutandFillAreaLayoutclasses no longer throw an exception for some input graphs with edge labels if propertyConsiderEdgeLabelsis enabled. -
The
TreeLayoutclass now correctly handles trees with group nodes. Previously, it sometimes produced overlapping elements and halo violations for such inputs. -
Curved edge routes generated by
HierarchicLayout,EdgeRouterandCurveRoutingStageno longer contain a self-crossing for edges that connect to a group node and where the connection styleCurveConnectionStyle.Organicis specified. -
The curved edge routes produced by
HierarchicLayout,EdgeRouterorCurveRoutingStageno longer violate the minimum node-edge distance or intersect the node. Intersections could previously happen especially when the specified node-edge distance was zero. -
The
PartialLayoutclass now transfers the value of itsPartialLayout.MaximumDurationproperty to the internally used edge routing algorithm. This means that when the partial layout has a restricted running time, the routing part will be restricted, too. Previously, the duration of the edge routing was unrestricted. Note that if the router instance is user-specified, this instance will not get a maximum duration. -
The element processing order in the
BendConverterlayout stage is now deterministic. The previous non-deterministic order of inserting and removing elements could lead to non-deterministic behavior for consecutive layout calculations. -
The
FamilyTreeLayoutclass now properly handles the case that the family tree contains cycles, e.g., due to a family founded by parent and (step-)child. Previously, it sometimes produced a stack overflow or non-orthogonal routes for such an input. -
The
HierarchicLayoutclass now correctly considers input graphs with group nodes and aPartitionGrid. Previously, in some rare cases, such inputs may have caused overlapping group nodes. -
A potential
NullReferenceExceptionfor theOrganicLayoutwith very small graphs has been fixed.
Incompatible Changes
-
The out-of-support .
NETCore 3.0SDKis no longer supported by yFiles. The minimum supported .NETCore version now is .NETCore 3.1. -
The protected method
HandleInputMode.IsHoveringhas been removed. To customize what handle should be used for a certain query location, the newHandleInputMode.QueryClosestHandleevent can be used. -
The methods
MouseHoverInputMode.OnShowandShownow return aTaskthat completes when the tooltip content is available and provides whether the tooltip is actually displayed. -
The
HandleInputMode.BeginDraggingmethod now returns aTask. -
The
GraphEditorInputMode.OnLabelTextEditedmethod now returns aTaskthat completes when the text validation is done and provides whether the validation succeeded or was canceled. -
The protected method
GraphEditorInputMode.EditLabelCorenow returns a Task instead of a Future. -
The new
GenericLayoutDataclass is a generic implementation ofLayoutDatathat allows to pass arbitrary data to layout stages. As a consequence, theLayoutData.Apply,ItemCollection.ProvideMapperandItemMapping.ProvideMappermethods were removed. -
The
PolylineEdgeRouterDataclass has been renamed toEdgeRouterDatato match the name of the layout algorithm it supports. -
The methods
CanvasControl.FitContentandGraphControl.FitGraphBoundsnow have an optional parameter that allows changing the viewport in an animated fashion. -
The
CanvasControl.Projectionproperty no longer accepts transforms with a non-zero translation component. -
The
CanvasControl.FitContentViewMarginsproperty has been renamed toContentMargins. Accordingly, theOnFitContentViewMarginsChangedmethod and theFitContentViewMarginsChangedevent have been renamed toOnContentMarginsChangedandContentMarginsChanged, respectively. -
The
ViewportLimiter.LimitViewportmethod now has an optional parameter that enforces theViewportLimitingPolicy.Strictpolicy. -
The
CanvasControl.EnsureVisiblemethod now has an additional parameterviewportInsets. -
The
TextEditorInputMode.GetTextBoxBoundsmethod has been removed. -
The
PixelImageExporter'sSmoothingMode,TextRenderingHint, andInterpolationModeproperties now default to high quality rendering. -
The return value of the
MouseHoverInputMode.GetToolTipContentmethod has been changed toobjectto accommodate being able to return aTaskas well.<string>
Behavior
-
The provider returned by
EdgeReconnectionPortCandidateProviders.AllNodeAndEdgeCandidatesnow doesn't return port candidates of the reconnected edge itself anymore as this lead to an unstable reconnection behavior. -
The
FitContentandFitGraphBoundscommands now change the viewport in an animated fashion. -
Zooming with the mouse wheel to the center of the viewport by using
CanvasControl'sCenterZoomRecognizerno longer uses theIncreaseZoomandDecreaseZoomcommands. - During animated viewport transitions, for performance reasons, mouse events are not redispatched, anymore, except for the last frame of the animation.
-
The
OrganicLayoutsubstructure stylesStarSubstructureStyle.Radial,StarSubstructureStyle.Circular,ChainSubstructureStyle.Rectangular,ChainSubstructureStyle.StraightLineandCycleSubstructureStyle.Circulardo no longer allow that the detected substructures are nested inside other substructures. To get the old behavior and allow nesting, new style values were added (e.g.StarSubstructureStyle.RadialNested). -
The following behavior change applies to class
HierarchicLayoutwith polyline edge routing style: the default value of propertyyWorks.Layout.Hierarchic.EdgeLayoutDescriptor.MinimumSlopewas changed from 0.3 to 0.2 which makes the sloped segments less steep and the overall results more compact. -
In organic layout, the way edge grouping influences the layout of certain substructures has
changed. Structures are not anymore split-up into several ones when edges of nodes in the structure have different
group IDs. Now, the new node types can be used to split-up structures (see
OrganicLayoutData.NodeTypes). If a structure contains different edge groups, the grouping is properly considered and may influence the sorting of elements within the structure. Affected substructure styles areStarSubstructureStyle.SeparatedRadial,ParallelSubstructureStyle.Radial,ParallelSubstructureStyle.StraightLineandParallelSubstructureStyle.Rectangular. -
As the
OrganicEdgeRouter.KeepExistingBendsproperty now correctly obeys its definition and actually keeps the absolute coordinates of the existing bends, a new property to get the old behavior was introduced:OrganicEdgeRouter.ConsiderExistingBends. Existing bends are considered, but their absolute coordinates are not kept. -
The default value of the
ClassicTreeLayout.MinimumLayerDistanceproperty was changed from 40.0 to 20.0 and the default value of theClassicTreeLayout.BusAlignmentproperty was changed from 0.3 to 0.5. In addition, the newMinimumFirstSegmentLengthandMinimumLastSegmentLengthproperties may lead to different results compared to previous versions. Setting both properties to zero will neutralize their influence on the result. -
For the
DefaultNodePlacerclass that is used by theTreeLayout, the default values of theHorizontalDistanceandVerticalDistanceproperties were changed from 40.0 to 20.0, and the default values of theMinimumFirstSegmentLengthandMinimumLastSegmentLengthproperties were changed from 0.0 to 20.0. -
For the
CompactNodePlacerclass that is used by theTreeLayout, the default values of theHorizontalDistanceandVerticalDistanceproperties were changed from 40.0 to 20.0, and the default values of theMinimumFirstSegmentLengthandMinimumLastSegmentLengthproperties were changed from 10.0 to 20.0. -
The default value of the
LayeredNodePlacer.BusAlignmentproperty was changed from 0.3 to 0.5.
Deprecations
-
The
CanvasControl.AnimateScrollCommandsproperty has been deprecated in favor of the newAnimatedViewportChangesproperty, which offers more control over viewport animations, not just the scroll commands. -
The
OrganicLayout.ClusterNodesproperty is now deprecated. It is replaced by the newOrganicLayout.ClusteringPolicyproperty. To disable clustering specifyClusteringPolicy.None. To enable it and use the same algorithm as before, specifyClusteringPolicy.EdgeBetweenness.
yFiles.NET 5.3.0.2
Improvements
- A dedicated .NET 5.0 version of the library now is bundled to facilitate the use with NuGet and to improve compatibility with certain obfuscation tools. A .NET 5.0 version of the samples is provided, too.
View
-
The
ViewportLimiterclass now always centers the viewport if itsHonorBothDimensionsproperty is disabled.
Layout
-
The
HierarchicLayoutclass now has an improved strategy for choosing the port candidates for same-layer edges with multiple available candidates. Previously, the chosen candidate may have led to superfluous back-loops.
Algorithms
-
The
LabelPropagationClusteringalgorithm now produces normalized, continuous clustering IDs. In other words, for example, if it finds 5 clusters, they get IDs from 0 to 4. Previously, the range of IDs may have contained holes. If initial label values are provided, this normalization is omitted.
Bugfixes
View
-
The clipboard now doesn't copy labels or ports if they are not selected and their owner's
IClipboardHelperforbids copying the owner. -
The
CanvasControl.ZoomToAnimatedmethod now works correctly when a Projection is used. -
Fixed a bug in
CanvasControl.FitContentandGraphControl.FitGraphBoundswhich causedFitContentViewMarginsbeing incorrectly applied in case aProjectionhas been set. -
The following issues of the
ZoomToCurrentItemCommandhave been corrected:- The item is now longer placed slightly out of center if scrollbars appear during the operation.
- If the current item is too large to fit the viewport at zoom 1, the command now zooms out.
-
Fixed incorrect margins on an
OverviewGraphControlwith aProjectionset. -
Fixed a bug which caused the
Zoomcommand to disrespect theViewportLimiterif executed with a rectangle as parameter. -
Fixed
ViewportLimitersometimes leading to jumping viewports and not allowing the user to zoom out in certain situations. - The mouse event coordinates are no longer quantized to very large steps if a projection is used and the viewport is zoomed in afterwards.
-
Fixed the
MaxXandMaxYproperties ofRectD.Infinitewhich now returnDouble.PositiveInfinityinstead ofNaN. In turn,RectD.Infinite'sTopRight,BottomRight, andBottomLeftcorners were fixed, too.
Graph
-
The
DefaultFolderNodeConverterandFoldingEdgeConverterBaseclasses (and thus, also theDefaultFoldingEdgeConverterandMergingFoldingEdgeConverterclasses) no longer ignore port labels. -
A label with
EdgeSegmentLabelModelorEdgePathLabelModelnow moves steadily when the segment to which it belongs moves.
Input
-
The
CreateEdgeInputModeclass no longer has an error which prevented the removal of port candidate visualizations after another input mode claimed to be active. -
Labels with
\nnow are displayed correctly when the label is edited.
GraphML
- Labels at ports of collapsed nodes are no longer lost during GraphML serialization.
Analysis
-
The Manhattan distance metric for
HierarchicalClusteringno longer ignores the vertical distance component. -
The
Cycles.FindCycleEdgesalgorithm no longer crashes when the given input graph contains self-loops.
Layout
-
The
TabularLayoutclass no longer throws an exception about a missingPartitionGridwhen used withinRecursiveGroupLayoutandRecursiveGroupLayoutDataandTabularLayoutDataare used without an explicit cell-id mapping. -
The
LayoutExecutorclass now uses the correct target bounds when a projection is set on theGraphControl. -
When the
MaximumDurationof theEdgeRouterclass is exceeded, it now still uses the same port for edges that are grouped. Previously, edge grouping constraints were mostly ignored when the time was up. -
Improved the reaction time of the
EdgeRouterclass when theMaximumDurationis exceeded or the algorithm should stop due toAbortHandlerfor some cases where previously the search for a path kept on running for a long time. -
The
RadialLayoutclass is now much faster if the input graph is a very large tree structure. -
The
OrganicLayoutandClassicOrganicLayoutclasses no longer produce an internal integer overflow that may lead to an early exit and, thus, poor layout results for very large input graphs. -
The
ClearAreaLayoutclass no longer throws an exception for some scenarios where the same algorithm instance was first applied to a graph withPartitionGridand later to a graph without grid. -
The
EdgeRouterandPolylineLayoutStageclasses no longer produce broken routes for edges with polyline segments. Previously, such broken routes may have appeared in rare cases. -
The
HierarchicLayoutclass now correctly considers the back-loop routing style (HierarchicLayout.BackLoopRouting) for graphs with critical edges (seeHierarchicLayoutData.CriticalEdgePriorities). -
The
ClearAreaLayoutandFillAreaLayoutclasses no longer throw an exception for some input graphs with edge labels if propertyConsiderEdgeLabelsis enabled. -
The
GenericLabelingclass no longer throws an exception for edge labels with preferred placement descriptor if propertyPlaceEdgeLabelsis disabled. -
The
TreeLayoutclass now correctly handles trees with group nodes. Previously, it sometimes produced overlapping elements and halo violations for such inputs. -
The curved edge routes produced by
HierarchicLayout,EdgeRouterorCurveRoutingStageno longer violate the minimum node-edge distance or intersect the node. Intersections could previously happen especially when the specified node-edge distance was zero. -
The
RecursiveGroupLayoutclass now correctly handles setups that use both recursive and non-recursive group nodes. Previously, such use-cases may have led to invisible/ignored edges and, thus, broken edge routes. -
The
PartialLayoutclass now transfers the value of itsPartialLayout.MaximumDurationproperty to the internally used edge routing algorithm. This means that when the partial layout has a restricted running time, the routing part will be restricted, too. Previously, the duration of the edge routing was unrestricted. Note that if the router instance is user-specified, this instance will not get a maximum duration. -
The
HierarchicLayout,EdgeRouterandCurveRoutingStageclasses no longer occasionally throw an exception when the curved routing style is used for graphs that have self-loop edges. -
The
ClearAreaLayoutclass now produces correct orthogonal routes for edges if itsClearAreaStrategyproperty is set to a local strategy. Previously, some of the edges may have received a non-orthogonal route. -
The
EdgeRouterclass no longer throws an exception if the input contains a bus defined viaBusDescriptorwhere all the associated edges are actually fixed.
Hierarchic Layout
-
The
HierarchicLayoutclass no longer produces an infinite looping issue in the incremental layout mode for some input graphs with layer constraints that specify that a node should be placed in the topmost/bottommost layer. -
The
HierarchicLayoutclass no longer produces unnecessary edge crossings between self-loop edges at the same node in cases where a larger number of self-loops exist at a node. -
The
HierarchicLayoutclass no longer ignores edges connected to group nodes when the group node contains a bus structure (seeHierarchicLayoutData.Buses) and no other elements. Such edges were previously actually removed from the layout graph such that other stages (e.g. theComponentLayout) could have failed with an exception. -
The
HierarchicLayoutclass no longer occasionally throws an exception when enablingHierarchicLayout.CompactGroupsand in conjunction with layering constraints and/or a group node marked as incremental. -
The
HierarchicLayoutclass does no longer violate the specified minimum length for edges incident to group nodes. -
The sequencing phase of the
HierarchicLayoutclass is now faster for large graphs with sequence constraints and non-incremental layout mode.
Edge Routing
-
The
BusRouterclass now produces more suitable edge routes for rare cases that were caused by an unsuitable bus placement. -
The
EdgeRouterclass now uses the given ports for edges of a bus with fixed edges. -
The
EdgeRouterclass now correctly considers edges incident to a fixed inner port of a group node when the routing algorithm has restricted maximum duration. Previously, this setup sometimes led to strange edge routes with many superfluous bends. -
The
EdgeRouterclass no longer contains edges with self-crossings in some rare cases where it previously failed to eliminate them. -
The
EdgeRouterandCurveRoutingStageclasses no longer change the path of unaffected (fixed) edges when theCreateControlPointsproperty of their associatedEdgeLayoutDescriptorinstance (CurveEdgeLayoutDescriptorrespectively) is enabled. -
The
EdgeRouterclass now correctly supports the use case that a subset of edges is routed with the curved routing style while another subset is routed with another routing style and different settings on the associated individualEdgeLayoutDescriptorinstances. Previously, with some edges being curved, the settings of the other edges got lost and the default settings were used. -
The
OrthogonalSegmentDistributionStageclass does no longer crash when receiving input graphs with a very large edge count (greater than approximately 22000). Note that theChannelEdgeRouterclass is affected too, as the stage is by default called from within the router.
New Demos
-
The new Sankey layout demo shows how
HierarchicLayoutcan be configured to show a Sankey diagram.
yFiles.NET 5.3.0.1
Bugfixes
-
An animation created with
Animations.CreateGraphAnimationno longer throws an Exception if the providedIMapperwith new bend locations doesn't provide bend locations for all edges. -
Using the
NinePositionEdgeLabelModelfor edges with theBezierEdgeStyleno longer throws an exception in theBezierEdgeStyleRenderer.getSegmentCountmethod. - Fixed exception which occurs with layout animations for graphs which contain edges with ports.
-
Fixed a bug when executing
ZoomToCurrentItemCommandwhich did not center on the current item with theViewportLimiterenabled and theLimitingPolicyset toTowardsBounds. -
Calling the
GraphInputMode.FindItemsandGraphInputMode.HitTester.EnumerateHitsmethods with a customIInputModeContextwill now always pass that context to theIHitTestableimplementations of the items being hit-tested. Previously, the main input mode's ownIInputModeContextwas used in certain cases. -
The
GraphModelManager.GetMainCanvasObjectmethod no longer throws aNullReferenceExceptionwhen overriding itsGetCanvasObjectmethods for items in an unexpected way. -
The new default
ViewportLimiterpolicyTowardsBoundsno longer causes the viewport to scroll to unexpected locations (including far away from the graph) during layout animations. -
The viewport rectangle in the
GraphOverviewControlis now displayed correctly if the referencedGraphControlhas a projection set. - The viewport rectangle in the overview is now correctly hit-tested when a projection is used.
-
DefaultLabelStyle.Insetsis now correctly applied around the content instead of just enlarging the preferred size. -
CommandManagerno longer causesICommand.CanExecutecalls if the targetGraphControlis already disposed. -
Mouse2DEvents now properly reflect changes of modifier keys in theirChangedModifiersproperty. - Fixed hit-test of handles being in a slightly different position from where the handles are displayed.
-
Labels with
\nnow are displayed correctly when the label is edited. -
Fixed
PanelNodeStlyeshadow that was mangled when printing. -
The
NodeDropInputModeclass now correctly considers port labels, both for creating the new node and for the preview.
Right-to-Left
-
The extent of the horizontal scrollbar now correctly accounts for the vertical scrollbar being
displayed on the left side with
RightToLeft. -
The
AutoDragfeature inCanvasControlnow works correctly withRightToLeftwhile the vertical scroll bar is visible. -
The vertical scrollbar location is now correctly adjusted when switching writing direction with the
RightToLeftproperty. -
CanvasControl.EnsureVisiblenow works correctly when the vertical scrollbar is on the left side due toRightToLeft. -
Commands.ScrollPageLeft,Commands.ScrollPageRightas well as horizontal mouse-wheel scrolling no longer scroll in the wrong direction whenRightToLeftis enabled.
Layout
-
The
HierarchicLayoutclass now correctly handles inputs that have both bus structures and edges with recursive style. Previously, an exception could be triggered when an edge was marked as recursive and belonged to a bus at the same time. -
The
EdgeRouterclass no longer has a problem that appeared with a bus containing affected as well as non-affected (fixed) edges at the same time. Previously, this could trigger an Exception or lead to the incorrect behavior that an actually affected other edge was not routed. -
The
EdgeRouterclass no longer occasionally throws an exception if the input contains bus edges defined viaBusDescriptor. -
The
BusRouterclass no longer fails to generate connected buses for cases with fixed and incremental edges on the same bus. Previously it sometimes generated a disjoint bus even though the bus IDs were equal. -
The
BusRouterclass no longer ignores edges that should be routed when a they are on a bus with fixed edges (seeBusDescriptor.Fixedproperty) and when they share both source and target port with a fixed edge. -
The element processing order in the
BendConverterlayout stage is now deterministic. The previous non-deterministic order of inserting and removing elements could lead to non-deterministic behavior for consecutive layout calculations. -
The
ParallelEdgeRouterclass no longer throws an exception if the input has both a large number of parallel edges and a leading edge with ports on the node border. -
The
OrthogonalLayoutclass now correctly handles input graphs with parallel edges if thePreferParallelRoutesproperty is enabled. Previously, such inputs have caused exceptions in some rare cases. -
The
FamilyTreeLayoutclass now properly handles the case that the family tree contains cycles, e.g., due to a family founded by parent and (step-)child. Previously, it sometimes produced a stack overflow or non-orthogonal routes for such an input.
Improvement
- The .NET Core version of the library (
lib/netcoreapp3.0) has been tested with .NET 5.0 and compatibility has been confirmed.
Incompatible Changes (Demos)
- The .NET Core versions of demos and tutorial (
samples-netcore) now target .NET Core 3.1. They can still be used with .NET Core 3.0 by simply changing the target framework. The library is not affected.
yFiles.NET 5.3
This release contains many new major features and lots of other new features, improvements, and bugfixes for all parts of the library. In addition to the new demos that show the new features, there are some notable new demos and demo improvements, too.
If you are updating from an older version of yFiles.NET, have a look at the list of incompatible changes.
Major New Features
- Isometric Drawing and Other Projections
-
CanvasControl(and thusGraphControl) now has an additionalProjectionproperty that can be used to transform the viewport into a different parallel projection, e.g. isometric or cabinet projection. Predefined useful projections are provided as constants on the newProjectionsclass. Interaction, including graph editing, snapping, orthogonal edge editing, etc. still work as expected, just within the new projection. That is, orthogonal edge editing becomes isometric edge editing with an isometric projection. There is a corresponding chapter in the Developer's Guide that goes into further detail what has changed and which customization options exist.The
IsometricDrawingdemo displays graphs in an isometric fashion to create an impression of a 3-dimensional view. - Fill Area Layout and Clear Area Layout
-
The new
ClearAreaLayoutalgorithm clears a user-specified area in an existing layout by moving elements. It is suitable if the rest of the layout should not change much but some free space is required, e.g., because new elements need to be inserted into the drawing or have been resized.The new
FillAreaLayoutalgorithm fills a user-specified area in an existing layout by moving elements into or towards it. It can make layouts around the specified area more compact and is suitable if, e.g., elements were removed from the graph or their size has changed substantially.A number of new demos showcase the new layout algorithms:
-
The new
MarqueeClearAreademo shows how to make space in a diagram by dragging a marquee rectangle. -
The new
OverlapAvoidingEditordemo shows how to interactively edit graphs without creating overlaps. -
The new
ComponentDragAndDropdemo shows how to make space for components that you can drag from a palette onto the canvas. -
The new
FillAreaAfterDeletiondemo shows how to fill free space after deleting nodes using theFillAreaLayoutalgorithm. -
The new
RelocateSubtreedemo shows how to reuse free space after relocating a subtree to a new parent.
-
The new
- Aggregation and Analysis of (Large) Graphs
-
Many new algorithms for analyzing graphs are now included, for example to detect components and clusters, to aggregate sub-graphs, and to calculate centrality values. In addition, the analysis algorithms now have the option to define a subset of the graph to work on. In detail, the new classes are:
-
The new
NodeAggregationclass provides an algorithm that intelligently aggregates nodes of (large) input graphs. It does not require complex configuration and can be used without knowledge of specific clustering or aggregation techniques. -
The
KCoreComponentsclass provides a component detection algorithm that finds k-cores. -
The classes
LouvainModularityClusteringandLabelPropagationClusteringprovide two new algorithms for cluster detection. -
The
EigenvectorCentralityclass offers a centrality algorithm that measures the influence of a node in a network based on the Eigenvector score. -
The
PageRankclass provides a centrality algorithm that calculates the so-called page rank for the nodes. -
The classes
ChainSubstructures,CliqueSubstructures,CycleSubstructures,StarSubstructures, andSubtreeSubstructuresprovide new algorithms that detect isolated substructures like chains, cliques, cycles, stars, or subtrees. This can be used as an input to other (layout) algorithms. -
The class
GraphStructureAnalyzernow offers additional methods to calculate the average degree, the average weighted degree, the diameter, and the density of a given graph.
The
Large Graph Aggregation Demoshows how to use theNodeAggregationalgorithm to automatically analyze and explore a large graph. Developers don't need to learn the academic details of the available clustering and centrality algorithms, but can simply configure their preferred aggregation sizes to automatically create perfect user-experiences in drill-down scenarios. -
The new
- Support for curved edges
-
The new
BezierEdgeStylerenders edges with smooth Bezier-curve paths.In addition, the new edge label models
BezierEdgePathLabelModelandBezierEdgeSegmentLabelModelplace labels optimally on curved edges rendered with this style.The
BezierEdgeStyledemo demonstrates the use of the newBezierEdgeStyleand shows additional customizations to support various features in interactive editing. For example, for intuitive interactive editing, the edges are edited with the same control points -or handles- that are known from other vector graphic drawing applications.Support for curved edges has been added to the layout and edge routing algorithms
EdgeRouterand theCurveRoutingStage, andHierarchicLayout. - Interactive Node Resizing
-
Resizing nodes using their handles now supports two new behaviors:
- Center resizing keeps the center fixed and scales the node in all directions. It is active when the
NodeReshapeHandleProvider.CenterReshapeRecognizeris triggered which defaults to theAltkey held down. - Aspect ratio resizing maintains the aspect ratio of a node. It is active when the
NodeReshapeHandleProvider.RatioReshapeRecognizeris triggered which defaults theShiftkey held down. - The
NodeReshapeHandleProvider.ReshapePolicydetermines how the mouse location is interpreted when aspect ratio resizing is active.
The
Reshape Handle Configuration Demoshowcases these different resizing behaviors.Related to this, the new
Node Group Resizing Demoshows how to resize a selection of nodes en bloc. In contrast to the default behavior, this changes both the sizes and the locations of the nodes and not just the sizes. - Center resizing keeps the center fixed and scales the node in all directions. It is active when the
- Graph Builder
-
The old
GraphBuilder,TreeBuilder, andAdjacentNodesGraphBuilderclasses have been replaced in the library with more powerful but incompatible builder classes. Loading graphs from external data sources has become even easier with the new graph builder implementations. This release contains completely rewritten utility classes that can help with the creation of diagrams from one or more data sources.The new classes can load nodes, edges, labels, and their properties from one or many different sources dynamically using a declarative-like approach. Binding expressions can be used for setting the visual properties of the graph entities depending on the values in the source data.
For backward compatibility, the old
GraphBuilder,TreeBuilder, andAdjacentNodesGraphBuilderclasses are available as demo code.
New Features
Viewer
-
The new
NodeLabelModelStripeLabelModelAdapterclass allows for using node label model parameters for the positioning of the row and column labels of a table. -
Resizing nodes using their handles now supports keeping the node center and/or the aspect ratio of
the node bounds.
- Center resizing is active when the
NodeReshapeHandleProvider.CenterReshapeRecognizeris triggered. The default is pressing the Alt key. - Aspect ratio resizing is active when the
NodeReshapeHandleProvider.RatioReshapeRecognizeris triggered. The default is pressing the Shift key. - The
NodeReshapeHandleProvider.ReshapePolicyproperty determines how the mouse location is interpreted when aspect ratio resizing is active.
- Center resizing is active when the
-
Besides the
CanvasControl.Projectionproperty itself a number of new properties and methods have been added to support to transform the viewport into a different parallel projection:-
CanvasControlhas additional methods to convert between the world, the new intermediate, and the view coordinate system. -
MarqueeSelectionInputMode,NavigationInputMode, andHandleInputModenow have a propertyUseViewCoordinates, which controls whether the input mode draws its decorations and processes input in view coordinates. -
When
MarqueeSelectionInputModeuses view coordinates, the resulting shape of the marquee in world coordinates may not be a rectangle. ThereforeMarqueeSelectionEventArgsnow has aPathproperty of typeGeneralPathto describe the marquee shape and aUsePathproperty that determines whether the Path property or the Rectangle property shall be used. -
EdgeDecorationInstaller,RectangleIndicatorInstaller,PointSelectionIndicatorInstaller, andDefaultPortCandidateDescriptornow have a propertyUseViewCoordinatesthat controls whether the decoration is rendered in view coordinates. -
CreateEdgeInputMode'sMeasureDistancemethod now has to return the distance in view coordinates if and only ifCanvasControl'sProjectionis used. -
IRenderContextnow has additional members that are useful with the new projections feature: the Projection transform, transforms used to paint in view, intermediate or world coordinate system, and members to convert points from one coordinate system to another. - The
GetTransformmethod of theDefaultLabelStyle,NodeStyleLabelStyleAdapter,, andLabelStyleBase<TVisual>IconLabelStyleRenderernow have anIRenderContextadded as first argument. -
A new
Projectionproperty has been added toContextConfiguratorandCanvasPrintDocument.
-
Analysis
-
A new component detection algorithm which finds k-cores has been made available using class
KCoreComponents. -
Centrality calculation algorithms which calculate the eigenvector centrality and
page ranks for nodes have been made available using classes
EigenvectorCentralityandPageRank, respectively. -
The new analysis algorithm
NodeAggregationsupports an algorithm that tries to intelligently aggregate nodes of (large) input graphs and does not require that the user is familiar with specific clustering/aggregation algorithms. -
New algorithms for detecting isolated substructures like chains, cliques, cycles, stars or
subtrees have been made available via the classes
ChainSubstructures,CliqueSubstructures,CycleSubstructures,StarSubstructures, andSubtreeSubstructures. -
GraphStructureAnalyzer: added methods to calculate the average degree, the average weighted degree, the diameter and the density of a given graph. -
New clustering detection algorithms using the Louvain Modularity and Label Propagation have
been made available via classes
LouvainModularityClusteringandLabelPropagationClustering. - The analysis algorithms now have the option to define a subset of the graph to work on.
Algorithms
The features listed here are new features of the low level analysis algorithms. Most of them are reflected in new features of the analysis facade classes as listed in the section Analysis.
-
New methods compute several
additional network statistics, namely
GetAverageDegree,GetAverageWeightedDegree,GetDiameter, andGetDensityof classGraphCheckerandGetModularityof classGroups. -
Added class
NodeAggregationwhich represents an algorithm that tries to intelligently aggregate nodes of (large) input graphs and does not require that the user is familiar with specific clustering/aggregation algorithms. -
Added new method
Transitivity.TransitiveEdgeswhich creates the transitive edges that connect the visible nodes in an input graph. -
Added method
Groups.GetClusteringCoefficientthat computes the local clustering coefficient for each node as well as the average clustering coefficient. -
Added the new methods
GraphConnectivity.KCoreandGraphConnectivity.KCore(Graph, int that compute the so-called k-cores of an undirected input graph. -
Added the new method
Centrality.EigenvectorCentralitywhich computes the eigenvector centrality for each node in an undirected graph. -
Added an implementation of the label propagation algorithm which detects communities in the input
graph. See the new method
Groups.LabelPropagation. -
Added the new method
Groups.LouvainModularitywhich detects the communities in the input graph by applying the well-known louvain modularity approach. -
Added the new method
Centrality.PageRankwhich provides an implementation of the page rank algorithm that computes a rank for each node. -
The new
Substructuresclass offers methods to detect the following graph structures: Chains, Cliques, Cycles, Stars, and Trees.
Layout
-
Added new property
EdgeLayoutDescriptor.RoutingStylethat allows to specify the routing style individually for each edge routed by theEdgeRouterclass. Furthermore, new propertiesMaximumOctilinearSegmentRatioandPreferredOctilinearSegmentLengthon the descriptor provide means to configure the octilinear routing style. -
The
EdgeRouterclass now supports a new routing style that generates curved edge paths. It can be specified for each edge individually usingEdgeRoutingStyle.Curved. -
Added new layout stage
CurveRoutingStage. It replaces polyline edge paths with curved segments using cubic bezier splines and provides a generic way to produce layouts with curved edges. -
Added the new routing style
EdgeRoutingStyle.Curvedto theHierarchicLayoutclass. The resulting edge paths consist of smooth curves that are constructed using cubic bezier splines. -
The
CircularLayoutclass now supports exterior edges that are routed around the exterior of the circle as smooth arcs, see the new propertyCircularLayout.EdgeRoutingPolicy. -
Added new class
EdgeBundlingStagethat offers edge bundling for general undirected graphs. Bundling together multiple edges means that their common parts are to some degree merged into a bundled part. Edge bundling is useful to increase the readability of graph drawings with a high number of edges that connect a comparably small number of nodes.
Improvements
View
-
A new policy has been added to the
ViewportLimiterwhich allows for zooming and panning towards the limits but not away from them. This prevents the viewport from "jumping" from out-of-limit coordinates into the limited bounds. -
FitContentwith an enabledViewportLimiternow respects theLimitedFitContentZoomproperty on theCanvasControl. -
An
Animationcan now be paused and unpaused by setting thePausedProperty on theAnimatorafter the animation has started. -
DefaultFolderNodeConverterandFoldingEdgeConverterBase: provide new protected methodsCreatePreferredLabelSizeto allow for overriding the default implementations. -
The property
GraphModelManager.ProvideUserObjectOnMainCanvasObjectwas added that can be set so that a model is accessible as its main canvas object's user object. -
The extension method
GetPathPointswas added for edges. The returnedIListEnumerablecontains the source port location, followed by the bend locations, followed by the target port location of an edge. -
NodeStyleLabelStyleAdapternow propagates the label's tag to the node that's rendered with the node style. -
NodeStylePortStyleAdapternow propagates the port's tag to the node that's rendered with the node style. -
NodeStyleStripeStyleAdapternow propagates the stripe's tag to the node that's rendered with the node style. -
CanvasControl.UpdateContentRectnow throws anInvalidOperationExceptionif an element on the canvas provided invalid (e.g. infinite) bounds. -
ITable.AddLabelno longer accepts label model parameters that do not supportIStripeinstances. Previously node label models could be used, but did not work properly at runtime. -
CompositeLabelModel: added support for label snapping. -
GraphModelManager: made methods Raise, Lower,ToFrontandToBackvirtual. -
Added the ability to the image export support (
PixelImageExporter,EmfExporter,ContextConfigurator) to define an arbitrary list of points. The export chooses the exported area in a way that all these points are enclosed in the smallest possible rectangular area which is axis-parallel to the output coordinates. -
Added the ability to the printing support (
CanvasPrintDocument,CanvasControl.Print) to define an arbitrary list of points. The printed area is defined in a way that all these points are enclosed in the smallest possible rectangular area which is axis-parallel to the output coordinates. -
PixelImageExporterandEmfImageExporternow have aBackgroundproperty which sets aBrushfor the background.
Input
-
GridVisualCreatornow supports to only draw horizontal or only vertical lines when itsGridStyleproperty is set to one of the new valuesHorizontalLinesorVerticalLines. -
GraphSnapContext.GridSnapDistanceandGraphSnapContext.GridSnapTypehave been pulled up toSnapContext. -
The zoom-invariant
GridSnapDistanceproperty has been added toCollectSnapResultsEventArgs. -
An optional parameter
preferredSnapTypehas been added to theSnapLineSnapResultconstructor and theSnapResults.CreateSnapLineSnapResultfactory method. -
SnapResults.CreateResizeSnapResultnow takes aPointDas delta parameter instead of a double so it is possible to create resize snap results where the orientation of the mouse delta differs from the orientation of the snapped size. -
GraphClipboardandGraphEditorInputMode: added new eventElementsDuplicatedthat occurs when a duplicate operation finished successfully. -
UndoEngine: The Undo and Redo methods now throw nowInvalidOperationExceptionif the current state does not allow performing Undo or Redo. Previously eitherNotSupportedExceptionorExceptionhave been thrown. -
The
GraphEditorInputMode.RequeryHandlesmethod has been made public and can now be used to refresh the displayed handles, ifIHandleProviderimplementations return different handles over time. -
It is now easier to customize
GroupingNodePositionHandler. The boolean propertiesAdjustParentNodeLayout,MoveChildNodesandReparentingEnabledhave been added to control whether ancestors' node layout should be adjusted when a node is moved, to not move the contents of a group node when a group node is moved or forbid any interactive reparenting. - The default position handler for edges now creates fewer additional bends when the edge is dragged while orthogonal edge editing is enabled.
-
A
ReshapeHandlerDecoratorproperty has been added toNodeDecoratorto simplify using a customIReshapeHandlerimplementation for nodes. -
The property
ReshapeRectangleContext.Ratiohas been added that describes the width/height ratio that is kept for aspect ratio resizing. -
The new classes
NodeReshapeHandleProviderandNodeReshapeHandlerHandleare used as default implementation for node resize handles. -
The factory method
OrthogonalEdgeEditingContext.CreateOrthogonalEdgeDragHandlerhas been added and can be used for custom node position handler and reshape handler to keep orthogonal edges attached to a node orthogonal during the drag/reshape gesture. -
A
MaximumBoundingAreacan now be set onReshapeHandleProviderBase,ReshapeHandlerHandle,RectangleHandleandReshapeRectangleContextto restrict reshaping to stay inside the given bounds. -
ReshapeHandlerHandle: Getter for theIReshapeHandlerand theHandlePositionshave been added. -
The property
ReshapePolicyhas been added toReshapeRectangleContextsoINodeReshapeSnapResultProviderimplementations can respect the node aspect ratio for according resize gestures. -
The new method
PointD.Interpolatecalculates the linear interpolation between two points. -
Added a new method
NavigationInputMode.FitContentthat is called after collapse, expand, enter and exit operations ifFitContentAfterGroupActionsis enabled. -
The
NavigationInputModeclass doesn't fit the content anymore after expand/collapse operations if anAutoGroupNodeAlignmentPolicyother thenNoneis used. -
ResizeStripeInputModenow has anIsDraggingproperty, indicating whether a drag currently is in progress. -
DropInputModenow has anIsDraggingproperty, indicating whether a drag on the canvas currently is in progress. -
HandleInputModenow has anIsDraggingproperty, indicating whether a drag currently is in progress. -
The new
ClickHandlerDecoratorproperty of Bend-, Edge-, Label-, Node- andPortDecoratorsimplifies using customIClickHandlerimplementations.
Analysis
-
Most of the algorithms in namespace
Analysisprovide propertiesSubgraphNodesandSubgraphEdgeswhich facilitate to analyze only a subset of the given graph. -
In a single node graph, the single node's closeness centrality and graph centrality value is
now 1.0 (previously, it was infinity). This also affects derived values such as minimum, maximum, and normalized
centrality. This change relates to
yWorks.Analysis.GraphCentralityandyWorks.Analysis.ClosenessCentrality. The backing algorithms inyWorks.Algorithms.Centralityare unchanged. -
GraphStructureAnalyzer: added methods to determine multiple edges. -
The
GraphCentralityandClosenessCentralityanalysis algorithms now calculate the centrality individually per component instead of returning a centrality value of0.0for nodes in graphs that are not connected. -
EdgeBetweennessClustering: throws anInvalidOperationExceptionif edge weights are not positive or finite. -
FeedbackEdgeSet: throws anInvalidOperationExceptionif edge weights are negative.
Layout
-
Constructor overloads have been added to
SingleItem,ItemCollection,ItemMappingandContextItemMappingthat initialize one of their properties on construction. - Frequently used types of the layout part have now nullability annotations.
-
LayoutExecutornow generates more specific port constraints withFixPortsenabled, resulting in better edge paths. -
HierarchicLayoutData.EdgeDirectedness: if theMapperproperty is directly accessed (not explicitly set) its default for unset values is 1.0 (directed edge). -
OrganicLayoutData.GroupNodeModes: if theMapperproperty is directly accessed (not explicitly set) its default for unset values isGroupNodeMode.Normal. This doesn't change the result of the layout. -
AspectRatioTreeLayoutData:RootPlacements,SubtreeRoutingPolicies,SubtreeAspectRatio: the type of the mapped values has been made nullable. Fornullor unset values now the settings on theAspectRatioTreeLayoutwill be taken as the documentation already stated. -
Improved the support for early exits of the
EdgeRouterclass. The routing algorithm now often reacts more sensibly to the case that the specifiedMaximumDurationis reached. -
The
HideGroupStageclass now offers a new propertyResetEdgePathsthat allows to specify whether or not the stage resets the path of edges incident to group nodes. -
The
ComponentLayoutclass now correctly considers node and edge labels when using the packed layout styles, e.g.,ComponentArrangementStyles.PackedRectangleorComponentArrangementStyles.PackedCircle. Previously, labels could overlap other elements when using these component arrangement styles. -
Improved the consideration of the minimum edge to edge distance of the
EdgeRouterclass when it runs with highly restricted time (seeEdgeRouter.MaximumDuration) or when it gets stopped by means ofAbortHandler. -
The
PartialLayoutclass now produces more stable results if it is multiple times applied to the same input graph and propertySubgraphPlacementis set toSubgraphPlacement.FromSketch.
New Demos and Demo Improvements
New Demos
-
The new
LargeGraphAggregationdemo that shows how to use the smartNodeAggregationclustering algorithm together with anAggregateGraphWrapperfor drill down exploration of a large graph. -
The new
BezierEdgeStyledemo demonstrates the use of the newBezierEdgeStyleand shows additional customizations to support various features in interactive editing. -
The new
NodeGroupResizingdemo shows how to apply different resize behaviors to a set of nodes. For instance, the nodes will keep their size but their positions are altered according to the resize gesture applied to the entire group. -
The new
ZOrderdemo shows how to persist the z-order during undo, clipboard operations, grouping, and saving and loading. -
The new
MarqueeClearAreademo shows how to make space in a diagram by dragging a marquee rectangle. -
The new
OverlapAvoidingEditordemo shows how to interactively edit graphs without creating overlaps. -
The new
ComponentDragAndDropdemo shows how to make space for components that you can drag from a palette onto the canvas. -
The new
RelocateSubtreedemo shows how to reuse free space after relocating a subtree to a new parent. -
The
IsometricDrawingdemo displays graphs in an isometric fashion to create an impression of a 3-dimensional view.
Noteworthy Demo Improvements
-
The
BPMNdemo has been improved to provide more flexibility. Its code now can easier be used in custom projects. -
Improved support for parsing the
BPMNDiagramm Interchanged format. -
The
BPMNnode styles now support setting colors. -
The
ReshapeHandleProviderdemo now shows how to implement a customIReshapeHandleProvider. The newReshapeHandleProviderConfigurationdemo shows how to configure the defaultIReshapeHandleProviderto modify the resizing behavior. -
The
LayoutStylesdemo has been enhanced to include new layout features:- Exterior edge routing for
CircularLayout. - Curved edge routing style for
HierarchicLayoutand PolylineEdgeRouter. - Bus routing for
HierarchicLayoutand PolylineEdgeRouter. - Integrated Edge Labeling for Polyline
EdgeRouter.
- Exterior edge routing for
Bugfixes
View
-
Fixed a bug in
FoldingManagerwhere a predicate change in aFilteredGraphWrapperwhich serves asMasterGraphcould trigger an exception if a child of a folder node has been hidden. -
ICanvasObject.AboveandBelowdon't unneccessarily triggerIRenderContext.VisualRemovedanymore. -
Fixed the explict conversion between
TransformandMatrix2Dwhich was incorrect forTransforms with a rotation component. -
SmartEdgeLabelModel: fixed a bug that caused a label with an angle other than 0 to jump when starting to move it interactively. -
IFoldingView.CollapseandExpandnow throw anArgumentExceptionwhen called with a node not belonging to the graph (instead of aNullReferenceException). -
Fixed a bug which caused custom
IEdgePathCropperimplementations which are defined on custom port styles ignored if the graph is grouped. - Edges between deeper nested nodes are now displayed correctly in front of a common ancestor after that ancestor has been added or removed.
-
Fixed a bug which caused the
ZoomToCurrentItemcommand to ignore theViewportLimiter. -
CanvasControl.ZoomTono longer triggers twoViewportChangedevents. -
Fixed a bug in
GraphCopierwhich caused theLabelCopiedevent to be dispatched twice for port labels on folder nodes. - Labels with line breaks now are displayed correctly in the text editor.
- The speed of the auto dragging feature now is independent of the scale.
-
Fixed
PanelNodeStlyeshadow that was mangled when printing.
-
The extent of the horizontal scrollbar now correctly accounts for the vertical scrollbar being
displayed on the left side with
RightToLeft. -
The
AutoDragfeature inCanvasControlnow works correctly withRightToLeftwhile the vertical scroll bar is visible. -
The vertical scrollbar location is now correctly adjusted when switching writing direction with the
RightToLeftproperty. -
CanvasControl.EnsureVisiblenow works correctly when the vertical scrollbar is on the left side due toRightToLeft. -
Commands.ScrollPageLeft,Commands.ScrollPageRightas well as horizontal mouse-wheel scrolling no longer scroll in the wrong direction whenRightToLeftis enabled.
Input
-
TextEditorInputModenow correctly queries theViewportLimiterifTextBoxPlacementPolicy.ScrollCanvasis used. If the text box is still not visible because it's outside the limited viewport, the text box will be moved as well. - Fixed Undo/Redo of addition and removal of bends on folding edges. The bends now are correctly restored at the location they had at the time of removal.
-
TextboxEditorInputModecorrectly rotates the textbox when Zoom is clamped. -
The
NavigationInputMode.FitContentAfterGroupActionsmethod is no longer ignored when theNavigationInputModeclass is used as a child input mode of theGraphEditorInputModeclass. -
The
NavigationInputModeclass now also updates theCanvasControl.ContentRectproperty when it is not used as a child input mode of theGraphEditorInputModeclass. -
Fixed that
GridVisualCreatorignored the grid origin when rendering lines or crosses. -
Fixed bugs that interpreted
SnapContext.GridSnapDistanceorSnapContext.SnapDistancein world coordinates when calculatingSnapResults. - Orthogonal Edge Editing: fixed a bug that created bends in edges that are marked as not orthogonal.
-
OverviewInputMode: Fixed jumping of both client canvas and overview when scrollbar visibilty changes. - When zooming to the current item, changes in scrollbar visibility are properly incorporated into the new viewport position.
- Scrolling the viewport with the mouse wheel no longer scrolls in the wrong direction if the mouse wheel is set to scroll one page at a time (instead of several lines).
-
Paste and duplicate operation now honor
GraphEditorInputMode'sShouldSelectpredicate. - Fixed a bug which could cause an input mode to be left in an undefined state if another input mode has been activated in an event handler of the first input mode. This usually resulted in the wrong cursor being displayed.
- Fixed hit-test of handles being in a slightly different position from where the handles are displayed.
Analysis
- Fixed analysis class Chains for undirected cycles: if these cycles are not connected to other parts of the graph the Nodes collection of a resulting Path could be in an incorrect order.
-
yWorks.Analysis.EdgeBetweennessClusteringno longer throws an exception with its default settings(MaximumClusterCount == -1). -
The
HierarchicalClusteringclass no longer throws an exception when applied to an empty graph. -
ClosenessCentralitydoes no longer returnNaNasNormalizedNodeCentralityif the graph consists of one single node. Instead, theNormalizedNodeCentralitywill be positive infinity. -
ClosenessCentrality.Runno longer throws an exception for unconnected graphs. Instead, allNodeCentralityandNormalizedNodeCentralityvalues will be0as the documentation states.
Layout
-
Fixed an exception in
EdgeRouterwhich could occur in rare cases. -
The
OrganicLayoutclass no longer throws an exception when having aPartitionGridand at the same time the scope set toSubsetorMainlySubsetwhere all nodes of the graph are marked as affected (could have used scopeAllinstead). -
Fixed method
NodePlacerBase.PlaceSubtree(IDataProvider, IDataProvider, LayoutGraph, Node, ParentConnectorDirection)to clear its internal caches, especially the graph cached in fieldNodePlacerBase.graph. Previously, holding onto a node placer instance could lead to subtle memory leaks. -
The
EdgeRouterclass no longer yields edge labels that overlap with unrelated group nodes when using the integrated label placement feature (EdgeRouter.IntegratedEdgeLabeling). -
Resolved a bug in the
EdgeRouterclass which caused that grouped edges were sometimes actually not grouped together. This mainly appeared in conjunction with a large value of either the minimum first or last segment length. -
The
EdgeRouterclass no longer produces an exception for some rare cases with fixed grouped edges and octilinear paths. -
The
HierarchicLayoutclass no longer throws an exception that was previously triggered in some cases with bus structures (see propertyHierarchicLayoutData.Buses) and in conjunction with layering constraints. -
The
EdgeRouterclass now correctly observes inputs where the user specifies buses with both fixed and non-fixed edges at the same time. -
The
EdgeRouterclass now properly considers ports provided by aPortCandidateSetwhen the set contains multiple candidates with single capacities and where the candidates are on the same node side. Previously, it could happen that only one of several edges connecting to the node correctly considered the ports. -
The
EdgeRouterclass does no longer use the same fixedPortCandidateout of a specifiedPortCandidateSetif another non-saturated candidate can be chosen. Thus, overlapping edge segments are avoided. -
The
OrthogonalSegmentDistributionStageno longer produces degenerated (very large or small) coordinates for edges that contain zero-length segments, that is, duplicate edge path points. -
The
ChannelEdgeRouterclass no longer yields degenerated routing results (very large or small coordinates) when using theOrthogonalPatternEdgeRouteras path finder strategy and setting its minimum distance to zero. TheOrthogonalPatternEdgeRouterclass now avoids duplicate points when theMinimumDistanceproperty is set to zero. -
The
AspectRatioTreeLayoutclass no longer crashes, causing a stack overflow, when applied to a large chain graph. -
Fixed a bug in the
HierarchicLayoutclass that could cause unnecessary (double) edge crossings when the algorithm was executed in incremental layout mode with edge grouping and alternative group bounds. -
The
RecursiveGroupLayoutclass now correctly moves child nodes along with their group also in case theRecursiveGroupLayout.CoreLayoutisnull. Previously, if additionally a group node had a specific layout algorithm associated to it, the content was not correctly moved along. If the core layout was notnull, the issue did not occur. -
The
EdgeRouterclass now considers the correct shape of non-affected, fixed edges. Previously, it sometimes incorrectly parsed their shape which could lead to undesired effects like incorrect path cost calculation of affected edges. -
The
BalloonLayoutclass now longer crashes due to a stack overflow for inputs containing very long chain graphs. -
Fixed a bug in the
HierarchicLayoutclass that in some cases caused a violation of the minimum first or last segment length (EdgeLayoutDescriptor.MinimumFirstSegmentLengthandEdgeLayoutDescriptor.MinimumLastSegmentLength). The bug was only triggered when the minimum length values were relatively large. -
The
TreeMapLayoutclass no longer produces results that may have infinite coordinates. -
The
EdgeRouterclass no longer produces unnecessary overlaps for cases where the source or target node is overlapped by (several) label elements. This generally improves the ability of the router to deal with input that contains source/target nodes that are overlapped by other elements and are required to be crossed by an edge route. -
The
HierarchicLayoutclass no longer throws an exception that was previously triggered in some cases with bus structures (see propertyHierarchicLayoutData.Buses) and in conjunction with undirected edges (seeHierarchicLayoutData.EdgeDirectedness). -
Fixed a bug in the
EdgeRouterclass that sometimes generated bad routing artifacts with edge grouping and when there were non-affected edges grouped at both end points. -
The
EdgeRouterclass no longer throws an Exception that was previously in some cases triggered when the input contained bus edges (defined viaBusDescriptor).
Incompatible Changes
API
-
The method
CanvasControl.CreateInputModeContextis protected again, after having been made public accidentally previously. -
The
GraphEditorInputMode.RequeryHandlesmethod is now public. -
The
HierarchicalClustering.Result.DendrogramRootproperty can now returnnullif the result has been obtained from an empty graph. -
The optional
IPortLocationModelParameterandIPortStyleparameters of theIGraph.AddPortandGraphExtensions.AddPortmethods can now benull. -
The properties
PixelImageExporter.ConfiguratorandEmfImageExporter.Configuratorare no longer virtual. -
The
ModelManager.UnInstallmethod has been renamed to the canonical nameUninstall. -
The
NodeReshapeSnapResultProvider.GetSnapLinesmethod now takesCollectSnapResultsEventArgsas additional parameter. -
Several methods related to snapping now take a
PointDinstead of adoubleasdeltaparameter. In detail, these areSnapResults.CreateResizeSnapResult,NodeReshapeSnapResultProvider.AddSnaplineSnapResult,NodeReshapeSnapResultProvider.AddGridLineSnapResult, andNodeReshapeSnapResultProvider.AddSameSizeSnapResult. -
The
NavigationInputMode.FitContentAfterGroupActionsproperty now isfalseby default. -
The
GetTransformmethod of theDefaultLabelStyle,NodeStyleLabelStyleAdapter,, andLabelStyleBase<TVisual>IconLabelStyleRenderernow have anIRenderContextadded as argument. -
IRenderContext.Transformhas been renamed toWorldToIntermediateTransform. -
The method
DefaultLabelStyleRenderer.IsTextMirroredhas been removed. -
The property
BackColoron thePixelImageExporterclass and theFillBackgroundproperty on theEmfImageExporterclass have been replaced with theBackgroundproperty which now takes aBrushinstead of aColoror a boolean value.
Behavior
- The view coordinate system now includes the projection. For customers who do not use a projection, nothing will change. However, when the (old) view coordinate system has been used to render parts of the visualization in a zoom-invariant manner, the equivalent now is called the intermediate coordinate system. The view coordinate system is still necessary when coordinates relative to the control are needed, e.g. for tooltips or a context menu.
-
When using the new projections feature,
CanvasControl'sContentRectproperty no longer has an effect on scrollbars orGraphControl.FitGraphBounds. -
CanvasControlignores itsViewportLimiterwhen projections are used. - Visuals that are rendered in view coordinates relative to the viewport may appear in a different location when exporting an image.
-
The
GraphCentralityandClosenessCentralityanalysis algorithms now calculate the centrality individually per component instead of returning a centrality value of0.0for nodes in graphs that are not connected. -
The
NavigationInputMode.AdjustContentRectmethod doesn't fit the graph bounds in the viewport anymore. -
The
NavigationInputModeclass doesn't fit the content after expand/collapse operations anymore. This can be re-enabled by setting theAutoGroupNodeAlignmentPolicyto a value other thanNoneandFitContentAfterGroupActionstotrue. -
The default value of the
MoveViewportInputMode.PinchZoomThresholdproperty has been changed from 100 to 50 to prevent pinch gestures from stopping periodically. -
The
ViewportLimiterno longer jumps to the limited viewports if the current viewport is outside the limited area. This behavior can be restored by setting theViewportLimiter.LimitingPolicyproperty toLimitingPolicy.Strict. -
HierarchicLayoutData.EdgeDirectedness: If theMapperproperty is directly accessed (not explicitly set), its default for unset values is now 1.0 instead of 0.0. These means that such edges are now treated as directed instead of undirected. -
For the
RootPlacements,SubtreeRoutingPolicies, andSubtreeAspectRatioproperties of theAspectRatioTreeLayoutDataclass, the type of the mapped values has been made nullable. Fornullor unset values, the settings on theAspectRatioTreeLayoutwill now be taken. This is the documented behavior, though. -
The value of the read-only property
EdgeRouter.Partitionis nownullafter applying the routing algorithm. It is only intended to be used during the execution. Previously, it was cached, even though the documentation stated otherwise. -
PixelImageExporter.Export: throwsInvalidOperationExceptionif the size of the image is empty. -
PixelImageExporter.ExportBitmap: throwsInvalidOperationExceptionif the size of the image is empty and throwsIOExceptionif the image needs too much memory. -
EmfImageExporter.Export: throwsInvalidOperationExceptionif the width or height of the image is negative. - The view coordinate system now includes the projection. For customers who do not use that feature, nothing will change. However, when the (old) view coordinate system has been used to render parts of the visualization in a zoom-invariant manner, the equivalent now is called the intermediate coordinate system. The view coordinate system is still necessary when coordinates relative to the control are needed, e.g. for tooltips or a context menu.
-
When using the new projections feature,
CanvasControl'sContentRectproperty no longer has an effect on scrollbars orGraphControl.FitGraphBounds. -
CanvasControlignores itsViewportLimiterwhen projections are used.
Deprecations
-
The properties
EdgeRouter.PolylineRouting,EdgeRouter.PreferredPolylineSegmentLengthandEdgeRouter.MaximumPolylineSegmentRatioare now deprecated. To enable polyline routing, specifyEdgeRoutingStyle.Octilinearas routing style viaEdgeLayoutDescriptor.RoutingStyle. The other two properties are also replaced by respective properties on theEdgeLayoutDescriptorclass.
yFiles.NET 5.2.0.2
Bugfixes
-
FilteredGraphWrapper: Fixed a possibleArgumentException("Node not in this graph") which could occur when the parent of a node which is not visible in the filtered graph has been changed in the wrapped graph. -
FoldingManager.GetFoldingEdgeStatenow throws anArgumentExceptionwith a meaningful message instead of aNullReferenceExceptionif the state is queried for a master edge (both source and target node are expanded). -
FoldingManager:HasFoldingEdgeStatenow returnsfalsefor a non-dummy edge (both source and target are expanded) instead of throwing aNullReferenceException.
Layout
-
The
EdgeRouterclass now considers the correct shape of non-affected, fixed edges. Previously, it sometimes incorrectly parsed their shape which could lead to undesired effects like incorrect path cost calculation of affected edges. -
The
BalloonLayoutclass now longer crashes due to a stack overflow for inputs containing very long chain graphs. -
The
HierarchicLayoutclass no longer throws an exception that was previously triggered in some cases with bus structures (see propertyHierarchicLayoutData.Buses) and in conjunction with undirected edges (seeHierarchicLayoutData.EdgeDirectedness). -
Fixed a bug in
TableLayoutConfiguratorwhich in rare cases could cause exceptions in additional layout stages. -
ILabelCandidateDescriptor'sProfitnow is considered properly by the labeling algorithms. -
The constants
EdgeLabelLayoutDpKeyandNodeLabelLayoutDpKeyof theLabelLayoutKeysclass now specify correctly that their generic type parameter isLabelLayoutData[] and not justLabelLayoutData.
Incompatible Changes
-
FoldingManager.GetFoldingEdgeStatenow throws anArgumentExceptioninstead of aNullReferenceExceptionif the state is queried for a master edge (both source and target node are expanded). -
FoldingManager:HasFoldingEdgeStatenow returnsfalsefor a non-dummy edge (both source and target are expanded) instead of throwing aNullReferenceException.
yFiles.NET 5.2.0.1
Major Improvements
- The .NET Core-based library has been built and tested with the GA release of .NET Core 3.0. No library changes have been necessary and yFiles.NET 5.2 works just as well on the GA release of .NET Core 3.0.
New Demos
-
The new
LayoutStylesdemo showcases the features and settings of the yFiles automatic layout algorithms.
Improvements
- A lot of small improvements and bugfixes have been applied to the demo applications.
Bugfixes
Viewer
-
Fixed an issue where
NavigationInputMode'sAutoGroupNodeAlignmentPolicywould sometimes not work when the expanded and collapsed group node sizes differ. -
The
GeneralPath.Prependmethod no longer loses a part of the combined path in certain circumstances.
Layout
-
The
HierarchicLayoutclass now produces better results for input graphs with grouped edges and aPartitionGrid. Previously, such inputs may have produced edge routes with superfluous bends. -
The
HierarchicLayoutclass now correctly considers the propertiesMaximumNodesAfterBusandMaximumNodesBeforeBusof theBusDescriptorfor single line (layer) buses. In addition, for multiple layer buses, the specified minimum node to edge distance is now considered for the distance between nodes and the vertical bus segment. -
The
OrganicLayoutclass now correctly removes node overlaps if itsScopeis set toScope.MainlySubsetand itsNodeOverlapsAllowedproperty is disabled. Previously, the layout sometimes produced superfluous overlaps for such cases. -
The
TreeMapLayoutclass no longer produces results that may have infinite coordinates.
yFiles.NET 5.2
This release contains many new major features and lots of other new features, improvements, and bugfixes for all parts of the library. In addition to the new demos that show the new features, there are some notable new demos and demo improvements, too.
Major New Features
- Support for .NET Core
-
yFiles.NET now provides assemblies for both .NET Framework and .NET Core. All demos and tutorials are also provided for both frameworks.
- Improved documentation including more than 1000 new example code snippets
-
The documentation has been improved. Particularly, more than 1000 new code examples have been added to the API documentation.
- Bus-like placement in hierarchic layouts
-
The
HierarchicLayoutclass is now able to arrange children of a specified root node in a bus-like way. This results in a very compact and uniform arrangement if a node has many successors. The bus sub-structures are defined by theHierarchicLayoutData.Busesproperty, and the newBusDescriptorclass provides more individual settings for the buses. - Label placement, bus routing, and port grouping for EdgeRouter
-
The
EdgeRouterclass now features integrated edge label placement. Labels are automatically placed when the new propertyIntegratedEdgeLabelingis enabled. The placement considers the optionalPreferredPlacementDescriptorof a label.Also, it now supports port grouping of edges at their source and target and orthogonal bus routing. To specify the port group IDs or the bus affiliation, use the associated properties in the
PolylineEdgeRouterDataclass. - Analysis wrapper
-
The powerful analysis algorithms got a new API that is based on the
IGraphinterface and streamlines working with the results. In particular, it makes working with a special analysis graph class obsolete. The algorithms that are available with the new API include centrality measures, clustering, flow calculation, rank assignment, spanning tree, shortest path, and more.This is accompanied by the new
GraphStructureAnalyzerclass that provides methods to check structural properties of a given graph.The new
GraphAnalysisdemo allows you to interactively explore all the algorithms. - NuGet Support
-
The yFiles.NET assemblies can easily be bundled into NuGet packages. The packages support multiple targets.
- New and improved demos
-
Added import feature for
BPMN2.0 abstract syntax format (Diagram Interchange).
New Features
View
-
The
DefaultLabelStyleclass got some new features:- Support for insets that specify a distance between the label border and the label content.
- New properties for minimum and maximum size to restrict the size of the label.
- The ability to quantify the preferred size to avoid unnecessary floating point precision when saving.
- New static properties to enlarge the preferred size which can be useful when converting graphs between different platforms.
-
The
CreateEdgeInputModeclass can now create edges in reversed direction, i.e., starting from the target port.- The new
EdgeDirectionPolicysupports starting creation at the source, at the target, in the last direction, or depending on the port candidate. - A configurable
ToggleDirectionRecognizerallows changing the edge direction during creation.
- The new
-
The new property
MoveLabelInputMode.AllowUnselectedenables moving labels without having to select them first. -
The method
CreateEdgeInputMode.DoStartEdgeCreationthat is used to programmatically start an interactive edge creation gesture now returns aTaskwith the newly created edge as result (ornullif the gesture was canceled). -
The method
MoveInputMode.DoStartDragthat is used to programmatically start an interactive drag gesture now returns aTaskwith the affected items as result (ornullif the gesture was canceled). -
The
GraphModelManagerclass has the new methodsRaise,Lower,ToFrontandToBackthat allow for changing the z-order ofIModelItems. All these z-order-related methods can also be triggered by the new commandsRaise,Lower,ToFrontandToBack.In addition, the
GraphEditorInputModeclass provides the new methodsRaiseSelection,LowerSelection,SelectionToFrontandSelectionToBackthat change the z-order of all selectedIModelItems. -
The new
PortStyleDecorationInstallerclass allows the use of anIPortStyleto render the selection, highlight, or focus indicator of ports.
Layout
-
The
HierarchicLayoutclass is now able to uniformly distribute ports at group nodes - with a few restrictions. The new propertyHierarchicLayoutData.UniformPortAssignmentGroups. defines the groups for which the feature should be enabled. -
The
HierarchicLayoutclass is now able to consider individual crossing costs for edges and for crossing a group node border. These can be defined with theHierarchicLayoutData.EdgeCrossingCostsand theHierarchicLayoutData.GroupBorderCrossingCostsproperties.In addition, the new callback method
DefaultLayerSequencer.GetCrossingCostallows to define an individual crossing cost value for a specific pair of edges when using this sequencer for theHierarchicLayout. In order to easily retrieve the original edge instance when customizing the hierarchic layout, theHierarchicLayout.GetOriginalEdgemethod was added. -
The
LeftRightNodePlacerclass now supports layouts with multiple branches. With this feature, subtrees can not only be placed left/right of a single vertical bus, but left/right of multiple vertical buses (the branches). The new propertyBranchCountallows to configure the number of branches. -
The tree node placer
GridNodePlaceroffers the following new features:- The placement of the bus for routes to its children can now be configured using the new enumeration
BusPlacement. Available placements areLeading,TrailingandCenter. - Child sub-trees can be assigned to rows automatically using the new property
GridNodePlacer.AutomaticRowAssignment. - The new alignment policy
GridNodePlacer.BusAlignedaligns the root node with the bus.
- The placement of the bus for routes to its children can now be configured using the new enumeration
-
The
OrganicLayoutclass is now able to consider user-specified inertia and stress values for nodes. -
The
OrthogonalLayoutclass is now able to consider custom crossing and bend costs for edges. They can be specified using the new propertiesOrthogonalLayoutData.EdgeCrossingCostsandOrthogonalLayoutData.EdgeBendCostsrespectively. -
The new
InteractiveOrganicLayout.CompactnessFactorproperty specifies the compactness of the result. If the graph contains several components, this feature can prevent that the components drift apart. -
The new
GivenCoordinatesStageclass changes node locations and edge paths to user-specified values before invoking the core layout algorithm. To specify locations and paths, use the newGivenCoordinatesStageDataclass. -
The new
GenericPartitionGridSupportStageclass offers generic support for partition grid structures. -
The
OrganicLayoutclass is now able to produce 3D layout results. -
The new
ChannelRoutingToolclass brings back the features of theChannelRouterclass that was removed in version 3.0.
Improvements
Graph and View
-
GraphOverviewControlno longer draws nodes and edges that are hidden viaVoidNodeStyleandVoidEdgeStyle. -
NodeStylePortStyleAdapterandPortControlPortStylenow have anOffsetproperty that allows to shift the port visualization so that it no longer is centered over the port. -
The
GraphModelManagerclass has new factory methods for creating theItemModelManagerof each item group. -
DefaultEdgePathCropper's methodsCropEdgePathandCropEdgePathAtArrowhave been made virtual. -
The performance of
EdgePathLabelModel.GetGeometryandEdgeSegmentLabelModel.GetGeometryhas been strongly increased. -
The
GraphModelManager.GetModelItemmethod now always returns theIModelItemfor anICanvasObjectretrieved for it viaGetMainCanvasObject. Previously this only worked in all cases for theICanvasObjectretrieved viaGetCanvasObject. -
Added the
GraphClipboard.GetIdmethod to facilitate retrieving the original item from which an item to be pasted has been copied from. -
The new property
GraphClipboard.ClipboardContextprovides access to the currentIGraphClipboardContextduring a clipboard operation. -
The properties
RectangleIndicatorInstaller.TemplateandOrientedRectangleIndicatorInstaller.Templatenow return always the value that has been set by client code and are not modified by internal code anymore. -
GraphBuilder'sEdgeLabelProvidernow is a function with return typeobjectinstead ofstring. The label text will be thestringreturned by the provided item'sToStringmethod.
Input
-
The new property
CreateEdgeInputMode.ShowTargetHighlightspecifies whether to enable or disable highlighting of potential targets for edge creation. Also, the methodUpdateTargetHighlighthas been added to allow for further customization of the highlight. -
The new properties
PortRelocationHandler.ShowTargetHighlightandPortRelocationHandlerProvider.ShowTargetHighlightspecify whether to enable or disable highlighting of potential targets for edge creation. Also, the methodUpdateHighlighthas been added to thePortRelocationHandlerclass to allow for further customization of the highlight. -
The new properties
PortRelocationHandler.ShowPortCandidatesandPortRelocationHandlerProvider.ShowPortCandidatesspecify whether to enable or disable showing port candidates during edge relocation. -
The
GraphEditorInputMode.DeletedItemevent provides now context information about the state before the item has been deleted. For example, if a label has been deleted you now can get its old owner. -
The method
GraphEditorInputMode.OnDeletedItemis now virtual. - Snaplines are now infinitely long by default.
-
HandleInputModenow clears theAffectedItemsafter theCanceledevent has been raised instead of before. -
GraphEditorInputModeprovides new protected methodsCreateLabelCoreandEditLabelCoreto allow for overriding the default implementations. - Fixed some rare cases where a new label was erroneously created by interactive editing instead of editing an existing one.
-
The methods
AddLabel,CreateLabelandEditLabelofGraphEditorInputModeandTableEditorInputModethat are used to start the respective interactive label editing gesture programmatically now return aTaskwith the edited or newly created label as result. Therefore, these methods can be awaited. -
GraphEditorInputModeprovides aTextEditorInputModeConfiguratorproperty to allow for configuring theTextEditorInputModebefore each label editing. -
NavigationInputMode: Added a propertyScrollToSelectionthat controls whether a node that is focused or selected with a keyboard gesture is automatically scrolled into the viewport if necessary.
GraphML Serialization
-
The
GraphMLIOHandlerclass now supports reading and writing arbitrary objects at graph level. - GraphML: Name mappings for both closed and unbound generic types are now supported.
-
GraphML: Generic type arguments are now available as a property of the
QueryTypeEventArgs. -
SizeDValueSerializerandSizeDConvertercan now read the strings "Zero" and "Infinite". -
RectDValueSerializerandRectDConvertercan now read the string "Infinite". -
PointDValueSerializerandPointDConvertercan now read the string "Origin".
Graph-Layout-Bridge
-
Combining multiple
LayoutDataclasses is now easier:- The base class
LayoutDataoffers a new methodCombineWiththat combines the current instance with anotherLayoutDatainstance. - The class
CompositeLayoutDatahas an additional constructor that takes a variable number ofLayoutDatainstances.
- The base class
-
The new
PortAdjustmentPolicyproperty ofLayoutExecutorandLayoutGraphAdapterreplaces the previousImprovePortAssignmentboolean property. The new property is of typePortAdjustmentPolicyand offers more options for adjusting the port locations after a layout calculation. -
The viewport animation of the
LayoutExecutorclass considers now the value of theLimitFitContentZoomproperty of the correspondingGraphControl.
Hierarchic Layout
-
The
HierarchicLayoutclass now also considers critical edge priorities for grouped edges. -
The
HierarchicLayoutclass now also considers sequence constraints for grouped edges. -
The
HierarchicLayoutclass now uses the specified layer alignment to align sub-components (seeHierarchicLayoutData.SubComponents). -
With
HierarchicLayout, the number of edges crossing through group nodes without starting or ending in them when using the default algorithm settings was reduced. Furthermore, the behavior can be customized using the new group node border crossing costs (see propertyHierarchicLayoutData.GroupBorderCrossingCosts). -
The
HierarchicLayoutclass no longer inserts superfluous bends for edges between group nodes if the input graph contains grouped edges. -
The layering of
HierarchicLayoutwas improved with respect to the resulting edge lengths if the recursive group layering feature is enabled. -
The
HierarchicLayoutclass now produces less overlapping elements for graphs with fixed coordinate hints. -
The
HierarchicLayoutclass now correctly calculates the group node bounds. Previously, the groups' insets were slightly too large (up to one pixel). -
The
HierarchicLayoutclass now always places a port label in the middle of a node side, if it is the only port on that side. Previously it was only centered if the label was additionally placed on the edge. -
The
HierarchicLayoutclass now requires less memory for graphs with sequence constraints.
Edge Routing
-
The
EdgeRouternow supports edge grouping on both endpoints. Previously, an edge could only be part of either a source or a target group. -
The
EdgeRouterclass now generates less edge-edge overlaps and a better distribution of edge segments when theEdgeRouter.MaximumDurationis strongly restricted or set to zero, or when the algorithm is stopped via theAbortHandler.Stopmethod. -
The
EdgeRouterclass now avoids superfluous bends that were in some cases caused by group nodes with (small) inset values. -
The path search performance of the
EdgeRouterclass has been improved for cases where an edge has a strong, externalPortConstraintor a fixed, externalPortCandidate. -
The
EdgeRouterclass now generates a proper routing from a group node border to a port location inside this group node defined by a strongPortConstraintor a fixedPortCandidate. Previously, the route was only calculated to the border and then the last segment was extended without consideration of obstacles and other elements. -
The new properties
AbortHandler,SourcePortConstraints,TargetPortConstraints,SourcePortCandidates, andTargetPortCandidatesofChannelEdgeRouterDatafacilitate using these features withChannelEdgeRouter.
Labeling
-
The performance of the
GenericLabelingalgorithm and the quality of the label placements were improved. -
The quality of edge label placement of the
GenericLabelingclass was improved in case that there are multiple labels with a source or target preference near the same node. They may now be placed further away but avoid undesired overlaps.
Other Layouts
-
The new
OrthogonalLayout.PreferParallelRoutesproperty allows for controlling how parallel edges (multi-edges) are routed. -
New options of the
PlaceNodeAtBarycenterStageclass allow for specifying the size of affected nodes, considering the grouping structure when calculating the barycenter of nodes as well as removing the bends of edges incident to affected nodes. -
The
TreeReductionStagenow marks non-tree edges if anIDataAcceptoris registered with the input graph with keyTreeReductionStage.NonTreeEdgeSelectionKey. This way a user is able to query which edges the algorithm determined to be the non-tree edges. -
The
RecursiveGroupLayoutclass now allows to define a localPartitionGridstructure for each recursively handled group node. See the new propertyRecursiveGroupLayoutData.GroupNodePartitionGridsfor details. -
If the master edge is clipped on the bounds of its source or target, the
ParallelEdgeRouterclass now always clips the associated parallel edges on that bounds, too. -
The
RemoveCollinearBendsStage.Scaleproperty now also allows zero and negative numbers as its value. This makes it possible to internally round coordinates to full integer values for the comparison of bend points and, thus, the stage can be made more fuzzy. -
The properties
RowsandColumnsof classPartitionGridare now of typeIEnumerable<RowDescriptor>andIEnumerable<ColumnDescriptor>instead of an un-typedYList. -
The
PartitionGridDataclass has new propertiesOptimizeRowOrderandOptimizeColumnOrderto indicate whether or not the order of the rows respectively columns should be chosen automatically to minimize edge lengths.In addition, the
RowIndicesandColumnIndicesproperties of thePartitionGridDataclass can now also be used in combination with theGridproperty. -
The
PortCalculatorclass now considers edge label positions such they are not affected by whether this stage is applied or not (see propertyLayoutExecutor.PortAdjustmentPolicy). Previously, label positions could be changed if the label position was stored relative to the first or last segment or the port.
Demos
- The demos now have shorter project and folder names.
Bugfixes
Graph and View
- Fixed a bug in the graph implementation that sometimes lead to a runtime that was quadratic in the number of nodes when creating large graphs.
-
Fixed a bug in the
UndoEngineclass that resulted in memory leaks if the tokens returned byGetTokenwere not disposed when theUndoEnginegot cleared. -
The
nullcheck for theGridVisualCreator.Penproperty works correctly now. -
Fixed a bug in
EdgePathLabelModelwhich could return an invalid geometry for parameters with a ratio < 0 and zero length edge segments. -
GeneralPath.Flatten(): Fixed unexpected behavior if a curve follows after a close operation. -
Fixed a bug in
DictionaryMapperandWeakDictionaryMapperwhere entries with keynullwere not included in the mapper'sEntriesenumeration. -
Fixed an exception which could occur in
CanvasControl's methodCompareRenderOrderand when usingGraphModelManager'sComparerproperty. -
Fixed some false positive errors emitted by
PEVerifydue to unused methods. -
Fixed a bug in
FilteredGraphWrapperwhich prevented port labels from being correctly added or removed together with their port owner after the predicate changed. -
Setting
nullorVoidNodeStyle/VoidEdgeStyleas theNodeStyle,GroupNodeStyleorEdgeStyleinOverviewGraphVisualCreatorno longer results in aNullReferenceException. -
TextVisual.GetBoundsnow returns correct results for Format alignments other then Near.
Input
- Reparenting an expanded group node into a collapsed group node no longer throws an error.
-
With
SmartEdgeLabelModel, it was impossible to move a label from the left side of an edge to the right side. Instead, the label stopped at the edge. -
The
CreateEdgeInputModeclass now considers the value of theCanvasControl.HitTestRadiusproperty when itsStartOverCandidateOnlyproperty is enabled. -
GraphClipboard's methodsOnElementCutandOnElementCopiedare no longer called for graph items which are not copied themselves but are owners of copied items.As a consequence, the methods
CutandCopyof theIClipboardHelperimplementations of these elements are no longer called, either. -
When an edge is duplicated using
GraphClipboardand a port is newly created during this operation, the new port now gets the old port's style and tag. -
The visualization of source port candidates by the
CreateEdgeInputModeclass does not flicker, anymore. -
Fixed a bug in
GraphEditorInputModewhere changing the value ofShowHandleItemswhile handles were already displayed resulted in duplicate handles. -
Fixed a bug in
PortRelocationHandleProviderwhere the settingsShowPortCandidatesandShowTargetHighlightwere ignored. -
Fixed a bug in
CreateEdgeInputMode.GetPortOwnerwhich could return edges even ifAllowEdgeToEdgeCreationwas set to false. This could result in the edge'sIPortCandidateProviderbeing queried for candidates erroneously. - Zooming the viewport during interaction no longer synthesizes mouse-move events in the wrong locations.
GraphML Serialization
- Parsing a GraphML file with a folding edge state with a label without a preferred size no longer throws an error.
-
Labels at folder nodes and their adjacent edges are no longer lost during GraphML deserialization
if the
DefaultFolderNodeConverter.CopyFirstLabelproperty is enabled. - Fixed GraphML exception when parsing generic types.
Hierarchic Layout
-
The
HierarchicLayoutclass now correctly considers the group insets for input graphs with nested group nodes. Previously, it sometimes produced too large insets for inner groups. -
The
HierarchicLayoutclass no longer throws an error if it is wrapped by an instance ofRecursiveGroupLayoutand the input graph contains layering constraints between elements of different groups. -
The
HierarchicLayoutclass no longer throws anArgumentExceptionfor some rare cases in incremental layout mode. -
The
HierarchicLayoutclass now produces shorter, more direct edge routes for edges connecting at a group node and leaving on the the left/right group side. This only affects cases where the relevant group node also contains direct-content edges (seeEdgeLayoutDescriptor.DirectGroupContentEdgeRouting). -
Self-loop segments generated by the
HierarchicLayoutclass are now shorter and take up less space if possible. Previously, segments were sometimes unnecessarily long even though the minimum length settings allowed shorter segments. -
The
HierarchicLayoutclass now produces less superfluous crossings if there are same-layer edges withPortConstraintsorPortCandidates. -
The
HierarchicLayoutclass now correctly handles port labels with zero height or width. Previously, such labels may have caused very large distances between some nodes. -
The
HierarchicLayoutclass sometimes threw anArgumentErrorfor input graphs that contained incremental elements in combination with groups. -
The
HierarchicLayoutclass now places sloped segments of grouped octilinear edges such that they are perfectly overlapping each other. Previously, it could happen that segments were slightly displaced with respect to each other. -
The
HierarchicLayoutclass no longer causes non-orthogonal segments when the input contained port labels in conjunction with edge grouping. -
The
HierarchicLayoutclass sometimes threw anArgumentErrorfor input graphs that contained fixed elements in combination with both swimlanes and groups. -
The
HierarchicLayoutclass now correctly considers fixed nodes with layering constraints. In previous versions there were some rare cases where such inputs caused infinite looping issues. -
The
HierarchicLayoutclass no longer produces intersections between edges and elements of a sub-component (seeHierarchicLayoutData.subComponents). Note that this fix may sometimes cause less compact results within a layer. -
The
HierarchicLayoutclass no longer throws an exception if the component arrangement policy is set toComponentArrangementPolicy.Compactand bus routing is enabled (see propertyHierarchicLayoutData.Buses).
Tree Layout
-
The
CompactNodePlacerclass no longer throws an exception for input graphs with specified memento strategies (seeTreeLayoutData.CompactNodePlacerStrategyMementosorCompactNodePlacer.StrategyMementoDpKey). -
The
CompactNodePlacerclass now correctly considers the specified values of theVerticalDistanceandHorizontalDistanceproperties. -
The
CompactNodePlacerclass no longer throws an exception for some inputs with specified strategy memento information. -
The
SimpleNodePlacerclass no longer produces unnecessarily long horizontal edge segments.
Edge Routing
-
The
EdgeRouterclass now correctly routes direct content edges with strong port constraints at the group nodes. Previously, the algorithm sometimes produced weird routes for such edges. -
Fixed a bug in the
EdgeRouterclass that sometimes caused a non-deterministic behavior. -
The
EdgeRouterclass now correctly handles edges with external ports. Previously, such inputs may have caused an exception. -
The
EdgeRouterclass now correctly groups edges associated with equal group IDs that have a different object ID. -
A rare error that was triggered by the
EdgeRouterclass during routing when aGridis defined on which edges need to be routed is now fixed. -
The
EdgeRouterclass now avoids unnecessary bends in cases that containPortCandidateswith fixed offsets (or strongPortConstraints) where the fixed port locations have a very similar x- or y-coordinate such that the path must consist of three segments with a single, very short middle segment. Previously, five segments in total were generated. -
The
PolylineLayoutStageclass no longer generates overlaps between sloped, polyline segments created by the stage and unrelated other obstacles (e.g. nodes). -
Fixed a rare error that was triggered by the
EdgeRouterclass during routing in cases where the input contained grouped edges. -
The
EdgeRouterclass no longer throws an exception if theEdgeRouter.PolylineRoutingproperty is enabled and the input contains fixed, grouped edges. -
The
EdgeRouterclass now considers the correctNodeHaloassociated with the target node when handling the minimum last segment length setting. Previously it incorrectly considered the halo of the source node which could lead to unnecessarily long or too short last segments. -
The
EdgeRouterclass now correctly considers intersections between edges and labels of fixed edges if propertyConsiderEdgeLabelsis enabled. -
The
EdgeRouterclass no longer throws an error during routing in cases where the source or target node is covered by obstacles (i.e. by other nodes or labels). -
The
EdgeRouterclass now correctly considers intermediate routing points when using the polyline routing style. Previously, it could happen that intermediate points were not part of the final polyline edge path. -
The
EdgeRouterclass no longer considers allPortCandidateswith multiple directions as fixedPortCandidates. -
Fixed two issues that induced the violation of a
PortCandidatewith fixed offsets (or a strongPortConstraint) by theEdgeRouterclass. The first was only triggered for constraints at the target side and only when the target node was additionally partly or fully covered by other obstacles (e.g. node labels). The second issue appeared in cases with the source and target node fully overlapping (e.g. an edge from a group to a child node). -
Improved the path search performance of the
EdgeRouterclass for cases where a large number of fixed and overlapping edge segments exist. Previously, the search could become very slow in such scenarios. -
The
EdgeRouterclass now correctly handles cases where the maximum duration is exceeded and where previously an exception was triggered. -
Fixed a
StackOverflowExceptioninEdgeRouter. -
The
EdgeRouterclass no longer produces bad, non-orthogonal edge segments in cases where a selected edge is grouped together with an un-selected edge and where both edges have strongPortConstraintsat their common source/target node. -
The
EdgeRouterclass no longer throws an exception if all fixed edges of a bus are non orthogonal/octilinear. -
The
EdgeRouterclass now correctly considers strong port constraints of edges that belong to a bus structure.
Labeling
-
The
GenericLabelingclass now produces better results for edge labels that have a preferred distance to the edge (PreferredPlacementDescriptor.DistanceToEdge) and at the same time multipleSideOfEdgepreferences (e.g. left of edge and on the edge). Previously, the algorithm sometimes violated the preferred distance even though it would have been possible to keep it. -
The
GenericLabelingclass now correctly places labels of direct content edges (edges that directly connect a group node with a descendant, without leaving the group) with a free edge label model. -
The
GenericLabelingclass no longer calculates wrong label profit values for some edge labels. Previously, edges that had aPreferredPlacementDescriptorwere sometimes affected. -
The
GenericLabelingclass now always prefersLabelCandidateswith higher profit values over others with lower profit. Previously, this sometimes happened even though both candidates did not intersect with other elements. -
The
GenericLabelingclass no longer assumes that allLabelCandidatesassociated to a label have the same size. Previously, this caused unexpected labeling results if custom candidates with different sizes were given. -
We fixed a rare bug in the
GenericLabelingthat may have caused anArgumentExceptionfor some input graphs that contain edges with zero length segments and labels associated with a free edge label model. -
The
GenericLabelingclass no longer throws anArgumentExceptionfor some input graphs containing labeled edges with zero length.
Other Layout Styles
-
The
OrthogonalLayoutclass no longer throws an exception when propertyOrthogonalLayout.UniformPortAssignmentis enabled and the input contains parallel edges. -
The
OrthogonalLayoutclass no longer causes an exception for some input graphs when propertyFaceMaximizationis enabled. -
The
OrthogonalLayoutclass no longer runs into an infinite loop for some input graphs that are tree structures with mixed edge directedness. Note that the problem only occurred if propertyOrthogonalLayout.TreeStyleis not set toTreeLayoutStyle.None. -
The
OrganicLayoutclass no longer throws an exception when usingCycleSubstructureStyle.Circularand arranging a cycle structure where at least one cycle node is also connected to a group node outside the cycle. -
The
OrganicLayoutclass now produces deterministic results for group nodes if its propertyDeterministicis enabled. -
The
OrganicLayoutclass now correctly considers input graphs where substructure handling is enabled and all nodes are located at coordinate(0,0). Previously, such inputs may have triggered anArgumentException. -
When using
RecursiveGroupLayout, the values of the propertiesComputedWidth,ComputedHeightandComputedPositionof the classesColumnDescriptorandRowDescriptorare now correctly set after the layout ifEdgeRouteris the correspondingInterEdgeRouter. -
The
ComponentLayoutclass now correctly handles input graphs with user-specified components that contain nodes withnullas their component ID (see propertyComponentLayoutData.ComponentIds). Previously, such inputs may have caused an exception. -
The
SeriesParallelLayoutclass now correctly handles input graphs with groups that only contain disconnected nodes. Previously, such inputs caused an exception. -
The
PartialLayoutclass now correctly considers the specifiedPortCandidatesduring orthogonal or octilinear routing of edges. -
The
PartialLayoutclass does no longer reduce the size of fixed group nodes if the optionPartialLayout.ResizeFixedGroupsis disabled. -
The
OrganicRemoveOverlapsStageno longer produces infinite loops in some rare cases. -
The
PortPlacementStageclass no longer destroys the grouping information for the core layout algorithm. -
Fixed a bug in
YGraphAdapterthat could trigger aNullReferenceExceptionwhen boolean, integer or double values were requested from registeredIMapperbut no value had been set beforehand. -
The
GraphStructureAnalyzer.HasMultipleEdgesmethod now returns the correct result for input graphs with self-loops. -
The
Paths.FindAllChainsmethod now correctly calculates the chains for input graphs with cycles. -
The
Bfs.GetLayersmethod now correctly stores the layer indices in the specifiedINodeMap. Previously, the maximum layer index stored in the map exceeded the number of returned layers. - Fixed a bug which caused licenses for public tokens not to work for the algorithms assembly.
Incompatible Changes
Incompatible API Changes
-
The
ImprovePortAssignmentboolean property ofLayoutExecutorandLayoutGraphAdapterhas been replaced by thePortAdjustmentPolicyproperty. -
SingleItemCollection'sItemproperty has been pulled up toItemCollection. ClassSingleItemCollectionhas been removed, its usages have been replaced byItemCollection. -
ItemCollection's type parameter has been constrained to reference types. -
The following properties of specific layout data types now have a name with the correct plural or singular
usage.
-
HierarchicLayoutData.AlternativeEdgePathhas been renamed toAlternativeEdgePaths. -
TreeLayoutData.LeftRightPlacersLeftNodeshas been renamed toLeftRightNodePlacerLeftNodes. -
TreeLayoutData.DelegatingNodePlacersPrimaryNodeshas been renamed toDelegatingNodePlacerPrimaryNodes. -
FixNodeLayoutData.FixedNodehas been renamed toFixedNodes.
-
-
The type of the properties
BalloonLayoutData.TreeRootandTreeLayoutData.TreeRoothas been changed toSingleItem<INode>. -
The property
HierarchicLayoutData.AlternativeEdgePathsnow expectsIEnumerable<IPoint>instead ofYPointPathas mapped values. -
The property
HierarchicLayoutData.AlternativeGroupBoundsnow expectsIRectangleinstead ofYRectangleas mapped values. -
The properties
RowsandColumnsof classPartitionGridare now of typeIEnumerable<RowDescriptor>andIEnumerable<ColumnDescriptor>instead of an un-typedYList. -
The properties
SourceGroupsandTargetGroupsofRadialLayoutDatahave been removed since edge grouping is not supported by theRadialLayoutclass. -
The
PenaltySettings.InvalidEdgeGroupingPenaltyproperty has been removed. If edge groups are defined, theEdgeRouterclass now always considers them. Therefore, this setting no longer applies. -
IXamlNameMapper.GetTypenow has a third argument for optional type parameters. -
Class
TextVisualnow is sealed. -
GraphBuilder'sEdgeLabelProvidernow is a function with return typeobjectinstead ofstring. The label text will be thestringreturned by the provided item'sToStringmethod.
Changes of Default Behavior
-
The
SimplexNodePlacer.BarycenterModeproperty is now enabled by default. Thus, theHierarchicLayoutclass with default settings now produces different (usually more symmetric) layouts. -
GraphClipboard's methodsOnElementCutandOnElementCopiedare no longer called for graph items which are not copied themselves but are owners of copied items.As a consequence, the methods
CutandCopyof theIClipboardHelperimplementations of these elements are no longer called, either. -
The default tooltip of the
ToolTipQueryEventArgsclass is now set tonull. Thus, the tooltip is not displayed when the event is handled without setting the tooltip content. -
The properties
RectangleIndicatorInstaller.TemplateandOrientedRectangleIndicatorInstaller.Templatenow return always the value that has been set by client code and are not modified by internal code anymore. -
The
GroupingSupportclass no longer throws anArgumentExceptionif there is a node without associated ID. Instead the class uses the node itself as ID. -
The
HierarchicLayoutclass now uses a higher crossing cost for group node borders. To specify custom values, use the propertyHierarchicLayoutData.GroupBorderCrossingCosts. -
If the master edge is clipped on the bounds of its source or target, the
ParallelEdgeRouterclass now always clips the associated parallel edges on that bounds, too. -
The default value of the property
GridNodePlacer.RootAlignmentwas changed toGridNodePlacer.BusAlignedfromRotatableNodePlacerBase.RootAlignment.Trailing.
Minor Incompatible Changes
-
The method
LayoutData.Applyis now protected instead of public. -
The
YList.SubListmethod was removed since it was not implemented at all and is not used by the library. - The
clonemethods of the geometric typesPoint,Rect,Size, andInsetswas removed since these types are immutable and the methods just returnedthis. -
The classes
GeneralPathandGeneralPathCursorare now sealed. -
The following changes regarding the expert API related to the
EdgeRouterclass were made:- The first parameter of the constructors in class
SegmentInfoBaseis now of typeObjectinstead ofEdge. The provided type should be eitherPathRequestfor affected edges orEdgefor non-affected, fixed ones. Furthermore, the propertySegmentInfoBase.Edgehas been removed as the info is not necessarily associated with an edge anymore. - Similarly, the first parameter of the constructor in class
EdgeCellInfois now of typeObjectinstead ofEdge. The provided type should be eitherPathRequestfor affected edges orEdgefor non-affected, fixed ones. - The constructor of class
EdgeInfonow additionally takes a parameter of typeEdge. - The parameter of type
Edgefrom the constructor ofPathas well as the respective property were removed. A path is now not necessarily associated with an edge but only with the newly introducedPathRequest. - The method
PathSearchResult.GetEdgeInfo(Path)has been removed.
- The first parameter of the constructors in class
yFiles.NET 5.1.0.2
Improvements
OrganicLayoutData: The new propertiesSourceGroupIdsandTargetGroupIdscan be used to group edges when some preconditions are met.- The performance of the
GenericLabelingalgorithm and the quality of the label placements were improved. - Added the
FixPortLocationStageDataclass that allows to conveniently define the port constraints that are considered bytheFixPortLocationStageclass.
Bugfixes
- User interactions in a folded graph which contains labels at ports no longer throw an exception.
- An edge in a folded view no longer loses its bends and labels after it is reversed multiple times.
- Scrolling with
CanvasControl.AnimateScrollCommandsenabled no longer changes the zoom level. - The labels of dragged ports are now displayed correctly by the
PortDropInputModeclass. - The
EdgeStyleDecorationInstallerclass now properly displays decorations for edges between group nodes and their descendants when displayed in view coordinates. - The
EdgeStyleDecorationInstallerclass no longer causes an exception when used on edges that attach to other edges. - Reparenting an expanded group node into a collapsed group node no longer throws an exception.
- Fixed a bug in the graph implementation that sometimes lead to a runtime that was quadratic in the number of nodes when creating large graphs.
GridVisualCreatornow renders grids withGridStyleCrossesand different horizontal and vertical spacings correctly.- The
nullcheck for theGridVisualCreator.Penproperty works correctly now. PixelImageReporter'sExportmethod doesn't get stuck anymore when rendering a grid.ContextConfigurator'sSetupmethod doesn't createIRenderContextinstances with unboundClipanymore.- With
SmartEdgeLabelModelit now is possible to move a label from the left side of an edge to the right side. Fixed a bug which stopped the label at the edge. - Parsing a GraphML file with a folding edge state with a label without a preferred size no longer throws an exception.
- Fixed GraphML exception when parsing generic types.
- Fixed a bug that rendered labels or ports neither in a separate layer nor at their owner
when exactly one of
LabelLayerPolicy.AtOwnerorPortLayerPolicy.AtOwnerwas used. - The
AutoGroupNodeAlignmentPolicyvaluesCenterLeft,CenterRight,TopCenter,BottomCenter, andBottomLeftnow work correctly. - The visualization of source port candidates by the
CreateEdgeInputModeclass does not flicker, anymore. - Fixed an exception which could occur in
CanvasControl's methodCompareRenderOrderand when usingGraphModelManager'sComparerproperty. - Fixed a bug which might occur in very rare cases in the undo/redo processing of several consecutive reparent actions.
- Fixed a bug in the
UndoEngineclass that resulted in memory leaks if the tokens returned byGetTokenwere not disposed when theUndoEnginegot cleared. CollapsibleNodeStyleDecorator:IsHitrespects buttons outside the node bounds.
Algorithms
- The
Paths.FindAllChainsmethod now correctly calculates the chains of input graphs with cycles.
Layout
- The
HierarchicLayoutclass now correctly handles port labels with zero height/width. Previously, such labels may have caused very large distances between some nodes. - The
HierarchicLayoutclass sometimes threw anArgumentExceptionfor input graphs that contained incremental elements in combination with groups. - The
HierarchicLayoutclass now prevents intersections between labels and the horizontal grid lines of aPartitionGrid. - The
HierarchicLayoutclass now properly handles input graphs with source/target port labels and where a subset of nodes hasNodeHalos. Previously, such inputs could cause an exception. - The
HierarchicLayoutclass does not longer violate fixedPortCandidatesin cases where also critical edges (HierarchicLayoutData.CriticalEdgePriorities) and edges connecting to group nodes are given. - The
HierarchicLayoutclass now produces less superfluous crossings if there are same-layer edges withPortConstraintsorPortCandidates. - The
HierarchicLayoutclass no longer causes non-orthogonal segments when the input contained port labels in conjunction with edge grouping. - The
HierarchicLayoutclass now correctly calculates the required length of straight-line same-layer edges. Previously, the calculated length could have exceeded the required length by the value of theHierarchicLayout.NodeToEdgeDistanceproperty. - The
HierarchicLayoutclass now places sloped segments of grouped octilinear edges such that they are perfectly overlapping each other. Previously, it could happen that segments were slightly displaced with respect to each other. - The
EdgeRouterclass no longer throws an exception for some inputs containing edges with intermediate routing points. - The
EdgeRouterclass now correctly handles cases where the maximum duration is exceeded and where previously an exception was triggered. - Improved the path search performance of the
EdgeRouterclass for cases where a large number of fixed and overlapping edge segments exist. Previously, the search could become very slow in such scenarios. - Fixed a
StackOverflowErrorinEdgeRouter. - When using
RecursiveGroupLayout, the values of the propertiesComputedWidth,ComputedHeightandComputedPositionof the classesColumnDescriptorandRowDescriptorare now correctly set after the layout ifEdgeRouteris the correspondingInterEdgeRouter. - The
ComponentLayoutclass now correctly handles input graphs with user-specified components that contain nodes withnullas their component ID (see propertyComponentLayoutData.ComponentIds). Previously, such inputs may have caused an exception. - The
CompactNodePlacerclass now correctly handles inputs where the tree root is marked as assistant node, seeTreeLayoutData.AssistantNodes. - The
CompactNodePlacerclass now correctly considers the specified values of theVerticalDistanceandHorizontalDistanceproperties. - The
CompactNodePlacerclass now produces more compact results for some cases where it previously generated larger, less compact results. - The
CompactNodePlacerclass no longer throws an exception for some inputs with specified strategy memento information (either via propertyTreeLayoutData.CompactNodePlacerStrategyMementosor with a mapper registered with keyCompactNodePlacer.StrategyMementoDpKey). - The
OrthogonalLayoutdoes no longer throw an exception if a graph is almost a tree and itsTreeStyleproperty is set toTreeLayoutStyle.Integratedand a fixedTreeOrientationis set. - The
OrganicLayoutclass now produces deterministic results for group nodes if its propertyDeterministicis enabled. - The
OrganicRemoveOverlapsStageno longer produces infinite loops in some rare cases. - Fixed a potential exception in
LayoutExecutorwhich could occur when a layout is applied to a graph which contains table nodes which are not group nodes. - Fixed a bug in class
EdgeRouterthat sometimes caused a non-deterministic behavior. - The
PolylineLayoutStagedoes no longer generate overlaps between sloped, polyline segments created by the stage and unrelated other obstacles (e.g. nodes). - Fixed a rare exception that was triggered by the
EdgeRouterclass during routing in cases where the input contained grouped edges. - The
GenericLabelingclass now produces better results for edge labels that have a preferred distance to the edge (PreferredPlacementDescriptor.DistanceToEdge) and at the same time multipleSideOfEdgepreferences (e.g. left of edge and on the edge). Previously, the algorithm sometimes violated the preferred distance even though it would have been possible to keep it. - Fixed two issues that induced the violation of a
PortCandidatewith fixed offsets (or a strongPortConstraint) by theEdgeRouterclass. The first was only triggered for constraints at the target side and only when the target node was additionally partly or fully covered by other obstacles (e.g. node labels). The second issue appeared in cases with the source and target node fully overlapping (e.g. an edge from a group to a child node). - The
EdgeRouterclass no longer throws an exception if theEdgeRouter.PolylineRoutingproperty is enabled and the input contains fixed, grouped edges. - The
EdgeRouterclass now considers the correctNodeHaloassociated with the target node when handling the minimum last segment length setting. Previously it incorrectly considered the halo of the source node which could lead to unnecessarily long or too short last segments. - The
EdgeRouterclass now correctly considers intersections between edges and labels of fixed edges if propertyConsiderEdgeLabelsis enabled. - The
EdgeRouterclass no longer throws an exception during routing in cases where the source or target node is covered by obstacles (i.e. by other nodes or labels). - The
EdgeRouterclass now correctly considers intermediate routing points when using the polyline routing style (EdgeRouter.PolylineRouting). Previously, it could happen that intermediate points were not part of the final polyline edge path. - The
PartialLayoutclass now correctly considers the specifiedPortCandidatesduring orthogonal or octilinear routing of edges. - The
EdgeRouterclass no longer considers allPortCandidateswith multiple directions as fixedPortCandidates. - The
OrthogonalLayoutclass no longer throws an exception when propertyOrthogonalLayout.UniformPortAssignmentis enabled and the input contains parallel edges. - Self-loop segments generated by the
HierarchicLayoutclass are now shorter and take up less space if possible. Previously, segments were sometimes unnecessarily long even though the minimum length settings allowed shorter segments. - The
CompactNodePlacerclass now correctly handles input graphs that contain assistant nodes and given placement strategies (see theCompactNodePlacerStrategyMementosproperty of theTreeLayoutDataclass). - The
SeriesParallelLayoutclass now correctly handles input graphs with groups that only contain disconnected nodes. Previously, such inputs caused an exception.
yFiles.NET 5.1.0.1
Bugfixes
PortRelocationHandle.GhostVisualizationPenKeynow is excluded from obfuscation.- Fixed the Save command always opening a file dialog even if a file has been specified in a previous file operation.
- The cursor is now correctly reset after editing an orthogonal edge.
- The
CreateEdgeInputModeclass doesn't show port candidates anymore if bend creation is enforced (by pressingCTRLkey during edge creation). - Bridges sometimes didn't appear on edges when they were scrolled into the viewport.
- Fixed a possible infinite loop in the
OrthogonalEdgeHelperclass. - Fixed a possible
NullReferenceErrorwhich could occur in customizedLabelDropInputModeandPortDropInputModeclasses. - The
Clonemethod now is overridable in all style implementations. - The
INodeInsetsProviderimplementations which can be retrieved fromInteriorLabelModelandInteriorStretchLabelModelnow correctly sum up the space required by overlapping labels. - The scrollbars now respect viewport limits set by a
ViewportLimitereven if the limited bounds are smaller than theGraphControl'sContentRect. - Fixed a possible
NullReferenceExceptioninTableNodeStyleRendererwhen aTableNodeStyleis rendered withTableset to null. - The indicators for bend grid snapping were not always drawn at the correct position for bends which were implicitly moved with a selected edge.
- Fixed
ContextMenuInputModenot showing the context menu upon the first right click after application startup. - Added missing support for context menus opened with the keyboard. The
PopulateItemContextMenuevent will then be raised for selected items instead of the item under the mouse pointer. KeyboardInputModeno longer forgets custom key bindings when reinstalled.
Demo Improvements
- The
RenderPoliciesdemo has been updated with a better design and description. - Fixed some issues in
BPMNdemo which occured when the style of an edge was changed.
yFiles.NET 5.1
Major New Features
- Labels at Ports
- Labels can now be added to ports and the new label models
FreePortLabelModelandInsideOutsideLabelModelcan be used to place such labels. On the technical side,IPortnow extends theILabelOwnerinterface and the enum constantGraphItemTypes.PortLabelwas added. - Customizable Rendering Order
-
Labels and ports can now optionally be rendered directly in front of their owner. Such a
rendering order can make the ownership of labels and ports clearer if nodes overlap. Previously, all labels and
ports were rendered in front of all nodes. The new rendering order can be enabled by setting the new properties
LabelLayerPolicyandPortLayerPolicyofGraphModelManagertoLabelLayerPolicy.AtOwnerandPortLayerPolicy.AtOwner, respectively.The nesting options of
GraphModelManagerfor the visualizations of nodes and edges have been improved and clarified. The propertiesUseHierarchicNodeNestingandUseHierarchicEdgeNestinghave been combined into the newHierarchicNestingPolicyproperty. It takes values of the newHierarchicNestingPolicyenum. Its new optionHierarchicNestingPolicy.GroupNodesconfiguresGraphModelManagerto visualize all leaf nodes in one canvas object group while nesting all group nodes depending on their hierarchical depth. - Drag and Drop
- The new
LabelDropInputModeandPortDropInputModeclasses implement drag and drop for labels and ports, respectively. The API of these classes is similar toNodeDropInputModefor nodes. - Lasso Selection
- The new
LassoSelectionInputModeselects all model items inside a hand-drawn lasso region. This mode allows combinations of free-hand and straight-line sections during path creation. - Improved Orthogonal Layout
-
Many parts of the orthogonal layout algorithm have been significantly
improved. In many cases, the drawings created by this algorithm are now much more compact and have smaller edge
lengths, and they contain less crossings and perceived bends.
In addition, this layout now supports special layout styles of various substructures that are automatically detected in the input graph. Supported substructures are trees, chains and cycles. In addition to the style, the new feature offers more settings, like, for example, the desired tree layout orientation.
Parallel edges (multi-edges that share the same source and target node) are now routed as parallel as possible; if there are edge labels, the routes must differ somewhat. Previously, parallel edges were not handled explicitly and their routes were often very different, making the recognition of parallel structures difficult.
- Sub-components in Hierarchic Layouts
-
In a hierarchic layout, you can now define sub-components of the input graph such
that each sub-component is arranged by a user-specified layout algorithm. This allows hierarchical layouts where
parts of the graph are arranged in a different fashion, e.g., to emphasize special sub-structures. The new
HierarchicLayoutData.SubComponentsproperty can be used to configure the new sub-components feature of the hierarchic layout. - Tree Map Layout
-
Added the new layout algorithm
TreeMapLayoutthat generates tree maps. Tree maps present hierarchical data using nested rectangles (nodes) where each rectangle (node) gets its size depending on a specific dimension of data associated to it. The newTreeMapLayoutDataclass provides additional configuration options for this algorithm. - Tabular Layout Style
-
The new layout algorithm
TabularLayoutgenerates simple tabular arrangements of nodes. It allows to place nodes in rows and columns, such that each table cell contains at most one node. Among its features is, for example, a from-sketch mode, the possibility to exactly map nodes to specific cells or different vertical and horizontal alignments. The newTabularLayoutDataclass provides additional configuration options for this algorithm.
New Features
View
-
The following types and methods were added to support the new
LassoSelectionInputMode.- Added the
GraphInputMode.LassoSelectionInputModeproperty and a corresponding factory method.LassoSelectionInputModeis disabled per default. - The new
GraphInputMode.LassoSelectmethod programmatically selects all items in the providedGeneralPath. - The new
ILassoTestableinterface specifies whether the item is considered to be inside the lasso path. This is analog to theIMarqueeTestableinterface for marquee selection. - Any model item can be decorated with an instance of
ILassoTestableor provide one in its lookup. For this, theNode/Edge/Port/Label/BendDecoratorclasses got the newLassoTestableDecoratorproperty for decorating an item with a customILassoTestable. - The new
IsInPathmethod ofNode/Edge/Port/LabelStyleBasecan be overridden to customize the lasso testing behavior.
- Added the
- With
TableEditorInputMode, double clicking a stripe or stripe label now edits the label in the same way as for other graph items. RectDandSizeD: Added methods toreducethe size of anRectDandSizeDinstance, respectively.- The new static method
PositionHandlers.Combinecombines multiple position handler instances into a single instance. - Added the events
ElementsCopied,ElementsCut, andElementsPastedtoGraphEditorInputMode, and the eventElementsCopiedtoGraphViewerInputMode. - The new
Animations.CreateSequentialAnimationmethod creates an animation that animates multiple animations in sequence. - The rectangle of the marquee selection can now be customized with the new protected method
MarqueeSelectionInputModes.CalculateMarqueeRectangle. - Added new decorator implementations for table items. You can access these new decorators via
the new method
ITable.GetDecoratorwith theRowDecorator,ColumnDecoratorandStripeLabelDecoratorproperties. - If the new
CanvasControl.QuantizeInputCoordinatesproperty is enabled, world coordinates of mouse events are rounded to nicer values to avoid unnecessary precision. For example, you'll get the value 326.375 instead of 326.3758109495. The rounding is chosen based on the zoom level to ensure that there is almost no visual deviation. Lower zoom levels will result in coarser rounding, higher zoom levels will use exactly as much precision as necessary. By default, this option is enabled.
Layout
- Added the
TreeMapLayoutDataconfiguration class for the newTreeMapLayoutalgorithm. - Added the
TabularLayoutDataconfiguration class for the newTabularLayoutalgorithm. - Added the
TemporaryGroupNodeInsertionDataconfiguration class for the newTemporaryGroupNodeInsertionStagelayout stage. - The new
HierarchicLayoutData.SubComponentsproperty can be used to configure the new sub-components feature of the hierarchic layout. - The new
TreeLayoutData.CompactNodePlacerStrategyMementosproperty can be used to maintain similar layout styles over subsequent runs of compact tree layout. -
ShortestPaths: Added a-star (A*) algorithm for finding the shortest path between two nodes in a directed or undirected, arbitrary graph. -
The new property
OrthogonalLayout.MaximumDurationcontrols the preferred time limit of this layout algorithm. -
The new
OrthogonalLayout.UniformPortAssignmentproperty allows you to obtain results with a more uniform port assignment. -
TreeLayout: Added node placerCompactNodePlacerthat produces more compact tree layouts. It uses a dynamic optimization approach that chooses a placement strategy of the children such that the overall result is compact with respect to a specified aspect ratio, see propertyCompactNodePlacer.PreferredAspectRatio. -
EdgeRouternow supports routing through user-specified intermediate points. All specified points will lie on the edge route in the given order. See new propertyEdgeLayoutDescriptor.IntermediateRoutingPoints. -
EdgeRouter: Edges that connect group nodes with their descendants can now directly connect from the inside to the group node border. Previously, an edge needed to always leave the group node before connecting to it. The feature can be enabled/disabled individually for each edge using the new propertyEdgeLayoutDescriptor.DirectGroupContentEdgeRouting. -
Added convenience layout stage
TemporaryGroupNodesInsertionStagethat automatically generates a (non-nested) grouping structure from a given mapping of nodes to a component ID. This temporary grouping is meant for use during the run of the core layout algorithm of the stage. It allows, for example, easy use ofRecursiveGroupLayoutwithout the need for a real grouping structure when the requirement is that different sub-graphs need to be arranged with different layout algorithms.The new
TemporaryGroupNodeInsertionDataclass provides additional configuration options for this algorithm. -
The new
PlaceNodesAtBarycenterStageplaces a user-specified subset of nodes on the barycenter of their neighbors. During the core layout, these nodes are hidden.
Improvements
General
- The
PointD.ToMutablePointandRectD.ToMutableRectanglemethods now return aMutablePointinstead ofIMutablePointand aMutableRectangleinstead of aIMutableRectangle, respectively. - The new method
determines whether the path intersects with anotherGeneralPath.Intersects(GeneralPath)GeneralPath. - When reading GraphML with the deserialization property
IgnoreXamlDeserializationErrorsenabled, invalid property content is now skipped instead of discarding the whole object with such content.
Graph
- Many label model
CreateParametermethods now have default values for parameters that are not needed every time. InteriorStretchLabelModel: Added new parametersCenterHorizontalandCenterVerticalfor horizontal or vertical centered one-line labels.- The
ElementCopiedCallbackparameter of the methodsGraphCopier.CopyandGraphClipboard.Duplicateis now optional (and can be null). - Added a
Removemethod toNodeDecorator,LabelDecorator,EdgeDecorator,PortDecorator, andBendDecoratorfor easy removal of decorations. GraphBuildernow supports edges to and from group nodes.GraphBuildernow supports parent-child relationships between nodes defined inNodesSourcewhen noGroupsSourceis set. The parent node of such a relation is converted to a group node.- The default value of
DefaultPortCandidate.LocationParameteris nowFreeNodePortLocationModel.NodeCenterAnchoredfor nodes andBendAnchoredPortLocationModel.FirstBendfor edges instead of a parameter of an internal model. DefaultGraphhas new factory methods to customize undo unit creation.
View
- Added the new
CanvasControl.LimitFitContentZoomproperty which controls whether the maximum zoom level for theCanvasControl.FitContentmethod as well as theFitContentcommand is restricted to1or the value of theMaximumZoomproperty. - The new method
GraphModelManager.GetMainCanvasObjectreturns the canvas object that should be used when changing the visibility or z-order of a model item. - The
ComponentCommands.ScrollPagecommands now accept anyIConvertiblecommand parameter instead of only doubles and strings. - Akin to the two
CanvasControl.ZoomTomethods, there are now twoCanvasControl.ZoomToAnimatedmethods that animate the viewport change. - Assigning a new graph instance to
GraphOverViewControlnow keeps configuration changes made to the overview'sVisualCreatorinstance. - Selfloop edges are now properly displayed in the
GraphOverviewControl. - Animations after a layout don't break anymore if the graph is modified concurrently.
ICanvasObjectGroup.AddChild(Object,ICanvasObjectDescriptor): The second parameter is now a default parameter with default value null and therefore changed its attribute toCanBeNull. If no descriptor is passed,CanvasObjectDescriptors.AlwaysDirtyInstanceis used by the default implementation.GraphModelManagernow avoids unnecessary re-installation of items if they keep theirICanvasObjectGroup. By these re-installations the z-order of the item in its group was lost and a new visual was created.PolylineEdgeStylerenders better looking paths for self loop edges whose ports are near the node border.
Input
- The
CanvasControl.CreateInputModeContextmethod is now public instead of protected. GraphEditorInputModeandTableEditorInputMode: MethodEditLabelnow also returns a Future, similar toAddLabelandCreateLabel.- The
INodeparameter of theNavigationInputMode.EnterGroupmethod is now optional. If it is omitted ornullthe whole graph will be revealed. - Moving a node with the
MoveInputModefor unselected nodes now moves the bends of adjacent self-loops, too. - The new methods
FindNextItemandFindNearestItemofNavigationInputModecan be used to configure the determination of the "next" item. - The type parameter
Tof classItemDropInputMode<T> is no longer restricted toIModelItem. - The following input modes now release the mutex before dispatching their final event:
CreateEdgeInputModenow releases the mutex before dispatching theEdgeCreatedevent.MoveInputModenow releases the mutex before dispatching theDragFinishedevent.ResizeStripeInputModenow releases the mutex before dispatching theDragFinishedevent.
CreateEdgeInputModenow removes coinciding bends if orthogonal edge creation is enabled.- The new
CreateEdgeInputMode.GetSourcePortCandidatesprotected method makes source port candidate determination more flexible. - The new optional parameter
initialTargetLocationof theCreateEdgeInputMode.DoStartEdgeCreationmethod can be used to define the initial location that shall be used to find a target node. - During interactive edge creation, the tip of a newly created edge now only snaps to valid target port candidates to create orthogonal end segments.
CreateEdgeInputModenow always creates dummy ports during a gesture, instead of temporarily reusing real ports if available. This makes it possible to change, e.g. the dummy edge's source port's style during the gesture.- The new
CreateEdgeInputMode.StartOverCandidateOnlyproperty can be used to restrict the start of an edge creation gesture to directly hovered port candidates. - The new
TextEditorInputMode.TextBoxPlacementPolicyproperty provides finer control of what happens when theTextBoxis (partially) outside of the viewport. - The new
TextEditorInputMode.TextBoxPaddingproperty controls the padding between theTextBoxand the border of the canvas. - The
CanvasControl.Mouse2DClickedevent now reports the position of the mouse down event as its location. Previously, this was the location of the up events which can be slightly different. - The properties
MaximumSnapDistance,ShowHitPortOwnerCandidatesOnlyandVisualizationhave been added toPortRelocationHandleProviderand are applied to eachPortRelocationHandlecreated by this provider. - Added overridable methods to
PortRelocationHandleto allow customization of the port candidates. - The new
PortRelocationHandle.Visualizationproperty controls how the preview during edge reconnection is handled. A new option is to change the edge during the gesture, which improves fidelity of the preview in certain cases. - The new optional
contentparameter of theMouseHoverInputMode.Showmethod defines the content of the tool tip to show. Now, theGetToolTipContentmethod only gets called if no content was specified. - The static constants
SelectedMovablesPositionHandlerandSelectedMovablesHitTestablehave been added toGraphEditorInputMode. These are used as defaultPositionHandlerandHitTestableproperties ofGraphEditorInputMode.MoveInputModeand can be reused for other input modes. - Introduced new property
HandleMissingMouseEventsonCanvasControlwhich allows for configurable handling of mouse gestures which are only received partially. - Canceled input modes now don't run unnecessary hit tests.
- The
CanvasControlnow reports losing the mouse capture with aMouse2DEventwith the typeLostCapture. Several input modes listen to this event and cancel themselves upon it.
Table
- The last parameter of the following extension methods of
ITableis now optional:FindRow,FindColumn,FindStripe, andFindStripes. TableEditorInputModenow handles clicks similar toGraphEditorInputMode:- New
ItemClicked,ItemLeftClicked,ItemRightClicked,ItemDoubleClicked,ItemLeftDoubleClicked,ItemRightDoubleClickedevents are raised. - If an event is handled, its default behavior is prevented.
- The new properties
ClickableItemsandClickableRegionsdetermine for which items and regions a click event will be raised.
- New
Layout
- The new
LayoutExecutor.CreateLayoutGraphAdaptercallback method makes it possible to configure theLayoutGraphAdapterthat is used for the layout calculation. - The new
TreeLayoutData.CriticalEdgePrioritiesproperty can be used to specify critical edges. SmartEdgeLabelModelnow is properly handled by labeling algorithms, resulting in better label placements.- The new
ImprovePortAssignmentproperty ofLayoutExecutorandLayoutGraphAdapterenablesPortCalculatorto improve the port assignment. - The combination of
PartitionGridDataandTableLayoutConfiguratorhas been improved:PartitionGridDatanow reuses thePartitionGridcreated by theTableLayoutConfigurator.- Several methods have been added to
TableLayoutConfiguratorwhich provide access to thePartitionCellIdassignment of the configurator as well as the mappings betweenIRow/IColumnandRowDescriptor/ColumnDescriptor.
-
Major performance improvement for
EdgeRouterin routing scenarios where it is unavoidable to cross obstacles (e.g. other nodes or labels) in order to reach the target. This includes cases where a crossing is necessary to guarantee that port candidates/constraints at the target side are satisfied.In addition, several minor performance improvements reduce the runtime of the path search phase as well as the segment location assignment phase.
-
EdgeRouter: Improved quality in maze routing scenarios. Previously, it could happen that edge-node overlaps occurred even though there exists a more complicated path that yields no overlaps. -
BusRouter: Now automatically ignores non-orthogonal edges with fixed bus descriptor (seeBusDescriptor.Fixed) or transforms them into orthogonal edges if they are octilinear. In previous versions, the layout algorithm simply throws an error in such cases. -
MultiPageLayout: Improved runtime as well as layout quality if the input is a tree structure and the specifiedCoreLayoutis either an instance of classTreeLayoutorClassicTreeLayout. Furthermore, propertyMultiPageLayout.AdditionalParentCountallows to specify the number of additional proxies that the algorithm tries to add to a subtree. The original nodes associated with these proxies lie on the path of the tree's root to the subtree placed on a page. -
MultiPageLayout: Added propertyCreateProxyReferenceNodesthat allows to disable the creation of proxy reference nodes as well as propertyMultipleComponentsOnSinglePagethat allows to prevent that elements of different connected components are placed on the same page. -
PortPlacementStagenow additionally considers port grouping constraints. If two edges are port-grouped at a certain node, the stage assigns the same port location to the edges. Port groups are marked usingDataProviders registered withPortConstraintKeys.SourcePortGroupIdDpKeyandPortConstraintKeys.TargetPortGroupIdDpKey. -
TreeComponentLayout: Added propertyConsiderUndirectedTreesthat allows to specify whether or not undirected tree structures should be handled or not. Previously, only directed tree structures were considered. -
DefaultNodePlacerandSimpleNodePlacernow both support to specify a minimum distance between the edge segments that are routed orthogonally in the channel between the root node and the child nodes, see methodDefaultNodePlacer.MinimumChannelSegmentDistanceandSimpleNodePlacer.MinimumChannelSegmentDistancerespectively. -
ClassicTreeLayoutnow allows you to specify a minimum vertical distance for the horizontal edge segments of the bus, seeClassicTreeLayout.MinimumBusSegmentDistance. -
The new properties
LayerConstraintsandSequenceConstraintsofHierarchicLayoutDatacan be used to configure layer and sequence constraints for theHierarchicLayout. These supersede the previousLayerConstraintFactoryandSequenceConstraintFactoryproperties. -
OrthogonalLayout: Reduced the number of bends of directed edges. -
The
EdgeRouterclass now calculates a better routing for edges between group nodes and their descendants in the case that the routing is aborted viaAbortHandleror when the maximum duration time limit is up. Previously, such edges might not have been handled in this case, whereas now they always get a simple but valid orthogonal route. -
The
HierarchicLayoutclass now respects the sequence and layering constraints between subcomponents. Previously, such constraints were ignored. - Added
PlaceNodesAtBarycenterStageDatawhich allows to conveniently define the affected nodes that should be affected byPlaceNodesAtBarycenterStage. - The
HierarchicLayoutnow requires less memory for graphs with sequence constraints. - The
HierarchicLayoutno longer inserts superfluous bends for edges between group nodes if the input graph contains grouped edges.
Bugfixes
Graph and View
- Reduced memory consumption of
DefaultEdgePathCropper. - Fixed a bug that sometimes detects a mouse move instead of a mouse drag.
- The
Mouse2DEventTypes.Enteredevent now provides the correct coordinates. - Fixed a bug that sometimes prevented dispatching the mouse up event.
- Fixed an exception when an edge or label is pasted without selected target while its original owner is not in the current view.
PolylineEdgeStylenow takes arrow heads into account for visibility checks.- Removing an item that is currently highlighted with a custom
HighlightIndicatorManager,FocusIndicatorManager, orSelectionIndicatorManagerno longer results in aNullReferenceException. - The extension method
OrientedRectangleExtensions.GetCenterdidn't return the correct center if the width or height of the rectangle was equal to 0. - The
HitTestRadiusproperty of the following implementations ofICanvasContextnow correctly contain the value in world coordinates instead of view coordinates:- The context created by
Contexts.CreateCanvasContextwhen passing aCanvasControlbut no hit test radius. - The context passed to
IPositionHandlersbyMoveInputMode. - The context passed to adjacent handles when moving a bend handle.
- The context created by
- The
InteriorStretchLabelModel.GetMinimumNodeSizemethod now uses the correct insets for width calculation. Previously the top insets were erroneously used for the width. - Sometimes, the
GroupNodeDefaults.Labels.AutoAdjustPreferredSizeproperty and theGroupNodeDefaults.Ports.AutoCleanupproperty were not considered for labels and ports of groups. - The
ApplicationCommands.Copycommand is no longer executed twice. - The methods
GraphClipboard.CopyandGraphClipboard.Cutdon't copy items anymore which depend on items that are selected but not included inGraphClipboard.CopyItems. - Snap lines which indicate the same size are no longer shown for implicitly re-sized parent group nodes.
- The validation schema for GraphML has been fixed to work with more validators.
FreeEdgeLabelModel: Static propertyInstanceis now excluded from obfuscation.- The graph of an
IFoldingViewnow raises theNodeCreated,EdgeCreated,PortAdded,LabelAdded, andBendAddedevents after the created element is registered. This fixes a bug where the master item of the created item was not available in handlers for these events. - Fixed wrong types of exceptions:
GraphMLIOHandler: The methodsOnQueryNameandOnQueryTypenow throw anArgumentNullExceptioninstead of aNullReferenceExceptionwhen one of the arguments is null.Table: The methodsSetLabelText,Remove,SetLabelPreferredSizeandSetLabelLayoutParameternow throw anArgumentExceptioninstead of anInvalidOperationException.
- Undo units created by the execution of a layout algorithm are now correctly merged with undo units of the previously executed interactive gesture.
- The default implementation of
IPortSnapResultProvidernever returned any snap results. - Corrected weird scrolling behavior of the scroll bar when the viewport was outside the content rectangle.
DefaultGraphnow calls theOnRemovingEdgeandOnRemovingPortmethods before their incident items are removed.- The commands
Copy,Cut, andDuplicateare no longer enabled if there are no elements to cut, copy, or duplicate. - The
GroupingSupport.HasGroupNodesmethod now returns only true if there are actually group nodes in the graph. Previously, it returned also true if there once were group nodes which had been removed in the meantime. BevelNodeStyleRenderer,PanelNodeStyleRenderer,ShadowNodeStyleDecoratorandShinyPlateNodeStyleRenderernow consider the shadow in theirIsVisibleandGetBoundsmethods.- Bridges: For edges which cross each other with the same absolute slope now a bridge is added on exactly one of these edges, depending on the crossing policy (was: either on both edges or none of them).
GraphModelManager: FixedNullReferenceExceptionthat occured when any of the Descriptor properties were set while theGraphModelManagerinstance was not yet associated to anIGraph.GenericLabelModelserialization: Fixed cyclic reference in GraphML which could happen while serializing aGenericLabelModelwith a parameter with associated descriptor.- The methods
GetBoundsandIsVisibledescribing theRectangleIndicatorInstallerreturned wrong values. This could impact the performance as e.g. some node selection highlights were updated although they were not in the view port and result in unnecessary large content rectangles. - Fixed
IHitTestableimplementation ofDefaultPortCandidateDescriptorwhich used incorrect coordinates. - Fixed the Save command always opening a file dialog even if a file has been specified in a previous file operation.
PortRelocationHandleProvidernow can handle null as "graph" constructor parameter.- The
PreferredPlacementDescriptor.Equalsmethod incorrectly reported instances with different angles and distances as equal. SmartEdgeLabelModelcentered all labels on an edge that overlapped with a segment of the edge or were placed directly next to it.- Fixed a possible
NullReferenceExceptionin class Animator, that might be caused when usingMoveViewportInputModewith inertia. - Fixed viewport "jumping" during mouse wheel zoom in rare cases.
- GraphBuilder: Two group nodes can now reverse their parent/child relationship between two calls to UpdateGraph without an exception.
CanvasControl: Fixed possible changes toZoomwhen moving the viewport while aViewportLimiteris active.
Input
- Fixed possible
NullReferenceExceptionwhenTextEditorInputModewas uninstalled directly after starting an edit. ClickInputModeprovided wrong click locations in theClickedevent if aMouse2DEventTypes.Clickedevent without precedingMouse2DEventTypes.Pressedevent was processed.CreateEdgeInputModeandCreateBendInputModenow cancel onLostCaptureDuringDragevent.CreateEdgeInputModedid not show port candidates after re-installation of the input mode.- Moving an edge label with
SmartEdgeLabelModelthat is owned by an edge without visible path no longer throws an exception. ItemHoverInputModenow resets the hovered item when moving the mouse out of the control.GraphEditorInputModeandGraphViewerInputModeno longer ignore changes to their sub-input modes after having been installed once.- Disabling
MarqueeSelectionInputModeduring the gesture via code left the marquee visible on the screen. - While relocating edges, dropping a port over an invalid target or empty canvas no longer creates an empty undo unit.
- The
ClickedandDoubleClickedevents ofClickInputModewere sometimes missing when clicking on a node or edge. Now, they are always triggered unless the event was handled before. TextEditorInputMode: Inserting a line break now replaces selected text.- Node-to-edge snapping is now disabled by default which is the documented and intended value.
For this, the initial value of the
GraphSnapContext.NodeToEdgeDistanceproperty is set to-1.0. - The
LabelEditingEventArgs.Context.ParentInputModeproperty provided in the eventsGraphEditorInputMode.LabelAdding,GraphEditorInputMode.LabelEditing,TableEditorInputMode.LabelAddingandTableEditorInputMode.LabelEditingnow contains the correspondingGraphEditorInputModeorTableEditorInputModeinstance. CreateEdgeInputMode: TheValidBeginCursoris now correctly hidden during edge creation when bend creation isn't allowed.CreateEdgeInputModedidn't always update the highlight of possible source port candidates when itsShowPortCandidatesproperty was configured to show the source port candidates.- Switching the input mode in an event handler of the current input mode no longer throws an exception.
ItemHoverInputModeupdates the hovered item upon mouse drag events, too. This is the documented behavior. Previously, the hovered item was only updated on mouse move events.ItemHoverInputModeremoves the hovered item uponCancel.- The
ParentInputModeproperty of theInputModeEventArgsnow is the input mode which has raised the event. Previously, some input modes erroneously set theParentInputModeto the containingGraphEditorInputModeorGraphViewerInputMode. GraphClipboard: The contents of a folder node was not copied if the folder was copied from within a group view, i.e. if the user entered a group node. In the worst case, this might have frozen the complete application.MouseHoverInputMode.QueryToolTipwas raised twice for every mouse hover event.
Table
- When a stripe is removed,
ITable.LabelRemovedevents for the implicitly removed associated labels are now raised, too. - When a selected stripe label is edited its
TextBoxnow is correctly placed. - Selected stripe labels no longer remain selected after their owning stripe is deleted.
- Selected stripe labels no longer cause exceptions when hovering over them.
- The selection indicator for selected stripe labels is now shown correctly.
Layout
OrthogonalLayoutnow considers edge grouping also if there are no directed edges specified.-
In
EdgeRouter, an error occurred when there were intermediate routing points and the path search got aborted (e.g. because of maximum duration time limit). -
In
ShortestPaths, an error occurred when the a-star algorithm was applied to a graph with non-monotonic heuristic costs. -
In
HierarchicLayout, an error was triggered when ayWorks.Algorithms.Util.DataProviderAdapterthat does not override theDataProvider.getmethod was registered with keyGivenLayersLayerer.LayerIdDpKey. This issue only appeared in conjunction with subcomponents. - The
HierarchicLayoutnow produces less bends if the edges should be routed on a grid and the grid reference point is not(0,0), seeNodeLayoutDescriptor.GridReference. HierarchicLayoutdid sometimes not correctly consider the edge thickness for grouped edge segments. Even though there would have been space for a thick edge it was placed too close to other elements.HierarchicLayoutnow produces more symmetric results for grouped edges if propertySimplexNodePlacer.BarycenterModeis enabled.- Fixed a rare bug in
OrthogonalLayoutthat may have caused infinite looping for grouped input graphs. - For some input graphs the
OrganicLayoutproduced an error if theCycleSubstructureStyleproperty was set toCycleSubstructureStyle.Circular. CircularLayoutdoes now correctly consider theEdgeBundleDescriptor.Bundledproperty for edges between different partitions. Previously, when at least one of these edges had theBundledproperty enabled, all of them were bundled, ignoring the property value of the other edges.- Fixed a bug in
TreeMapLayoutthat may have causedNaN-coordinates or infinite looping for input graphs that are non-directed trees. - For grouped segments the
GraphLayoutLineWrappernow produces more compact results. - In rare cases the
GraphLayoutLineWrapperproduced drawings with large empty space between lines. -
HierarchicLayout: Fixed problem that sometimes caused an unnecessarily large distance between adjacent layers. -
The
MultiPageLayoutnow correctly considers the maximum page size for tree layouts. -
TabularLayoutno longer crashes when applying an instance of it to a single-node graph after that same instance was previously applied to a larger graph. -
HierarchicLayoutnow correctly considers fixed nodes with layering constraints. In previous versions there were some rare cases where such inputs caused infinite looping issues. -
GenericLabelingnow always prefersLabelCandidateswith higher profit values over others with lower profit (seeLabelingBase.GetProfit). Previously, this sometimes happened even though both candidates did not intersect with other elements. -
GenericLabelingdoes no longer assume that allLabelCandidatesassociated to a label have the same size. Previously, this caused unexpected labeling results if custom candidates with different sizes were given. -
The
EdgeRouternow always considers thePortCandidatesfor edges grouped with fixed edges. -
The
EdgeRouternow keeps collinear bends of fixed edges. -
The
FamilyTreeLayoutnow correctly considers the preferred family member order. OrthogonalLayoutdoes no longer throw an exception for some input graphs when propertySubtreeStyleis set toCompactandChainStyleis set to a wrapped style.OrthogonalLayoutno longer throws exceptions if propertyCycleStyleis set to a specific style and the input graph only consists of a single cycle.BusRouterdoes no longer produce non-deterministic results, i.e. different results for consecutive runs on the same input. Previously, this was possible in rare cases.EdgeRouterdoes no longer crash when defining exactly two equal intermediate routing points for an edge.- An invalid license no longer leads to a
NullReferenceExceptionwhen callingIGraph.ApplyLayout.
Incompatible Changes
Incompatible API Changes
ReparentStripePositionHandler: All callback methods dealing with ghost objects have been renamed consistently:UpdateXyzVisualisationtoUpdateXyzGhost.UpdateTargetVisualizationBoundstoUpdateTargetGhostBounds.
- The protected factory method
MoveLabelInputMode.CreateLabelHitTestablehas been removed. Developers who want to set a custom instance need to set it directly to theHitTestableproperty. -
The
CanvasControl.AnimateScrollTomethod has been removed and is superseded by the newZoomToAnimatedmethods. - The
AnchoredPortLocationModelExtensionclass has been moved to the GraphML compatibility demo where it was really needed. - The
GraphInputMode.CanvasClickedevent now provides theGraphEditorInputModeor theGraphViewerInputModeas parent input mode in theContextproperty of itsClickEventArgs. - The
ITable.RelativeLocationproperty has been removed. UseITable.Insetswith correspondingLeftandTopvalues instead. - Renamed all occurrences of
CleanuptoCleanUpin API names. ItemClickedEventArgsnow extendsClickEventArgs.CreateEdgeInputMode'sEdgeCreatormight receive null astargetPortCandidateparameter. Callbacks must handle this case by either creating a target port of their own or canceling the edge creation by returning null.- The
StripeSubregion.TargetTableNodeproperty is now read-only. - Renamed the enumeration value
ShowFocusPolicy.WhenFocusedtoOnlyWhenFocused. - Removed unnecessary
Enabledparts from the following property names.EdgeSegmentLabelModel.AutoRotationEnabledis nowAutoRotation.EdgePathLabelModel.AutoRotationEnabledis nowAutoRotation.LabelLayoutTranslator.AutoFlippingEnabledis nowAutoFlipping.SingleCycleLayout.FromSketchModeEnabledis nowFromSketchMode.SliderEdgeLabelLayoutModel.AutoRotationEnabledis nowAutoRotation.DiscreteEdgeLabelLayoutModel.AutoRotationEnabledis nowAutoRotation.
- Renamed the
Animator.Destroymethod toStop. - The
GraphEditorInputMode.CreateMoveUnselectedInputModemethod has been removed. Use the propertyMoveUnselectedInputModeinstead. - The
CreateEdgeInputMode.ShowPortCandidatesproperty has now the enum typeShowPortCandidatesinstead ofboolean. - Removed the (undocumented) classes
SelectionControl,HighlightControl, andFocusControl. - Removed
SnapLine.SnapLineColorKey, which never worked correctly. UseSnapLine.SnapLinePenKeyinstead. - Removed properties for touch devices from
MoveViewportInputMode.
Changes of Default Behavior
- The
OverviewInputMode.AutoMouseWheelZoomproperty is superseded by the newMouseWheelBehaviorproperty. RectD.IsFiniteandSizeD.IsFinitenow also consider empty instances as not finite.- By default, stripe labels that are programmatically selected or highlighted don't show a selection or highlight indicator anymore.
- Inertia scrolling of the viewport behaves now in a more natural way. The scrolling stops now after a fixed amount of time. Previously, the duration depended on the initial inertia velocity.
- The
IGraph.SetNodeLayoutmethod and the various methods to create a node now throw anArgumentExceptionif the layout rectangle contains one or moreNaNvalues. Similarly, theIGraph.SetBendLocationand the various methods to add a bend to an edge now throw anArgumentExceptionif the location point contains one or twoNaNvalues. - GraphML: Duplicate properties on XAML input are now considered an error in accordance with the XAML specification.
- The stroke thickness is now considered for the calculation of the origin of the default arrow visualizations. This can result in a slightly different rendering of the arrows.
- The
CreateEdgeInputMode.DummyEdgeproperty is now always reset after the edge creation was finished or canceled. MoveLabelInputMode: The moved label now is visualized as a preview instead of a symbolic rectangle. Set theVisualizationproperty toVisualization.Ghostto restore the old mode.- The
LayoutExecutor.UpdateContentRectproperty is now enabled by default. CreateEdgeInputMode, determination whether the mouse hovers over a valid end: ifForceSnapToCandidateis disabled, theEndHitTestablenow is queried first and a target port candidate is only searched if the hit testable returns true. Previously, the hit testable was only queried if no target port candidate was found at the current location.- Previously, even if the
GraphModelManager.UseHierarchicEdgeNestingproperty was set to true, canvas objects for edges were added to theGraphModelManager.EdgeGroupas long as no group nodes were part of the graph. The corresponding newHierarchicNestingPolicyNodesAndEdgeshas no such behavior and thus,EdgeGroupis empty by default. Use one of the other polices if canvas objects for edges should be part ofEdgeGroup. PolylineEdgeStyledefaults to an improved smoothing algorithm when using theSmoothingLengthproperty. This is especially apparent when using large values forSmoothingLength.- The mouse button which is reported in
Mouse2DEventArgsnow is more synchronized with the real mouse button state. The old behavior can be restored using the new propertyHandleMissingMouseEventsonCanvasControl. TextEditorInputMode.Editingis now false whenUninstallTextBoxis called.TextEditorInputMode.InstallTextBox()is now called afterAdjustPositionandAdjustSize, so theTextBoxis not yet available as a child control of the Canvas in those methods.
Minor Incompatible Changes
- The method
CollapsibleNodeStyleDecorator.CreateSelectionInstallerhas been removed.
Types and Members Marked as Obsolete
- The properties
LayerConstraintFactoryandSequenceConstraintFactoryofHierarchicLayoutDatahave been marked as obsolete. The new propertiesLayerConstraintsandSequenceConstraintsshould be used instead. Similarly, the extension methodsHierarchicLayout.CreateLayerConstraintFactory(IGraph)andHierarchicLayout.CreateSequenceConstraintFactory(IGraph)have been marked as Obsolete.
Most Notable Demo Improvements
- The new
RotatableNodedemo shows how support for rotated node visualizations can be implemented on top of the yFiles library. -
The new
RenderPoliciesdemo shows the effect of different render policies on the z-order of nodes, edges, labels and ports. This demo replaces theIntegrated Node Styledemo. - Demonstrated highlighting elements as hover effects in the Viewer demo.
GraphMLCompatibilitydemo: Added missing implementation ofAnchoredParameter.BpmnDemo: Fixed clone implementations of some styles.yEd.NET: Fixed a bug that prevents using triangle arrows for edges.
yFiles.NET 5.0.0.2
Bugfixes
- Fixed an exception in
DropInputModewhich occurred if a drag enter was recognized while another drag action was still running. - Removing an item that is currently highlighted with a custom
HighlightIndicatorManager,FocusIndicatorManager, orSelectionIndicatorManagerno longer results in aNullReferenceException. - Moving an edge label with
SmartEdgeLabelModelthat is owned by an edge without visible path no longer throws an exception. GraphEditorInputModeandGraphViewerInputModeno longer ignore changes to their sub-input modes after having been installed once.CreateEdgeInputModeno longer fires gesture cancel events if it has not been started before.- Fixed a bug in
CreateEdgeInputModewhich caused port candidates not to be shown after re-installation of the input mode. - The extension method
OrientedRectangleExtensions.GetCenterdidn't return the correct center if the width or height of the rectangle was equal to 0. StripeDropInputModeno longer callsItemCreatortwice.- The
StripeDropInputMode.ItemCreatedevent now is properly raised. - The
InteriorStretchLabelModel.GetMinimumNodeSizemethod now uses the correct insets for width calculation. Previously the top insets were erroneously used for the width. MoveViewportInputMode: TheDragging,Dragged,DragCanceling,DragCanceled,DragFinishingandDragFinishedevents did not fire reliably for touch input and when mouse inertia was active.TextEditorInputMode: inserting a line break now replaces selected text.- The
HitTestRadiusproperty of the following implementations ofICanvasContextnow correctly contain the value in world coordinates instead of view coordinates:- The context created by
Contexts.CreateCanvasContextwhen passing aCanvasControlbut no hit test radius. - The context passed to
DisposeVisualCallback. - The context passed to
IPositionHandlersbyMoveInputMode. - The context passed to adjacent handles when moving a bend handle.
- The context created by
- Fixed an issue where bridges would erroneously appear when using
EdgeStyleDecorationInstallerto use an edge style for highlight or selection. RectangleVisualno longer truncates the rectangle coordinates to integers when drawing a rectangle with an outline.- Fixed validation for signing licenses which could fail with certain public keys.
- Fixed an error message that could appear erroneously at build time when using a signing license.
- Fixed a
NullReferenceExceptionwhen callingIGraph.ApplyLayoutwhen the license is invalid. - Sometimes, the
GroupNodeDefaults.Labels.AutoAdjustPreferredSizeproperty and theGroupNodeDefaults.Ports.AutoCleanupproperty were not considered for labels and ports of groups. - Relocation of edges: dropping a port over an invalid target or empty canvas no longer creates an empty undo unit.
- The
ApplicationCommands.Copycommand is no longer executed twice. - The validation schema for GraphML has been fixed to work with more validators.
FreeEdgeLabelModel: static propertyInstanceis now excluded from obfuscation.AdjacentNodesGraphBuilderandTreeBuilderno longer remove unchanged nodes unnecessarily when those have been created lazily.
Layout
- Corrected an error in the
Rectangle2D.Contains(Rectangle2D)method. As a consequence of this error, the results of various algorithms and automatic layouts could have been wrong. - Fixed some
InvalidCastExceptionsthat might occur when using port candidates. -
HierarchicLayout: FixedArgumentExceptionthat could be triggered when the user specified both edge directedness (seeHierarchicLayout.EdgeDirectednessDpKey) and layering constraints. -
HierarchicLayoutwith partition grid: Fixed bug that in some cases caused anArgumentExceptionwhen the layout algorithm was configured to stop after the layering or sequencing phase (seeHierarchicLayout.StopAfterLayeringandHierarchicLayout.StopAfterSequencing). -
HierarchicLayout: Fixed bug that caused unnecessarily large layer distances in case that there exist empty partition grid rows with a minimum row height. -
HierarchicLayoutandSimplexNodePlacer: Fixed rareArgumentExceptionthat could be triggered when the input graph had a partition grid andPortCandidates orPortConstraints. -
TreeLayout: Fixed bug in the integrated edge labeling feature that caused that multiple edge labels were not always ordered correctly along the edge with respect to their preferred placement setting (i.e., place at source, center or target preference). For example, a source label should always come before a target label in the direction of the actual edge flow. -
OrthogonalLayout: Fixed rare bug that caused node-edge overlaps. -
SeriesParallelLayout: Fixed bug that caused misplaced edge labels for graphs containing only a single edge. -
PortPlacementStage: Fixed bug that causedNullReferenceExceptionwhen the ports of edges in the input graph were outside the node bounds. -
LayeredNodePlacer: Fixed bug that caused node-edge overlaps for some configurations. -
MultiPageLayout: Fixed bug that proxy edges were never routed as such. -
Polyline.EdgeRouter: FixedExceptionthat could be triggered when the graph contained fixed edges (seeEdgeRouter.SphereOfAction) with very short segments. -
BusRouter: Fixed rareNullReferenceExceptionthat could be triggered if there are buses with both fixed and movable edges at the same time.
Improvements
GraphBuilderno longer requires an edge source, allowing graphs to be built consisting only of nodes.- If the
GroupsSourceproperty is not set (is null),GraphBuilderno longer removes existing groups duringBuildGraphandUpdateGraph. The same applies to the related classesTreeBuilderandAdjacentNodesGraphBuilder.
Layout
-
HierarchicLayout: Improved adherence to the specified maximum duration by applying a suitable runtime restriction to classPortCandidateOptimizer. Previously, this class didn't have any runtime restrictions.
yFiles.NET 5.0.0.1
Bugfixes
- Fixed several problems with relative resource URIs for
UriImageNodeStyleandUriIconNodeStylewhen reading and writing GraphML.
yFiles.NET 5.0
Major Features Added
General
- The complete yFiles.NET API has been overhauled, simplified, and made more consistent. Many strange and dark corners of the API have been cleaned up. Types have more logical and intuitive names. The namespace structure is more logical and intuitive as well.
- The Developer's Guide has been completely revised. It now consists of two major parts: The first part covers the basics of yFiles.NET, while the second part describes in detail how the behavior of the library can be adapted to the customer's requirements.
- API documentation and Developer's Guide are now integrated into our Documentation Viewer that provides useful search and filtering facilities.
Viewer
- Support for building graphs based on user data offered by new classes
GraphBuilder,TreeBuilder, andAdjacentNodesGraphBuilder. - High DPI support: A new
Scaleproperty allows for adapting zoom independent sizes in rendering (e.g. drawings for resize handles) as well as in user interaction (hit test radius or double click size) to higher screen resolutions and thus smaller pixels. An extension method automatically chooses an appropriate scaling in high DPI aware applications. Furthermore, the default font now is resolution independent. - Running animations and performing layouts now offers .NET's Task-based mechanism for asynchronous processes. This leads to easier composition of asynchronous processes using C#'s
awaitkeyword where code is written close to how synchronous code would look like instead of chaining callbacks. This also simplifies exception handling which works as usual viatry-catchinstead of callbacks.
Layout
- Performance for many layout algorithms has been improved.
- There now is a new way to configure yFiles automatic layout algorithms. The
LayoutDataclass and its sub-classes can be used to pass configuration data to a layout algorithm by setting properties instead of registeringDataProviders on the graph which have to be filled with this data. This reduces the code needed to configure a layout and is more flexible as well as reusable. As most subclasses ofLayoutDataare specialized for one layout algorithm, their properties provide a good overview which data can be passed to the algorithm. - Added new layout algorithm
SeriesParallelLayoutfor graphs that are constructed only by series (combining two series parallel graphs by merging the source of one graph with the sink of the other) and parallel (combining two series parallel graphs by merging the sources and the sinks) operations. -
Added edge bundling feature. Bundling together multiple edges means that their common parts are to some degree merged into a bundled part. Edge bundling is useful to increase the readability of graph drawings with a high number of edges that connect a comparably small number of nodes. The following layout algorithms support edge bundling:
CircularLayout: Edge bundling is applied to edges of the same partition.TreeReductionStage: Edge bundling is applied to non-tree edges.RadialLayout: Edge bundling is applied to non-tree edges.
- Added support for Sankey diagrams which visualize flow quantity between entities like e.g., cost or energy flow.
OrganicLayoutnow supports the detection of regular substructures in the graph (seeOrganicLayout.ChainSubstructureStyle,OrganicLayout.StarSubstructureStyle,OrganicLayout.CycleSubstructureStyle, andOrganicLayout.ParallelSubstructureStyle) and applies a specific layout style to them such that they can be better recognized.
Deployment
-
The Software License Agreement now provides an alternative to the requirement of obfuscating the redistributable DLLs: delivering the redistributables as part of
software applications is now allowed if the redistributable DLLs are obfuscated or if the assemblies of the application which reference yFiles
are signed with a strong name whose public key token is bound to the license. See distribution.html for details.
Minor Features Added
Layout
- Added multi-parent support to
TreeLayout. A tree node can have multiple parents that are connected to all of its siblings and share the same parents. This might come to use in organizational charts where a team answers to multiple superiors. - Added grid placement support for nodes and edges to
HierarchicLayout. RecursiveGroupLayout: Added theInterEdgeRouterproperty to specify an edge router to layout edges that cross group node bounds. Thus, it is not necessary to subclass the layout algorithm to change inter-edge routing anymore.HierarchicLayoutsupports recursively routed edges. Edges that pass the border of group nodes will always leave at the bottom side and enter at the top side of the group node. This routing style is specified usingEdgeLayoutDescriptor.RecursiveEdgeStyle.HierarchicLayout: Improved from-sketch behavior for groups with changed bounds (e.g. after folding or expanding a group node).HierarchicLayout: Added support for port grouping, seePortConstraintKeys.SourcePortGroupIdDpKeyandPortConstraintKeys.TargetPortGroupIdDpKey. Edges are bundled at their ports, but routed independently.HierarchicLayoutnow allows to specify the directedness of edges, seeHierarchicLayout.EdgeDirectednessDpKey. This new feature enables to, for example, support mixed graphs that contain both directed and undirected edges: While for directed edges the layering step tries to find a solution where the source of an edge is placed above the target (with respect to the main layout direction), for undirected edges the direction doesn't matter and the edge may also be inserted as same-layer edge. This feature also enables to force some edges to specifically point against the main layout direction.HierarchicLayout: Added support for edges with a specific thickness. Minimum distances in the layout will consider these thicknesses, seeHierarchicLayout.EdgeThicknessDpKey.
Incompatible Changes
General
- The rendering mechanism has been overhauled: Most rendering code that previously used the
IPaintableinterface now uses the newIVisualCreatorinterface instead for improved rendering performance. Please see the migration guide for details on the resulting incompatibilities. - The minimum required framework version for the viewer part and the layout adapter is now .NET Framework 4.0. The minimum required framework version for the algorithms part still is .NET Framework 3.5
- The return type of several methods has been changed from
IEnumerator<T>toIEnumerable<T>. - Many usages of
reforoutparameters have been replaced with a suitable structure as return type. The most prominent example of this change are the variousGetTangentmethods inIPathGeometryandGeneralPaththat now return aTangent. - All methods that take a parameter of type
ICanvasContext,IRenderContext,IInputModeContext,IParseContext,IWriteContext,SnapContext,GraphSnapContext, orLabelSnapContextnow have that parameter as their first parameter. - With the new web-based Documentation Viewer, the integrated help for the Visual Studio Help Viewer has been discontinued.
Namespace Structure
- Classes of the viewer part have been reorganized into a simpler namespace structure.
yWorks.Graphcontains types related to the graph structure, including label models and port location models.yWorks.Controlscontains types related to theGraphControlandCanvasControl, and to the visualization in general.yWorks.Graph.Stylescontains the style implementations.yWorks.Controls.Inputcontains the types related to input modes.
- Geometry types remain in
yWorks.Geometry. - Layout and analysis types are in
yWorks.Layout,yWorks.Algorithms, and the namespaces that correspond to a specific layout style.
Factory Methods Instead of Default Implementations
Contexts: Factory methods replace the removed classesCanvasContextandSimpleInputModeContext.Lookups: Factory methods replace the removed propertiesHidingLookupChainLink,FactoryLookupChainLinkandAddingLookupChainLink.Animations: Factory methods replace the removed classesEasedAnimation,ParallelAnimation,GeneralPathAnimation,LayoutMorpher,LayoutMorpherWrapper,EdgeAnimation,LabelAnimation,NodeAnimation, andPortAnimation.PortCandidateProviders: Factory methods replace all existing non-abstractimplementations.PortCandidateProviderBaseremains for an easier start for own implementations.EdgeReconnectionPortCandidateProviders: Factory methods replace all existing implementations.Commands: Factory methodCreateCommandreplaces all existing implementations ofICommand.
Model
IGraph
- Support for grouped graphs has been simplified to a large extent:
IGraphnow supports grouping by default. TheGroupingSupportedproperty has been removed fromDefaultGraph. Grouping is now always enabled for graphs.- The new property
AllowGroupingOperationsonGraphEditorInputModeallows for switching interactive grouping operations on or off. Grouping operations are disabled by default and have to be enabled explicitly if the input mode should support them. - The grouping support interfaces
IGroupedGraphandIHierarchy<T>have been removed and folded withIGraph. IHierarchy<T>'sRootproperty is no longer available. The root of a grouping hierarchy is now represented bynull.
- Overhaul of
IGraph'sCreateNode,CreateEdge,AddLabel,AddPort: Ambiguous overloads have been removed, missing overloads have been added and parametershave been ordered to be consistent throughout all overloads. IGraph'sNodes,Edges,Labels, andPortsproperties have been changed fromICollectionModeltoIListEnumerable. To be notified of created or removed items, the correspondingIGraphevents should be used instead.- The properties
NodeLabelsandEdgeLabelsonIGraphhave been replaced by the extension methodsGetNodeLabelsandGetEdgeLabels. - The properties
CollectionModelandBendshave been removed.Bendshas been replaced by theGetBendsextension method. - The classes
BendListandListLabelCollectionhave been removed. UseListEnumerableinstead. IGraphnow provides events for property changes on model items, e.g.NodeStyleChanged,NodeLayoutChanged, etc. Those events replace the dedicated change reporters available previously (e.g.INodeBoundsChangeReporter,ILabelTextChangeReporter, etc.), which have been removed.- The signatures of event handlers throughout the
IGraphAPI have been made consistent using properly typedEventArgssubtypes. Exceptions are a few events that are raised very often which retain an argument list to improve performance. - The methods
IsLeaf/SetLeafand related properties and events have been replaced byIsGroupNode/SetIsGroupNodewhich have the exact opposite meaning from the old ones. - The signature of
IGraph.AddBendhas changed. The index parameter has been moved to the end and made optional. - The
IGraphStructureinterface and itsSimpleGraphStructureimplementation have been removed, as well asDefaultGraph's constructor that accepted anIGraphStructure. IGraphnow extends theITagOwnerinterface. Thus graphs now have aTagproperty.
DefaultGraph
DefaultGraphnow raises removal events for labels, ports, and bends which are implicitly removed when their owner is removed.- Various protected factory methods on
DefaultGraphhave been removed:CreateNodeDefaults,CreateEdgeDefaultsandCreateMapperRegistry, amongst others. - The method
GetBoundshas been removed fromDefaultGraph. - The property
UsePortCandidateProvidershas been removed from bothDefaultGraphandGraphSettings. Creating an edge using port candidate providers has to be done by manually querying the provider and callingCreateEdge(IPort, IPort).
Folding
- The method
IsInitiallyExpandedhas been removed fromIFoldedGraph. The methodsIsInitiallyExpanded,SetInitiallyExpanded, and the propertyDefaultExpandedPredicatehave been removed fromFoldingManager. - The
Expand,Collapse, andIsExpandedmethods onIFoldingView(previouslyIFoldedGraph) now also work with nodes that belong to the master graph instead of the view graph. Thus the collapsed/expanded state can be set or queried for items that are currently not in the view graph. This replaces part of the removed functionality mentioned above. - The interfaces
IChangeDummyNodeAppearanceCallback,IChangeDummyEdgeAppearanceCallback, andIChangeLabeledItemAppearanceCallbackas well as theFoldingManager.GetChangeDummyAppearanceCallbackmethods have been removed. The view state properties can now directly be changed on the view state implementations returned byFoldingManager.GetFolderNodeStateandFoldingManager.GetFoldingEdgeState, respectively. -
IFoldingView.IsInFoldingState(previouslyIFoldedGraph.IsDummy) now throws anArgumentExceptionfor labels and ports that are not part of this view. Previously, this method returnedtruefor such items. Since this exception is already thrown for nodes, edges, and bends that are not part of this view, the behavior is now the same for all types of graph items.
Labels
- The order of the parameters of
ILabelModel.GetGeometryhas been changed toILabelModel.GetGeometry(ILabel, ILabelModelParameter). FreeNodeLabelModel.CreateNodeCenterAnchoredandFreeNodeLabelModel.CreateNodeLayoutAnchoredhave been removed.FreeNodeLabelModel.CreateDefaultParameternow uses the label's center as its anchor point.- The new edge label models
EdgeSegmentLabelModelandEdgePathLabelModelhave been added.EdgeSegmentLabelModelallows to create parameters for a segment index and segment ratio whileEdgePathLabelModelcreates parameters using a ratio of the edge path.- The new label models replace the following removed label models:
RotatingEdgeLabelModel,SliderEdgeLabelModel,SideSliderEdgeLabelModel,RotatedSliderEdgeLabelModel, andRotatedSideSliderEdgeLabelModel. - The label layout parameter of the edge label defaults now uses the
EdgeSegmentLabelModel.
- The new label models replace the following removed label models:
Ports
- The property
IPort.Location(to obtain a snapshot of the port's location) has been replaced by the extension methodGetLocation. To retrieve a live view of the location of a port, use the new extension methodIPort.DynamicLocation. NodeScaledPortLocationModelhas been replaced byFreeNodePortLocationModelthat allows to specify the port location by a ratio of the node layout's size and an additional offset. The placement options and API are very similar toFreeNodeLabelModel.AnchoredPortLocationModelhas been removed.
Table
ITableinterface:- The signature of
CreateRowandCreateColumnhas changed. The index parameter has been moved to the end and made optional. - The events
StripeChangedandStripeRemoveduseStripeEventArgsnow. The corresponding event raiser methods have been changed accordingly. - The event
LabelRemovedusesLabelEventArgsnow. - New extension methods have been added:
FindColumn,FindRow,GetCellBounds.
- The signature of
Tableclass:- The table's lookup decorator can now decorate stripe labels, too.
- The following methods have been removed:
CreateDefaultColumnStyle,CreateDefaultColumnInsets,CreateDefaultColumnLabelStyle,CreatedDefaultColumnLabelModelParameter,CreateColumnLabelDefaults,CreateDefaultRowStyle,CreateDefaultRowInsets,CreateDefaultRowLabelStyle,CreatedDefaultRowLabelModelParameter,CreateRowLabelDefaults,RemoveUndoSupport, some overloads ofCreateRow/CreateColumn, some overloads ofAddLabel - The properties
DefaultStripeLookup,DefaultColumnLookupandDefaultRowLookuphave been added, which replace the removed classes with the same same.
TableExtensions: TheGetElementsToMovemethod has been removed- The
IStripeSelection.SelectedStripesproperty has been removed. Use the individual properties forSelectedRowsandSelectedColumnsinstead StripeSelection: The superfluous overloads ofIsSelectedandSetSelectedtaking anIRoworIColumnhave been removed.- The static helper method
PlaceNodeInCellhas been added toITableto easily move a node into a specific table cell.
Undo Support
- Extension methods to enable/disable Undo have been added to
IGraph. - Setting the
Tagproperty on model items and the graph now works with Undo. - Undo operations for the removal of graph elements now keep the proper item order. This improves the consistency especially for layouts between undo operations.
- Overloads of the
IGraph.BeginEditextension method that work withIMementoSupport(either viaILookupor anIMementoSupportProvider) have been added. - The overload of the
IGraph.BeginEditextension method that accepted anIEnumerableofIModelItemshas been removed. IUndoSupport,MementoUndoUnit,MementoUndoableEdit, andMementoStateStructhave been removed.IUndoUnit: The methodsCanUndoandCanRedohave been removed.- The methods
UndoImplandRedoImplonUndoUnitBasehave been removed. Implementations should useUndoandRedofrom theIUndoUnitinterface instead. - The properties
UndoTextandRedoTextonUndoEnginehave been removed. - The interface
IGraphUndoUnitSupporthas been removed. Its methodsCreate...UndoUnithave been moved toDefaultGraph. Developers who have created a custom implementation have to derive fromDefaultGraphand override the corresponding method(s).
Geometry
TheyWorks.Geometry namespace has been simplified and cleaned up.
- The basic geometry types
PointD,SizeD,RectDandInsetsDhave been made immutable. - The classes
ImmutablePoint,ImmutableSize,ImmutableRectangleandImmutableOrientedRectanglehave been removed. The immutable typesPointD,SizeDandRectDas well as the immutable instance provided by the new static methodOrientedRectangle.CreateImmutablecan be used instead. - The interfaces
IPointSetterandISizeSetterhave been removed. Instead the interfacesIMutablePointandIMutableSizeare used. - The
IReshapeableinterface has been removed. The various overloads of theReshapemethod have been implemented as extension methods onIMutableRectangleinstead. IMovablehas been removed as well. Instead anIPositionHandlercan be used.PointD.FromPoint,SizeD.FromSizeandRectD.FromRectanglehave been removed and replaced by the extension methodsIPoint.ToPoint,ISize.ToSize, andIRectangle.ToRect.- Various other geometry-related infrequently-used or duplicate classes and interfaces have been removed.
- The static fields
SizeD.Unbound,SizeD.EmptyandSizeD.Zerohave been added.
Controls
- The
ContentRectwill now also be updated when creating edges, adding, editing or moving labels or deleting graph items. - The
Cut,CopyandPastecommands are no longer handled byGraphControland the respective methods have been removed as well. Command bindings forCopyare still supplied byGraphViewerInputModeandGraphEditorInputMode. Command bindings forCutandPasteare still supplied byGraphEditorInputMode. - The
UndoandRedocommands are no longer handled byGraphControland the respective methods have been removed as well. Command bindings forUndoandRedoare still supplied byGraphEditorInputMode. Furthermore, the respective methods can still be called on the UndoEngine directly. - The
UndoabilityEnabledproperty has been removed.UndoandRedocommand bindings can be enabled onGraphEditorInputMode. - The
ClipboardEnabledproperty has been removed. Clipboard command bindings can be enabled onGraphViewerInputModeandGraphEditorInputMode. - The
GetUndoEnginemethod has been removed. The currentUndoEnginecan be retrieved from the graph instead. - The
SelectionChangedevent has been removed. - The new property
LastEventLocationalways contains the location of the last mouse or touch event. - The
MouseWheelBehaviorproperty replaces the previous propertyAutoMouseWheelZoomEnabledand not only allows disabling mouse wheel zoom, but also enabling scrolling with the mouse wheel. - The methods
Add,AddCreator,AddGroupandAddGroupToGrouphave been removed as the new methodsAddChildandAddGroupofICanvasObjectGroupprovide a more intuitive way to add child elements to e.g. theGraphControl.GetBackgroundGroup. - The
InputModesproperty has been removed. Developers who want to install multiple input modes on aCanvasControlhave to set aMultiplexingInputModeasCanvasControl.InputModeand add their input modes to that mode. - The
CollectCanvasObjectsmethod has been removed.
Visualization
Styles
- Renamed
SimpleAbstractNode/Edge/Port/LabelStyletoNode/Edge/Port/LabelStyleBase. - Removed
SimplePortStyle. Instead, useNodeStylePortStyleAdapterwithShapeNodeStyle. - Renamed
SimpleLabelStyletoDefaultLabelStyle. - Added the interface
IStripeStylefor styles ofIColumnsandIRows. WithNodeStyleStripeStyleAdapter, you can still use node styles as styles for columns and rows. - The style and style renderer hierarchies have been flattened:
- Removed all sub-interfaces of
INodeStyle,IEdgeStyle,ILabelStyle, andIPortStyle. - Removed classes
AbstractEdgeStyle,AbstractStyleRenderer,AbstractNodeStyleRenderer,AbstractEdgeStyleRenderer,AbstractLabelStyleRenderer,AbstractShapedNodeStyleRenderer,AbstractShapedLabelStyleRenderer,VoidVisualStyle, andVoidStyleRenderer. - Merged types
AbstractTableNodeStyleandDynamicTableNodeStyleintoTableNodeStyle.
- Removed all sub-interfaces of
- Removed superfluous interfaces
IUserTagProviderandITableProvider, and all implementations. - Removed superfluous constructors from all style implementations.
- All
IStyleRendererimplementations: The accessibility of theStyle,Layout, andItemproperties has been reduced to protected. In addition, the latter has been renamed toNode,Label,Edge, orPortrespectively. - Various changes to
IModelItemInstallerand related interfaces and classes. Styles no longer implementIModelItemInstaller, simplifying certain custom style implementations.
Animations
Animator.AnimateAndWaithas been removed.- The original overloads of
Animator.Animatethat accept a callback for finishing the animation have been removed. Instead the new Task-based overloads can be used.
Various Visualization Changes
- Replaced
IPaintablewithIVisualCreatorfor improved rendering performance.IPaintable'sPaintmethod now has to be implemented on theIVisualreturned byIVisualCreator'sCreateVisualandUpdateVisualmethods. - The protected factory methods that supplied the initial value for
GraphModelManager's Installer properties (EdgeStyleInstaller,NodeStyleInstaller, etc.) have been removed. GraphModelManager.Invalidatehas been removed.- The
IRenderContext.Canvasmethod has been pulled up toICanvasContextand renamed toCanvasControl. IRenderContext: TheTransformproperty has been removed.- The
RenderContextclass has been removed. UseCanvasControl.CreateRenderContextinstead to retrieve an instance ofIRenderContext. DefaultEdgePathCroppernow uses the new methodHandleEmptyPathif cropping the edge would result in an empty path. By default this method crops at the ports instead which results in edges between a group node and one of its children being no longer hidden.DefaultEdgeIntersectionCalculator: A callback methodGetNodeGeometryhas been added.- The
CanvasObjectGroupProviderCallbackproperty onModelManagerhas been replaced with theGetCanvasObjectGroupmethod. TheCanvasObjectGroupProviderCallbackproperty onItemModelManagerhas been replaced with theCanvasObjectGroupproperty and theGetCanvasObjectGroupmethod; the default implementation just defers to the property, just likeGetDescriptor. IGroupActionas well asICanvasObjectGroup.GetGroupActionhave been removed as they had hardly any use.- The interface
ICanvasGroupProviderand the delegateCanvasObjectGroupProviderCallbackhave been removed. Accessing the individual CanvasObjectGroups can be done via the properties ofCanvasControlinstead. ICanvasObjectTreeEventSourceand the corresponding classesCanvasObjectAddEventArgs,CanvasObjectRemoveEventArgs,CanvasObjectMoveEventArgs, andCanvasObjectInvalidateEventArgshave been removed.
Input
General Input Mode Refactorings
- The type hierarchy for input modes has been simplified considerably:
- All input modes except
OverviewInputMode,GraphViewerInputMode, andGraphEditorInputModenow directly implementIInputModewithout any abstract base classes in between. IConcurrentInputModehas been removed and merged withIInputMode.- The
Enabledproperty on theIInputModeinterface has been removed. It is still present on all concrete implementations. - The
ConcurrencyControllerproperty has been removed. Instead, a parameter of typeConcurrencyControllerhas been added to theIInputMode.Installmethod.
- The
- All abstract input mode base classes except
AbstractInputMode(which has been renamed toInputModeBase) have been removed.AbstractConcurrentInputModehas been merged intoInputModeBase.
- All input modes except
- Input mutex handling has been refactored considerably:
IInputMode'sConcurrencyControllerproperty has been removed. Input modes now get aConcurrencyControlleras parameter of theirInstallmethod.- The
ConcurrencyControllerhas been refactored and is now only responsible for a single input mode. ItsActiveproperty indicates if the input mode currently has or may request the mutex. - The
InputMutexclass has been removed. - The
PreferredCursorproperty has been moved fromIInputModetoConcurrencyController. - The input mutex should be requested and released using the according methods on
ConcurrencyController. Most input modes don't provide the methodsHasMutex,CanRequestMutex,RequestMutexandReleaseMutexanymore. - The
Enabledproperty ofIInputModesis not set tofalseanymore if another input mode acquires the mutex. Instead theirConcurrencyControlleris deactivated. This provides a clear separation between suppressing input modes (while another mode holds the mutex) and explicitly disabling a mode from user code (via theEnabledproperty). - As a consequence most input modes don't provide the
EnabledChangedevent and theOnEnabledandOnDisabledmethods anymore, butOnConcurrencyControllerActivatedandOnConcurrencyControllerDeactivatedinstead.
IInputModehas a new propertyPrioritywhich defines the installation priority of the input mode. Previously those have been available as properties onGraphViewerInputMode,GraphEditorInputMode, andTableEditorInputMode. Those have been removed.IInputMode'sStopmethod has been renamed toTryStopto make it more obvious that an implementation might returnfalseto indicate that it did not actually stop.- All input modes no longer raise
StoppedandCanceledevents. Developers who want to get notified when an input mode gets stopped or canceled have to override theOnStoppedorOnCanceledmethods. Also, the eventsInitializingandInitializedno longer exist. Input modes that need to perform one-time initialization on firstInstallcan keep track of that themselves. MultiplexingInputMode: TheAddConcurrentmethods as well as theAddmethod which takes an additional priority parameter have been removed. There is only oneAddmethod left, which takes an input mode as its only parameter. Priority is determined by the input mode'sPriorityproperty. Whether an input mode runs exclusive or always active alongside other input modes is determined by the input mode'sConcurrencyControllerwhich has anExclusiveproperty controlling that. This property is also available for all defaultIInputModeimplementations.MultiplexingInputModeis now aware of changes to the priority of already installed input modes and will update the installation order accordingly when an input mode's priority is changed.IInputModes in general:- The setter for
GraphandGraphSelectionproperties, if present, and its associatedSet*methods have been removed. Both are now always retrieved from the input mode context dynamically. - The read-only property
InputModeContexthas been introduced to expose theIInputModeContextthe mode is installed in. - Many input modes now no longer have protected methods for state machine transitions. Instead those methods are mostly parameterless now.
- The setter for
GraphEditorInputMode and GraphViewerInputMode
GraphViewerInputModeandGraphEditorInputModehave been made more similar regarding customization in the capabilities they both provide:GraphViewerInputModenow supports the same click and selection behavior asGraphEditorInputMode. This includes detail selection (Shift+Click) and cyclic selection (Alt+Click) as well as finer control over behavior like theClickSelectableItemsproperty and theShouldClickSelectmethod.- The methods
ClickandDoubleClicknow take anIModelItemandClickEventArgsas arguments and have no return value. Instead of returning a boolean, theHandledproperty on theClickEventArgsshould be set. - Their
ClickInputModeinstances is now configured to raise events for both left and right clicks. - The default click actions that change the selection and create new nodes are only triggered on left mouse clicks now.
- An explicit hit-test order for double clicks is provided that can be changed through the
DoubleClickHitTestOrderproperty. By default, this hit-test order prefers labels over other graph elements. GraphViewerInputModenow also has theAvailableCommandsproperty, already known fromGraphEditorInputModeorNavigationInputMode.- Several child input mode priorities in
GraphViewerInputModehave been changed and most of them now have the same priorities as inGraphEditorInputMode. - The new
CanvasClickedevent reports clicks on an empty canvas location. - The new
SelectablePredicateproperty allows finer control over what particular items should be selectable without the need to create a custom subclass. - The new
CreateSelectionEventArgsmethod createsSelectionEventArgsusing theGraphSelection. - The events
MultiSelectionStartedandMultiSelectionFinishednow useSelectionEventArgs<IModelItem>. GraphViewerInputModenow has improved support for marquee selection. Marquee selection is no longer turned on or off viaMarqueeSelectableItemsbut instead directly on theMarqueeSelectionInputMode. The recognizer for marquee selection is Shift+Drag and the child input mode priorities have been adjusted accordingly so that marquee selection and viewport movement can co-exist. The child input mode still defaults to being disabled, though.GraphViewerInputModenow also has aKeyboardInputMode.GraphViewerInputModenow allows copying items (including the convenience method) and handles the command appropriately.
- Improved functionality of
GraphEditorInputMode- Changing the
ShowHandleItemsproperty will now immediately update the currently visible handles. - The new
DeletablePredicateproperty allows finer control over what particular items should be deletable without the need to create a custom subclass. - The new
LabelAddingandLabelEditingevents have been added. Those allow fine-grained control over adding or editing labels and tie into the existing functionality provided byIEditLabelHelper. -
TextEditorInputModenow ensures that the TextBox is visible in the viewport when starting editing. This behavior can be adjusted by creating a custom subclass and overriding theEnsureVisiblemethod.
- Changing the
- Cleanup of the old
GraphEditorInputModeAPI- The type of the
OrthogonalBendRemovalproperty has been changed frombooltoOrthogonalEdgeEditingPolicy. - The
DeletingSelectionandDeletedSelectionevents now useSelectionEventArgs<IModelItem>. - The constructor that take additional
IGraphandIGraphSelectionarguments have been removed, as well as the protected methodsSetGraph,SetGraphControl,OnGraphChangedand the protected setter for theGraphSelectionproperty. Instead, theIGraphinstance is now always taken from theInputModeContextand cannot be changed after the mode is installed. - The
CreateDefaultLabelConfigurationmethod has been removed. - The
MarqueeSelect<T>(RectD,IEnumerable<T>)method has been removed. - The
SelectionModelproperty has been removed. Instead theGraphSelectionproperty is used. - The
CollectionModelproperty has been removed. Instead the model items of theGraphproperty are used. - The
GraphInputModeControllerproperty has been removed. - The protected event handlers for
ClickInputMode'sClickedandDoubleClickedevents have been removed. FindItemhas been removed. An additional overload ofFindItemswithout the context parameter has been added. To replicate the previous behavior ofFindItem,FindItemscan be called and the first element taken from the resulting enumeration.ShouldBeMovableForMoveInputModehas been removed.
- The type of the
- Improved
GraphViewerInputModeAPI:- Added support for the
Copycommand. - Added support for multi-selection via Ctrl+Click and marquee selection. The latter is disabled by default.
- The click hit-test order can now be configured by property
ClickHitTestOrder. - By default, clipboard commands are now disabled. This can be controlled with the new property
AllowClipboardOperations. - The
ItemSelectedevent has been removed. ClipboardCommandsEnabledhas been removed.
- Added support for the
CreateEdgeInputMode
CreateEdgeInputMode has been refactored and streamlined:
- Orthogonal edge creation is automatically enabled if orthogonal edge editing is enabled on the containing
GraphEditorInputMode. - The
ConnectToCandidatesOnlyproperty has been removed. Edge creation now always uses port candidates. - The creation callbacks
NodeBasedEdgeCreationCallbackandPortBasedEdgeCreationCallbackhave been replaced by the newEdgeCreatorwhich is always port-based. - The methods
GetSourcePortOwner,GetTargetPortOwner,GetSourceNodeandGetTargetNodehave been replaced byGetSourceandGetTarget. - The properties
SourcePortCandidateandTargetPortCandidateare no longer read-only. - The methods
DetermineEdgeStyle,AssignSourcePortPosition,AssignEdgeStyleas well as theEdgeStyleproperty have been removed. Instead the newEdgeDefaultsproperty can be used to customize the new edge. - The
UseHitNodeTargetCandidatesOnlyproperty has been replaced by the newUseHitItemsCandidatesOnlyproperty. - The type of the
OrthogonalEdgeCreationproperty has been changed frombooltoOrthogonalEdgeEditingPolicy. - The new
DummyEdgeGraphproperty is used to create the dummy edge that visualizes the edge during creation. - The preview edge which is displayed during edge creation now shows the edge as it will be created, i.e. the preview edge has the same style, port visualization, and labels as the created edge will have.
- The
SnapToTargetCandidateOwnerproperty has been removed. The preview edge now is always being cropped at the candidate owner's borders. - A new
CancelGestureOnInvalidTargetproperty has been added that makes it possible to cancel the gesture immediately if ended on an invalid target. - The
EdgeCreatorcallback now has atemplateEdgeparameter where all data for edge creation can be retrieved from. The source and targetIPortparameters have been changed toIPortCandidates. - The
AssignBendsmethod has been removed and its functionality folded into the defaultEdgeCreatorimplementation. This also means that customizedEdgeCreators now have to add bends to the created edge as well. - The following methods have been removed:
IsPortCandidateResolutionEnabled,IsValidEnd,IsValidBegin,IsCancelGesture,IsBendCreationEnforced,IsValidBend,IsSourceNodeDraggingFinished,IsRemoveBendEvent. Instead, use the corresponding...EventRecognizerproperties to customize the behavior. - The following methods and properties have been removed:
CreateBend(PointD),StartCreateEdge,OnTargetLocationChanged,GetNodes,NodeComparerandPortOwnerComparer.
Other Input Modes
ContextMenuInputMode: Support for different context menu trigger events has been added. Currently only mouse (right-click) and keyboard (application / context menu key) are distinguished, more may be added in the future.ClickInputMode: TheValidClickHitCursorproperty has been added. This cursor is used when hovering over a valid hit region.ClickInputMode: ThePreventNextDoubleClickmethod has been added that can be used in event handlers for single clicks to prevent that this click can become part of a double click event.CreateBendInputMode: TheCancelEventRecognizerproperty has been removed.HandleInputMode: TheActiveproperty has been removed. The mode can be manually deactivated using theEnabledproperty instead.HandleInputMode: TheArmmethod now has a handle parameter for the handle that is under the mouse cursor.NodeDropInputMode: TheNodeCreatorcallback,NodeCreatedevent, andGetDraggedNodemethod have been removed. TheItemCreatorcallback,ItemCreatedevent andDraggedItemproperty from its base classItemDropInputModeis used instead.OverviewInputModenow extendsMultiplexingInputModeand can be customized more easily. Minor modes can be replaced and adjusted, as well as the list of available default command bindings can be modified.OverviewInputMode: The newMarginsproperty specifies margins for the visible area of the boundGraphOverviewControl. The new protected methodUpdateVisibleAreaprovides further means for customizing the visible area.MarqueeSelectionInputMode: The eventsDragStarting,DragStarted,Dragging,Dragged,DragFinishing,DragFinished,DragCancelingandDragCancelednow useMarqueeSelectionEventArgsthat provide the current selection rectangle.MarqueeSelectionInputMode: TheMarqueeSelectedevent has been removed. TheDragFinishedevent can be used instead.MarqueeSelectionInputMode: TheLastModifierStateproperty has been removed.MoveInputModenow provides aQueryPositionHandlerevent that queries anIPositionHandlereach time a drag is started.MoveViewportInputMode: Mouse cursor handling is now also done by protected methodsArmandDisarm, similar to other input modes.MultiplexingInputMode: TheChildControllerproperty andCreateChildConcurrencyControllermethod have been removed.TableEditorInputMode: The new eventsLabelAddingandLabelEditingallow fine-grained control over adding or editing labels and tie into the existing functionality provided byIEditLabelHelper.TableEditorInputMode: The eventsDeletingSelectionandDeletedSelectionnow useSelectionEventArgs<IStripe>.TableEditorInputMode: Now contains theAllowMixedSelectionproperty which has been moved from the removed classCompositeStripeSelection.WaitInputMode.GetMultiplexingInputModehas been removed.TextEditorInputMode: The eventsEditingStarted,EditingCanceledandTextEditednow useTextEventArgs.TextEditorInputMode: The propertiesStopRecognizer,CancelRecognizerandLineBreakRecognizerhave been added which allow for easy customization of the key gestures used to add new line breaks and to cancel or stop the text editing.
Label Editing
IEditLabelHelperhas been refactored:AddLabelandEditLabelhave been replaced by the methodsOnLabelAddingandOnLabelEditingwhich take the newLabelEditingEventArgsas their only argument.- The
IEditLabelHelper.ConfigureTextEditorInputModemethod has been removed. It has been replaced by theLabelEditingEventArgs.TextEditorInputModeConfiguratorproperty. - The customizations possible from
IEditLabelHelperare the same as those from theLabelAddingandLabelEditingevents onGraphEditorInputModeandTableEditorInputMode.IEditLabelHelperis conceptually used as another event handler for those events. - The
Ownerproperty ofEditLabelHelperhas been removed, along with the respective constructor. The label owner can usually be queried from theLabelEditingEventArgs. Custom subclasses can of course still opt to store the item they were created for and use that field.
- If an
IEditLabelHelperimplementation is present in anILabeledItem's lookup, itsAddLabelmethod is called to determine whether a label may be added and provide a suitable label instance. Additionally, the predicate methodGraphEditorInputMode.ShouldLabelBeAddedalways has to returntrue, whether edit helpers are present or not. If the new label should be edited interactively after it's creation (the default behavior), it also must be editable, following the rules above. Therefore anIEditLabelHelperimplementation usually should allow editing of label instances that it has created itself inOnLabelAdding. - The current label visual can be hidden while the text editor is shown to reduce visual clutter. This feature is enabled by default and can be controlled through the
GraphEditorInputMode.HideLabelDuringEditingproperty.
Snapping
SnapContext:- A boolean parameter
snappingDisabledhas been added to the methodsHandleMoveandDragFinished. This parameter has to be set totrueto handle moves or finish a drag when snapping is temporarily disabled. This replaces the call toSnapContext.DisableSnapping. - The events
Initializing,InitializedandCleanedUpas well as their associated methods now useInputModeEventArgs. - The
VoidInstancefield has been removed.
- A boolean parameter
GraphSnapContext:- The return type of
GetMovementInfoshas been changed toIListEnumerable<MovementInfo>and the classesNodeMovementInfo,PortMovementInfo,BendMovementInfoandEdgeEndMovementInfohave been removed. - The info parameter's type of
AddEdgeEndToBeMovedhas been changed to the more generalMovementInfo. A boolean parameterAtSourcehas been added. - The methods
AddSameWidthEntriesandAddSameHeightEntriesnow return anIListEnumerable<RectD>containing the rectangles whose widths respectively heights are closest to the given size. The parametersresultingSizeandrectshave been removed.
- The return type of
IEdgeSnapResultProvider:- The methods
InitializeSnappingandCleanupSnappinghave been removed. - The info parameter's type of
CollectSnapResultshas been changed toIListEnumerable<MovementInfo>.
- The methods
SnapResultnow has more factory methods. The classSnapLineSnapResulthas been replaced with a factory method as well.- The classes
SnapLineContainer,SingleLineSnapLineContainer,EdgeSegmentSnapLineContainer,FixedDistanceSnapLineContainer,InBetweenSnapLineContainerhave been removed.
Clipboard
- The
GraphClipboard.ClipboardContextproperty has been removed. - The
Copymethods inGraphCopiernow have a newPointDoffsetparameter that shifts nodes and bends by a given amount upon copying them. - The signature of
IClipboardIdProvider.GetIdhas changed. The context parameter has been moved to the front.
KeyboardInputMode
KeyboardInputMode has been simplified along with all helper types and infrastructure around commands:
KeyboardInputModenow allows creating a mapping between a key gesture and a command as well as providing custom execution logic for a given command.- There is also a single new method
RemoveCommandonKeyboardInputModewhich removes all currently existing bindings for a given command.
Various Input-related Changes
- Events
- The properties
LastMouse2DEventArgsandLastEventLocationhave been removed from all input modes. Instead, the propertiesLastMouseEventandLastEventLocationonCanvasControlcan be used. EdgeEventArgsnow also contains the owner of the source and target port.ItemClickedEventArgsnow also contains the location of the click.StripeEventArgsnow also contains theTablefor this event.OrthogonalEdgeEditingContext: The eventsInitializing,InitializedandCleanedUpas well as associated methods now useInputModeEventArgs.GraphCommands.AdjustGroupNodeSizenow always processes the nodes in bottom to top order instead of using the order in which the nodes were selected.
- The properties
- The command framework has been simplified.
Classes
ApplicationCommands,NavigationCommands, andGraphCommandshave been removed. All commands are now available on new classCommands. The ending "Command" has been removed from the command's names. There is no public implementation for a command, now. Instead, the factory methodCreateCommandon classCommandshas to be used. - All hit-testing methods as well as the methods in
IPortSelectionTesterandIBendSelectionTesternow take anIInputModeContextinstead ofICanvasContextas their context parameter. IPositionHandlerandIHandleimplementations no longer implementIPoint.IPositionHandler.SetPositionhas been removed. The interface is now used as a flagging interface only.- The classes
DefaultPositionHandlerandPointHandlehave been removed. GraphEditorInputMode.NodeCreatornow has an additional parent parameter which can be used as the parent node for creating a new node.GraphEditorInputModetries to find a group node at the click location to pass as parent to theNodeCreator.- Opening a context menu from the keyboard no longer uses the last known mouse pointer location for opening the context menu. Instead, the location of the current selection or the current item are used.
IPortCandidateProvider: The two method overloadsGetSourcePortCandidatesForEdgeandGetTargetPortCandidatesForEdgethat had anIEdgeparameter have been removed - the two remaining pairs have been merged into a single method with an optional argument for the opposite candidate.- The property
AbstractPortCandidateProvider.PortOwnerhas been removed, along with the methods that made use of it. AbstractPortCandidateProvider: Overloads ofCreateCandidatetaking anIPortan optionally anIPortLocationModelhave been removed.DefaultPortCandidate: A constructor overload taking the optionalPortCandidateValidityadditionally has been added.OrthogonalEdgeEditingContext.AddMovedEdgeEnd: ThemovementInfoparameter's type has been changed to the more generalMovementInfo. A boolean parameteratSourcehas been added.PortRelocationHandle: The methodConfigureDummyEdgehas been folded intoCreateDummyEdge.- The methods
IDragHandler.HandleMoveandIReshapeHandler.HandleReshapeno longer has a return value. - The classes
InputModeControllerandGraphInputModeControllerhave been removed. - The abstract class
EdgeEndMoveHandlehas been removed. - The
StateMachineclass as well as the associated types and infrastructure have been removed from the API.
GraphML
The XML namespaces have been updated and the mapping from yFiles.NET types to their corresponding XML namespace has been changed.
- All platform-independent graph model types are now mapped to
http://www.yworks.com/xml/yfiles-common/3.0. This includes the following types:- all graph item types
- all default label models
- all port location models
- all "void" styles
- serialization for geometric primitives
- All platform-independent GraphML support types are now mapped to
http://www.yworks.com/xml/yfiles-common/markup/3.0. - All platform-independent framework classes are now mapped to
http://www.yworks.com/xml/yfiles-common/markup/primitives/2.0. This includes the following types:- Built-in value types (
int,double,bool, etc., and enumeration types) string
- Built-in value types (
- All library types specific to yFiles.NET are now mapped to
http://www.yworks.com/xml/yfiles.net/5.0/forms. These are mainly the types in the following namespaces:yWorks.Graph.StylesyWorks.Markup.Platform
- The following events have been added to signal the end of the write or parse process, respectively:
GraphMLIOHandler.Parsed,GraphMLParser.Parsed,GraphMLIOHandler.Written,GraphMLWriter.Written, together with the corresponding event raiser methods. SerializationProperties:- The new serialization property
ParseLabelSizeoptionally disables parsing of the preferred size of a label. This can be used to prevent unexpected clipping when parsing GraphML written on different machines, or with fonts that are not available. WriteGraphSettingsandDisableGraphSettingshave been merged to a singleDisableGraphSettingsproperty which is interpreted according to the context where it is set.IndentOutputhas been added that allows to define whether the XML output should be properly indented.
- The new serialization property
- A few abstract base classes have been merged:
AbstractXmlWriterandDirectXmlWriterhave been merged intoXmlWriterAbstractMapperInputHandlerandComplexMapperInputHandlerhave been merged intoMapperInputHandlerAbstractMapperOutputHandlerandComplexMapperOutputHandlerhave been merged intoMapperOutputHandler
- The legacy interface
IDeserializerhas been removed. For custom deserialization an event handler forGraphMLIOHandler.HandleDeserializationcan be used. - The classes
ArrayValueSerializerandNullXmlWriterhave been removed. IXamlNameMapperhas been refactored to andAddXamlNamespaceMappinghas been added toGraphMLIOHandler.QueryOutputHandlersEventArgs: The overload ofAddOutputHandlertaking an object id has been removed.XmlWriter: A propertyindenthas been added that allow to define whether the XML output should be properly indented.XmlWriter: The constructor overload taking anInternalXmlWriteras well as the corresponding propertyDelegateWriterhave been removed.
Utility Types
A lot of the utility types have been either replaced or removed.
- The
yWorks.Modelnamespace has been removed and its types have been moved to more intuitive namespaces. - The
yWorks.Supportnamespace has been removed along with most of the types contained within, since they were not really needed. The remaining types have been moved to more meaningful namespaces, mainlyyWorks.Controls. - The classes
EmptyCollection<T>,EmptyList<T>,CompositeEnumerable,CompositeEnumerator,CompositeListEnumerable,CompositeCollectionModel,SingleListEnumerable,SingletonCollection,SingletonList,DoubleCollection, andCollectionChangedEventArgshave been removed. - The classes
CompositeHandle<T>andCompositePositionHandlerhave been removed. - The
IMapper.RemoveValuemethod has been removed. It depends on the specific implementation of the mapper whether a mapping can be removed. If an implementation provides a way to remove a mapping, that should be preferred over setting anullvalue. - The classes
GenericYList,GenericListCell, andHashSethave been removed. - The classes
DefaultNodeLookup,DefaultEdgeLookup,DefaultPortLookup,DefaultLabelLookup,DefaultBendLookupandDefaultItemLookuphave been removed. Properties with the same names have been added toDefaultGraphinstead. - The
ItemDecorator<TModelItem>class has been removed. Its members have been pushed down to its former sub-classesNodeDecorator,EdgeDecorator,LabelDecorator,PortDecorator, andBendDecorator. - The events
ItemSelectedandItemDeselectedonISelectionModelhave been merged into theItemSelectionChangedevent. - The
GeomSupport.CreateSmoothedPathmethod has been moved toGeneralPath.
Layout
Layout Execution
LayoutExecutor:- The method
Stopnow stops a running layout calculation as soon as possible and then immediately shows the result so far, skipping any animation. In addition, the new methodCancelimmediately cancels a running calculation and doesn't change theGraphControl'sGraphunless the animation was already running. - The property
AbortHandlerhas been made read-only. There is a protected factory methodCreateAbortHandlerwhich can be overridden to create a customAbortHandlerimplementation. - Labels are now taken into account for the final content rectangle and viewport animation.
- The new property
ConsiderViewportLimitercan be enabled to let the target viewport after a layout respect theViewportLimiterof theGraphControl. TheViewportAnimationhas a new propertyConsiderViewportLimiterfor the same purpose. - The classes
LayoutExecutorandLayoutGraphAdapternow have a propertyAutomaticEdgeGroupingthat automatically configures edge groups for ports with multiple incoming or outgoing edges. This feature is enabled by default. - The classes
LayoutExecutorandLayoutGraphAdapternow have a propertyFixPortsthat automatically configures strong source and target port constraints for all edges in the graph. This feature is disabled by default. LayoutExecutorno longer throws an exception wrapping a layout exception if no event handler ofLayoutFinishedhandled the event arguments. This means that exceptions in a layout algorithm can go by unnoticed if the layout runs asynchronously, and the task returned fromLayoutExecutor.Startis not awaited.
- The method
LayoutGraphAdapternow adds data providers that map each node, edge, and label of aLayoutGraphto their correspondingIModelItemin the originalIGraph. Especially, these data providers are available if a layout is run with aLayoutExecutoror the convenience methodsMorphLayoutorApplyLayout.
Layout API
- The legacy hierarchic layout algorithms
HierarchicLayouter,HierarchicGroupLayouter, and the associated legacy interfacesILayerer,IDrawer,IMementoSupport,ILayerSequencer, together with their implementations, have been removed. Instead,IncrementalHierarchicLayouterhas been renamed toHierarchicLayoutand is now the only implementation of the hierarchic layout style. All associated interfaces and implementations from the namespaceyWorks.yFiles.Layout.Hierarchic.Incrementalhave been moved up toyWorks.Layout.Hierarchic. - The legacy classes
OrthogonalGroupLayouterandDirectedOrthogonalLayouterhave been removed and their features have been incorporated intoOrthogonalLayout. - The legacy class
OrthogonalEdgeRouterand all associated classes have been removed. - The
HVTreeLayouterclass has been removed and its features have been incorporated intoTreeLayout. - The
DefaultGraphLayoutclass has been removed. - The
ParentEdgeAugmentationStageclass has been removed. - The
Graph.MoveSubgraphmethod has been removed. CopiedLayoutIGraphhas been removed. An instance of the base typeCopiedLayoutGraphwith the same functionality can be obtained fromLayoutGraphAdapter'sCreateCopiedLayoutGraphfactory method.- The
CanLayoutmethod has been removed from all layout algorithms. Previously it pretty much always returnedtrue.
Renamed Layout Types
| yFiles.NET 4.4 | yFiles.NET 5.0 |
|---|---|
| Main Interface | |
ILayouter |
ILayoutAlgorithm |
ILayouter.DoLayout |
ILayoutAlgorithm.ApplyLayout |
ILayouter.CanLayout |
removed |
| Major Layout Algorithms | |
HierarchicLayouter |
removed |
HierarchicGroupLayouter |
removed |
IncrementalHierarchicLayouter |
HierarchicLayout |
DirectedOrthogonalLayouter |
removed; functionality incorporated into OrthogonalLayout |
OrthogonalGroupLayouter |
removed; functionality incorporated into OrthogonalLayout |
OrthogonalLayouter |
OrthogonalLayout |
OrthogonalEdgeRouter |
removed; functionality incorporated into EdgeRouter |
OrganicLayouter |
ClassicOrganicLayout |
SmartOrganicLayouter |
OrganicLayout |
TreeLayouter |
ClassicTreeLayout |
GenericTreeLayouter |
TreeLayout |
HVTreeLayouter |
removed; functionality incorporated into TreeLayout |
SALabeling |
GenericLabeling |
GreedyMISLabeling |
removed; functionality incorporated into GenericLabeling |
MultiPageLayouter |
MultiPageLayout |
MultiPageLayout |
MultiPageLayoutResult |
| Changes in alphabetical order | |
AbstractLabelingAlgorithm |
LabelingBase |
ARTreeLayouter |
AspectRatioTreeLayout |
BalloonLayouter |
BalloonLayout |
BufferedLayouter |
BufferedLayout |
CanonicMultiStageLayouter |
MultiStageLayout |
CanonicMultiStageLayouter.LabelLayouter |
MultiStageLayout.Labeling |
CanonicMultiStageLayouter.LabelLayouterEnabled |
MultiStageLayout.LabelingEnabled |
CircularLayouter |
CircularLayout |
CompactOrthogonalLayouter |
CompactOrthogonalLayout |
ComponentLayouter |
ComponentLayout |
FamilyTreeLayouter |
FamilyTreeLayout |
GenericTreeLayouter |
TreeLayout |
GroupedShuffleLayouter |
RecursiveShuffleLayout |
GroupNodeHider |
HideGroupsStage |
IncrementalHierarchicLayouter |
HierarchicLayout |
yWorks.yFiles.Layout.Hierarchic.Incremental.HierarchicLayouter |
yWorks.Layout.Hierarchic.HierarchicLayoutCore |
IncrementalHierarchicLayouter.CreateHierarchicLayouter |
HierarchicLayout.CreateHierarchicLayoutCore |
IncrementalHierarchicLayouter.HierarchicLayouter |
HierarchicLayout.HierarchicLayoutCore |
InteractiveOrganicLayouter.DisableStages |
InteractiveOrganicLayout.DisableAllStages |
InteractiveOrganicLayouter |
InteractiveOrganicLayout |
IsolatedGroupComponentLayouter |
IsolatedGroupComponentLayout |
LayouterKeys |
LayoutKeys |
LayoutTool |
LayoutGraphUtilities |
MinNodeSizeStage |
MinimumNodeSizeStage |
MISLabelingAlgorithm |
MISLabelingBase |
NormalizingGraphElementOrderStage |
NormalizeGraphElementOrderStage |
OrganicLayouter |
ClassicOrganicLayout |
OrientationLayouter |
OrientationLayout |
PartialLayouter |
PartialLayout |
RadialLayouter |
RadialLayout |
RecursiveGroupLayouter |
RecursiveGroupLayout |
ReducedScopeStage |
(removed) |
RemoveOverlapsLayoutStage |
RemoveOverlapsStage |
SALabeling |
GenericLabeling |
SequentialLayouter |
SequentialLayout |
SeriesParallelLayouter |
SeriesParallelLayout |
ShuffleLayouter |
ShuffleLayout |
SingleCycleLayouter |
SingleCycleLayout |
SmartOrganicLayouter |
OrganicLayout |
SplitEdgeLayoutStage |
SplitEdgeStage |
SubgraphLayouter |
SubgraphLayout |
TreeComponentLayouter |
TreeComponentLayout |
TreeLayouter |
ClassicTreeLayout |