yFiles for HTML Changelog

This is the 3rd bugfix release for yFiles for HTML 2.6. It corrects a small number of errors, and includes a new source code demo. There are no incompatible API changes.

Bugfixes

Visual Studio Code no longer suggests auto-imports that incorrectly import from yfiles/*, but only from yfiles. This is achieved by a slight improvement of the typesVersion property in the package.json file.

WebGL2 rendering mode

• The WebGL2ArcEdgeStyle class now draws the arc with the correct height in some edge cases. Previously, the visualization was incorrect if the given height was less than 0.5 and the fixedHeight property was set to false, or if the given height was greater than 255 and the fixedHeight property is set to true.
• The WebGL2BridgeEdgeStyle class now draws the bridge on the correct side if the given height is greater than 255.
• WebGL2 handle hit testing now correctly considers the value of the GraphComponent.hitTestRadius property.
• WebGL2 handles now correctly register hits when a projection other than the identity projection is applied to the GraphComponent.
• Deleting a selected edge with bends that uses the WebGL2PolylineEdgeStyle no longer leaves rendering artifacts of the target port handles the graph component.

Other features

• With ArcEdgeStyle, the 3 center positions of the NinePositionEdgeLabelModel are now in the right places. Previously they were often way off.
• The default visualization for selected ports is now displayed correctly.
• The NodeStyleStripeStyleAdapter class now correctly updates the visualization when its nodeStyle property is changed.
• The problem of excessive memory consumption in the analysis algorithm Paths when setting a large number of start and end nodes has been fixed.
• If labels are specified through the LabelingData.affectedLabels property but the LabelingData.affectedLabels.dpKey property is not set, the key set to the LabelingBase.affectedLabelsDpKey property is used.

Notable demo improvements

• When editing demo code in Visual Studio Code, auto-import is now much more convenient to use. In addition to suggesting importing from plain yfiles instead of yfiles/*, it no longer suggests importing from the yFiles UMD modules.

  To achieve this, some of the demos that used the yFiles UMD modules were removed. These showed outdated technologies anyway. You can still find their source code in the GitHub demo repository with the v2.6.0.2 tag.

• The new Home Automation Demo is an example of a tool for visually programming a home automation network.
• BPMN DI file import now correctly handles lane sets in a subprocess node.

This is the 2nd bugfix release for yFiles for HTML 2.6. It corrects a small number of errors.

Bugfixes

WebGL2 rendering mode

• In this rendering mode, certain interactions no longer result in exceptions when using a FilteredGraphWrapper with a folded graph as the complete graph.
• SVG visuals no longer disappear when using WebGL2GraphModelManager with render mode WebGL2GraphModelManagerRenderMode.SVG and a graph item style that changes the instance of the SVG visual in its updateVisual method.
• In this rendering mode, the shadow effect of self-loops and arcs is now an actual shadow, not a wide ambient light. Also, when zooming out, the effects of all edge types now disappear in the same way, in sync with the effects on nodes.
• Browsers no longer complain about certain WebGL vertex attributes being supplied without a bound buffer under certain conditions.

Radial layout

• The RadialLayout class no longer throws an exception if the layout algorithm is executed too many times from the same instance.

This is the 1st bugfix release for yFiles for HTML 2.6. Compared to version 2.6, it includes several error corrections and a minor incompatible change.

Incompatible change

• When WebGL2 handles are used in SVG render mode and the tree-shaking step of the build tool removes the view-webgl module, a meaningful error is now thrown. Previously, the handle functionality would just silently break. Add the line Class.ensure(WebGL2GraphModelManager) to prevent the removal of the module and thus the error.

Bugfixes

View and Styles

• The ArrowEdgeStyle's bounds now tightly enclose the rendered shape. Before, they were too large.
• The StretchStripeLabelModel class no longer causes incorrect handling of insets.
• ViewportAnimations now are properly cleaned up on cancel.
• Uninstalling the WebGL2GraphModelManager class during an animation no longer causes an exception.
• Removing highlighted edges from their graph no longer causes an exception.
• Changing the GraphComponent.inputMode property while the context menu is open no longer results in an exception.
• The GroupNodeStyle class no longer renders a hairline in place of the tab when using a stroke in combination with tabWidth 0.
• The ShapeNodeStyleRenderer class now always uses the protected getFill and getStroke methods for all shapes instead of falling back to the respective style properties for some shapes.
• The indicator style decorators now correctly render elements provided as SVGDefsElement. For example, the arrows of the IndicatorEdgeStyleDecorator are now rendered.
• The RadialGradient class now properly respects its gradientOrigin property.
• Fixed a memory leak in the GraphHighlightIndicatorManager class that occurred when removing highlighted model items from their graph.
• Fixed a potential memory leak that could occur when switching between WebGL2 and SVG render modes.

GraphML

• During GraphML writing, the IWriteEvents.DataWriting event is now dispatched correctly after the writing process instead of before.
• Labels whose text start with an opening brace are now correctly serialized to GraphML.
• Fixed GraphML serialization and deserialization for certain configurations of the GroupNodeStyle and RectangleNodeStyle classes.

Layout

• The CircularLayout class no longer throws an exception if its property starSubstructureStyle is set to CircularLayoutStarSubstructureStyle.RADIAL and the whole input graph is a star.
• The OrganicLayout class no longer produces edge overlaps when its property chainRecognition is enabled.
• The new protected LayoutExecutorAsync.graphComponent property replaces the incorrectly named LayoutExecutorAsync.graphControl property, which is now deprecated and will be removed in the next major version.

New features

View and Styles

• The WebGL2-based selection, highlight, and focus rendering managers can now be used together with SVG-based graph rendering. Any combination of SVG- and WebGL2-based implementations is supported.
• The GraphModelManager.labelLayerPolicy property, which defines whether labels should be rendered at their owner or in a separate layer, has been split into the separate properties nodeLabelLayerPolicy, edgeLabelLayerPolicy, and portLabelLayerPolicy to support different policies for node, edge, and port labels.
• 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, and GraphHighlightIndicatorManager classes that can be set as corresponding managers on the GraphComponent. This removes the need for using NodeStyleDecorationInstaller, etc.
• To render items in a zoom-invariant fashion, their style can be wrapped in one of the new IndicatorNodeStyleDecorator, IndicatorEdgeStyleDecorator, IndicatorLabelStyleDecorator, or IndicatorPortStyleDecorator classes. The main use case for these decorators is using item styles as selection, focus or highlight indicators.
• The new GraphComponent.SelectionModelChanged event is raised when the model managing the selection is changed itself, not when the selected items change.
• The new TextRenderSupport.invalidateTextMeasurementCache method can be used to reset measure mode detection for a single font or all fonts.

Layout

• The PreferredPlacementDescriptor class now offers two new static factory methods fromModel and fromParameter, to create PreferredPlacementDescriptor instances from ILabelModel and ILabelModelParameter instances, respectively.

• The CircularLayout class now offers the possibility to define star substructures. Its starSubstructureStyle property specifies the style of star substructures and its starSubstructureSize property specifies their minimum size (structures of smaller size are not handled as a star substructure). Furthermore, its starSubstructureTypeSeparation property specifies whether star substructures should be separated by the node type. The new Circular Substructures Demo shows this feature.

  The new CircularLayoutData.edgeDirectedness property specifies how the direction of an edge is considered by the detection of star-substructures.

• The RadialLayout class 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 the RadialLayoutData.nodeTypes property.
• The RadialLayout class 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 new RadialLayoutData.outEdgeComparers property. It is especially suitable for tree-like input graphs. For specifying a single global order for all nodes, for example, alphabetically, the new RadialLayoutData.nodeComparables property is a more convenient option.
• The OrganicLayout class 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 or circle. This new feature can be enabled with the chainRecognition and circleRecognition properties.
• Data registered with GenericLayoutData is now automatically transferred to a Worker when using LayoutExecutorAsyncWorker.
• The HierarchicLayout class now also considers layering constraints between elements of different grouping hierarchies if the recursive group layering is enabled with the HierarchicLayout.recursiveGroupLayering property. Previously, such constraints were ignored in that case.

Improvements

General

• All yFiles modules can now be loaded in environments with incomplete SVG implementation, such as jsdom, without causing exceptions. It is also possible to create a new GraphComponent in these environments, although many operations on the GraphComponent will still fail.
• License checking is now more careful when testing on non-browser environments and detects them more reliably.

• Obsolete compatibility files for old yFiles versions have been removed.

Graph and collections

• The EdgePathLabelModel and EdgeSegmentLabelModel classes have been improved to provide better placements with edge-cases where the path is too short for the label or degenerates completely.
• The GroupNodeLabelModel class no longer triggers an error when used with or set to a node that does not use GroupNodeStyle. GroupNodeLabelModel is still not intended to be used with nodes that do not use GroupNodeStyle. This restriction has been lifted to support workflows where the node style is set to GroupNodeStyle after the label model is set to GroupNodeLabelModel.
• The List class now implements the IListEnumerable interface. This allows using List instances where an IListEnumerable is expected, e.g., assigning the instance returned by the IEdge.bends.toList method to the SimpleEdge.bends property.
• The types of the IEnumerable.groupBy and IEnumerable.from methods or now properly inferred from their parameters. Similarly, the List.from method can now infer the type argument of the returned list even if no mapFunction argument was passed.
• The Exception class no longer re-declares the cause property, but just inherits it from Error, to make sure that the types don't clash. This has been a problem for TypeScript 4.6 through 4.8.
• Functions that are method parameters now have meaningful parameters names and descriptions for their own parameters. In particular, this applies to the methods of the IEnumerable class.

GraphBuilder

• The NodeCreator, EdgeCreator, and LabelCreator classes can now be used without a GraphBuilder. This enables developers to apply styles and labels from a data object in cases where a GraphBuilder is not suitable for graph creation.
• A NodeSource now allows for recursive definition of child nodes in a grouping hierarchy. The new methods addChildNodesSource and createChildNodesSource allow for defining a source to fetch child node items from a node data item.
• A NodeSource now allows for implicit definition of parent nodes in a grouping hierarchy. The new methods addParentNodesSource and createParentNodesSource allow for defining a source to fetch a parent node item from a node data item.
• The getUpdatedStyle method of the NodeCreator, EdgeCreator, and LabelCreator classes now uses the default style from the graph as fallback if the style provider is not set.
• The LabelCreator.getUpdatedLayoutParameter method now uses the default layout parameter from the graph as fallback if the layout parameter provider is not set.
• The TypeScript types for the graph builders and their sources and creators have been made more precise. Many parameters and providers now support strings, objects, or arrays which can be converted into their actual type.

View and Styles

• All base style classes now have an optional generic type parameter. The type defines the exact type of the visual, making it easier to properly implement custom styles with comprehensive IDE type-checking. In addition, for the SvgVisual and the new HtmlVisual classes, there are now factory methods that help with the type-safe creation of the visual along with a type-safe storage of tag data for the purpose of caching rendering data. See the new custom style tutorial on how to use the new type safety.

  The IRenderContext.setDisposeCallback method has now a type parameter for the type of the Visual it handles.

• Bends in edges that use ArcEdgeStyle, ArrowEdgeStyle, or BridgeEdgeStyle are no longer shown when selecting these edges. Additionally, marquee selection will not select these bends anymore even if they lie in the selection rectangle.
• Changing the height of an arc or bridge edge via its handle is now undoable.
• The MarkupLabelStyle class is now faster when the shown text does not contain HTML, and it can now correctly render <sub> and <sup> elements in Firefox..
• The rendering performance of the ShapeNodeStyle class has been improved.
• Initial text measurement when adding labels with the DefaultLabelStyle or MarkupLabelStyle classes is now faster.
• Text measurement no longer sometimes mistakenly uses a slower method, even though this is not necessary.
• Improved SVG rendering performance when embedded in a framework with extensive CSS resets (e.g., Vuetify, Material UI, ...).
• The rendering order of nodes in the GraphOverviewComponent has been improved to be more in sync with the rendering order in the corresponding GraphComponent.
• The GraphOverviewComponent class now uses its contentGroup instead of the rootGroup to add the visualization of its graph content. This makes it easier to customize the overview, for example, by adding a background visual.

WebGL2 rendering mode

• The WebGL2DefaultLabelStyle class now uses the actual label layout to render the labels at the same positions as DefaultLabelStyle, especially with label models that adjust the label size like InteriorStretchLabelModel and GroupNodeLabelModel.
• WebGL2 labels are now rendered in batches to ensure browser responsiveness when lots of labels must be rendered.
• The GraphOverviewComponent class now supports rendering in WebGL2 using suitable WebGL2 item styles for the nodes and edges. Similarly, the GridVisualCreator class now support rendering in WebGL2, too.
• Automatic conversion of a NodeStyleLabelStyleAdapter instance to a WebGL2 style now yields a closer matching visualization.
• The shader for polyline edges compiles faster when only a subset of visual features like dashed, effect, or smooth bends are enabled.
• The fallback shader for polyline edges now respects bends.
• Several style-related methods of the WebGL2GraphModelManager class have now better types.
• The WebGL2Stroke class now supports type conversion from the Stroke class.
• WebGL2PolylineEdgeStyle now renders polyline edges with smooth bends without artifacts on Android devices that do not have enough mediump precision. These edges will be rendered without smoothing, though.

Interaction

• The ItemDroppedInputMode.DragDropped event is now raised after the drop gesture has actually finished, in line with how similar events are raised elsewhere.
• The MoveInputMode, MoveLabelInputMode, and HandleInputMode sub-modes of the GraphEditorInputMode class no longer have a pre-set SnapContext instance. Instead, they get their SnapContext instance from the InputModeContext. That way, setting the GraphEditorInputMode.snapContext property will affect all sub-modes unless a custom SnapContext is set to them.
• The new protected CreateEdgeInputMode.createDummyBend method can be overridden to customize bends added during edge creation. The new protected CreateEdgeInputMode.dummySourceNodePort property provides the temporary port used during edge creation and simplifies overriding the createDummyEdge method.
• The PortRelocationHandle.createDummyEdge method is now virtual and can be overridden.
• The gesture to start edge creation while dragging inside the source node can now be customized with the new CreateEdgeInputMode.sourceNodeDraggingFinishedRecognizer property.
• To improve the usability of resize handle for small nodes, their rendering order has been adjusted.
• To improve the usability of pen input devices, yFiles is more tolerant of small movements during pressing (similar to touch).
• The HoveredItemChangedEventArgs.item property is now properly annotated as nullable.

Layout

• For oriented rectangles the intersection test no longer allocates unnecessary memory and no longer creates unnecessary objects, which improves its allocation performance.
• The TreeLayout class 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 value type of IncrementalHintItemMappingConvertible is now object instead of any and matches the return type of the factory methods of IIncrementalHintsFactory. This means the union type of HierarchicLayoutData.incrementalHints no longer contains any.

Bugfixes

Graph

• The EdgePathLabelModel.findBestParameter method now creates correct parameters for locations close to bends.
• NinePositionsEdgeLabelModel center 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.
• GroupNodeLabelModel no longer stretches tab labels and tab background labels into the collapse/expand icon of the corresponding GroupNodeStyle.
• The findBestParameter methods of EdgePathLabelModel, EdgeSegmentLabelModel, and SmartEdgeLabelModel now create correct parameters for label boxes that overlap the edge's source or target node.
• GroupingSupport's methods enlargeGroupNode and enlargeAllGroupNodes no longer create empty undo units if nothing has changed.
• Passing an IEnumerable as data to GraphBuilder, TreeBuilder, or AdjacencyGraphBuilder now behaves correctly in environments without Symbol, such as Internet Explorer.
• Fixed a bug in LabelCreator which caused setting preferredSizeBindings to result either in nothing or an error.

View and Styles

• GroupNodeStyle's collapse and 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.
• The GroupNodeStyle class now shows the icon in a way that renders correctly in non-browser SVG renderers.
• The DefaultLabelStyle class now adds an ellipsis more reliably at the end when the text does not fit into the specified text wrapping shape.
• Bezier edges no longer turn into polyline paths under rare circumstances.
• The ArrowEdgeStyle class now correctly determines its visibility with thicknesses greater than 13.
• The IArrow type converter no longer produces arrows of incorrect size when strings are given that contain only the arrow color in hex and the arrow type, omitting the scale parameter.
• CSS 4 generic font-family names are no longer quoted erroneously when passed to the Font constructor (or used in font conversions).
• The drop shadows created with the ShadowNodeStyleDecorator class are no longer cut off for small node sizes.
• The drop shadow of the GroupNodeStyle class is now correctly displayed in the top left part if the corner radius is greater than 16.
• Animated viewport changes of a GraphComponent no longer cause strange behavior when values for maximum or minimum zoom are set and are also violated by the viewport change.
• Layout animation performance has been improved for edges with many bends.

Interaction

• Self-loops no longer disappear when resizing nodes while orthogonal editing is enabled.
• MoveViewportInputMode's inertia feature is now less easy to trigger when the mouse or touch pointer has stopped moving for some time before releasing the mouse or touch pointer.
• Starting a CanvasComponent or GraphComponent viewport animation now properly stops a running MoveViewportInputMode inertia 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.
• SmartEdgeLabelModel now properly supports the original position snap line.
• Pinch-zooming no longer jitters when dragging one or more touch points beyond the canvas borders.
• The NavigationInputMode.expandGroup, NavigationInputMode.enterGroup methods, and the ICommand.EXPAND_GROUP and ICommand.ENTER_GROUP commands do not create empty undo units anymore if nothing has changed.
• The NavigationInputMode.exitGroup method and the ICommand.EXIT_GROUP command now create undo units if the bounds of the exited group node were adjusted.
• Fixed a bug in HighlightIndicatorManager that could result in missing or surplus highlight visualizations when changing the GraphComponent.highlightIndicatorManager property.
• Fixed pixelated rendering of handles when a HandleInputMode.renderMode other than RenderModes.SVG was used in combination with a GraphComponent.theme.scale larger than 1.0.
• The Workarounds.touchstartPreventDefault property now is only enabled by default on iOS devices. Before, it has been enabled on all touch devices, preventing the contextmenu event from being dispatched on certain non-iOS browsers and devices.
• Fixed snapping overwrite with CTRL modifier in Firefox on macOS caused by bogus mouse events on these clients.

WebGL2 rendering mode

• WebGL2 rendering mode no longer tries to update the label texture position in the texture atlas if no texture is assigned.
• WebGL2 rendering of edges is now updated correctly when they are reconnected to different ports.
• Layout morph animations with WebGL2 rendering started immediately at app startup now correctly morph the graph.
• The displayed label text is now correctly updated in rendering mode when the label text changes.
• Group node styles are now correctly converted to expanded WebGL2 group node styles.
• WebGL2 rendering no longer breaks if a graph with group nodes is replaced with a graph that does not contain group nodes.
• WebGL2 rendering no longer throws an error when the graph instance is replaced while a label is selected.
• The IconLabelStyle class can now be auto-converted to a WebGL2IconLabelStyle class without throwing an error. Note however that in this case, the WebGL2 style will render only the label text, not the icon.

Layout

• For hierarchical layouts, rare combinations of PortCandidates in PortCandidateSets no longer result in exceptions.
• In organic layouts, fixed nodes no longer move in any case when also a group node is marked as fixed.
• The OrthogonalLayout class no longer throws an exception for some input graphs with tree substructures when the treeStyle property is set to a value different from TreeLayoutStyle.NONE.
• The EdgeRouter class does no longer yield different results in rare cases when the same instance is applied twice to the same input graph.
• The EdgeRouter class no longer produces self-crossing routes of edges with labels if its integratedEdgeLabeling property is enabled.
• The EdgeRouter class no longer produces bad layout results for some scenarios with grouped edges and multiple PortCandidates. Previously, the algorithm selected any of them without considering the alternative options.
• The ClearAreaLayout class no longer produces results where the specified area is not cleared for some input graphs when its clearAreaStrategy property is set to ClearAreaStrategy.PRESERVE_SHAPES or ClearAreaStrategy.PRESERVE_SHAPES_UNIFORM.
• The PartialLayout class does no longer yield different results in rare cases when the same instance is applied twice to the same input graph.
• The PartialLayout class now correctly places disconnected components for cases where a layout orientation is specified, and its componentAssignmentStrategy property is not ComponentAssignmentStrategy.SINGLE. Previously, such components were sometimes placed far away from the remaining graph elements.
• The ShortestPaths class now correctly calculates the k-shortest paths of graphs. Previously, in rare cases, the algorithm sometimes produces wrong results, i.e., returns paths that are not the shortest.

Notable demo improvements

In addition to the demos for new yFiles features, the extensive demo modernization, and the new tutorials, all listed above, there have been numerous improvements of demo source code. The most notable ones are listed below. To check out the new demos in the demo overview, filter it to the version "v2.6.0.0".

• We modernized the existing demos for testing frameworks, and added several new ones, namely Jest, Jest Puppeteer, Cypress, Playwright, Selenium Webdriver, Vitest, and WebDriverIO.
• Several new demos show how to use UI framework components as node styles in a React, Vue, and Angular app.
• The new WebGL2 Label Fading Demo shows how to create a level-of-detail behavior by fading graph items in WebGL2.
• The new Neighborhood Circles Demo shows the neighborhood of selected nodes arranged on concentric circles. The concentric arrangement highlights how close the connection between a selected node and a neighbor node is.
• Two new demos show the integration of yFiles in Next.js and SolidJS apps, respectively.
• The React Demo is now based on Vite instead of create-react, and the new React Class Components Demo shows a hooks-only approach in contrast to the class component-based approach of the existing demo.
• The Vue Demo is now based on create-vue and thus uses Vue 3, TypeScript, and Vite.
• As part of the demo modernization, demos now make use of modern ECMAScript features when appropriate, and consequently, we dropped support for Internet Explorer for the demos. Note that the yFiles for HTML library itself is still compatible with Internet Explorer 9-11.
• We removed some obsolete demos from the yFiles package, but the last version of their source code is still available in the release 2.5.0.4 of the yfiles-for-html-demos GitHub repo.
• All demos will now be part of the Layout and Viewer yFiles packages. With a viewer-only library, you still won't be able to run a demo that uses the layout part of the API, and vice versa, but you can now easily browse the source code of such demos in your IDE.
• We have changed the category/directory of some demos to improve discoverability. For example, 'complete' has now the more descriptive name 'showcase', and some of its demos moved to other categories like Layout and Styles.

Incompatible Changes

See the Migration Guide for more details and advice on migrating.

Incompatible API Changes

• The CactusGroupLayout's defaultNodeComparator property has been renamed to defaultNodeComparer.
• The StarSubstructureStyle enum has been renamed to OrganicLayoutStarSubstructureStyle since there is now also a CircularLayoutStarSubstructureStyle with different values.
• The GraphModelManager.labelLayerPolicy property has been marked as deprecated and will be removed in a future release. Use the more specific properties nodeLabelLayerPolicy, edgeLabelLayerPolicy, and portLabelLayerPolicy instead.
• The TreeNodeSource and AdjacencyNodesSource classes no longer inherit from NodeSource. Consequently, the TreeBuilder.setData method now only accepts TreeNodesSource instances instead of NodesSource instances as its nodesSource parameter.
• The HoveredItemChangedEventArgs class is no longer a subclass of the unrelated ItemEventArgs class. Nevertheless, it still has the same members as before.
• The type of the nodeStyle properties of the WebGL2SelectionIndicatorManager, WebGL2HighlightIndicatorManager, and WebGL2FocusIndicatorManager classes changed from WebGL2NodeIndicatorStyle to WebGL2NodeIndicatorStyle | WebGL2BeaconNodeIndicatorStyle.
• The YObject.referenceEquals method has been removed. We don't expect anyone to have used this method, and it can simply be replaced with the === operator.

Incompatible behavior changes

• When IEnumerable.orderBy and IEnumerable.orderByDescending are called without a comparison function, they now sort numbers by their numerical values. Before, they were sorted by their string values.
• The ItemDroppedInputMode.dragDropped event 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, or BridgeEdgeStyle are no longer shown when selecting these edges. Additionally, marquee selection will not select these bends anymore even if they are in the selection rectangle. This is because these styles either consider bends as control points or do not consider them at all.
• The MoveInputMode, MoveLabelInputMode, and HandleInputMode sub-modes of GraphEditorInputMode no longer have a pre-set snapContext. Instead, they take the SnapContext instance from the input mode context. That way, changing the GraphEditorInputMode.snapContext property will also affect these sub-modes.
• EdgePathLabelModel and EdgeSegmentLabelModel have been modified to yield better results when the path is not long enough for the label or even completely invisible due to overlapping nodes. This leads to greater visual stability in such cases, but results in slightly different placements in these edge cases.
• Adding a label with GroupNodeLabelModel to a node that does not use GroupNodeStyle or setting a GroupNodeLabelModel-created parameter for a label whose owner node does not use GroupNodeStyle no longer throws an error claiming "The parameter does not support this kind of label.".
• For GroupNodeStyle and WebGL2GroupNodeStyle, if the 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 TextRenderSupport.addText method now consistently returns a string containing line breaks for wrapped texts.
• The EdgeRouter class now ignores inner node labels by default, see property ignoreInnerNodeLabels. Previously, this property was disabled by default.
• The layout-radial module now depends on the layout-tree module. Since you typically import from yfiles and not an individual module, this doesn't affect your source code. However, build tools that do tree shaking will now include the layout-tree module together with the layout-radial module.

This is the 4th bugfix release for yFiles for HTML 2.5. This version brings several error corrections.

Bugfixes

Graph and styles

• When folding is enabled, undoing label removal or re-doing label creation will no longer throw an error.
• Corrected NinePositionsEdgeLabelModel's center placements above and below the edge. Before the fix, the labels were not always in the middle of the path, and they seemed to jump around when the path changed.
• The GroupNodeLabelModel class no longer stretches tab labels and tab background labels into the collapse/expand icon of the corresponding GroupNodeStyle.
• With the GraphBuilder class, updating an existing edge whose (new) source or target nodes cannot be resolved now removes the edge from the graph.
• Fixed potential memory leaks in the GraphBuilder, AdjacencyGraphBuilder, and TreeBuilder classes.
• The IconLabelStyle.updateVisual method now properly updates the visual if the style's icon is changed.

WebGL 2

• Group node styles are now correctly converted to expanded WebGL2 group node styles.
• WebGL2 rendering no longer breaks if a graph with group nodes is replaced with a graph that does not contain group nodes.
• WebGL2 rendering no longer throws an error if the graph instance is replaced while a label is selected.
• WebGl2 rendering no longer shows warnings about GL_INVALID_OPERATION in the browser's console if polyline edges are selected.

Layout

• The EdgeRouter class no longer produces bad layout results for some scenarios with grouped edges and multiple PortCandidates. Previously, the algorithm selected any of them without considering the alternative options.
• A circular layout with LayoutStyle.BCC_ISOLATED can no longer get into an infinite loop for inputs where a component consists only of articulation points.
• The GenericLabeling class 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.

This is the 3rd bugfix release for yFiles for HTML 2.5. This version brings a minor incompatible change, some improvements of the Dev UX, several error corrections, and some demo improvements.

Minor incompatible change

The value of the DefaultLayerSequencer.maximumDuration property is now unrestricted. Previously, it was restricted to 10 seconds. This class is used by the HierarchicLayout class, which still adheres to its own maximum duration. Therefore, we do not expect this change to have any negative practical impact.

Improvements

• We replaced all usages of "direct eval" with "indirect eval". This should avoid problems when the code is optimized by build tools like esbuild.
• In the TypeScript type definitions, the documentation of option object properties now correctly references the corresponding member documentation, which usually contains more information about this API.

Bugfixes

General

• The custom formatters for the browser's dev tools can now be used again. In a previous version, we accidentally broke their registration code.

Hierarchical Layout

• The HierarchicLayout class no longer throws an exception for some invalid specifications of alternative group bounds in incremental layout mode
• For input graphs with a PartitionGrid structure, the HierarchicLayout class now correctly considers the layering produced by its fromScratchLayerer if it is already compatible with the specified grid structure.
• The results of the DefaultLayerSequencer class are now deterministic by default, since it no longer aborts the calculation after 10s. For this, its maximumDuration value is now unrestricted.

Organic Layout

• The OrganicLayout class now satisfies its deterministic property for more often, even if the maximum duration is restricted. Note, however, that non-deterministic behavior is still possible when restricting the duration.
• The OrganicLayout class no longer violates the specified minimum node distance for separated radial substructures.
• The OrganicLayout class no longer produces broken routes of self-loops at group nodes if the scope is not equal to OrganicLayoutScope.ALL.

Orthogonal Layout

• The OrthogonalLayout class no longer generates overlaps between edge segments (of a parallel edge) and edge labels of other edges for some rare scenarios.
• The OrthogonalLayout class 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.

Edge Router

• The EdgeRouter class now correctly considers the maximum duration and the AbortHandler when the octilinear routing style is chosen. Previously, it could happen that the algorithm kept on running even though the time was up.
• The EdgeRouter class no longer throws an exception for some rare cases with collinear bends.

Other Layouts

• Improved the initialization time and memory consumption of layout animations.
• The new CactusGroupLayoutData.nodeComparer property specifies the comparison function used to sort a parent node's child nodes.
• The SingleCycleLayout class no longer produces violations of the specified minimum node distance.
• The ClearAreaLayout class no longer produces results where the specified area is not cleared for some input graphs its clearAreaStrategy property is set to ClearAreaStrategy.PRESERVE_SHAPES or ClearAreaStrategy.PRESERVE_SHAPES_UNIFORM.
• The PolylineLayoutStage class now correctly considers a registered AbortHandler instance so that it is possible to terminate early. Previously, the stage ignored the AbortHandler.

New demos and notable demo improvements

• The new Subdivide Edges Demo shows a custom interaction that lets users insert a node into an edge by dropping it onto its path.
• The new Parcel Demo shows how to integrate the yFiles library in a Parcel project.
• The Angular CLI Demo now shows how to run more yFiles features "outside of Angular". This can drastically improve performance, especially of layout calculations.
• The HTML Label Style Demo now shows styles which better support interaction. The visualizations now include scrollable areas and clickable links.

This is the 2nd bugfix release for yFiles for HTML 2.5. This version brings several error corrections, including all fixes from version 2.4.0.7, and new demos.

Exceptionally, this bugfix release also contains an incompatible change related to the new shape text wrapping feature. Since this feature was only introduced in 2.5 and the change improves the vast majority of use cases, we decided to implement it in this release instead of waiting for 2.6.

Incompatible change

• The default value of the DefaultLabelStyle.textWrappingShape property is now TextWrappingShape.RECTANGLE. The previous default TextWrappingShape.LABEL_SHAPE resulted in unexpected and inconsistent rendering behavior for labels whose style only differed in the DefaultLabelStyle.shape property.

Bugfixes

Graph and View

• With DefaultLabelStyle and its textWrappingShape property set to rectangle) the results of the preferred size calculation are now more compact and more consistent between the different available label shapes. In particular, the height is now the same for all shapes, and as a result, labels whose style just differ in shape now get the same height by default.

  Consequently, the default value of the DefaultLabelStyle.textWrappingShape property is now TextWrappingShape.RECTANGLE instead of TextWrappingShape.LABEL_SHAPE.

• Viewport animations no longer suddenly stop when the current CanvasComponent.zoom value approaches the values of the minimumZoom or maximumZoom properties.
• Using HierarchicNestingPolicy.GROUP_NODES, LabelLayerPolicy.AT_OWNER and undo support together in a GraphComponent no longer results in an error.
• The CanvasComponent.cleanUp method now removes all internal event listeners from the div element. Version 2.5 introduced a new listener that was not properly removed, resulting in a potential memory leak or unexpected behavior.
• The promise returned by the SvgExport.exportSvgAsync method is now fulfilled, even when the graph contains styles with an SVG <image> element whose href attribute is either empty or not present at all. Previously, the promise remained forever in pending state in this case.
• The TypeScript type definitions now specify the DashStyle.dashes property as nullable instead of not-null, since this was always the intended state. In fact, the DashStyle.SOLID singleton always used null dashes.
• The NodeEventArgs.parent property of the FilteredGraphWrapper.NodeRemoved event no longer provides groups that are only present in the complete graph but not in the filtered graph itself.

Interaction

• Pinch-zooming with two fingers now works a lot more reliably when the frame rate is low due to complex and large graphs.
• All UI components now listen for the pointercancel event of pen devices and handle it like lostpointercapture events. Thus, if such an event occurs, the CanvasComponent.MouseLostCapture event is now fired, and active input modes properly clean up their internal state. In version 2.5, we already added this for devices of touch pointer type.
• If the graph component's internal event processing has entered an invalid state due to incomplete native mouse events, it will now recover in more cases and explicitly abort the ongoing user interaction.
• When the "Tap to click" setting is enabled for the trackpad under macOS, a tap on the trackpad is now actually reliably recognized as a click. Previously, many of these taps were ignored, since the browser often doesn't provide sane native events in this case.
• Touch move events are now guaranteed to be raised up to the location where a touch up event happens.
• After pasting, a closed group node within another closed group now stays closed. Previously, it was open due to a bug in the GraphClipboard class.

WebGL2

• The SvgExport class now works correctly with WebGL2 rendering mode. It now makes sure that parallel shader compilation is disabled, and waits until the actual shaders are compiled to use them for rendering into the exported element.
• The promises returned by the IAnimation.start and IAnimation.stop methods are now fulfilled even when the animation is not associated with any graph item. Also, these promises are now fulfilled when the corresponding WebGL2GraphModelManager is removed from its GraphComponent. Previously, such promises remained forever in pending state.

Layout

• The HierarchicLayout class now also considers layering constraints between elements of different grouping hierarchies if the recursive group layering is enabled. Previously, such constraints were ignored in that case.
• The OrthogonalLayout class now correctly considers the specified minimum group node sizes. Previously, the minimum sizes were always enlarged by the groups' insets. Actually, the minimum size should include the insets.
• The GenericLabeling class no longer produces superfluous label overlaps if one of its removeNodeOverlaps or removeEdgeOverlaps properties is enabled.
• The TabularLayout class 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 IsolatedGroupComponentLayout class no longer produces unnecessarily large group nodes if the specified gridSpacing is zero.

New demos

• The new Company Ownership Chart Demo allows you to interactively explore the ownership of companies and their management relationships.
• In the new Deep Zoom Demo you can seamlessly zoom into the contents of deeply nested group nodes, similar to "deep zoom" for images.
• The new React JSX Component Node Style Demo presents a versatile and easily customizable template node style based on JSX and React.
• The new Lit Template Node Style Demo presents a versatile and easily customizable template node style based on the Lit templating framework.
• The Simple Arrow Style Demo shows the implementation of a basic custom arrow visualization for edges.
• The new Non-ribbon Chord Diagram Demo shows how to create a chord diagram that emphasizes the connections between nodes.
• In addition, we have made improvements and fixed bugs in several other demos. Particularly noteworthy are the improvements of the Tree of Life Demo.

This is the 1st bugfix release for yFiles for HTML 2.5. This version brings no incompatible API changes.

Bugfixes

Interaction

• The HandleInputMode.handleIsHitTouch method now correctly uses the value of the CanvasComponent.hitTestRadiusTouch property instead of the value of the CanvasComponent.hitTestRadius property for its calculations. As a result, dragging handles during touch input should be much easier.
• An instance of the HandleInputMode class is no longer canceled if a handle is removed during its own dragFinished call. This fixes some very rare exceptions under complicated circumstances.
• The new columnValidBeginCursor, columnResizeCursor, rowValidBeginCursor, and rowResizeCursor properties of the ResizeStripeInputMode class now have reasonable default values, namely Cursor.COL_RESIZE and Cursor.ROW_RESIZE, respectively. These are also the cursors that were used by default for column and row editing in yFiles for HTML 2.4.
• The new workaround flag Workarounds.ff1729465 can be enabled to skip Event.preventDefault calls on touch events. It is enabled by default in Firefox to allow multitouch gestures there. Otherwise, yFiles would call Event.preventDefault on the primary touch event, preventing any secondary touch events in Firefox, too. See Firefox bug 1729465 for details.

View

• Cloning an ITable instance now properly clones all the table's internal state. Previously, changing a cloned table's insets could result in the cloned table's stripes not updating their geometry.
• The MarkupLabelStyle class is now properly excluded from obfuscation such that reading and writing GraphML files with items that use this style works without errors.

WebGL2

• The WebGL2GraphModelManager class no longer throws a TypeError when switching from WebGL2 to SVG rendering. Previously, many circumstances could trigger such an error.
• Enabling the Workarounds.precompileWebGLSelectionShaders property no longer results in TypeErrors.
• The simple and fallback highlight indicators now support elliptical shapes in addition to rectangular shapes, such that these initial visualizations match more closely the actual indicator visualizations.
• The WebGL2Animator.cleanUp method no longer completely resets the animation to the start state. As a consequence, a WebGL2Animation that is run with the Animator class now again stays in its final state, as it was the case in yFiles for HTML 2.4. This is notable for animations like fade and scale.
• Edges with the WebGL2ArcEdgeStyle class are now also rendered if their height is close to 0. Similarly, edges with the WebGL2BridgeEdgeStyle class and a height close to 0 now show shadows and ambient lights correctly.
• Using the WebGL2ArcEdgeStyle class with a dashed line no longer causes an exception.
• Fixed a bug that sometimes used the wrong WebGL2 styles when WebGL2 rendering is used together with Folding.

Demo improvements

• BPMN Editor Demo: EventPortStyles do not share internal state after cloning anymore. Thus, changing the properties of one instance will no longer affect other instances, too.

Major new features

This is the 7th bugfix release for yFiles for HTML 2.4. This version brings error corrections, including performance improvements for the WebGL2 rendering mode. There are no incompatible API changes.

This is the 6th bugfix release for yFiles for HTML 2.4. This version brings error corrections and no incompatible API changes.

This is the 5th bugfix release for yFiles for HTML 2.4. This version brings error corrections, a new demo, and no incompatible API changes.

This is the 4th bugfix release for yFiles for HTML 2.4. This version brings error corrections, but no incompatible API changes.

In addition, there are lots of new demos, and while our old demos weren't ugly, it was time for a change. The new look combines harmonious colors, round shapes with clear borders, and even better readability.

Last but not least, we updated the user interface of our API documentation and Developer's Guide for better usability and readability, and a more pleasant design. At the same time, we ironed out some quirks in the content.

This is the third bugfix release for yFiles for HTML 2.4 which brings some error corrections.

In addition, a new version of the yFiles for HTML Optimizer is available on npm. The optimizer now supports the obfuscation of babel's safe public class fields output and comes with a TypeScript type declaration file that provides code completion in webpack config files.

This is the second bugfix release for yFiles for HTML 2.4. There are 2 error corrections and some demo improvements.

This is the first bugfix release for yFiles for HTML 2.4. In addition to the usual error corrections, there are some demo improvements.

This release reverts an unintended incompatible change in yFiles for HTML 2.4.

Major New Features

WebGL 2.0-based rendering mode

The new WebGL2GraphModelManager allows for leveraging WebGL 2.0 for the GPU-accelerated rendering, editing, and animation of very large graphs. The rendering path comes with an extra set of style implementations for nodes, edges, and labels. The style implementations come with built-in hardware accelerated animations and interactivity, allowing smooth editing and animation for several hundred thousand elements even on mid-range graphics card adapters. The new infrastructure lends itself especially well for large graph visualizations and can be toggled on/off to support the full yFiles extensibility and editing fidelity, when required. The infrastructure is bundled as an extra bundle that will be automatically removed by tree-shaking tool-chains, when not required.

WebGL2Visual is a new base class implementation for visuals that want to use WebGL 2.0 for the rendering of custom visuals, which is now supported in addition and in parallel to WebGL 1.0, HTML5 Canvas, and SVG by the rendering pipeline.

The features and possibilities of this new rendering mode are shown in the following new demos: Large Graphs Demo, Large Collapsible Tree Demo, WebGL2 Styles Demo, WebGL2 Icon Node Demo, WebGL2 Animations Demo, and Rendering Optimizations Demo.

Web Worker

The new pair of classes LayoutExecutorAsync and LayoutExecutorAsyncWorker make it very easy to add multi-threaded layout and algorithm execution to your web applications. Using a similar API as the existing LayoutExecutor class, work can be offloaded off the main-thread and performed on one or more Web Workers or external processes (other browser tabs, browser instances, or even Node.js servers) in parallel without blocking user interactions or animations on the main thread.

New demos show how to add Web Worker-based layouts, and existing examples for the major third party framework examples like Vue.js, React, Angular, Webpack, Node.js, and Rollup.js have been updated to show the new approach.

Smooth 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 CanvasComponent.animatedViewportChanges property, and customized with the new protected method CanvasComponent.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 HierarchicLayout class, 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 TreeLayout and ClassicTreeLayout classes 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 the TreeLayoutData.nodeTypes property.

The OrganicLayout class now allows to define node types via the new OrganicLayoutData.nodeTypes property. 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 properties parallelSubstructureTypeSeparation and starSubstructureTypeSeparation. 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 OrthogonalLayout class now allows to define node types via the new OrthogonalLayoutData.nodeTypes property. 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 CircularLayout class is now able to separate nodes that are on the same cycle with respect to their node type. For this, the new NodeTypeAwareSequencer class can be set as NodeSequencer on the CircularLayout.singleCycleLayout. Node types are specified via the CircularLayoutData.nodeTypes property.

In the ComponentLayout class, 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 the ComponentLayoutData.nodeTypes property to define types.

The node types feature is shown in the new Node Types Demo and the new Organic Substructures Demo.

Edge Routing Only if Needed

Optionally, the EdgeRouter, ChannelEdgeRouter and BusRouter classes now automatically determine whether or not a new path should be calculated for a certain edge. This is controlled via the new properties EdgeRouterEdgeLayoutDescriptor.routingPolicy, ChannelEdgeRouter.routingPolicy and BusRouterBusDescriptor.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.PATH_AS_NEEDED: 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.SEGMENTS_AS_NEEDED: 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 the EdgeRouter class.

The new penalty property PenaltySettings.sketchViolationPenalty supported by the EdgeRouter class defines the cost for a deviation from the original edge path if the new routing policy property is set to SEGMENTS_AS_NEEDED.

This feature is shown in the new Interactive Edge Routing Demo.

More Precise TypeScript Type Declarations

The TypeScript type declarations for yFiles for HTML are now more precises for a lot of yFiles API members. JavaScript projects will benefit from these improvements, too, since the IDEs' code completion for JavaScript projects is based on these files, too. Some notable improvements are:

• New TypeScript definition files for TypeScript 4.3 and higher allow for a more exact documentation of properties whose getter and setter have different types. This is especially useful for setters that support type conversion.
• The type declarations of the UMD module have been changed to a slightly different format that works a lot better with modern TypeScript.
• Members that are readonly or protected are now documented as such.
• A lot more features which are supported by the class framework are now reflected in the type declarations. This includes, e.g., more supported parameter types, inherited properties of option objects, or support for options objects.
• More improvements are listed below.

Improved TypeScript Support

All source code demos and code snippets in the documentation are now available in both JavaScript and TypeScript.

yFiles now comes with type definition files for all versions of TypeScript since 3.1. This is made possible by including different typing files with the typesVersion property of package.json such that you automatically use the file that matches your TypeScript version.

yFiles Dev Suite

Last but not least, the yFiles Dev Suite is now available. It provides a graphical interface that facilitates working with a yFiles for HTML package:

• Integration with my.yworks.com for a simplified evaluation process and direct communication with the yWorks support team.
• Create your own yFiles app with just a few clicks.
• Browse and adapt the plethora of demo applications, manage your changes through integrated diffing, and spawn your own projects from one of the samples as a starting point.

New Features

Graph, View, and Interaction

• All required CSS rules are now created in code, removing the need to include the yfiles.css file. In addition, styling that is mandatory is now added as inline style to prevent accidental omission or overwriting. This behavior can be disabled with the Workarounds.loadDefaultCSS property, and the CSS file yfiles.css is still part of the lib directory of the yFiles package.
• The graph and tree builders now support bindings for bend locations. This is implemented by new bend-related members of the EdgeCreator class.
• The new EdgePathPortLocationModel for 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.
• The new MouseHoverInputMode.toolTipParentElement property defines the element in the DOM to which tooltips are added.
• The new HandleInputMode.QueryClosestHandle event can be used to provide the closest handle for a certain query location.
• The new GraphComponent.noFocusMouseWheelRecognizer property can be used to implement a differing mouse wheel behavior when the GraphComponent is not focused.

Layout and Algorithms

• The new GenericLayoutData class is a generic implementation of LayoutData that allows passing arbitrary data to layout stages. As a consequence, the LayoutData.apply, ItemCollection.provideMapper and ItemMapping.provideMapper methods were removed.
• The new LayoutExecutor.sequentialExecution property controls whether an instance of LayoutExecutor should wait for other instances to finish before executing a layout.
• The OrganicLayout class offers the new clusteringPolicy property, 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 OrganicLayout and ClassicOrganicLayout classes support the new scope MAINLY_SUBSET_GEOMETRIC. 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 scope MAINLY_SUBSET is similar, but it does determine the closeness of other nodes by using the graph structure instead of the current geometry (i.e. location).
• The PartialLayout class offers a new property allowMovingFixedElements to 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 new TreeAnalysis algorithm offers a convenient way of analyzing tree structures and querying tree-related properties (e.g. leaf nodes, parent-child relations and more).
• The new ParallelEdgesAlgorithm.findParallelEdges method allows to find all sets of parallel edges contained in a given graph or incident to a specific node.
• The new SelfLoopRouterData class specifies custom data for the SelfLoopRouter class. In more details, it allows to define which self-loop edges should be routed and which should keep their current path.
• The new PortPlacementStageData class specifies custom data for the PortPlacementStage class. 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 SubgraphLayout class now supports defining which edges must be included or excluded in the subgraph. Previously, only nodes could be specified. The new SubgraphLayoutData class offers the subgraphNodes and subgraphEdges properties to conveniently define the nodes and edges that should form the subgraph the core layout runs on.

Improvements

General

• The yfiles.debug() function now adds all yFiles types to the global yfiles object for a better debugging experience.
• The JS modules variant of the yFiles npm package now correctly advertises its modules as modules instead of commonjs.
• Most parts of the layout and graph algorithms API are now annotated with nullability information. As always, this information is reflected in the API documentation and the TypeScript type declarations.
• The following types can now be initialized with option arguments to more conveniently initialize instance properties at creation: SvgExport, ViewportLimiter, NodeCreator, LabelCreator, and EdgeCreator.

Graph and Collections

• The DefaultFolderNodeConverter and FoldingEdgeConverterBase classes now have portLabelStyle and portLabelLayoutParameter properties to control the style and label layout parameter of copied port labels.
• The methods IEnumerable.last and IEnumerable.lastOrDefault now have an optional parameter predicate that can be used to decide which items may be returned.
• The new NodeInsetsProvider class is an INodeInsetsProvider that returns the same insets for each node.
• Insets instances can now be converted from arrays of length 1 and from objects that only contain some of the top, left, right, bottom, horizontal, or vertical properties.

View

• The CanvasComponent.ensureVisible method now has an additional parameter to specify insets to keep around what to make visible in the viewport.
• The CanvasComponent.ensureVisible method 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.
• The CanvasComponent.ensureVisible, CanvasComponent.fitContent, and GraphComponent.fitGraphBounds methods now return a Promise that completes when the view port adjustment has been finished.
• The CanvasComponent.ensureVisible method now respects margins defined by the CanvasComponent.contentMargins property. The ensureVisible method is called for example by keyboard navigation.
• The ZOOM command now respects margins defined by the CanvasComponent.contentMargins property when executed with a rectangle as parameter.
• The ZOOM_TO_CURRENT_ITEM command now respects the margins defined in the CanvasComponent.contentMargins property.
• All of the following features no longer block user interaction: the viewport animations for CanvasComponent.ensureVisible, executing scroll commands when the CanvasComponent.animateScrollCommands property is enabled, and executing an animated ZOOM_TO_CURRENT_ITEM command.
• The CanvasComponent.fitContent and GraphComponent.fitGraphBounds methods now have an optional parameter that allows changing the viewport in an animated fashion.
• The ViewportLimiter.limitViewport method now has an optional parameter that enforces the ViewportLimitingPolicy.STRICT policy.
• The ViewportLimiter class now always centers the viewport if its honorBothDimensions property is disabled.
• The new install and uninstall methods of the GraphModelManager class simplify exchanging the manager used by a GraphComponent. They are called when setting/removing a GraphModelManager as GraphComponent.graphModelManager and should also be called when combining a GraphModelManager with a CanvasComponent.
• Setting the various descriptor properties of the GraphModelManager class no longer causes updates for every installed item if the descriptor hasn't actually changed.
• A graph component now utilizes the native ResizeObserver API if it is available and the GraphComponent.sizeChangedDetection property is set to SizeChangedDetectionMode.SENSOR. This results in a more robust detection of size changes.
• The new static IAnimation.createDelay method 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 static IAnimation.createDelayedAnimation method delays a provided animation.

• The SvgExport class works better with the new Projections feature by being able to define an arbitrary list of points as well as the projection that should be used for export or printing. The export chooses the exported area in a way that all these points are enclosed in a rectangular area which is axis-parallel to the output coordinates under the given projection.

  The PrintingSupport class provided as demo source code now correctly handles projections as well. Similar to SvgExport, a set of points can be provided to construct an axis-aligned bounding box to print.

• The new canvas object descriptor ICanvasObjectDescriptor.ALWAYS_DIRTY_VISUAL prevents stale rendering states for WebGL2Visuals and other HtmlCanvasVisuals.
• The following WebGL uniforms are now available in a WebGLProgram: u_yf_worldToWebGL, u_yf_viewToWebGL, u_yf_intermediateToView, u_yf_worldToWebGL_3d, u_yf_viewToWebGL_3d, u_yf_intermediateToWebGL, u_yf_intermediateToWebGL_3d, u_yf_worldToIntermediate, and u_yf_zoom.
• The new WebGLSupport.deleteProgram method deletes cached WebGL programs created with the WebGLSupport.useProgram method. This helps prevent memory leaks if deleting a WebGL program is required.

Interaction

• Changing the selection state of a large number of elements is now faster.
• Tooltip contents can now be provided asynchronously. As an alternative to setting the tooltip content directly, the ToolTipQueryEventArgs class also accepts a Promise that provides the tooltip content asynchronously.
• A visible tooltip is now automatically hidden if the mouse leaves the component.
• The HandleInputMode.beginDragging method now returns a Promise which 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.validatedText property accepts a Promise that provides the validated text asynchronously.
• The DragSource.startDrag method now returns a Promise that resolves when the drag operation is done. It resolves to true on a successful drop and to false if the drag operation was canceled or otherwise unsuccessful.
• The OrthogonalEdgeEditingContext.createOrthogonalEdgeDragHandler method now accepts an IPortOwner instead of only an INode as dragged item. This can be used for custom edge drag handling that should support orthogonal edge editing.
• The ItemCopiedEventArgs class now guarantees that its original and copy properties are not null.
• The OverviewInputMode now renders its handle on top of the viewport rectangle instead of below it.

Hierarchic Layout

• The HierarchicLayout, EdgeRouter, and CurveRoutingStage classes 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 the BezierEdgeStyle.
• The HierarchicLayout class now generates shorter paths for edges that cross borders of PartitionGrid columns 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 HierarchicLayout class 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 HierarchicLayout class 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 OrganicLayout it 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 will no longer generate nested structures.
  • Star structures offer the new styles StarSubstructureStyle.RADIAL_NESTED and StarSubstructureStyle.CIRCULAR_NESTED.
  • ChainSubstructureStyle.RECTANGULAR_NESTED and ChainSubstructureStyle.STRAIGHT_LINE_NESTED are the new styles for nested chains.
  • CycleSubstructureStyle.CIRCULAR_NESTED is the new style for nested cycles.
• The OrganicLayout class 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.cycleSubstructureSize, and OrganicLayout.parallelSubstructureSize.
• With substructures, the OrganicLayout class now often produces more compact results and comes with an improved placement of degree-one nodes.
• When specified for the OrganicLayout class, the scope MAINLY_SUBSET now 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

• The EdgeRouter class now supports explicitly defining costs for different types of edge crossings. The new properties PenaltySettings.adjacentEdgeCrossingPenalty and PenaltySettings.selfCrossingPenalty relate 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 existing edgeCrossingPenalty property.
  • 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 edgeLengthPenalty and groupNodeCrossingPenalty properties were increased to obtain more balanced results.
• The EdgeRouter class 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.
• When the EdgeRouter class runs with a highly restricted maximum duration or is aborted via the AbortHandler class, 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 HierarchicLayout, EdgeRouter, and CurveRoutingStage classes 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 the BezierEdgeStyle.

Other Layouts

• The new LayoutGraphAdapter.ORIGINAL_TAG_DP_KEY data provider key provides access to the object stored in the tag property 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 for HierarchicLayout (HierarchicLayoutRoutingStyle.curveShortcuts), EdgeRouter (EdgeRouterEdgeLayoutDescriptor.curveShortcuts) and CurveRoutingStage (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 for HierarchicLayout (HierarchicLayoutRoutingStyle.curveUTurnSymmetry), EdgeRouter (EdgeRouterEdgeLayoutDescriptor.curveUTurnSymmetry) and CurveRoutingStage (CurveEdgeLayoutDescriptor.curveUTurnSymmetry).
• The ClassicTreeLayout class now features properties minimumFirstSegmentLength and minimumLastSegmentLength that allow to specify the minimum first and last segment length for the orthogonal routing style.
• The new ParallelEdgeRouterData.routedParallelEdges property returns which edges the ParallelEdgeRouter class 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.
• The new BalloonLayoutData.OutEdgeComparer property specifies a comparison function used to sort a nodes' outgoing edges.

Type Declarations

The type parameters of the BaseClass function are now inferable by the TypeScript compiler. This makes implementing yFiles interfaces easier: in most cases the type arguments of the BaseClass function can be omitted now.

• The sender argument of event listeners is now the type of the declaring class, which removes the need for type assertions.
• If a returned Promise has no (meaningful) resulting value, this resulting value is now correctly specified as void instead of any or another object. Namely, this affects the methods LayoutExecutor.start, LayoutExecutor.stop, GraphComponent.morphLayout, GraphComponent.updateVisualAsync, GraphComponent.zoomToAnimated, Animator.animate, and SvgExport.fixViewBoxAttribute.

The types of option objects are now more precise. Especially any has been replaced with arrays of the correct type.

• The CanvasComponent.lastInputEvent property now has the more narrow type MouseEventArgs | TouchEventArgs.

Bugfixes

General

• The parameters and return values of various event handlers and callbacks are now correctly annotated with not-null.
• Assigning JSON data in constructor option parameters to properties of object type that initially are null is now properly supported. Previously, the properties were applied recursively resulting in a TypeError.

Graph and Geometry

• The FilteredGraphWrapper class now dispatches ParentChanged events in the correct order after predicate changes.
• All setFactory methods of the Node-, Edge-, Label-, Port-, and BendDecorator classes now respect the nullIsFallback property.
• A label with EdgeSegmentLabelModel or EdgePathLabelModel now moves steadily when the segment to which it belongs moves.
• The DefaultFolderNodeConverter and FoldingEdgeConverterBase classes (and thus, also the DefaultFoldingEdgeConverter and MergingFoldingEdgeConverter classes) no longer ignore port labels.
• The area property of an empty Rect instance (including Rect.EMPTY) is now always zero, and no longer a negative value.
• Labels at ports of collapsed nodes are no longer lost during GraphML serialization.

View

• The CanvasComponent.ensureVisible method no longer ignores the limited viewport size in certain cases.
• The CanvasComponent.zoomToAnimated method now works correctly when a projection is used.
• The following issues of the ICommand.ZOOM_TO_CURRENT_ITEM command have 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.
  • The item is no longer moved outside the visible area in rare cases. This was caused by a problem in the ViewportLimiter class.
• The CanvasComponent.fitContent and GraphCanvasComponent.fitGraphBounds methods now correctly apply the fitContentViewMargins in case a projection is set.
• Fixed incorrect margins on an OverviewGraphCanvasComponent with a projection set.
• Fixed a bug which caused the ICommand.ZOOM command to disrespect the ViewportLimiter if executed with a rectangle as parameter.
• Callbacks registered for removed visuals on the CanvasObject tree now reliably run after the visual is indeed no longer visible.
• Callbacks registered with the IRenderContext.setDisposeCallback method now are reliably called, even when a canvas object has been explicitly removed.
• In SizeChangedDetectionMode.AUTO, the CanvasComponent now correctly falls back to timer-based resize detection when the preferred resize detection modes are not supported.
• In exported images, handles are now always drawn in the correct positions.
• The Animator class will now properly turn off WaitInputMode if an error occurs during an animation.
• Using the scrollbars no longer triggers unnecessary CSS invalidations.
• Fixed memory leaks when disposing the GraphComponent with the cleanUp method.
• The IShapeGeometry parameter of the DefaultEdgePathCropper.isInside and getIntersection methods is now nullable.
• The result of the TextRenderSupport.measureText method is now correct when the font is updated and the text content is a single line.
• The TextRenderSupport.measureText, TextRenderSupport.addText and DefaultLabelStyleRenderer.addTextElements methods, as well as the DefaultLabelStyle class now take empty lines into consideration.
• Fixed an infinite loop in MarkupLabelStyle when not even the first character fits the label.
• Whitespace with multiple spaces in a row is now handled correctly in MarkupLabelStyle.
• The parameters of the add and remove methods of the SvgVisualGroup class are now correctly annotated with not-null.
• Automatic type conversion now converts a none fill or stroke to null instead of black.

Interaction

• The text box shown by the TextEditorInputMode class is now correctly placed if the TextBoxPlacementPolicy.MOVE_TEXT_BOX is set and a projection is used.
• Editing self-loops with PolylineEdgeStyle and orthogonal edge editing enabled works now correctly.
• Auto-dragging now stops in all cases. Previously, it sometimes never stopped.
• The GraphComponent class no longer consumes mousewheel events if it is not focused and its mouseWheelBehavior property is set to MouseWheelBehaviors.ONLY_WHEN_FOCUSED.
• The CreateEdgeInputMode class no longer has an error which prevented the removal of port candidate visualizations after another input mode claimed to be active.

Hierarchic Layout

• The HierarchicLayout class 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 HierarchicLayout class 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 HierarchicLayout class no longer ignores edges connected to group nodes when the group node contains a bus structure (see HierarchicLayoutData.buses) and no other elements. Such edges were previously actually removed from the layout graph such that other stages (e.g. the ComponentLayout) could have failed with an exception.
• The HierarchicLayout class no longer occasionally throws an exception when enabling HierarchicLayout.compactGroups and in conjunction with layering constraints and/or a group node marked as incremental.
• The HierarchicLayout class does no longer violate the specified minimum length for edges incident to group nodes.
• The sequencing phase of the HierarchicLayout class is now faster for large graphs with sequence constraints and non-incremental layout mode.
• Curved edge routes generated by HierarchicLayout, EdgeRouter and CurveRoutingStage no longer contain a self-crossing for edges that connect to a group node and where the connection style CurveConnectionStyle.ORGANIC is specified.
• The curved edge routes produced by HierarchicLayout, EdgeRouter or CurveRoutingStage no longer violate the minimum node-edge distance or intersect the node. Intersections could previously happen especially when the specified node-edge distance was zero.

Edge Routing

• The EdgeRouter class now uses the given ports for edges of a bus with fixed edges.
• The EdgeRouter class 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 CurveRoutingStage class now correctly considers the minimum distance to nodes specified as value of the CurveEdgeLayoutDescriptor.minimumNodeToEdgeDistance property. Previously, the curves could violate the distance and get too close to nodes.
• The EdgeRouter class no longer contains edges with self-crossings in some rare cases where it previously failed to eliminate them.
• The EdgeRouter and CurveRoutingStage classes no longer change the path of unaffected (fixed) edges when the createControlPoints property of their associated EdgeLayoutDescriptor instance (CurveEdgeLayoutDescriptor respectively) is enabled.
• The EdgeRouter class 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 individual EdgeLayoutDescriptor instances. Previously, with some edges being curved, the settings of the other edges got lost and the default settings were used.
• The EdgeRouter class 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 EdgeRouter class no longer occasionally throws an exception if the input contains bus edges defined via BusDescriptor.
• The EdgeRouter class 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.*.
• Curved edge routes generated by HierarchicLayout, EdgeRouter and CurveRoutingStage no longer contain a self-crossing for edges that connect to a group node and where the connection style CurveConnectionStyle.Organic is specified.
• The curved edge routes produced by HierarchicLayout, EdgeRouter or CurveRoutingStage no 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 BusRouter class 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 BusRouter class no longer ignores edges that should be routed when a they are on a bus with fixed edges (see BusDescriptor.fixed property) and when they share both source and target port with a fixed edge.
• The BusRouter class now produces more suitable edge routes for rare cases that were caused by an unsuitable bus placement.
• The ParallelEdgeRouter class 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 EdgeRouter class no longer occasionally throws an exception if the input contains bus edges (defined via BusDescriptor).
• The OrthogonalSegmentDistributionStage class does no longer crash when receiving input graphs with a very large edge count (greater than approximately 22000). Note that the ChannelEdgeRouter class is affected too, as the stage is by default called from within the router.
• The OrganicEdgeRouter.keepExistingBends property now correctly obeys its definition and actually keeps the absolute coordinates of the existing bends.

Other Layouts

• Fixed a bug in LayoutExecutor which caused port labels not to be placed in their calculated position after a layout animation.
• Fixed LayoutExecutor to use wrong target bounds when a projection is set on the GraphComponent.
• The comparison delegates defined in TreeLayoutData.outEdgeComparers and SeriesParallelLayoutData.outEdgeComparers no longer receive null elements during runtime.
• The OrganicLayout and ClassicOrganicLayout classes 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 ClearAreaLayout class no longer throws an exception for some scenarios where the same algorithm instance was first applied to a graph with PartitionGrid and later to a graph without grid.
• The ClearAreaLayout and FillAreaLayout classes no longer throw an exception for some input graphs with edge labels if property ConsiderEdgeLabels is enabled.
• The TreeLayout class now correctly handles trees with group nodes. Previously, it sometimes produced overlapping elements and halo violations for such inputs.
• The RadialLayout class is now much faster if the input graph is a very large tree structure.
• The FamilyTreeLayout class 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 SimpleProfitModel class now computes meaningful different profits based on the PreferredPlacementDescriptor for candidates that belong to a SliderEdgeLabelLayoutModel or a DiscreteEdgeLabelLayoutModel. Previously, the computed profit was equal for all candidates.
• The PartialLayout class now transfers the value of its PartialLayout.maximumDuration property 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 BendConverter layout 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 TabularLayout class no longer throws an error about a missing PartitionGrid when used within RecursiveGroupLayout, and RecursiveGroupLayoutData and TabularLayoutData are used without an explicit cell-id mapping.

Incompatible Changes

See the Migration Guide for more details and advice on migrating.

General

• The TypeScript type declarations of the UMD module have been changed to a slightly different format that works a lot better with modern TypeScript. The main drawback is that quick interface implementation cannot be used with new anymore. Instead, use the static create method of the interface.
• The documentation file ide-support/yfiles-api-umd-jsdoc.js has been removed. The various TypeScript type declaration files provide much better IDE support.

Incompatible API Changes

• The PolylineEdgeRouterData class has been renamed to EdgeRouterData to match the name of the layout algorithm it supports.
• The protected method HandleInputMode.isHovering has been removed. To customize what handle should be used for a certain query location, use the new HandleInputMode.QueryClosestHandle event.
• The TextEditorInputMode.getTextBoxBounds method has been removed.
• The CanvasComponent.fitContentViewMargins property has been renamed to contentMargins. Accordingly, the onFitContentViewMarginsChanged method and the FitContentViewMarginsChanged event have been renamed to onContentMarginsChanged and ContentMarginsChanged, respectively.
• The optional projection parameter for the SvgExport.calculateScaleForWidth and calculateScaleForHeight methods has been removed. Instead, there is a projection property on SvgExport, which should be set to the same projection as the exported canvas component.

• The following methods now return a Promise:

  • The methods MouseHoverInputMode.OnShow and Show now return a Promise that completes when the tooltip content is available and provides whether the tooltip is actually displayed.
  • The HandleInputMode.BeginDragging method now returns a Promise.
  • The GraphEditorInputMode.OnLabelTextEdited method now returns a Promise that completes when the text validation is done and provides whether the validation succeeded or was canceled.
• The LayoutData.apply, ItemCollection.provideMapper, and ItemMapping.provideMapper methods were removed. The new GenericLayoutData class is a generic implementation of LayoutData that allows to pass arbitrary data to layout stages.
• The CanvasComponent.fitContent and GraphComponent.fitGraphBounds methods now have an optional parameter that allows changing the viewport in an animated fashion.
• The CanvasComponent.ensureVisible method now has an additional parameter viewportInsets.
• The constructor of the TreeReductionStage class no longer contains the core property in the extra option object parameter. It is replaced by property coreLayout which previously was a duplicate.
• The following properties of the option object parameter of the DelegatingNodePlacer constructor have been renamed to match the respective node placer property names: placerUpperLeft was renamed to primaryPlacer and placerLowerRight was renamed to secondaryPlacer.
• The options overload of the following methods and constructors has been removed since they were ambiguous with the regular invocation: ICommand.canExecute, ICommand.execute, constructor of InsetsGroupBoundsCalculator, and constructor of SwimlaneDescriptor.
• IComparable's useless static create method has been removed. A proper IComparable requires state to compare the object passed to its compareTo method with.
• Some callbacks whose parameter types or return types erroneously accepted null now have the proper type. This might result in compile time errors in TypeScript.
• If a returned Promise has no (meaningful) resulting value, this resulting value is now correctly specified as void instead of any or another object. Namely, this affects the methods LayoutExecutor.start, LayoutExecutor.stop, GraphComponent.morphLayout, GraphComponent.updateVisualAsync, GraphComponent.zoomToAnimated, Animator.animate, and SvgExport.fixViewBoxAttribute.
• The BusRouter class and the accompanying helper class BusRepresentations are now located in the newly added module yfiles/router-bus.

Changes in Default Behavior

• As a result of the improvements and bugfixes for text measuring, a single line of text is no longer visible if the specified maximum height is smaller than its actual line height.
• The CanvasComponent.projection property no longer accepts transforms with a non-zero translation component.
• The FIT_CONTENT and FIT_GRAPH_BOUNDS commands now change the viewport in an animated fashion.
• Zooming with the mouse wheel to the center of the viewport by using CanvasComponent's centerZoomEventRecognizer no longer uses the INCREASE_ZOOM and DECREASE_ZOOM commands.
• During animated viewport transitions, for performance reasons, mouse events are not redispatched, anymore, except for the last frame of the animation.
• Measuring an empty string with wrapping in TextRenderSupport.measureText now returns the line height instead of 0.0.
• The provider returned by IEdgeReconnectionPortCandidateProvider.ALL_NODE_AND_EDGE_CANDIDATES now doesn't return port candidates of the reconnected edge itself anymore as this lead to an unstable reconnection behavior.
• The HierarchicLayoutData class now assigns same-layer constraints to nodes with the same comparable in LayerConstraintsData.nodeComparables. This is an unintended change that was reverted in yFiles for HTML 2.4.0.1.
• The OrganicLayout substructure styles StarSubstructureStyle.RADIAL, StarSubstructureStyle.CIRCULAR, ChainSubstructureStyle.RECTANGULAR, ChainSubstructureStyle.STRAIGHT_LINE, and CycleSubstructureStyle.CIRCULAR do 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.RADIAL_NESTED).
• 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. 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 are StarSubstructureStyle.SEPARATED_RADIAL, ParallelSubstructureStyle.RADIAL, ParallelSubstructureStyle.STRAIGHT_LINE and ParallelSubstructureStyle.RECTANGULAR.
• As the OrganicEdgeRouter.keepExistingBends property 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 following behavior change applies to class HierarchicLayout with polyline edge routing style: the default value of property EdgeLayoutDescriptor.minimumSlope was changed from 0.3 to 0.2 which makes the sloped segments less steep and the overall results more compact.
• The default value of the ClassicTreeLayout.minimumLayerDistance property was changed from 40.0 to 20.0 and the default value of the ClassicTreeLayout.busAlignment property was changed from 0.3 to 0.5. In addition, the new minimumFirstSegmentLength and minimumLastSegmentLength properties may lead to different results compared to previous versions. Setting both properties to zero will neutralize their influence on the result.
• For the DefaultNodePlacer class that is used by the TreeLayout, the default values of the horizontalDistance and verticalDistance properties were changed from 40.0 to 20.0, and the default values of the minimumFirstSegmentLength and minimumLastSegmentLength properties were changed from 0.0 to 20.0.
• The default value of the LayeredNodePlacer.busAlignment property was changed from 0.3 to 0.5.

Deprecations

• The CanvasComponent.animateScrollCommands property has been deprecated in favor of the new animatedViewportChanges property, which offers more control over viewport animations, not just the scroll commands.
• The automatically inserted WebGL uniforms viewTransform, worldTransform, and projection have been superseded by u_yf_worldToWebGL, u_yf_viewToWebGL, and u_yf_intermediateToView, respectively.
• The OrganicLayout.clusterNodes property is now deprecated. It is replaced by the new OrganicLayout.clusteringPolicy property. To disable clustering, specify OrganicLayoutClusteringPolicy.NONE. To enable it and use the same algorithm as before, specify OrganicLayoutClusteringPolicy.EDGE_BETWEENNESS.

This is the 4th bugfix release for yFiles for HTML 2.3. It brings error corrections and some demo improvements.

There are no incompatible API changes in this release.

This is the third bugfix release for yFiles for HTML 2.3. It brings error corrections and a few improvements of the developer experience.

There are no incompatible API changes in this release.

This is the second bugfix release for yFiles for HTML 2.3. There are only a few error corrections but several new demos.

There are no incompatible API changes in this release.

This is the first bugfix release for yFiles for HTML 2.3. In addition to the usual error corrections, there is a new demo and a noteworthy correction in demo code.

There are no incompatible API changes in this release.

Major New Features

Isometric Drawing and Other Projections

CanvasComponent and thus GraphComponent now have an additional projection property 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 Matrix class. 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. The corresponding chapter in the Developer's Guide has all details about the customization options and the changes related to these features.

Projections are supported by all three rendering modes SVG, HTML Canvas, and WebGL.

The new Isometric Drawing Demo displays graphs isometrically and allows for adjusting the projection to rotate the graph in 3D.

Fill Area Layout and Clear Area Layout

The new ClearAreaLayout algorithm 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 FillAreaLayout algorithm 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.

These new layout algorithms are part of the new layout-area module.

The Component Drag and Drop Demo uses the ClearAreaLayout algorithm to create space in the graph for newly inserted components. In the Fill Area Layout Demo, the FillAreaLayout algorithm closes gaps in the graph layout after graph elements were deleted. Finally, the Interactive Graph Restructuring Demo combines both algorithms to adjust the graph layout while sub-graphs are moved and reconnected within the graph.

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 NodeAggregation class 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 KCoreComponents class provides a component detection algorithm that finds k-cores.
• The classes LouvainModularityClustering and LabelPropagationClustering provide two new algorithms for cluster detection.
• The EigenvectorCentrality class offers a centrality algorithm that measures the influence of a node in a network based on the Eigenvector score.
• The PageRank class provides a centrality algorithm that calculates the so-called page rank for the nodes.
• The classes ChainSubstructures, CliqueSubstructures, CycleSubstructures, StarSubstructures, and SubtreeSubstructures provide 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 GraphStructureAnalyzer now 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 Demo shows how to use the NodeAggregation algorithm 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 other new graph analysis algorithms are shown in either the Graph Analysis Demo or the Clustering Algorithms Demo.

Markup Label Style

The new MarkupLabelStyle interprets the label's text as markup and renders the label accordingly, for example with bold or italic parts, different colors, and different sizes. With this style, many typical text styling requirements can be realized without implementing a custom label style.

The new Markup Labels Demo shows the markup that is supported by this style. The new Markdown Label Demo realizes basic markdown rendering based on this style and the new Rich Text Label Demo shows how to implement interactive rich text editing for this style.

Bezier Edge Style

The new BezierEdgeStyle renders edges with smooth Bezier-curve paths. For intuitive interactive editing, the style comes with the same control points -or handles- that are known from other vector graphic drawing applications.

In addition, the new edge label models BezierEdgePathLabelModel and BezierEdgeSegmentLabelModel place labels optimally on curved edges rendered with this style.

The new Bezier Edge Style Demo presents this edge style and its label models. In addition, several of the existing demos with curved edges now use the new style.

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.centerReshapeRecognizer is triggered which defaults to KeyEventRecognizers.ALT_PRESSED.
• Aspect ratio resizing maintains the aspect ratio of a node. It is active when the NodeReshapeHandleProvider.ratioReshapeRecognizer is triggered which defaults to KeyEventRecognizers.SHIFT_PRESSED.
• The NodeReshapeHandleProvider.reshapePolicy property determines how the mouse location is interpreted when aspect ratio resizing is active.

The Reshape Handle Configuration Demo showcases these different resizing behaviors.

Related to this, the new Node Selection Resizing Demo shows 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.

Graph Builder

The old GraphBuilder, TreeBuilder, and AdjacentNodesGraphBuilder classes 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.

With perfect TypeScript-based code completion, 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, and AdjacentNodesGraphBuilder classes are available as demo code in the demos-js/utils directory.

The Graph Builder Demo, the Tree Builder Demo, the Adjacency Graph Builder Demo, and the Simple Graph Builder Demo show how to load graph data from JSON using the new graph builder classes.

Improvements for Developers

• The new development mode variant of the library includes the powerful yFiles runtime type checking. It's no longer needed to include it separately and deployment tools like webpack can strip it from "production" builds.
• Custom object formatters for the developer tools in Google Chrome and other Chromium browsers.
• The UMD variant of the library now also provides namespace-less names, so the modern "flat" API can easily be used with Node.JS, web workers, or RequireJS.
• Various improvements for the optimizer.
• The semi-automatic migration tool was rewritten to make the migration process for returning users easier. It now offers built-in TS support, an incremental mode, and clear output with source code references recognized by major IDEs.
• Removed the create-node-library tool, as the UMD library now already includes top-level exports of all types.
• Two new demos show how to lazily load yFiles modules with dynamic imports, namely the Webpack Lazy Load yFiles Demo and the Webpack Lazy Load Layout Modules Demo.

TypeScript Demos

A large number of demos is now available in a TypeScript version in addition to the JavaScript version. In this release, these demos include all tutorials of the Getting Started, Custom Styles, and Application Features tutorials, as well as all the new demos. More demos in TypeScript will be added in future minor and major releases, but all demos will always be available in JavaScript, too, and both versions will be identical except for language differences.

New Features

General

• yFiles interfaces now provide a static create method that creates a new instance of the interface. The signature of this method follows the same rules as the quick interface implementation of the interface. This is especially useful in TypeScript projects since the previous JavaScript-style quick interface implementation syntax cannot be expressed with TypeScript definition files.
• Types that support type conversion now have a static from method to explicitly invoke the conversion. This is especially useful in TypeScript projects and custom code to set properties in this way.
• GraphML I/O now supports a static $meta attribute to annotate properties of classes with GraphMLAttributes. This alleviates the need to revert to the yFiles class framework for classes that should be serialized through GraphML.

Graph Component and Interaction

• To improve accessibility, the new GraphComponent.ariaLiveRegion property provides an aria-live region that can be used to update screen readers. The new Accessibility Demo shows how to make use of this property.
• The default label style now supports right-to-left text direction. Label text is properly placed and wrapped when the CSS direction of the GraphComponent's <div> element is set to rtl. The Label Text Wrapping Demo has a new graph sample with right-to-left text.
• The GraphComponent is now prepared to provide complete control of the z-order of elements in all cases. The new Z-order Demo shows how to use this to maintain the z-order during operations there the library does not maintain this order by default, e.g. for undo and redo, expanding and collapsing groups, and clipboard commands.
• Added support for two-finger drag and pinch touchpad gestures. The new MouseEventArgs.wheelDeltaX property provides the horizontal mouse wheel component.
• The template styles now provide a makeObservable method to transform a regular data object into an observable object, allowing TemplateBindings to react to changes of these objects automatically.

  In addition, bindings in template styles now support "duck typing". In other words, if the bound object fires the appropriate events, the binding is updated automatically.

• All string template styles now strip executable code from the templates to prevent attacks via GraphML. To re-enable code injection set the new static property trusted on any of these classes to true.
• The new NodeLabelModelStripeLabelModelAdapter class allows using node label model parameters for the positioning of the row and column labels of a table.
• A new policy has been added to the ViewportLimiter class which 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.
• An Animation can now be paused and unpaused by setting the new Animator.paused property after the animation has started. This feature is used in the Network Monitoring Demo to pause the animation of the network traffic.
• The GridVisualCreator class can now also draw only horizontal lines or only vertical lines when its gridStyle property is set to one of the new enum values GridStyle.HORIZONTAL_LINES or GridStyle.VERTICAL_LINES.

Layout

• The EdgeRouter class and the HierarchicLayout class now support a new routing style that generates curved edge paths. This style can be specified for each edge individually using the EdgeRouterEdgeRoutingStyle.CURVED enum value and the HierarchicLayoutEdgeRoutingStyle.CURVED enum value, respectively.
• The new layout stage CurveRoutingStage replaces polyline edge paths with curved segments using cubic bezier splines and provides a generic way to produce layouts with curved edges.
• The new property EdgeRouterEdgeLayoutDescriptor.routingStyle allows specifying the routing style individually for each edge routed by the EdgeRouter class. Furthermore, the new properties maximumOctilinearSegmentRatio and preferredOctilinearSegmentLength on the descriptor provide means to configure the octilinear routing style.
• The CircularLayout class now supports exterior edges that are routed around the exterior of the circle as smooth arcs. This can be specified with the new CircularLayout.edgeRoutingPolicy property.
• The new EdgeBundlingStage class 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.
• The RadialLayout class now supports a user-defined layer/circle assignment strategy. This can be specified with the RadialLayoutLayeringStrategy.USER_DEFINED enum value and the layout data property RadialLayoutData.layerIds.
• The Layout Styles Demo has been enhanced to include the following layout features and improvements:
  • Exterior edge routing for the circular layout
  • Curved edge routing and bus routing for the hierarchic layout and the edge router.
  • Integrated edge labeling for the edge router.

Algorithms

The "algorithms" part of the library provides the actual implementation of the new aggregation and analysis algorithms. Since this part uses the Graph API instead of the common IGraph API, using these implementations directly is rarely needed.

• New methods of the GraphStructureAnalyzer and GroupAlgorithm classes compute several additional network statistics, namely GraphStructureAnalyzer.getAverageDegree, GraphStructureAnalyzer.getAverageWeightedDegree, GraphStructureAnalyzer.getDiameter, GraphStructureAnalyzer.getDensity, and GroupAlgorithm.getModularity.
• The new NodeAggregationAlgorithm class provides an algorithm that intelligently aggregates nodes of (large) input graphs.
• The new TransitivityAlgorithm.transitiveEdges method creates the transitive edges that connect the visible nodes in an input graph.
• The new GroupAlgorithm.getClusteringCoefficient method computes the local clustering coefficient for each node as well as the average clustering coefficient.
• The new GraphConnectivity.kCore overloaded methods compute the so-called k-cores of an undirected input graph.
• The new CentralityAlgorithm.eigenvectorCentrality method computes the eigenvector centrality for each node in an undirected graph.
• The new GroupAlgorithm.labelPropagation method implements the label propagation algorithm which detects communities in the input graph.
• The new GroupAlgorithm.louvainModularity method detects the communities of an input graph by applying the well-known Louvain method for community detection.
• The new CentralityAlgorithm.pageRank method provides an implementation of the page rank algorithm that computes a rank for each node.
• The new Substructures class offers methods to detect the following graph structures: Chains, Cliques, Cycles, Stars, and Trees.

Improvements

• The new static method IEdge.getPathPoints returns an IListEnumerable that contains a snapshot of the source port location, followed by the bend locations, followed by the target port location of an edge.
• The ITable.addLabel method no longer accepts label model parameters that do not support IStripe instances. Previously node label models could be used but did not work properly at runtime.
• The new Fill.hasSameValue method can be used to check two fills for equality.
• The classes DefaultFolderNodeConverter and FoldingEdgeConverterBase provide a new protected method createPreferredLabelSize to allow for overriding the default implementations.
• The performance of GraphML serialization and deserialization was improved.
• The parameter of all predicate functions is now annotated as not-null which makes it more comfortable to implement these functions.
• BaseClass has now overloads with more than one type parameter, making the TypeScript syntax for implementing several interfaces less complicated.

Collections

• The interfaces IEnumerable and IList now provide the methods indexOf and findIndex which behave similarly to the corresponding functions of JavaScript Arrays. The method IList.indexOf now has an optional parameter fromIndex.
• The IList interface now declares the methods push, pop, shift, and unshift that work in the same way as the corresponding methods of JavaScript arrays.
• The static methods Point.from, Size.from and Rect.from can now convert any object that provides at least properties like x, y, width, and height.
• The new Point.interpolate method calculates the linear interpolation between two points.
• The IMap interface now extends the IMapper interface to facilitate registering instances of maps in the MapperRegistry.
• A native JavaScript Map can now be converted automatically to IMapper.

View

• The DOM update performance when elements in the back of the rendering stack got removed or changed their z-Order was massively improved.
• The GraphOverviewComponent is now rendered with HTML Canvas instead of SVG by default. This results in better performance and was always the intended behavior.
• The performance of general text measuring for TextMeasurePolicy.SVG was improved for cases in which a lot of measurements are done in a short period of time, e.g. during bulk label creation.
• The CanvasComponent.fitContent method now respects the limitedFitContentZoom property if a ViewportLimiter is enabled.
• The CanvasComponent.updateContentRect method now throws an exception if an element on the canvas provided invalid bounds, e.g. one with infinite values.
• The methods raise, lower, toFront, and toBack on class GraphModelManager are now virtual.
• The new GraphModelManager.provideUserObjectOnMainCanvasObject property can be set so that a model is accessible as its main canvas object's user object.
• The new SvgExport.cssStylesheet property allows for defining CSS rules that are added to the exported SVG. Additionally, setting it explicitly to null lets the SvgExport class automatically add all relevant CSS rules from available stylesheets to the exported SVG.
• The classes NodeStyleLabelStyleAdapter, NodeStylePortStyleAdapter, and NodeStyleStripeStyleAdapter now propagate the tags of labels, ports, and stripes to the node that's rendered with the node style.
• The rendering performance of the DefaultLabelStyle class was improved when setting a maximumSize.
• To make overriding easier, the overloaded method IPathGeometry.getTangent that has a segment index and a ratio as parameters was renamed to getTangentForSegment. The corresponding methods of EdgeStyleBase and GeneralPath were renamed as well.
• To make overriding easier, the overloaded methods GraphModelManager.getCanvasObjectGroup now have distinguishable names, namely getNodeCanvasObjectGroup, getEdgeCanvasObjectGroup, etc.

Graph Component's New Projection Feature

• The CanvasComponent class has additional methods to convert between the world, the new intermediate, and the view coordinate system.
• The MarqueeSelectionInputMode, NavigationInputMode, and HandleInputMode classes now have a property useViewCoordinates which controls whether the input mode draws its decorations and processes input in view coordinates.
• When the MarqueeSelectionInputMode class uses view coordinates, the resulting shape of the marquee in world coordinates may not be a rectangle. Therefore, the MarqueeSelectionEventArgs class now has a path property of type GeneralPath to describe the marquee shape and a usePath property that determines whether the path property or the rectangle property shall be used.
• The EdgeDecorationInstaller, RectangleIndicatorInstaller, PointSelectionIndicatorInstaller, and DefaultPortCandidateDescriptor classes now have a useViewCoordinates property that controls whether the decoration is rendered in view coordinates.
• The ContextConfigurator.calculateScaleForHeight and calculateScaleForWidth methods now take an additional optional parameter with the projection to correctly calculate the scale factor when a projection is used.
• The CreateEdgeInputMode.measureDistance method now has to return the distance in view coordinates if and only if CanvasComponent's projection is used.
• The IRenderContext interface now has additional members that are useful with the new projections feature: projection, intermediateTransform, worldToIntermediateCoordinates, and intermediateToViewCoordinates.

Interaction

• Zooming speed of two-finger scroll and pinching was improved for Chrome and Firefox on macOS.
• The default position handler for edges now creates fewer additional bends when the edge is dragged while orthogonal edge editing is enabled.
• The new factory method OrthogonalEdgeEditingContext.createOrthogonalEdgeDragHandler 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 maximumBoundingArea can now be set on the classes ReshapeHandleProviderBase, ReshapeHandlerHandle, RectangleHandle, and ReshapeRectangleContext to restrict reshaping to stay inside the given bounds.
• The new NodeDecorator.reshapeHandlerDecorator property simplifies using custom IReshapeHandler implementations for nodes.
• The new ReshapeRectangleContext.ratio property specifies the width/height ratio that is kept for aspect ratio resizing.
• The new classes NodeReshapeHandleProvider and NodeReshapeHandlerHandle are used as the default implementation for node resize handles.
• With the new ReshapeRectangleContext.reshapePolicy property, INodeReshapeSnapResultProvider implementations can respect the node aspect ratio for according resize gestures.
• The ReshapeHandlerHandle class has new getters for the IReshapeHandler and the HandlePositions.
• The new NavigationInputMode.fitContent method is called after collapse, expand, enter, and exit operations if the fitContentAfterGroupActions property is enabled.
• The NavigationInputMode class doesn't fit the content anymore after expand and collapse operations if an autoGroupNodeAlignmentPolicy other then NodeAlignmentPolicy.NONE is used.
• An optional parameter preferredSnapType has been added to the SnapLineSnapResult constructor and the SnapResults.createSnapLineSnapResult factory method.
• The GraphClipboard and GraphEditorInputMode class now provide the new ElementsDuplicated event that occurs when a duplicate operation finished successfully.
• The undo and redo methods of the UndoEngine class now throw an exception with the name InvalidOperationError if the current state does not allow performing undo or redo. Previously, the name was either NotSupportedError or just Error.
• The classes ResizeStripeInputMode, DropInputMode, and HandleInputMode now have an isDragging property indicating whether a drag currently is in progress.
• The CompositeLabelModel class now supports label snapping.
• The SnapResults.createResizeSnapResult method now takes a Point as delta parameter instead of a number so it is possible to create resize snap results where the orientation of the mouse delta differs from the orientation of the snapped size.
• The properties gridSnapDistance and gridSnapType of the GraphSnapContext class have been pulled up to the SnapContext class.
• The zoom-invariant gridSnapDistance property has been added to the CollectSnapResultsEventArgs class.
• It is now easier to customize the GroupingNodePositionHandler class. The boolean properties adjustParentNodeLayout, moveChildNodes and reparentingEnabled have been added to control whether an 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 GraphEditorInputMode.requeryHandles method has been made public and can now be used to refresh the displayed handles if IHandleProvider implementations return different handles over time.

Layout

• Frequently used types of the layout part have now nullability annotations.
• The LayoutExecutor class now generates more specific port constraints with the FixPorts property enabled, resulting in better edge paths.
• The methods IGraph.applyLayout and GraphComponent.morphLayout now support the configuration of their internal LayoutExecutor instance. Hence, options like viewport animation can be adjusted without switching to the LayoutExecutor class.
• The EdgeRouter class now provides improved support for early exits. The routing algorithm now often reacts more sensibly to the case that the specified maximumDuration is reached.
• If the EdgeRouter algorithm runs with highly restricted maximum time or when it gets stopped by means of an AbortHandler, it now better adheres to the minimum edge-to-edge distance.
• The new HideGroupStage.resetEdgePaths property allows specifying whether or not the stage resets the path of edges incident to group nodes.
• The ComponentLayout class now correctly considers node and edge labels when using the packed layout styles, e.g., ComponentArrangementStyles.PACKED_RECTANGLE or ComponentArrangementStyles.PACKED_CIRCLE. Previously, labels could overlap other elements when using these component arrangement styles.
• The new DefaultPortAllocator.considerFixedPorts property allows specifying whether edges with strong port constraints or fixed port candidates should be considered during the port assignment. Previously, such edges were ignored which could lead to intersections with the ports of the other edges. This new feature is enabled by default.
• The PartialLayout class now produces more stable results if it is multiple times applied to the same input graph and the subgraphPlacement property is set to SubgraphPlacement.FROM_SKETCH.
• Constructor overloads have been added to the classes SingleItem, ItemCollection, ItemMapping, and ContextItemMapping that initialize one of their properties on construction.
• If the mapper property of HierarchicLayoutData.edgeDirectedness is directly accessed (not explicitly set) its default for unset values is 1.0 (in other words, such edges are considered to be directed).
• If the mapper property of OrganicLayoutData.groupNodeModes is directly accessed (not explicitly set) its default for unset values is GroupNodeMode.NORMAL. This doesn't change the result of the layout.
• For the rootPlacements, subtreeRoutingPolicies, and subtreeAspectRatio properties of the AspectRatioTreeLayoutData class, the type of the mapped values has been made nullable. For null or unset values, the settings on the AspectRatioTreeLayout will now be taken.
• All PortCandidate.createCandidate methods now support type conversion for the port direction.

Analysis

• The GraphCentrality and ClosenessCentrality analysis algorithms now calculate the centrality individually per component instead of returning a centrality value of 0.0 for nodes in graphs that are not connected.
• 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. The backing algorithms in the Centrality class are unchanged.
• When EdgeBetweennessClustering and FeedbackEdgeSet are executed, the specified edge weights are checked and in case they are not positive or finite, an exception is thrown.
• The GraphStructureAnalyzer class has now methods to determine whether there are multiple edges between the same pair of nodes.

Bugfixes

• Fixed a bug in FoldingManager where a predicate change in a FilteredGraphWrapper which serves as the master graph could trigger an exception if a child of a folder node has been hidden.
• Undo and redo of additions and removals of bends on folding edges now correctly restores the bends at the location they had at the time of removal.
• Fixed a bug in the GraphCopier class which caused the LabelCopied event to be dispatched twice for port labels on folder nodes.
• Using ES6 classes together with GraphMLIOHandler.addXamlNamespaceMapping(xmlNamespace, module) no longer results in an exception when writing GraphML.
• We now make sure that types that are structural compatible for TypeScript are actually different in the TypeScript typings. Otherwise, the overload resolution provided by the typings wouldn't reflect the actual outcome. This affected especially the EdgeDpKey and NodeDpKey classes and the IMapperRegistry.createMapper methods.
• The methods createNodeMapper and createEdgeMapper of class YGraphAdapter are no longer interchanged. Previously, the createNodeMapper method created an IMapper for keys of type IEdge and vice versa.

View

• The methods ICanvasObject.above and below don't unnecessarily trigger IRenderContext.ChildVisual anymore.
• Fixed a bug that sometimes callbacks registered via the IRenderContext.setDisposeCallback method have not been called when the visual was disposed.
• 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).
• 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 ZOOM_TO_CURRENT_ITEM command to ignore the ViewportLimiter of the corresponding CanvasComponent.
• The CanvasComponent.zoomTo method no longer triggers two ViewportChanged events.
• The scrollbars of a GraphComponent are no longer missing if it was lazily initialized with the policy ScrollBarVisibility.ALWAYS.
• Setting the CanvasComponent.useGlassPane property to true now enables a glass pane as intended.
• The CanvasComponent.SizeChanged event now also returns the correct old size if the ErrorHandling.CatchErrors property is not enabled.
• Fixed a bug where setting the SvgExport.encodeImagesBase64 property to true together with setting the SvgExport.inlineSvgImages property to false would encode SVG images as base64 bitmap images.
• Fixed a bug where SVG images with data URLs as source would not be inlined when the SvgExport.inlineSvgImages property was set to true.

Styles

• The TemplateBinding.bounds property is no longer undefined.
• Setting the fill of an Arrow of type SHORT now works also with automatic type conversion.
• When setting a new Font whose textDecoration property had the value NONE, this TextDecoration was not applied to the SVG text element.
• The TextRenderSupport.addText method now also applies the properties of the given font to the text element, as stated in the documentation.

Interaction

• Pinch-zoom no longer stops periodically during the gesture.
• Fixed a touch interaction bug in Safari that resulted in a freeze of the CanvasComponent when lifting two fingers at once.
• Using a custom input element for editing label text now works correctly since the GraphEditorInputMode.editLabelCore method now sets the label text to the TextEditorInputMode.editorText property instead of to its own internal text input element.
• The NavigationInputMode.fitContentAfterGroupActions property is no longer ignored when the NavigationInputMode class is used as a child input mode of the GraphEditorInputMode class.
• The NavigationInputMode class now also updates the CanvasComponent.contentRect property when it is not used as a child input mode of the GraphEditorInputMode class.
• The SnapContext.gridSnapDistance and SnapContext.snapDistance properties are no longer incorrectly interpreted in world coordinates when calculating snapResults.
• Orthogonal edge editing does not add bends anymore to edges that are marked as not orthogonal.
• The paste and duplicate operations now honor the GraphEditorInputMode.shouldSelect predicate.
• 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.
• The property name reported by the UndoEngine.PropertyChanged event is now always equal to the name of the corresponding property. Previously, some of the reported names started with an uppercase letter.
• Under rare circumstances, tooltip elements were not removed from the DOM after their leave animation ended. There is now a configurable maximum duration for such animations after which the tooltip is removed in any case. The default value is 5 seconds.

Layout

• The HierarchicLayout class no longer throws an exception that was previously triggered in some cases with bus structures and in conjunction with layering constraints.
• The HierarchicLayout class no longer throws an exception that was previously triggered in some cases with bus structures and in conjunction with undirected edges.
• Fixed a bug in the HierarchicLayout class that could cause unnecessary (double) edge crossings when the algorithm was executed in incremental layout mode with edge grouping and alternative group bounds.
• The NodePlacerBase.placeSubtree method now clears its internal caches, especially the graph cached in field NodePlacerBase.graph. Previously, holding onto a node placer instance could lead to subtle memory leaks.
• The EdgeRouter class 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 EdgeRouter class now correctly observes inputs where the user specifies buses with both fixed and non-fixed edges at the same time.
• The EdgeRouter class no longer throws an exception when points specified with the EdgeLayoutDescriptor.intermediateRoutingPoints property are too close together.
• The EdgeRouter class no longer yields edge labels that overlap with unrelated group nodes when using the integrated label placement feature.
• Resolved a bug in the EdgeRouter class 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 EdgeRouter class no longer produces an exception for some rare cases with fixed grouped edges and octilinear paths.
• The OrganicLayout class no longer throws an exception when having a PartitionGrid and at the same time the scope set to SUBSET or MAINLY_SUBSET where all nodes of the graph are marked as affected (could have used scope ALL instead).
• The EdgeRouter class now properly considers ports provided by a PortCandidateSet when 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 EdgeRouter class does no longer use the same fixed PortCandidate out of a specified PortCandidateSet if another non-saturated candidate can be chosen. Thus, overlapping edge segments are avoided.
• The OrthogonalSegmentDistributionStage no longer produces degenerated (very large or small) coordinates for edges that contain zero-length segments, that is, duplicate edge path points.
• The ChannelEdgeRouter class no longer yields degenerated routing results (very large or small coordinates) when using the OrthogonalPatternEdgeRouter as path finder strategy and setting its minimum distance to zero. The OrthogonalPatternEdgeRouter class now avoids duplicate points when the minimumDistance property is set to zero.
• The AspectRatioTreeLayout class no longer crashes, causing a stack overflow, when applied to a large chain graph.
• The RecursiveGroupLayout class now correctly moves child nodes along with their group also in case the RecursiveGroupLayout.coreLayout is null. Previously, if additionally a group node had a specific layout algorithm associated with it, the content was not correctly moved along. If the core layout was not null, the issue did not occur.
• The EdgeRouter class 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 BalloonLayout class no longer crashes due to a stack overflow for inputs containing very long chain graphs.
• Fixed a bug in the HierarchicLayout class that in some cases caused a violation of the minimum first or last segment length. The bug was only triggered when the minimum length values were relatively large.
• The TreeMapLayout class no longer produces results that may have infinite coordinates.

Analysis

• The HierarchicalClustering class no longer throws an exception when applied to an empty graph.
• The results of the Chains class are now correct for undirected cycles, too. If such cycles are not connected to other parts of the graph, the nodes collection of a resulting Path could have been in an incorrect order.
• The ClosenessCentrality class no longer calculates NaN as results of the normalizedNodeCentrality property if the graph consists of one single node. Instead, the value of the normalizedNodeCentrality property is now positive infinity.
• The ClosenessCentrality.run method no longer throws an exception for unconnected graphs. Instead, all values of the nodeCentrality and normalizedNodeCentrality properties will be 0.0 as the documentation states.
• The EdgeBetweennessClustering.run method no longer throws an exception with its default setting for the maximumClusterCount property.

Incompatible Changes

See the Migration Guide for more details and advice on migrating.

Incompatible API Changes

• The GraphBuilder, TreeBuilder, and AdjacentNodesGraphBuilder classes have been replaced in the library with more powerful but incompatible builder classes. Drop-in replacement classes that resemble the API of the previous builders, named SimpleGraphBuilder, SimpleTreeBuilder, and SimpleAdjacentNodesGraphBuilder, are available as demo code in the demos-js/utils directory. See the migration guide for details.
• The KMeansClusteringDistanceMetric enum was removed in favor of the DistanceMetric enum with the same members.
• The ToolTip class has now a constructor without parameters to make custom implementations easier.
• To make overriding easier, the overloaded method IPathGeometry.getTangent that has a segment index and a ratio as parameter was renamed to getTangentForSegment. The corresponding methods of EdgeStyleBase and GeneralPath were renamed as well.
• To make overriding easier, the overloaded methods GraphModelManager.getCanvasObjectGroup now have distinguishable names, namely getNodeCanvasObjectGroup, getEdgeCanvasObjectGroup, etc.
• To support right-to-left text direction, a new optional rightToLeft parameter with default value false was added to the methods DefaultLabelStyleRenderer.addTextElements and TextRenderSupport.addText.
• The DefaultLabelStyleRenderer.addTextElements method now consumes an SVGElement as first parameter. For the default left-to-right text direction, this is an SVGTextElement like before. For the newly supported right-to-left text direction, this is an SVGGElement.
• The NodeReshapeSnapResultProvider.getSnapLines method now takes CollectSnapResultsEventArgs as additional parameter.
• Several methods related to snapping now take a Point instead of a number as delta parameter. In detail, these are SnapResults.createResizeSnapResult, NodeReshapeSnapResultProvider.addSnaplineSnapResult, NodeReshapeSnapResultProvider.addGridLineSnapResult, and NodeReshapeSnapResultProvider.addSameSizeSnapResult.
• The HierarchicalClusteringResult.dendrogramRoot property can now return null if the result has been obtained from an empty graph.
• The optional IPortLocationModelParameter and IPortStyle parameters of the IGraph.addPort method can now be null.
• The ModelManager.unInstall method has been renamed to the canonical name uninstall.
• The singleton returned by the static DefaultEdgePathCropper.INSTANCE property has been moved to the IEdgePathCropper.INSTANCE property. This singleton doesn't implement DefaultEdgePathCropper and similar singletons are defined on their corresponding interface, too.
• The method CanvasComponent.createInputModeContext is protected again, after having been made public accidentally previously.
• The GraphEditorInputMode.requeryHandles method is now public.
• The static methods createDelegate and dynamicInvoke of delegate have been removed. They were never intended to be part of the public API and didn't work as intended in all cases.
• The methods getPreferredSize and getPreferredSizeCore of (String)TemplateNodeStyle, (String)TemplatePortStyle, and the corresponding renderer implementations have been removed since they were never used by the library and returned no meaningful value.
• The methods createNodeMapper and createEdgeMapper of YGraphAdapter are no longer interchanged. Previously, createNodeMapper created an IMapper for keys of type IEdge and vice versa.
• Some methods of the YList class have been replaced to be consistent with the new methods of IList and the corresponding methods of JavaScript arrays. Note that YList is a special-purpose list implementation that is typically only used when implementing a layout customization. In detail, pop has been renamed to shift, popLast has been renamed to pop, and push has been changed to be in line with IList.push: it now returns the length of the list instead of a ListCell.

Changes in Default Behavior

• The GraphOverviewComponent is now rendered with HTML Canvas instead of SVG by default. This results in better performance and was always the intended behavior. You can switch to SVG rendering with the GraphOverviewComponent.renderMode property.
• The NavigationInputMode.adjustContentRect method doesn't fit the graph bounds in the viewport anymore.
• The NavigationInputMode class doesn't fit the content after expand and collapse operations anymore. This behavior can be restored by setting the autoGroupNodeAlignmentPolicy property to a value other than NONE and the fitContentAfterGroupActions property to true.
• The NavigationInputMode.fitContentAfterGroupActions property now is false by default.
• The ViewportLimiter no longer jumps to the limited viewports if the current viewport is outside the limited area. This behavior can be restored by setting the ViewportLimiter.limitingPolicy property to LimitingPolicy.STRICT.
• The default value of the MoveViewportInputMode.pinchZoomThreshold property has been changed from 100 to 50 to prevent pinch gestures from stopping periodically.
• All string template styles now strip executable code from the templates to prevent attacks via GraphML. To re-enable code injection set the new static property trusted on the classes StringTemplateNodeStyle, StringTemplateStripeStyle, StringTemplateLabelStyle, or StringTemplatePortStyle to true.
• The GraphCentrality and ClosenessCentrality analysis algorithms now calculate the centrality individually per component instead of returning a centrality value of 0.0 for nodes in graphs that are not connected.
• HierarchicLayoutData.edgeDirectedness property: If its mapper property is directly accessed (and not explicitly set), its default for unset values is now 1.0 instead of 0.0. This means that such edges are now treated as directed instead of undirected.
• For the rootPlacements, subtreeRoutingPolicies, and subtreeAspectRatio properties of the AspectRatioTreeLayoutData class, the type of the mapped values has been made nullable. For null or unset values, the settings on the AspectRatioTreeLayout will now be taken. This is the documented behavior, though.
• The value of the read-only property EdgeRouter.partition is now null after applying the routing algorithm. It is only intended to be used during the execution. Previously, it was cached, even though the documentation stated otherwise.

Changes When using a Projection

• 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, the CanvasComponent.contentRect property no longer has an effect on scrollbars or the GraphComponent.fitGraphBounds method.
• SvgExport.viewWidth and SvgExport.vViewHeight are no longer used for the exported image dimensions when using a projection. If you need to know the size of the resulting image, this can be obtained from the image after export.
• Visuals that are rendered in view coordinates relative to the viewport may appear in a different location when exporting an image.
• CanvasComponent ignores its ViewportLimiter when projections are used.

Deprecations

• The LabelStyleBase.createLayoutTransform method has a new overload with the render context as the first parameter to take non-identity projections of the corresponding CanvasComponent into consideration. Without this context, this method cannot respect a projection and, consequently, the overload with the previous signature is now deprecated.
• The properties EdgeRouter.polylineRouting, EdgeRouter.preferredPolylineSegmentLength and EdgeRouter.maximumPolylineSegmentRatio are now deprecated. To enable polyline routing, specify EdgeRoutingStyle.octilinear as routing style via EdgeLayoutDescriptor.routingStyle. The other two properties are also replaced by respective properties on the EdgeLayoutDescriptor class.

Demo Changes

• Our simple RequireJS demo implementation is no longer part of the package. The demos now use module loading instead, and we always recommended to use the official RequireJS implementation.

This is the third bugfix release for yFiles for HTML 2.2. In addition to the usual error corrections , there are small improvements for the library and the demos.

There are no incompatible API changes in this release.

This is the second bugfix release for yFiles for HTML 2.2. Besides the usual error corrections for the library, there are small improvements like meaningful error messages for some common programming errors. Moreover, we created several new demos and improved existing demos, added new sections to the Developer's Guide, and improved the documentation viewer.

There are no incompatible API changes in this release, but we document two incompatible changes from previous releases that were un-documented so far.

The GWT overlay was made available for yFiles for HTML 2.2 some weeks ago and will be updated for this and all future bugfix releases of yFiles for HTML 2.2. The yFiles for HTML Optimizer was updated, too. We added the new shouldOptimize setting and fixed a problem that resulted in broken overloads.

This is the first bugfix release for yFiles for HTML 2.2. It corrects several problems in the TypeScript definition files and two other minor errors. There are no incompatible changes.
Note that the bugfixes of yFiles for HTML 2.1.0.7 are part of this release, too.

Bugfixes

• The TypeScript definition files now pass the compiler's strict checks.
• The UMD variants of the TypeScript definition files no longer contain erroneous usages of the this type.
• The constructor of the SolidColorFill class now converts floating-point values to integers. This prevents incorrect values in exported GraphML files.
• There was a regression in mouse click fuzziness detection. As a result, mouse double clicks were sometimes not properly detected in Chrome on Windows and other browsers that fire superfluous mouse move events.

Major New Features

npm package of the library

The yFiles library now comes as a local npm package. This makes it much easier to include yFiles in projects with third-party tools and frameworks like webpack and Angular. In addition to the library, the npm module installs the typings that come with yFiles. Thus, code completion and documentation lookup work in JavaScript IDEs like JetBrains WebStorm and Visual Studio Code without further configuration.

Since the format for the documentation is slightly different for WebStorm and VS Code, a tool is included that tailors the typings for your preferred IDE.

Improved coding assistance and 1000 new code snippets

The typings that provide code completion for JavaScript IDEs like JetBrains WebStorm and Visual Studio Code have been reworked to be more precise and extensive. For example, they now contain the static members of interfaces, support type conversion, and specify whether properties, parameters, and return values can be null or not and whether they must be an object or can be of any type. Of course, TypeScript projects benefit from these improvements, too.

In addition, the documentation viewer has more than 1000 new code snippets and shows the new information, too.

CSS styling for handles etc.

All visualizations of handles and indicators for interactive editing have now CSS classes to allow styling with CSS rules. This includes the selection, focus, and highlight templates, resize and move handles, snap lines and grids, the visualization of port candidates, marquee and lasso selection, and the viewport rectangle in the overview. The documentation and the Developer's Guide contain extensive lists of all available classes.

In addition, the edit label input box and the tooltips now have dedicated CSS classes during entering and leaving of the DOM. Also, a subtle fade animation was added to these elements that is enabled by default.

The new CSS Styling Demo shows this new styling feature.

WebGL and HTML Canvas rendering

WebGL and HTML Canvas rendering are now supported for the visualization of handles and grids, and for the overview component. These rendering techniques provide significant performance improvements especially for large graphs. The rendering technique is specified by the new property renderMode of HandleInputMode, GridVisualCreator, and GraphOverviewComponent, respectively.

Note that WebGL and HTML Canvas rendering for the visualization of graph items like nodes and edges is already supported.

Bus-like placement in hierarchic layouts

The HierarchicLayout class 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 the HierarchicLayoutData.buses property, and the new BusDescriptor class provides more individual settings for the buses.

Label placement, bus routing, and port grouping for EdgeRouter

The EdgeRouter class now features integrated edge label placement. Labels are automatically placed when the new property integratedEdgeLabeling is enabled. The placement considers the optional PreferredPlacementDescriptor of 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 PolylineEdgeRouterData class.

Analysis wrapper

The powerful analysis algorithms got a new API that is based on the IGraph interface 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 GraphStructureAnalyzer class that provides methods to check structural properties of a given graph.

The new Analysis Algorithms Step of the Getting Started Tutorial shows how to run an algorithm. The existing Graph Analysis Demo allows you to interactively explore all the algorithms.

Demos use ES module imports

Using ES modules makes it easier to re-use demo code in your own project since many third-party frameworks and tools work with ES modules, too, most notably webpack and Angular. In addition, the source code is now more concise due to the absence of fully-qualified names and can be better analyzed by IDEs for code completion and documentation lookup.

In addition, we provide several tools that help existing customers in either migrating to ES modules or converting new demo code with ES modules syntax back to the previous require.js and UMD usages.

New and improved demos

This release contains the following new demos:

• Metaball Groups Demo: Shows how to render metaball-like background visualizations where nodes can be associated to zero or more groups.
• Web Worker Demo: There are now two versions of this demo, one with UMD loading and one with import statements.
• d3 Node Style Demo: Presents a node style that visualizes dynamic data with d3.js.
• Family Tree Demo: Show the automatic layout for genealogical graphs.
• Simple Partition Grid Demo: Shows how to manually create a PartitionGrid for the automatic layout.
• Overview Styles Demo: Shows several different rendering techniques and styles for the overview.

The Application Features Tutorial has the following new demos which concentrate on a single feature and make it particularly easy to re-use their code:

• Background Image Demo: Shows two different ways of adding an image to the background of the graph component.
• Graph Search Demo: Shows how to search in the graph and highlight the result.
• Smart Click Navigation Demo: Shows how to scroll and zoom the viewport to the area of interest by single edge-clicks.
• Rectangular Indicator Demo: Shows how to add an interactive indicator to the graph component.
• Level of Detail Style Demo: Shows a node style that hides details when zooming out.
• Filtering Demo: Shows how to configure graph filtering.

The new Layout Data Step of the Getting Started Tutorial shows how to configure individual settings for each node for the automatic layout.

In addition, we refactored several of the demos to make it easier to re-use their yFiles-specific code. These demos include, amongst others, Organization Chart Demo, Hierarchic Grouping Demo, and Sankey Demo.

New Features

General

• The new yFiles for HTML Optimizer replaces the previous deployment tool. It is available as npm package. The optimizer can be seamlessly integrated into JavaScript deployment setups as a webpack plugin or using its JavaScript API.
• Many types now support parameter objects in their constructors and we added several new type conversions for frequently used types like the ones used in LayoutData. This allows you to write more concise code.

View

• The DefaultLabelStyle class 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 CreateEdgeInputMode class can now create edges in reversed direction, i.e., starting from the target port.
  • The new EdgeDirectionPolicy supports starting creation at the source, at the target, in the last direction, or depending on the port candidate.
  • A configurable ToggleDirectionRecognizer allows changing the edge direction during creation.
• The new property MoveLabelInputMode.allowUnselected enables moving labels without having to select them first.
• The MoveInputMode and the CreateEdgeInputMode classes now use Promises in doStartDrag and doStartEdgeCreation. These Promises return either the affected/new items or null if the gesture was canceled.
• The GraphModelManager class has the new methods raise, lower, toFront and toBack that allow changing the z-order of IModelItems. All new z-order-related methods can also be triggered by the new commands RAISE, LOWER, TO_FRONT and TO_BACK.

  In addition, the GraphEditorInputMode class provides the new methods RaiseSelection, LowerSelection, SelectionToFront and SelectionToBack that change the z-order of all selected IModelItems.

• The new PortStyleDecorationInstaller class allows the use of an IPortStyle to render the selection, highlight, or focus indicator of ports.

Layout

• The HierarchicLayout class is now able to uniformly distribute ports at group nodes - with a few restrictions. The new property HierarchicLayoutData.uniformPortAssignmentGroups. defines the groups for which the feature should be enabled.
• The HierarchicLayout class is now able to consider individual crossing costs for edges and for crossing a group node border. These can be defined with the HierarchicLayoutData.edgeCrossingCosts and the HierarchicLayoutData.groupBorderCrossingCosts properties.

  In addition, the new callback method DefaultLayerSequencer.getCrossingCost allows to define an individual crossing cost value for a specific pair of edges when using this sequencer for the HierarchicLayout. In order to easily retrieve the original edge instance when customizing the hierarchic layout, the HierarchicLayout.getOriginalEdge method was added.

• The LeftRightNodePlacer class 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 property BranchCount allows to configure the number of branches.
• The tree node placer GridNodePlacer offers 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 are LEADING, TRAILING and CENTER.
  • Child sub-trees can be assigned to rows automatically using the new property GridNodePlacer.automaticRowAssignment.
  • The new alignment policy GridNodePlacer.BUS_ALIGNED aligns the root node with the bus.
• The OrganicLayout class is now able to consider user-specified inertia and stress values for nodes.
• The OrthogonalLayout class is now able to consider custom crossing and bend costs for edges. They can be specified using the new properties OrthogonalLayoutData.edgeCrossingCosts and OrthogonalLayoutData.edgeBendCosts respectively.
• The new InteractiveOrganicLayout.compactnessFactor property specifies the compactness of the result. If the graph contains several components, this feature can prevent that the components drift apart.
• The new GivenCoordinatesStage class changes node locations and edge paths to user-specified values before invoking the core layout algorithm. To specify locations and paths, use the new GivenCoordinatesStageData class.
• The new GenericPartitionGridSupportStage class offers generic support for partition grid structures.
• The OrganicLayout class is now able to produce 3D layout results.
• The new ChannelRoutingTool class brings back the features of the ChannelRouter class that was removed in version 2.0.

Improvements

General

• We identified and changed the (valid) code in the library that was previously broken by certain build optimizers, e.g., the production build of Angular CLI (ng build --prod). Thus, you no longer need to disable it or work around this issue.
• Incorrect usage of $class before calling lang.util.fixType() on ES6 classes will now throw a TypeInfoError with typeinfo enabled.
• The new function yFiles.help(object) provides information about the given instance if it is a yFiles class, namely the class name, the implemented interfaces, and the base class.
• The constructors of most types now support parameter objects, e.g. the GraphBuilder class, label models, layout algorithms, and layout helper classes.
• Improved performance with the webcomponents polyfill by working around its performance bottlenecks.

Graph and Collections

• The properties rows and columns of class PartitionGrid are now of type IEnumerable<RowDescriptor> and IEnumerable<ColumnDescriptor> instead of an un-typed YList.
• Point, Size, Rect, Insets, and IEnumerable now have a static from function that converts objects that are similar in shape to the corresponding type.
• Each of the methods concat, filter, map, selectMany, takeWhile, and reversed of IEnumerable now return a dynamic enumerable, i.e., if the original enumerable changes the returned enumerable changes, too. Previously, the enumerables returned by map, takeWhile, and reversed were a copy of the state of the original enumerable at the time of invocation.
• In addition, the IEnumerable interface now provides lazily evaluated prepend, append, flatMap, from, ofRange, ofRepeat, take, reduceRight, skip, skipWhile, groupBy, orderBy, orderByDescending, and distinct methods, similar to what other platforms offer.
• The List class now supports the methods push, pop, slice, splice, shift, unshift, and fill as known from plain JavaScript Arrays.

View

• The type conversion for Color now supports the CSS4 syntax.
• Adding and removing visualizations from the GraphComponent is now much faster in Chrome when there are more than 12000 elements.
• If the content of a tooltip changes while it's visible, the new method ToolTip.updateLocation can be called to trigger an update of the location to reflect the changed size.
• The default CSS rule for the tooltip now sets a large value for the z-index. To override it, set a different value to the yfiles-tooltip class.
• The TextRenderSupport.measureText method now returns the result as Size. Previously, it returned a Rect.
• The constructors of CanvasComponent, GraphComponent, and GraphOverviewComponent now throw an error if the specified <div> element is already in use by another component.
• The CanvasComponent class no longer prevents external drag and drop handling by calling stopPropagation and preventDefault on all drop events. Instead, such an event is now handled by a corresponding (drop) input mode if such an input mode is enabled and responsible for the event's data type.
• The new property SvgDefsManager.cleanUpDuration sets a soft limit for the runtime of the SvgDefsManager.cleanUpDefs method.
• A component with zero size now updates its internal size automatically if its container <div> element gets a non-zero size. This can happen for example if the <div> element is not part of the DOM during initialization.
• GraphOverviewComponent no longer draws nodes and edges that are hidden via VoidNodeStyle and VoidEdgeStyle.
• NodeStylePortStyleAdapter and PortControlPortStyle now have an offset property that allows to shift the port visualization so that it no longer is centered over the port.
• The GraphModelManager class has new factory methods for creating the ItemModelManager of each item group.
• DefaultEdgePathCropper's methods cropEdgePath and cropEdgePathAtArrow have been made virtual.
• The GraphModelManager.getModelItem method now always returns the IModelItem for an ICanvasObject retrieved for it via getMainCanvasObject. Previously this only worked in all cases for the ICanvasObject retrieved via getCanvasObject.
• Added the GraphClipboard.getId method to facilitate retrieving the original item from which an item to be pasted has been copied from.
• The new property GraphClipboard.clipboardContext provides access to the current IGraphClipboardContext during a clipboard operation.
• The GraphMLIOHandler class now supports reading and writing arbitrary objects at graph level.
• The properties RectangleIndicatorInstaller.template and OrientedRectangleIndicatorInstaller.template now return always the value that has been set by client code and are not modified by internal code anymore.
• The type conversion of DashStyle now supports the constant names of DashStyle, like real enums do.
• The type conversion of Stroke can now create dashed and dotted lines similar to CSS border.
• The CanvasComponent.exportContent method now always returns an <svg> element with proper size declaration that can be embedded into a document.

Input

• In Microsoft browsers, the selection gesture is now much faster if selecting many items at once.
• New overloads for the KeyboardInputMode.addKeyBinding and addRecognizerBinding methods make it easy to register key bindings and key recognizer listeners.
• The new property CreateEdgeInputMode.showTargetHighlight specifies whether to enable or disable highlighting of potential targets for edge creation. Also, the method updateTargetHighlight has been added to allow for further customization of the highlight.
• The new properties PortRelocationHandler.showTargetHighlight and PortRelocationHandlerProvider.showTargetHighlight specify whether to enable or disable highlighting of potential targets for edge creation. Also, the method updateHighlight has been added to the PortRelocationHandler class to allow for further customization of the highlight.
• The new properties PortRelocationHandler.showPortCandidates and PortRelocationHandlerProvider.showPortCandidates specify whether to enable or disable showing port candidates during edge relocation.
• The GraphEditorInputMode.DeletedItem event 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.onDeletedItem is now virtual.
• Mouse move and drag events now correctly report the changed modifier keys.
• Snaplines are now infinitely long by default.
• The classes NodeDropInputMode, LabelDropInputMode, PortDropInputMode, and StripeDropInputMode now also support the simple type name as expected type. This type is set by user code on drag start.
• The properties GraphInputMode.clickHitTestOrder and GraphInputMode.doubleClickHitTestOrder which are of type GraphItemTypes[] now support type conversion and can be specified as arrays of strings. Each of the string values is converted to GraphItemTypes with the existing type conversion of that enum.
• The drag and drop behavior when multiple input devices are used simultaneously has improved.

Graph-Layout-Bridge

• Combining multiple LayoutData classes is now easier:
  • The base class LayoutData offers a new method combineWith that combines the current instance with another LayoutData instance.
  • The class CompositeLayoutData has an additional constructor that takes a variable number of LayoutData instances.
• The classes ItemMapping, ContextItemMapping, IncrementalHintsItemMapping, ItemCollection, DpKeyItemCollection and SingleItem now support type conversion which makes it easier to configure layout data.
• The new PortAdjustmentPolicy property of LayoutExecutor and LayoutGraphAdapter replaces the previous ImprovePortAssignment boolean property. The new property is of type PortAdjustmentPolicy and offers more options for adjusting the port locations after a layout calculation.
• The viewport animation of the LayoutExecutor class considers now the value of the LimitFitContentZoom property of the corresponding GraphComponent.

Hierarchic Layout

• The HierarchicLayout class now also considers critical edge priorities for grouped edges.
• The HierarchicLayout class now also considers sequence constraints for grouped edges.
• The HierarchicLayout class now uses the specified layer alignment to align sub-components (see HierarchicLayoutData.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 property HierarchicLayoutData.groupBorderCrossingCosts).
• The HierarchicLayout class no longer inserts superfluous bends for edges between group nodes if the input graph contains grouped edges.
• The layering of HierarchicLayout was improved with respect to the resulting edge lengths if the recursive group layering feature is enabled.
• The HierarchicLayout class now produces less overlapping elements for graphs with fixed coordinate hints.
• The HierarchicLayout class now correctly calculates the group node bounds. Previously, the groups' insets were slightly too large (up to one pixel).
• The HierarchicLayout class 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 HierarchicLayout class now requires less memory for graphs with sequence constraints.

Edge Routing

• The EdgeRouter now supports edge grouping on both endpoints. Previously, an edge could only be part of either a source or a target group.
• The EdgeRouter class now generates less edge-edge overlaps and a better distribution of edge segments when the EdgeRouter.maximumDuration is strongly restricted or set to zero, or when the algorithm is stopped via the AbortHandler.stop method.
• The EdgeRouter class now avoids superfluous bends that were in some cases caused by group nodes with (small) inset values.
• The path search performance of the EdgeRouter class has been improved for cases where an edge has a strong, external PortConstraint or a fixed, external PortCandidate.
• The EdgeRouter class now generates a proper routing from a group node border to a port location inside this group node defined by a strong PortConstraint or a fixed PortCandidate. 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, and targetPortCandidates of ChannelEdgeRouterData facilitate using these features with ChannelEdgeRouter.

Labeling

• The performance of the GenericLabeling algorithm and the quality of the label placements were improved.
• The quality of edge label placement of the GenericLabeling class 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.preferParallelRoutes property allows for controlling how parallel edges (multi-edges) are routed.
• New options of the PlaceNodeAtBarycenterStage class 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 TreeReductionStage now marks non-tree edges if an IDataAcceptor is registered with the input graph with key TreeReductionStage.nonTreeEdgeSelectionKey. This way a user is able to query which edges the algorithm determined to be the non-tree edges.
• The RecursiveGroupLayout class now allows to define a local PartitionGrid structure for each recursively handled group node. See the new property RecursiveGroupLayoutData.groupNodePartitionGrids for details.
• If the master edge is clipped on the bounds of its source or target, the ParallelEdgeRouter class now always clips the associated parallel edges on that bounds, too.
• The RemoveCollinearBendsStage.scale property 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 PartitionGridData class has new properties optimizeRowOrder and optimizeColumnOrder to indicate whether or not the order of the rows respectively columns should be chosen automatically to minimize edge lengths.

  In addition, the rowIndices and columnIndices properties of the PartitionGridData class can now also be used in combination with the grid property.

• The PortCalculator class now considers edge label positions such they are not affected by whether this stage is applied or not (see property LayoutExecutor.portAdjustmentPolicy). Previously, label positions could be changed if the label position was stored relative to the first or last segment or the port.

Bugfixes

Graph

• 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 UndoEngine class that resulted in memory leaks if the tokens returned by getToken were not disposed when the UndoEngine got cleared.

View

• Tooltips can now correctly flow out of the area of the graph component.
• The TextRenderSupport.addText method now takes into account existing x attribute values of the text element and places the text relatively to this value.
• The EdgeStyleDecorationInstaller class no longer causes an error when used on edges that attach to other edges.
• A template style with an unresolved template now creates a visual with an empty SVG <g> element instead of null. This avoids seemingly unrelated errors later on.
• Fixed a memory leak and possible UI freezes that could occur in certain circumstances when using template styles.
• If the SvgExport.shouldEncodeImageBase64 property is enabled, images that use data URIs and are not already encoded are now Base64 encoded during export as well.
• Parsing a GraphML file with a folding edge state with a label without a preferred size no longer throws an error.
• In rare cases, saving a graph that uses folding to GraphML threw an error.
• Newline and tab characters in GraphML attribute values were written as-is, but replaced with whitespaces when reading the GraphML back in. These characters are now written as character entity references and correctly restored.
• The null check for the GridVisualCreator.stroke property works correctly now.
• Setting an ICanvasObjectGroup to invisible now clears all containing visuals. As a consequence, child visuals are correctly initialized when the group is set to visible again.
• A grid with crosses using a stroke with a large thickness is now rendered correctly.
• It is now possible to change only the color of a grid after the grid was initialized.

Input

• The speed of pinch zooming on certain trackpads is no longer way to fast.
• 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 promises returned by the label editing methods in GraphEditorInputMode now provide null when canceled instead of the dummy label.
• The parentInputMode property of the context of the InputModeEventArgs class now contains the input mode which has raised the event. Previously, some input modes erroneously set this property to the containing GraphEditorInputMode or GraphViewerInputMode.
• The type IGridConstraintProvider cannot be used in lookup methods since it has a generic type parameter. Therefore, new specific interfaces have been added for each item type (for example INodeGridConstraintProvider).
• The CreateEdgeInputMode class now considers the value of the CanvasComponent.hitTestRadius property when its startOverCandidateOnly property is enabled.
• GraphClipboard's methods onElementCut and onElementCopied are no longer called for graph items which are not copied themselves but are owners of copied items.
• When an edge is duplicated using GraphClipboard and 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 CreateEdgeInputMode class does not flicker, anymore.
• The classes MarqueeSelectionInputMode and OverviewInputMode now install new visual templates correctly when they are set through the corresponding template property.

Hierarchic Layout

• The HierarchicLayout class now correctly considers the group insets for input graphs with nested group nodes. Previously, it sometimes produced too large insets for inner groups.
• The HierarchicLayout class no longer throws an error if it is wrapped by an instance of RecursiveGroupLayout and the input graph contains layering constraints between elements of different groups.
• The HierarchicLayout class no longer throws an ArgumentError for some rare cases in incremental layout mode.
• The HierarchicLayout class 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 (see EdgeLayoutDescriptor.directGroupContentEdgeRouting).
• Self-loop segments generated by the HierarchicLayout class 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 HierarchicLayout class now produces less superfluous crossings if there are same-layer edges with PortConstraints or PortCandidates.
• The HierarchicLayout class now correctly handles port labels with zero height or width. Previously, such labels may have caused very large distances between some nodes.
• The HierarchicLayout class sometimes threw an ArgumentError for input graphs that contained incremental elements in combination with groups.
• The HierarchicLayout class 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 HierarchicLayout class no longer causes non-orthogonal segments when the input contained port labels in conjunction with edge grouping.
• The HierarchicLayout class sometimes threw an ArgumentError for input graphs that contained fixed elements in combination with both swimlanes and groups.
• The HierarchicLayout class now correctly considers fixed nodes with layering constraints. In previous versions there were some rare cases where such inputs caused infinite looping issues.
• The HierarchicLayout class no longer produces intersections between edges and elements of a sub-component (see HierarchicLayoutData.subComponents). Note that this fix may sometimes cause less compact results within a layer.

Tree Layout

• The CompactNodePlacer class no longer throws an error for input graphs with specified memento strategies (see TreeLayoutData.compactNodePlacerStrategyMementos or CompactNodePlacer.STRATEGY_MEMENTO_DP_KEY).
• The CompactNodePlacer class now correctly considers the specified values of the verticalDistance and horizontalDistance properties.
• The CompactNodePlacer class no longer throws an error for some inputs with specified strategy memento information.
• The SimpleNodePlacer class no longer produces unnecessarily long horizontal edge segments.

Edge Routing

• The EdgeRouter class 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 EdgeRouter class that sometimes caused a non-deterministic behavior.
• The EdgeRouter class now correctly handles edges with external ports. Previously, such inputs may have caused an error.
• The EdgeRouter class now correctly groups edges associated with equal group IDs that have a different object ID.
• A rare error that was triggered by the EdgeRouter class during routing when a grid is defined on which edges need to be routed is now fixed.
• The EdgeRouter class now avoids unnecessary bends in cases that contain PortCandidates with fixed offsets (or strong PortConstraints) 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 PolylineLayoutStage class 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 EdgeRouter class during routing in cases where the input contained grouped edges.
• The EdgeRouter class no longer throws an error if the EdgeRouter.polylineRouting property is enabled and the input contains fixed, grouped edges.
• The EdgeRouter class now considers the correct NodeHalo associated 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 EdgeRouter class now correctly considers intersections between edges and labels of fixed edges if property considerEdgeLabels is enabled.
• The EdgeRouter class 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 EdgeRouter class 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 EdgeRouter class no longer considers all PortCandidates with multiple directions as fixed PortCandidates.
• Fixed two issues that induced the violation of a PortCandidate with fixed offsets (or a strong PortConstraint) by the EdgeRouter class. 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 EdgeRouter class for cases where a large number of fixed and overlapping edge segments exist. Previously, the search could become very slow in such scenarios.
• The EdgeRouter class now correctly handles cases where the maximum duration is exceeded and where previously an error was triggered.
• Fixed a StackOverflowError in EdgeRouter.

Labeling

• The GenericLabeling class now produces better results for edge labels that have a preferred distance to the edge (PreferredPlacementDescriptor.distanceToEdge) and at the same time multiple sideOfEdge preferences (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 GenericLabeling class 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 GenericLabeling class no longer calculates wrong label profit values for some edge labels. Previously, edges that had a PreferredPlacementDescriptor were sometimes affected.
• The GenericLabeling class now always prefers LabelCandidates with higher profit values over others with lower profit. Previously, this sometimes happened even though both candidates did not intersect with other elements.
• The GenericLabeling class no longer assumes that all LabelCandidates associated 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 GenericLabeling that may have caused an ArgumentError for some input graphs that contain edges with zero length segments and labels associated with a free edge label model.

Other Layout Styles

• The OrthogonalLayout class no longer throws an error when property OrthogonalLayout.uniformPortAssignment is enabled and the input contains parallel edges.
• The OrthogonalLayout class no longer causes an error for some input graphs when property faceMaximization is enabled.
• The OrthogonalLayout class 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 property OrthogonalLayout.treeStyle is not set to TreeLayoutStyle.NONE.
• The OrganicLayout class no longer throws an error when using CycleSubstructureStyle.CIRCULAR and arranging a cycle structure where at least one cycle node is also connected to a group node outside the cycle.
• The OrganicLayout class now produces deterministic results for group nodes if its property deterministic is enabled.
• When using RecursiveGroupLayout, the values of the properties computedWidth, computedHeight and computedPosition of the classes ColumnDescriptor and RowDescriptor are now correctly set after the layout if EdgeRouter is the corresponding interEdgeRouter.
• The ComponentLayout class now correctly handles input graphs with user-specified components that contain nodes with null as their component ID (see property ComponentLayoutData.componentIds). Previously, such inputs may have caused an error.
• The SeriesParallelLayout class now correctly handles input graphs with groups that only contain disconnected nodes. Previously, such inputs caused an error.
• The PartialLayout class now correctly considers the specified PortCandidates during orthogonal or octilinear routing of edges.
• The PartialLayout class does no longer reduce the size of fixed group nodes if the option PartialLayout.resizeFixedGroups is disabled.
• The OrganicRemoveOverlapsStage no longer produces infinite loops in some rare cases.
• Fixed a bug in YGraphAdapter that could trigger an error when boolean, integer or double values were requested from registered IMapper but no value had been set beforehand.
• The GraphStructureAnalyzer.hasMultipleEdges method now returns the correct result for input graphs with self-loops.
• The PathAlgorithm.findAllChains method now correctly calculates the chains for input graphs with cycles.
• The BfsAlgorithm.getLayers method now correctly stores the layer indices in the specified INodeMap. Previously, the maximum layer index stored in the map exceeded the number of returned layers.

Incompatible Changes

See the Migration Guide document (of your local yFiles for HTML installation) for more details and advice on migrating.

Incompatible API Changes

• In the ECMAScript module variant of the library, the names of some types have been changed to make it more clear to which layout style they belong. The new names include a 'Layout' part, for example HierarchicLayeringStrategy is now HierarchicLayoutLayeringStrategy.

  In addition, the existing analysis algorithm classes got a Algorithm postfix since the canonical short names are now used by the new IGraph-based analysis classes and YMap has been renamed to HashMap. See the migration guide for a complete list of these changes.

• The IEnumerable.selectMany method has been renamed to IEnumerable.flatMap.
• The GraphOverviewComponent.svgRendering property has been removed in favor of the new GraphOverviewComponent.renderMode property.
• The IGraph.portLabels property replaces the getPortLabels method. The similar API members for other item types already are properties.
• The methods ITable.getDecorator and ITable.getAccumulativeInsets have been replaced by the corresponding properties ITable.decorator and ITable.accumulativeInsets.
• The resource keys of the SnapLine class have been removed. They are replaced by the new SnapLineVisualizationType enum.
• The TextRenderSupport.measureText method now supports the parameters maximumSize and textWrapping to measure the size of wrapped text. The method parameter order was changed to fit the TextRenderSupport.addText method.

  In addition, the TextRenderSupport.measureText method now returns the result as Size. Previously, it returned a Rect.

• The MouseHoverInputMode.toolTip property was removed to support separate fade out animations for tooltips. To specify a tooltip overwrite the MouseHoverInputMode.createToolTip method instead.

  In addition, some properties of the ToolTip class have been made read-only because changes to these properties had no effect anyway.

• The improvePortAssignment boolean property of LayoutExecutor and LayoutGraphAdapter has been replaced by the portAdjustmentPolicy property.
• SingleItemCollection's item property has been pulled up to ItemCollection. Class SingleItemCollection has been removed, its usages have been replaced by ItemCollection.
• The following properties of specific layout data types now have a name with the correct plural or singular usage.
  • HierarchicLayoutData.alternativeEdgePath has been renamed to alternativeEdgePaths.
  • TreeLayoutData.leftRightPlacersLeftNodes has been renamed to leftRightNodePlacerLeftNodes.
  • TreeLayoutData.delegatingNodePlacersPrimaryNodes has been renamed to delegatingNodePlacerPrimaryNodes.
  • FixNodeLayoutData.fixedNode has been renamed to fixedNodes.
• The type of the properties BalloonLayoutData.treeRoot and TreeLayoutData.treeRoot has been changed to SingleItem<INode>.
• The property HierarchicLayoutData.alternativeEdgePaths now expects IEnumerable<IPoint> instead of YPointPath as mapped values.
• The property HierarchicLayoutData.alternativeGroupBounds now expects IRectangle instead of YRectangle as mapped values.
• The properties rows and columns of class PartitionGrid are now of type IEnumerable<RowDescriptor> and IEnumerable<ColumnDescriptor> instead of an un-typed YList.
• The properties sourceGroups and targetGroups of RadialLayoutData have been removed since edge grouping is not supported by the RadialLayout class.
• The PenaltySettings.invalidEdgeGroupingPenalty property has been removed. If edge groups are defined, the EdgeRouter class now always considers them. Therefore, this setting no longer applies.
• Implementing yFiles interfaces in TypeScript now requires to specify the intersection type of all implemented interfaces. See the Developer's Guide for an example.
• The BfsDirection enum has been renamed to TraversalDirection since it is now used for other graph traversal algorithms, too.

Changes of Default Behavior

• The SimplexNodePlacer.barycenterMode property is now enabled by default. Thus, the HierarchicLayout class with default settings now produces different (usually more symmetric) layouts.
• The CanvasComponent class no longer calls preventDefault on all 'drop' events. Instead, this is now called only for events for which an enabled and responsible (drop) input mode exists.
• The methods map, takeWhile, and reversed of IEnumerable now return a dynamic enumerable, i.e., if the original enumerable changes, the returned enumerable changes, too. Use the toArray or toList method if you want to store the current state of an enumerable.
• GraphClipboard's methods onElementCut and onElementCopied are no longer called for graph items which are not copied themselves but are owners of copied items. As a consequence, the methods cut and copy of the IClipboardHelper implementations of these elements are no longer called, either.
• The Promise returned from the GraphEditorInputMode.editLabel method now resolves with null if the edit was canceled or did not validate successfully.
• The default tooltip of the ToolTipQueryEventArgs class is now set to null. Thus, the tooltip is not displayed when the event is handled without setting the tooltip content.
• The properties RectangleIndicatorInstaller.template and OrientedRectangleIndicatorInstaller.template now return always the value that has been set by client code and are not modified by internal code anymore.
• Newline and tab characters in GraphML attribute values are now written as character entity references instead of writing actual newline or tab characters.
• The SvgExport.shouldEncodeImageBase64 method is now only called for images that are not already Base64 encoded.
• The GroupingSupport class no longer throws an ArgumentError if there is a node without associated ID. Instead the class uses the node itself as ID.
• The HierarchicLayout class now uses a higher crossing cost for group node borders. To specify custom values, use the property HierarchicLayoutData.groupBorderCrossingCosts.
• If the master edge is clipped on the bounds of its source or target, the ParallelEdgeRouter class now always clips the associated parallel edges on that bounds, too.
• The default value of the property GridNodePlacer.rootAlignment was changed to GridNodePlacer.BUS_ALIGNED from RotatableNodePlacerBase.RootAlignment.TRAILING.

Minor Incompatible Changes

• The TypeScript .d.ts file doesn't contain typings that allow quick interface implementations anymore. Quick interface implementations still work at runtime though.
• The CanvasComponent.exportContent method now always returns an <svg> element instead of either an SVG group <g> element for SVG-only rendering and a <div> element with <canvas> and <svg> children otherwise.
• The method LayoutData.apply is now protected instead of public.
• The YList.subList method was removed since it was not implemented at all and is not used by the library.
• The clone methods of the geometric types Point, Rect, Size, and Insets was removed since these types are immutable and the methods just returned this.
• The classes GeneralPath and GeneralPathCursor are now sealed.
• The protected DefaultLabelStyleRenderer.measureText method got an additional parameter for the maximum size.
• The following changes regarding the expert API related to the EdgeRouter class were made:
  • The first parameter of the constructors in class SegmentInfoBase is now of type object instead of Edge. The provided type should be either PathRequest for affected edges or Edge for non-affected, fixed ones. Furthermore, the property SegmentInfoBase.edge has been removed as the info is not necessarily associated with an edge anymore.
  • Similarly, the first parameter of the constructor in class EdgeCellInfo is now of type Object instead of Edge. The provided type should be either PathRequest for affected edges or Edge for non-affected, fixed ones.
  • The constructor of class EdgeInfo now additionally takes a parameter of type Edge.
  • The parameter of type Edge from the constructor of Path as well as the respective property were removed. A path is now not necessarily associated with an edge but only with the newly introduced PathRequest.
  • The method PathSearchResult.getEdgeInfo was removed.

This is the 7th bugfix release for yFiles for HTML 2.1. It corrects several errors. There are no incompatible API changes.
Note that the bugfixes of this release are part of yFiles for HTML 2.2.0.1, too.

Bugfixes

Graph and View

• Improved code paths in the implementations of the IGraph interface that sometimes led to a runtime that was quadratic in the number of nodes when creating large graphs.
• The EdgeStyleDecorationInstaller class no longer causes an exception when used on edges that attach to other edges.
• The EdgeStyleDecorationInstaller class now properly displays decorations for edges between group nodes and their descendants when displayed in view coordinates.
• A template style with an unresolved template now creates a visual with an empty SVG <g> element instead of null. This avoids seemingly unrelated exceptions later on.
• If the SvgExport.encodeImageBase64 property is enabled, images that use data URIs and are not already encoded are now Base64 encoded during export as well.
• The TextRenderSupport.addText method now takes into account existing x attribute values of the text element and places the text relatively to this value.
• Fixed a but that rendered labels or ports neither in a separate layer nor at their owner when exactly one of LabelLayerPolicy.AT_OWNER or PortLayerPolicy.AT_OWNER was used.
• Fixed an exception which could occur in the CanvasComponent.compareRenderOrder method and in the function set to the GraphModelManager.comparer property.
• The GridVisualCreator.stroke is now correctly checked for null.

Input

• The speed of pinch zooming on certain trackpads is no longer way to fast.
• Reparenting an expanded group node into a collapsed group node no longer throws an exception.
• 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 AutoGroupNodeAlignmentPolicy values CENTER_LEFT, CENTER_RIGHT, TOP_CENTER, BOTTOM_CENTER, and BOTTOM_LEFT now work correctly.
• Fixed a memory leak in the UndoEngine class if the tokens returned by the getToken method were not disposed when the UndoEngine got cleared.
• In very rare cases, the undo/redo processing of several consecutive reparent actions threw an exception.
• The visualization of source port candidates by the CreateEdgeInputMode class does not flicker, anymore.
• The CollapsibleNodeStyleDecorator.isHit method now respects buttons that are located outside of the node bounds.
• The classes MarqueeSelectionInputMode and OverviewInputMode now install new visual templates correctly when they are set through the corresponding template property.
• The promises returned by the label editing methods in GraphEditorInputMode and TableEditorInputMode now fulfill with null instead of the temporary label if the editing was canceled or the text did not validate. This was already the documented behavior.

GraphML

• Labels at folder nodes and their adjacent edges are no longer lost during GraphML deserialization if the DefaultFolderNodeConverter.copyFirstLabel property is enabled.
• Parsing a GraphML file with a folding edge state with a label without a preferred size no longer throws an exception.
• In rare cases, saving a graph with folding to GraphML threw an exception.

Hierarchic Layout

• The HierarchicLayout class now correctly calculates the group node bounds. Previously, the groups' insets were slightly too large (up to one pixel).
• The HierarchicLayout class no longer throws an exception if it is wrapped by an instance of RecursiveGroupLayout and the input graph contains layering constraints between elements of different groups.
• The HierarchicLayout class now correctly considers the group insets for input graphs with nested group nodes. Previously, it sometimes produced too large insets for inner groups.
• The HierarchicLayout class no longer throws an exception for some rare cases in incremental layout mode.
• Self-loop segments generated by the HierarchicLayout class 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.

Edge Router

• The EdgeRouter class now correctly groups edges associated with equal group IDs that have a different object ID.
• A rare exception that was triggered by the EdgeRouter class during routing when a grid is defined on which edges need to be routed is now fixed.
• The EdgeRouter class now avoids unnecessary bends in cases that contain PortCandidates with fixed offsets (or strong PortConstraints) 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 EdgeRouter class now correctly handles edges with external ports. Previously, such inputs may have caused an exception.
• The EdgeRouter class 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 EdgeRouter class that sometimes caused a non-deterministic behavior.
• The EdgeRouter class no longer throws an exception during the routing of some graphs with grouped edges.
• Fixed two issues in the EdgeRouter class that resulted in the violation of a PortCandidate with fixed offsets or a strong PortConstraint. 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 EdgeRouter class no longer throws an exception if its polylineRouting property is enabled and the input contains fixed, grouped edges.
• The EdgeRouter class now considers the correct NodeHalo associated 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 EdgeRouter class now correctly considers intersections between edges and labels of fixed edges if its property considerEdgeLabels is enabled.
• The EdgeRouter class 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 EdgeRouter class 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 EdgeRouter class no longer considers all PortCandidates with multiple directions as fixed PortCandidates.

Label Placement

• The performance of the GenericLabeling algorithm and the quality of the label placements were improved.
• The GenericLabeling class no longer throws an exception for some input graphs containing labeled edges with zero length.
• The GenericLabeling class 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 GenericLabeling class no longer calculates wrong label profit values for some edge labels. Previously, edges that had a PreferredPlacementDescriptor were sometimes affected.
• The GenericLabeling class now produces valid results for edge labels that have a preferred distance to the edge and at the same time multiple sideOfEdge preferences (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.

Other Layouts

• The Paths.findAllChains method now correctly calculates the chains of input graphs with cycles.
• Fixed a potential exception in the LayoutExecutor class which could occur during a layout of a graph with table nodes which are not group nodes.
• The OrganicLayout class 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 an exception.
• The OrganicLayout class no longer throws an exception when using CycleSubstructureStyle.CIRCULAR and arranging a cycle structure where at least one cycle node is also connected to a group node outside the cycle.
• The OrthogonalLayout class no longer causes an exception for some input graphs when its faceMaximization property is enabled.
• The OrthogonalLayout class no longer runs into an infinite loop for some input graphs that are tree structures with mixed edge directedness (see the OrthogonalLayout.edgeDirectednessDpKey property). Note that the problem only occurred if the OrthogonalLayout.treeStyle property is not set to TreeLayoutStyle.NONE.
• The OrthogonalLayout class no longer throws an exception when its uniformPortAssignment property is enabled and the input contains parallel edges.
• The CompactNodePlacer class no longer throws an exception for input graphs with specified memento strategies (see TreeLayoutData.compactNodePlacerStrategyMementos.
• The SimpleNodePlacer class no longer produces very long horizontal edge segments for inputs where they aren't required.
• The PolylineLayoutStage does no longer generate overlaps between sloped, polyline segments created by the stage and unrelated other obstacles (e.g. nodes).
• The PartialLayout class now correctly considers the specified PortCandidates during orthogonal or octilinear routing of edges.
• The SeriesParallelLayout class now correctly handles input graphs with groups that only contain disconnected nodes. Previously, such inputs caused an exception.

Minor Behavior Change

• The SvgExport.shouldEncodeImageBase64 method is now only called for images that are not already Base64 encoded. This method is only meant to specify whether images that are not already Base64 encoded should be encoded for the export. SvgExport doesn't (and didn't) change images that are already Base64 encoded.

This is the 6th bugfix release for yFiles for HTML 2.1. It corrects several errors and brings some improvements. There are no incompatible changes.

Improvements

• By default, the Backspace key now deletes the selected elements, as the Delete key does. This is especially useful on MacBooks since their 'Delete' key is Backspace. Previously, the Backspace key had no default command.
• Added the FixPortLocationStageData class that allows to conveniently define the port constraints that are considered by the FixPortLocationStage class.
• The new properties OrganicLayoutData.sourceGroupIds and OrganicLayoutData.targetGroupIds can be used to specify edge grouping.

Bugfixes

View

• Exporting with the SvgExport class silently failed without exporting anything if the text of a label contained emojis or some other unusual Unicode characters.
• 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 the CanvasControl.animateScrollCommands property enabled no longer changes the zoom level.
• The labels of dragged ports were not displayed correctly by the PortDropInputMode class.
• The EdgeStyleDecorationsInstaller class now properly displays decorations for edges between group nodes and their descendants when displayed in view coordinates.
• The IAnimation.createSequentialAnimation method no longer throws a TypeError due to 'Object.binarySearch is not a function'.

Layout

• The HierarchicLayout class now correctly handles port labels with zero height/width. Previously, such labels may have caused very large distances between some nodes.
• The HierarchicLayout class sometimes threw an exception for input graphs that contained incremental elements in combination with groups.
• The HierarchicLayout class now prevents intersections between labels and the horizontal grid lines of a PartitionGrid.
• The HierarchicLayout class now properly handles input graphs with source/target port labels and where a subset of nodes has NodeHalos. Previously, such inputs could cause an exception.
• The HierarchicLayout class does no longer violate fixed PortCandidates in cases where also critical edges (HierarchicLayoutData.criticalEdgePriorities) and edges connecting to group nodes are given.
• The HierarchicLayout class now produces less superfluous crossings if there are same-layer edges with PortConstraints or PortCandidates.
• The HierarchicLayout class no longer produces non-orthogonal segments if the graph has port labels and the edge grouping feature is enabled.
• The HierarchicLayout class 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 the HierarchicLayout.nodeToEdgeDistance property.
• The HierarchicLayout class 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 EdgeRouter class no longer throws an exception for some inputs containing edges with intermediate routing points.
• The EdgeRouter class now correctly handles cases where the maximum duration is exceeded and where previously an exception was triggered.
• Improved the path search performance of the EdgeRouter class 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 stack overflow error in EdgeRouter.
• When using RecursiveGroupLayout, the values of the properties computedWidth, computedHeight and computedPosition of the classes ColumnDescriptor and RowDescriptor are now correctly set after the layout if EdgeRouter is the corresponding InterEdgeRouter.
• The ComponentLayout class now correctly handles input graphs with user-specified components that contain nodes with null as their component ID (see property ComponentLayoutData.componentIds). Previously, such inputs may have caused an exception.
• The CompactNodePlacer class now correctly considers the specified values for the verticalDistance and horizontalDistance properties.
• The CompactNodePlacer class now correctly handles inputs where the tree root is marked as assistant node, see TreeLayoutData.assistantNodes.
• The CompactNodePlacer class now correctly handles input graphs that contain assistant nodes and given placement strategies (see the TreeLayoutData.compactNodePlacerStrategyMementos property).
• The CompactNodePlacer class now produces more compact results for some cases where it previously generated larger, less compact results.
• The CompactNodePlacer class no longer throws an exception for some inputs with specified strategy memento information.
• The OrthogonalLayout does no longer throw an exception if a graph is almost a tree and its treeStyle property is set to TreeLayoutStyle.INTEGRATED and a fixed TreeOrientation is set.
• The OrganicLayout class now produces deterministic results for group nodes if the property deterministic is enabled.
• The OrganicRemoveOverlapsStage class no longer gets stuck in an infinite loop in some rare cases.

This is the 5th bugfix release for yFiles for HTML 2.1. It corrects just one issue that prevented backwards compatibility with old browsers.

Bugfixes

• A deployment issue caused the "lang" library module to contain a 'const' declaration. This declaration has now been replaced by a 'var' declaration, so the modules are fully ECMAScript 5 compatible again.

This is the 4th bugfix release for yFiles for HTML 2.1. It corrects several errors and comes with some improvements of the library and the demos. There is one minor incompatible change.

Improvements

• Some code optimizers break the library code, most prominently the build optimizer of Angular CLI, Rollup when 'tree shaking' is enabled, and Uglify when the 'pure_getters' setting is enabled. We now check whether the code has been wrecked and show a corresponding warning in the console. For more details, see the Known Issues document (of your local yFiles for HTML installation) and the corresponding angular-cli issue.
• The LayoutExecutor now automatically enables and disables a wait input mode for the GraphComponent during layout and subsequent animation. This can be turned off with the new allowUserInteraction property.
• Input modes no longer run unnecessary hit tests when they are canceled.

Bugfixes

• ES6 library modules that are packed with webpack no longer contain 'const' variables.
• The deployment tool did not rename references to obfuscated types in some cases when using the simple names exported from the yFiles ES6 modules.

View and Input

• GraphModelManager: Fixed an error that occurred when any of the descriptor properties were set while the GraphModelManager instance was not yet associated with an IGraph.
• Fixed a possible infinite loop in the OrthogonalEdgeHelper class.
• The cursor is now correctly reset after editing an orthogonal edge.
• Fixed a possible error which could occur in customized LabelDropInputMode and PortDropInputMode classes.
• The drop input modes now make sure not to throw "Invalid Argument" errors in Internet Explorer.
• The PortRelocationHandle.GHOST_VISUALIZATION_STROKE_KEY constant was not excluded from obfuscation.
• The graph parameter of the constructor of the PortRelocationHandleProvider class can now be null. This was already the documented behavior.
• Mouse wheel scrolling and scroll commands no longer move the view to the top left corner if the viewport is limited by a ViewportLimiter.
• The bounds and the visibility state of the ICanvasObject installed by the RectangleIndicatorInstaller class were wrong. This impacted the performance as e.g. some node selection highlights were updated although they were not in the viewport and resulted in unnecessary large content rectangles.
• The IHitTestable implementation of the DefaultPortCandidateDescriptor class used incorrect coordinates.
• Changing the MouseHoverInputMode.duration property had no effect.
• The ItemHoverInputMode class now updates the hovered item upon mouse drag events, too. This was already the documented behavior. Previously, the hovered item was only updated on mouse move events.
• The ItemHoverInputMode class now removes the hovered item upon Cancel.
• The CreateEdgeInputMode class doesn't show port candidates anymore if bend creation is enforced (by pressing CTRL key during edge creation).
• Key bindings registered with KeyboardInputMode were gone after re-installation of the mode.
• The INodeInsetsProvider implementations which can be retrieved from InteriorLabelModel and InteriorStretchLabelModel now correctly sum up the space required by overlapping labels.
• Bridges sometimes did not appear on edges when they were scrolled into the viewport.
• The overview did not render self-loops whose ports were owned by another edge correctly.
• 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 a possible TypeError in TableNodeStyleRenderer when a TableNodeStyle is rendered with the table property set to null.
• The GraphBuilder.updateGraph method properly builds the graph now even if buildGraph was not called before.

Layout

• The HierarchicLayout class placed source and target edge labels at the wrong location when integrated edge labeling was enabled and if there were either critical edges or the property SimplexNodePlacer.straightenEdges was enabled.
• The HierarchicLayout class sometimes threw an error for input graphs that contained fixed elements in combination with both swimlanes and groups.
• HierarchicLayout is no longer stuck in an endless loop if a sub-component with a nested layout algorithm that again contains a HierarchicLayout algorithm is defined.
• The OrganicLayout class now always correctly moves the nodes for inputs with scope set to SUBSET or MAINLY_SUBSET and with specified output restrictions.
• The TreeLayout class now correctly passes on exceptions that occurred during the layout calculation. Previously, they were sometimes caught without proper handling.
• The SeriesParallelLayout class can now handle input graphs that contain nodes with very large location coordinates (e.g. largest possible floating-point value) when the fromSketchMode property is disabled.
• The RadialLayout class does no longer throw an error if there is an IDataProvider registered with the key HierarchicLayout.SUB_COMPONENT_ID_DP_KEY.
• The RecursiveGroupLayout class now correctly considers PortConstraints and PortCandidates of self-loops where both end points are restricted to the same node side.
• A rare bug in the GenericLabeling may have caused an error for some input graphs that contain edges with zero length segments and labels associated with a free edge label model.
• The EdgeRouter now avoids edge-to-edge distance violations for segments directly connecting at a node if there exists a cheaper route that, e.g., introduces a bend (which costs less by default). The effect of this issue was mainly observable in cases where the edge-to-edge distance was set to a rather large value.
• The EdgeRouter now avoids some unnecessary bends that were previously created for edges that needed to pass group node borders and in conjunction with rather large minimumNodeToEdgeDistance values.
• The EdgeRouter class now keeps paths with self-crossings belonging to fixed edges. Previously, the self-crossings were removed, i.e. paths of fixed edges were changed.
• The PolylineLayoutStage class now keeps collinear bends of fixed edges.

Notable Demo Improvements

• Updated third-party toolkits and dependencies of the demos to the current versions, most notable to webpack 4 and TypeScript 3.
• Improved the performance of the Structure View and Neighborhood View demo components.
• The new JSONWriter and JSONReader classes show how to write and read a graph to/from JSON. They supersede the GraphToJSON class and are more universal to support more use cases.
• Enabled a workaround for Microsoft Edge in the Image Export demo. Otherwise gradients are not drawn correctly.

Incompatible Change

• Reverted the following improvement of version 2.1 since it turned out to cause problems: "CreateEdgeInputMode now 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.".

This is the 3rd bugfix release for yFiles for HTML 2.1. It includes several new demos, improvements, and corrections of errors. There are no incompatible changes.

Improvements

• The yFiles type checking now complains always when trying to create an instance of an abstract class.

View

• Reduced memory consumption of Void styles like VoidNodeStyle.
• Improved performance for graphs with a large number of dynamically data-bound template styles.
• Improved performance of the WebGLTaperedEdgeStyle.

Layout

• The new PlaceNodesAtBarycenterStageData class allows to conveniently define the nodes that should be affected by PlaceNodesAtBarycenterStage.
• HierarchicLayout now requires less memory for graphs with sequence constraints.
• HierarchicLayout no longer inserts superfluous bends for edges between group nodes if the input graph contains grouped edges.

Bugfixes

• Prevent a TypeError due to missing createElementNS property in web workers and in node.js when using the ES6 modules variant of the library.

View

• GraphModelManager no longer removes the port visualizations if PortLayerPolicy.AT_OWNER is used and the HierarchicNestingPolicy is changed.
• Bridges: For edges which cross each other with the same absolute slope a bridge is added on exactly one of these edges, depending on the crossing policy. Previously, a bridge was added either on both edges or none of them.
• SmartEdgeLabelModel centered all labels on an edge that overlapped with a segment of the edge or were placed directly next to it.
• Switching the input mode in an event handler of the current input mode no longer throws an error.
• GraphClipboard: The contents of a folder node were 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.
• GenericLabelModel serialization: Fixed cyclic reference in GraphML which could happen while serializing a GenericLabelModel with a parameter with associated descriptor.
• Corrected the GraphML serialization of the IArrow instances that are returned by the Arrow.asFrozen method.

Layout

• HierarchicLayout now correctly considers fixed nodes with layering constraints. Previously, there were some rare cases where such inputs caused infinite looping issues.
• OrthogonalLayout does no longer throw an error for some input graphs when its treeStyle property is set to COMPACT and its chainStyle property is set to a wrapped style.
• OrthogonalLayout no longer throws an error if its cycleStyle property is set to a specific style and the input graph only consists of a single cycle.
• EdgeRouter now always considers the PortCandidates for edges grouped with fixed edges.
• EdgeRouter now keeps collinear bends of fixed edges.
• EdgeRouter no longer crashes when defining exactly two equal intermediate routing points for an edge.
• EdgeRouter threw an error when the list of intermediate points for an edge consisted of exactly two equal points.
• BusRouter no longer produces non-deterministic results, i.e. different results for consecutive runs on the same input. Previously, this was possible in rare cases.
• TabularLayout no longer crashes when applying an instance of it to a single-node graph after that same instance was previously applied to a larger graph.
• GenericLabeling now always prefers LabelCandidates with higher profit values over others with lower profit. Previously, this sometimes happened even though both candidates did not intersect with other elements.
• GenericLabeling does no longer assume that all LabelCandidates associated to a label have the same size. Previously, this caused unexpected labeling results if custom candidates with different sizes were given.
• MultiPageLayout now correctly considers the maximum page size for tree layouts.
• FamilyTreeLayout now correctly considers the preferred family member order.
• The PreferredPlacementDescriptor.equals method incorrectly reported instances with different angles and distances as equal.

New Demos and Tutorials

Gantt Chart

Shows how to create an interactive Gantt chart from JSON data.

Structure View Demo

Features a tree list component that shows a structural view of a grouped graph.

Edge Groups

Shows how to configure HierarchicLayout to group edges. Grouped edges share common segments, thus making the layout more understandable and cleaner.

Split Edges

Shows that RecursiveGroupLayout in combination with HierarchicLayout presents the option to align edges that are split at a group's border. This leads to better routes for edges between groups and allows edges that connect ports at a group's border to the nodes of the group.

Rendering Order

Shows how to use the GraphModelManager class to control the order in which graph elements are rendered.

Build Swimlanes from Data Tutorial

Shows how to build a swimlane graph from JSON data.

Native Listeners Tutorial

Describes how to use a native click listener to add a button on a style.

Filtering with Folding Tutorial

Shows how to configure filtering and folding in the same diagram.

This is the 2nd bugfix release for yFiles for HTML 2.1. It includes four new demos, restructured tutorials, some improvements, and corrects several errors. There are no incompatible changes.

Improvements

• Reduced the number of bends of directed edges in OrthogonalLayout.
• The new TreeLayoutData.criticalEdgePriorities property can be used to specify critical edges.
• The INode parameter of the NavigationInputMode.enterGroup method is now optional. If it is omitted or null the whole graph will be revealed.
• The CanvasControl.createInputModeContext method is now public instead of protected.
• The PointD.toMutablePoint and RectD.toMutableRectangle methods now return a MutablePoint instead of IMutablePoint and a MutableRectangle instead of a IMutableRectangle, respectively.
• The new optional parameter initialTargetLocation of the CreateEdgeInputMode.doStartEdgeCreation method can be used to define the initial location that shall be used to find a target node.

Bugfixes

• For some constructors, the automatic type conversion did not work as documented. Also many simple constructors were not type-checked at run-time at all even if yfiles-typeinfo.js was available.
• Due to a bug in Safari 10.0 and earlier, using the new automatic type conversion feature for enum values resulted in a TypeError in these browsers. We now avoid the problematic code.
• Since version 2.1, the workaround IE7766782 for a problem in Internet Explorer with GWT was not applied to all problematic usages of Array.isArray. Thus, instanceof checks for arrays could have been wrong in rare cases, resulting in different kinds of subsequent errors.

View

• yFiles no longer shows an error if WebGL support is not available but no WebGL rendering is used at all. If WebGL support is not available and WebGL rendering is used, the resulting error has now a clear error message.
• The Workarounds class now correctly documents that it is exported by the yfiles/core ES6 module.
• CreateEdgeInputMode did not show port candidates after re-installation of the input mode.
• CreateEdgeInputMode didn't always update the highlight of possible source port candidates when its showPortCandidates property was configured to show the source port candidates.
• The default input mode that available view the GraphEditorInputMode.moveUnselectedInputMode property moved the bottom-most item at the cursor position instead of the top-most. This is most apparent when trying to move a child node of a group.
• ClickInputMode provided wrong click locations in the Click event if a MouseEventTypes.CLICK event without preceding MouseEventTypes.DOWN event was processed.
• If the MouseHoverInputMode.toolTip property was changed while a tool tip was visible, that tool tip was shown forever.
• ItemHoverInputMode now resets the hovered item when moving the mouse out of the control.
• While relocating edges, dropping a port over an invalid target or empty canvas no longer creates an empty undo unit.
• Fixed an exception when an edge or label was pasted without selected target while its original owner was not in the current view.
• The marquee visual of the LassoSelectionInputMode class was not updated properly during zooming.
• PolylineEdgeStyle now takes arrow heads into account for visibility checks.
• Reduced memory consumption of DefaultEdgePathCropper.
• EdgeSegmentLabelModel and EdgePathLabelModel placed the label on the wrong side for EdgeSides.ABOVE_EDGE and EdgeSides.BELOW_EDGE if the distance and offset was both 0.
• The TextWrapConverter for template styles threw a TypeError if the resolved value was not a string (e.g. for numbers or null). Now, it handles null and undefined like an empty string and converts non-string values to string.
• The maximumSize parameter of the TextRenderSupport.addText method is now optional, and consequently handles null arguments as it was already documented.

Layout

• The HierarchicLayout now produces less bends if the edges should be routed on a grid and the grid reference point is not (0,0), see NodeLayoutDescriptor.gridReference.
• HierarchicLayout did 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.
• HierarchicLayout now produces more symmetric results for grouped edges if property SimplexNodePlacer.barycenterMode is enabled.
• For some input graphs with port groups, the HierarchicLayout threw an exception for layout mode LayoutMode.INCREMENTAL.
• Fixed a rare bug in OrthogonalLayout that may have caused infinite looping for grouped input graphs.
• For some input graphs the OrganicLayout produced an error if the CycleSubstructureStyle property was set to CycleSubstructureStyle.CIRCULAR.
• CircularLayout does now correctly consider the EdgeBundleDescriptor.bundled property for edges between different partitions. Previously, when at least one of these edges had the Bundled property enabled, all of them were bundled, ignoring the property value of the other edges.
• Fixed a bug in TreeMapLayout that may have caused NaN-coordinates or infinite looping for input graphs that are non-directed trees.
• The EdgeRouter now produces better routes if there are edges with intermediate routing points, see property EdgeLayoutDescriptor.intermediateRoutingPoints.
• For grouped segments the GraphLayoutLineWrapper now produces more compact results.
• In rare cases the GraphLayoutLineWrapper produced drawings with large empty space between lines.

New and Improved Demos

Application Features Tutorial

These new small tutorials show how to implement features that applications typically have, like drag and drop, building graphs from JSON data, and tool tips.

Map Integration

Draws a graph on top of an interactive map. The nodes are placed at the correct locations on the map with geo-coordinates. The map in this demo is realized with the Leaflet.js library.

Contextual Toolbar

In this demo, contextual toolbars for the nodes and edges allow quick modifications of the styling and other actions.

Template Styles

Shows how to rapidly create node, label, and port styles from SVG template snippets. These styles can show information about their item with dynamic data binding.

Lasso Selection

Shows how to configure a lasso tool for freeform selection.

Other Notable Demo Improvements

• The performance of the Large Graphs Demo was significantly improved.
• The PDF Export now supports custom fonts and non-Latin-1 characters. A second sample graph shows such fonts and characters.
• The load and save operations in the File Operations demo have been refactored and simplified to make it much easier to re-use the code in customer applications.

This is the 1st bugfix release for yFiles for HTML 2.1. It includes four new demos, some improvements, and corrects several errors. There are three minor incompatible behavior changes.

In addition, there are new tutorial videos available online. We'll add more videos in the future.

Improvements

• Calling a method that is not available because its required module is missing now throws an informative error message. Prominent examples are the LayoutExecutor.morphLayout and the IGraph.applyLayout methods which are only available if the view-layout-bridge module is loaded.
• The EdgeRouter class now calculates a better routing for edges between group nodes and their descendants in the case that the routing is aborted via AbortHandler or 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 HierarchicLayout class now respects the sequence and layering constraints between subcomponents. Previously, such constraints were ignored.

Bugfixes

• The amount of time that may pass before a touch movement is considered a drag instead of a press is now correctly read from CanvasComponent.dragTime. Previously, the value of the CanvasComponent.longPressTime property was used instead.
• The IOrientedRectangle.orientedRectangleCenter property didn't return the correct center if the width or height of the rectangle was equal to 0.
• Moving an edge label with SmartEdgeLabelModel that is owned by an edge without visible path no longer throws an exception.
• The behavior of the DefaultObservableCollection.clear method has been corrected. Previously, it always threw an error.
• For template-based label and port styles, the binding context was not initialized early enough. As a result, these styles first created the DOM elements for the wrong, uninitialized vales and then updated them to the correct values.
• The new CSS classes yfiles-selected, yfiles-highlighted and yfiles-focused for template-based styles were not always applied correctly at element creation time.
• Removing an item that is currently highlighted with a custom HighlightIndicatorManager, FocusIndicatorManager, or SelectionIndicatorManager no longer results in an error.
• Fixed a bug that resulted in an unresponsive input mode in Safari on iOS. This error happened only if the CollapsibleNodeStyleDecoratorRenderer.addToggleExpansionStateCommand method was used in a custom group node style.
• The TypeScript definition files incorrectly required the implementation of some non-abstract properties in the quick-interface implementation constructors of some interfaces.
• 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 a yfiles.algorithms.DataProviderAdapter that does not override the DataProvider.get method was registered with key GivenLayersLayerer.LAYER_ID_KEY. This issue only appeared in conjunction with subcomponents.

New and Improved Demos

UML Editor

An editor for UML diagrams that features a tailored UML node style, a custom automatic layout, and special pop-up menu to quickly add new connections of different types with the mouse and touch.

Rotatable Nodes

Shows nodes that can be rotated interactively by dragging a rotation handle. Labels and ports rotate with their node and edges clip perfectly at the rotated node bounds. Automatic layout can deal with rotated nodes, too.

Hierarchic Subcomponents

Hierarchic layout can now arrange selected subcomponents with a different style. This can be a tree, organic, or orthogonal style, or a hierarchic style with different settings than the main layout.

Critical Paths

In hierarchic and tree graphs, some paths can be more important than others. This demo shows how the hierarchic and tree layout styles align the nodes and edges of such important, or 'critical', paths to make them more striking.

Other Notable Demo Improvements

• The context menu that is used in the demos is now an actual class and its menu items are real input elements. It now returns the focus to its graph component when closed and is easier to open with a touch long-press gesture.
• The Image Export, PDF Export and Web Worker demos have been refactored to make it easier to re-use the code in other projects.
• The GraphToJSON converter correctly parses bend locations and port locations now.

Changes of Default Behavior

• The IGraph.setNodeLayout method and the various methods to create a node now throw an ArgumentError if the layout rectangle contains one or more NaN values. Similarly, the IGraph.setBendLocation and the various methods to add a bend to an edge now throw an ArgumentError if the location point contains one or two NaN values.
• The ContextMenuInputMode.populateMenu event is now only fired if the current input mode state allows opening the context menu. Previously, the event was fired before the input mode had even checked whether another active input mode would prevent the opening of the menu.
• The default value of DragSource.effectAllowed is now DragDropEffects.ALL instead of DragDropEffects.NONE. This was always the intended default value.

Major New Features

ES6 Modules of the Library

The yFiles package now contains the library as ES6 modules in addition to the existing UMD modules. This makes, amongst others, working with modern IDEs, popular tools like Webpack and Angular CLI, and TypeScript much easier.

WebGL Rendering

Added WebGL as a third rendering option besides the already available SVG and HTML5 Canvas rendering. This allows the rendering of very large graphs with good performance. The Large Graphs demo shows the new technique in action.

Labels at Ports

Labels can now be added to ports and the new label models FreePortLabelModel and InsideOutsideLabelModel can be used to place such labels. On the technical side, IPort now extends the ILabelOwner interface and there is a new enum constant: GraphItemTypes.PortLabel.

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 LabelLayerPolicy and PortLayerPolicy of GraphModelManager to LabelLayerPolicy.AtOwner and PortLayerPolicy.AtOwner, respectively.

The nesting options of GraphModelManager for the visualizations of nodes and edges have been improved and clarified. The properties useHierarchicNodeNesting and useHierarchicEdgeNesting have been combined into the new hierarchicNestingPolicy property. It takes values of the new HierarchicNestingPolicy enum. Its new option HierarchicNestingPolicy.GROUP_NODE configures GraphModelManager to visualize all leaf nodes in one canvas object group while nesting all group nodes depending on their hierarchical depth.

Touch Improvements

A completely new Touch demo shows how the user experience can be optimized for touch-only devices, for example with large handles and a context dial menu that is triggered on "long-press".

This is accompanied by several improvements in the library that make touch input more fun. Especially, the hit test radius and drag detection area is now autoamtically enlarged for touch input, inertia scrolling of the viewport behaves now in a more natural way and stops after a fixed amount of time and two-finger panning and zooming now smooths small movements to avoid undesired changes of the zoom level.

Drag and Drop

Native HTML5 drag and drop is now supported in addition to the custom yFiles implementation that is based on mouse and touch event listeners. Both ways can now display a preview image of the dragged item all of the time and not only inside the graph component. Finally, the new LabelDropInputMode and PortDropInputMode classes implement drag and drop for labels and ports, respectively. The API of these classes is similar to the existing NodeDropInputMode for nodes.

Lasso Selection

The new LassoSelectionInputMode selects 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.SubComponents property can be used to configure the new sub-components feature of the hierarchic layout.

Tree Map Layout

Added the new layout algorithm TreeMapLayout that 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 new TreeMapLayoutData class provides additional configuration options for this algorithm and the new Tree Map Demo shows a possible use case for the new layout style.

Tabular Layout Style

The new layout algorithm TabularLayout generates 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 new TabularLayoutData class provides additional configuration options for this algorithm and the Layout Styles Demo shows the new layout style.

New Features

General

If you are updating from an older version of yFiles for HTML, have a look at the list of incompatible changes and at the more detailed description in the Migration Guide document (of your local yFiles for HTML installation). An updated version of our automatic source code conversion tool is available for this release, too.

• Many common simple types can now be created, or automatically type converted, from a shorthand string or object notation. For example, you can specify a point with {x:100, y: 200}, an arrow with "blue large circle", and an enum just by its name, e.g. "TOP_LEFT". Usages that allow the conversion of a parameter or property value are marked with a 'Conversion' badge in the API Doc and the valid syntax for each type is described with the corresponding type.
• The deployment tool can now optimize and obfuscate ES6 sources directly; transpiling the sources to ES5 first is not required anymore.

View

• The performance of FilteredGraphWrapper has been significantly improved. Now, it depends mainly on the size of the resulting filtered graph. This makes use cases that load very large graphs into memory and displaying only a subset of them using FilteredGraphWrapper much more reactive.
• The new property CanvasComponent.devicePixelRatio can be adjusted to achieve crisp Canvas or WebGL rendering on high DPI devices.
• CanvasComponent and GraphComponent can automatically detect (re-)insertions into the DOM now, allowing the size calculation and adjustment to also work in cases where the component previously was not displayed (out of DOM or display:none).
• The following types and methods were added to support the new LassoSelectionInputMode:
  • Added the GraphInputMode.lassoSelectionInputMode property and a corresponding factory method. LassoSelectionInputMode is disabled by default.
  • The new GraphInputMode.lassoSelect method programmatically selects all items in the provided GeneralPath.
  • The new ILassoTestable interface specifies whether the item is considered to be inside the lasso path. This is analogous to the IMarqueeTestable interface for marquee selection.
  • Any model item can be decorated with an instance of ILassoTestable or provide one in its lookup. For this, the Node/Edge/Port/Label/BendDecorator classes got the new lassoTestableDecorator property for decorating an item with a custom ILassoTestable.
  • The new isInPath method of Node/Edge/Port/LabelStyleBase can be overridden to customize the lasso testing behavior.
• With TableEditorInputMode, double clicking a stripe or stripe label now edits the label in the same way as for other graph items.
• The rectangle of the marquee selection can now be customized with the new protected method MarqueeSelectionInputModes.calculateMarqueeRectangle.
• Added the events ElementsCopied, ElementsCut, and ElementsPasted to GraphEditorInputMode, and the event ElementsCopied to GraphViewerInputMode.
• Added new decorator implementations for table items. You can access these new decorators via the new method ITable.GetDecorator with the RowDecorator, ColumnDecorator and StripeLabelDecorator properties.
• The mouse wheel behavior of the overview can now be switched between Zoom, Scroll, and None, and optionally the action can be performed only when the control is focused. This can be configured with the new OverviewInputMode.MouseWheelBehavior property.
• If the new CanvasControl.QuantizeInputCoordinates property is enabled, world coordinates of mouse and touch events are rounded to nicer values to avoid unnecessary precision. For example, you'll get the value 326.375 instead of 326.3858109495. 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.
• Added text wrapping support to the template styles. This feature is available through the built-in converter function TextWrapConverter.

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.maximumDuration controls the preferred time limit of this layout algorithm.
• The new OrthogonalLayout.uniformPortAssignment property allows to obtain results with a more uniform port assignment.
• TreeLayout: Added node placer CompactNodePlacer that 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 property CompactNodePlacer.preferredAspectRatio.
• The new TreeLayoutData.CompactNodePlacerStrategyMementos property can be used to to maintain similar layout styles over subsequent runs of compact tree layout.
• EdgeRouter now supports routing through user-specified intermediate points. All specified points will lie on the edge route in the given order. See new property EdgeLayoutDescriptor.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 property EdgeLayoutDescriptor.directGroupContentEdgeRouting.
• Added convenience layout stage TemporaryGroupNodesInsertionStage that 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 of RecursiveGroupLayout without 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 TemporaryGroupNodeInsertionData class provides additional configuration options for this algorithm.

• The new stage PlaceNodesAtBarycenterStage places a user-specified subset of nodes on the barycenter of their neighbors. During the core layout, these node are hidden.

Improvements

General

• The TypeScript declaration files now support quick interface implementations.
• The new yfiles.lang.Workarounds class provides properties that activate workarounds for known browser issues. This alternative way of setting workarounds is especially useful in ES6 modules where no reference to the yfiles top-level namespace is required anymore.
• The new yfiles.lang.License object has a value property that can be set to the license values. This alternative way of setting the license data is especially useful in ES6-style code where no reference to yfiles is required anymore.
• Errors thrown during the execution of the default implementations of ICommand.SAVE and ICommand.OPEN can now be caught by setting an error handler function to the yfiles.lang.Exception.handler property.
• The IEnumerable.reduce method now uses the same argument order and semantics as the default Array.prototype.reduce method.
• Rect and Size: Added methods to reduce the size of a Rect and a Size instance, respectively.
• The new method GeneralPath.intersects(GeneralPath) determines whether the path intersects with another GeneralPath.
• Saving a GraphML file now works in Safari 10.1 and 11 on macOS.
• When reading GraphML with the deserialization property IGNORE_XAML_DESERIALIZATION_ERRORS enabled, invalid property content is now skipped instead of discarding the whole object with such content.
• The GraphMLSupport.graphMLIOHandler property is initialized with a GraphMLIOHandler instance.

Graph

• The default value of DefaultPortCandidate.locationParameter is now FreeNodePortLocationModel.NODE_CENTER_ANCHORED for nodes and BendAnchoredPortLocationModel.FIRST_BEND for edges instead of a parameter of an internal model.
• Added a remove method to NodeDecorator, LabelDecorator, EdgeDecorator, PortDecorator, and BendDecorator for easy removal of decorations.
• Many label model createParameter methods now have default values for parameters that are not needed every time.
• InteriorStretchLabelModel: Added new parameters CENTER_HORIZONTAL and CENTER_VERTICAL for horizontal or vertical centered one-line labels.
• The elementCopiedCallback or elementDuplicated parameter of the methods GraphCopier.copy and GraphClipboard.duplicate is now optional (and can be null).
• DefaultGraph now fills the undo engine and triggers events in a consistent manner for all graph element factory methods.
• DefaultGraph has new factory methods to customize undo unit creation.
• The performance of GraphBuilder, TreeBuilder, and AdjacentNodesGraphBuilder was drastically improved if node and edge ID bindings are set. Additionally, these types have an improved API that makes it easier to customize the created and updated graph elements.

View

• The new CanvasComponent.hitTestRadiusTouch property controls the hit test radius for touch interaction. The existing hitTestRadius property now only applies to mouse interaction. The ICanvasContext.HitTestRadius property automatically uses one or the other value, depending on the last input event.
• The new CanvasComponent.dragSizeTouch property specifies the size of the area where a touch point may stay in before a movement is considered a drag. The existing dragSize property now only applies to mouse interaction.
• Added the new CanvasComponent.limitFitContentZoom property which controls whether the maximum zoom level for the CanvasComponent.fitContent method as well as the fitContent command is restricted to 1 or the value of the maximumZoom property.
• Akin to the two CanvasComponent.zoomTo methods, there are now two CanvasComponent.zoomToAnimatedmethods that animate the viewport change. The CanvasComponent.zoomToAnimated method now returns a Promise that fulfills when the viewport animation has finished.
• The new CanvasComponent.updateVisualAsync method behaves like the invalidate method but yields a Promise that can be awaited for.
• The new CanvasComponent.lastInputEvent property contains the lastMouseEvent or lastTouchEvent depending on which was dispatched last.
• The CanvasComponent.cleanup method new removes all DOM children and attributes created during the lifetime of the CanvasComponent from its div element.
• The CanvasComponent.sizeChangedTimerInterval property now is a proper TimeSpan instead of a simple number.
• The new CanvasComponent.toWorldFromPage method converts from HTML page coordinates to world coordinates.
• Improved styling of scrollbars and provided more CSS classes for different states of the scrollbar.
• Improved zooming and scrolling behavior for touch pads in Chrome, Safari, Edge and Opera.
• GraphModelManager now avoids unnecessary re-installation of items if they keep their ICanvasObjectGroup. By these re-installations the z-order of the item in its group was lost and a new visual was created.
• The new method GraphModelManager.getMainCanvasObject returns the canvas object that should be used when changing the visibility or z-order of a model item.
• ICanvasObjectGroup.addChild(Object,ICanvasObjectDescriptor): The second parameter is now an optional parameter. If no descriptor is passed, ICanvasObjectDescriptor.ALWAYS_DIRTY_INSTANCE is used by the default implementation.
• Assigning a new graph instance to GraphOverviewComponent now keeps configuration changes made to the overview's IVisualCreator instance.
• Self-loop edges are now properly displayed in the GraphOverviewComponent.
• The new Animations.createSequentialAnimation method creates an animation that animates multiple animations in sequence.

Styles

• PolylineEdgeStyle renders better looking paths for self-loop edges whose ports are near the node border.
• The GeneralPath.createSmoothedPath method now has additional parameters to change how smoothing is applied. Those new options result in nicer smoothing when combined with large smoothing lengths and many different segment lengths of the path.
• The stroke thickness is now considered for the calculation of the origin of the default arrow visualizations. Therefore, the visualizations no longer extend into the node bounds.
• Template styles now search for binding converter functions in a static converter store object on the template type before checking the `window` object. This helps preventing pollution of the global scope.
• Template styles can now bind to the current zoom level of the component.
• Template styles now provide yfiles-selected, yfiles-highlighted and yfiles-focused CSS classes depending on their current state.
• Some styles unnecessarily added empty SVG <g> elements to the DOM.
• New instances of SolidColorFill are now automatically frozen which can result in performance improvements. This type was already immutable anyway.
• The new static methods Stroke.setStroke and Fill.setFill are null-safe replacements for the existing applyTo methods of Fill and Stroke.

Input

• ItemClickedEventArgs now extends ClickEventArgs and therefore provides additional information like the IInputModeContext.
• Added MouseEventRecognizers that recognize a current down state of a mouse button. These can be used to recognize ongoing gestures like drags, in contrast to recognizers for the actual mousedown event.
• The static constants SELECTED_MOVABLES_POSITION_HANDLER and SELECTED_MOVABLES_HIT_TESTABLE have been added to GraphEditorInputMode. These are used as default IPositionHandler and IHitTestable properties of GraphEditorInputMode.moveInputMode and can be reused for other input modes.
• The new GraphEditorInputMode.moveUnselectedInputMode property provides a child input mode for moving unselected items. It supersedes the previous createMoveUnselectedInputMode method. This input mode is disabled by default.
• CreateEdgeInputMode now removes coinciding bends if orthogonal edge creation is enabled.
• The new property CreateEdgeInputMode.prematureEndHitTestable allows for considering any location as valid target point for an edge.
• The new CreateEdgeInputMode.getSourcePortCandidates protected method makes source port candidate determination more flexible.
• CreateEdgeInputMode provides access to a dummy target node which is used during the interactive edge creation. This allows making the node visible during creation by setting a style and size.
• CreateEdgeInputMode now supports edges ending without a valid target port candidate. This allows creating new target nodes together with a newly created edge.
• During interactive edge creation, the tip of a newly created edge now only snaps to valid target port candidates to create orthogonal end segments.
• The new CreateEdgeInputMode.dragCursor property specifies the cursor that is used during edge creation when no bend may be created at the current location.
• CreateEdgeInputMode now 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.startOverCandidateOnly property can be used to restrict the start of an edge creation gesture to directly hovered port candidates.
• CreateEdgeInputMode now supports showing port candidates at potential sources for edge creation, too.
• Moving a node with the MoveInputMode for unselected nodes now moves the bends of incident self-loops, too.
• MoveLabelInputMode: The visualization of a moved label has been improved. The new property visualization allows easy switching between a symbolic preview, a preview or a live view.
• The new static methods PositionHandlers.combine combine multiple position handler instances into a single instance.
• Added overridable methods to PortRelocationHandle to allow customization of the port candidates.
• The new PortRelocationHandle.visualization property 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.
• ClickInputMode now dispatches the clicked events in the same order as GraphInputMode, i.e. the more specific events LeftClicked, RightClicked, LeftDoubleClicked and RightDoubleClicked are now dispatched before Clicked and DoubleClicked. Hence, Clicked and DoubleClicked will only be triggered if the event wasn't handled before.
• The events ItemTapped, ItemDoubleTapped, and CanvasTapped have been added to GraphInputMode.
• The new TapEventArgs.tapCount property can be used to distinguish between single and multiple taps.
• Added a originalEvent property to TapEventArgs and ClickEventArgs.
• TouchEventArgs now provides the modifier keys that were pressed when the event was dispatched as well as those that have changed their state since the last TouchEventArgs.
• The CanvasComponent.MouseClick event now reports the position of the mouse down event as its location, and the CanvasComponent.TouchClick event reports the location of the touch down event as its location. Previously, this was the location of the up events which can be slightly different.
• The new properties MoveViewportInputMode.snapPanning and snapPanningThreshold allow for snapping touch panning to one axis.
• The new optional content parameter of the MouseHoverInputMode.show method defines the content of the tool tip to show. Now, the getToolTipContent method only gets called if no content was specified.
• The new methods findNextItem and findNearestItem of NavigationInputMode can be used to configure the determination of the "next" item.
• The generic type parameter T of class ItemDropInputMode<T> is no longer restricted to IModelItem.
• Several improvements of the interactive label editing.
  • Improved the focus handling of the text box.
  • Other elements can now be added to the default text box, e.g. buttons.
  • A new factory method allows replacing the text box with a custom label editor.
• The new TextEditorInputMode.textBoxPlacementPolicy property provides finer control of what happens when the TextBox is (partially) outside of the viewport.
• The new TextEditorInputMode.TextBoxPadding property controls the padding between the text box and the border of the canvas.
• The properties maximumSnapDistance, showHitPortOwnerCandidatesOnly and visualization have been added to PortRelocationHandleProvider and are applied to each PortRelocationHandle created by this provider.
• The following input modes now release the mutex before dispatching their final event:
  • CreateEdgeInputMode now releases the mutex before dispatching the EdgeCreated event.
  • MoveInputMode now releases the mutex before dispatching the DragFinished event.
  • ResizeStripeInputMode now releases the mutex before dispatching the DragFinished event.

Table

• The last parameter of the following extension methods of ITable is now optional: findRow, findColumn, findStripe, and findStripes.
• TableEditorInputMode now handles clicks and taps similar to GraphEditorInputMode:
  • New ItemClicked, ItemLeftClicked, ItemRightClicked, ItemDoubleClicked, ItemLeftDoubleClicked, ItemRightDoubleClicked, ItemTapped, ItemDoubleTapped events are raised.
  • If an event is handled, its default behavior is prevented.
  • The new properties clickableItems and clickableRegions determine for which items and regions a click or tap event will be raised.

Layout and Algorithms

• SmartEdgeLabelModel is properly handled by labeling algorithms now, resulting in better label placements.
• The new LayoutExecutor.createLayoutGraphAdapter callback method makes it possible to configure the LayoutGraphAdapter that is used for the layout calculation.
• The new improvePortAssignment property of LayoutExecutor and LayoutGraphAdapter enables PortCalculator to improve the port assignment.
• Major performance improvement for EdgeRouter in 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.
• The combination of PartitionGridData and TableLayoutConfigurator has been improved:
  • PartitionGridData now reuses the PartitionGrid created by the TableLayoutConfigurator.
  • Several methods have been added to TableLayoutConfigurator which provide access to the PartitionCellId assignment of the configurator as well as the mappings between IRow/IColumn and RowDescriptor/ColumnDescriptor.
• BusRouter: Now automatically ignores non-orthogonal edges with fixed bus descriptor (see BusDescriptor.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 specified coreLayout is either an instance of class TreeLayout or ClassicTreeLayout. Furthermore, property MultiPageLayout.additionalParentCount allows 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 property createProxyReferenceNodes that allows to disable the creation of proxy reference nodes as well as property multipleComponentsOnSinglePage that allows to prevent that elements of different connected components are placed on the same page.
• PortPlacementStage now 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 using DataProviders registered with PortConstraintKeys.SOURCE_PORT_GROUP_ID_DP_KEY and PortConstraintKeys.TARGET_PORT_GROUP_ID_DP_KEY.
• TreeComponentLayout: Added property considerUndirectedTreesthat allows to specify whether or not undirected tree structures should be handled or not. Previously, only directed tree structures were considered.
• DefaultNodePlacer and SimpleNodePlacer now 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 method DefaultNodePlacer.minimumChannelSegmentDistance and SimpleNodePlacer.minimumChannelSegmentDistance respectively.
• ClassicTreeLayout now allows to specify a minimum vertical distance for the horizontal edge segments of the bus, see ClassicTreeLayout.minimumBusSegmentDistance.
• The new properties layerConstraints and sequenceConstraints of HierarchicLayoutData can be used to configure layer and sequence constraints for the HierarchicLayout. These supersede the previous layerConstraintFactory and sequenceConstraintFactory properties.

Bugfixes

Graph and View

• Corrected weird scrolling behavior of the scroll bar when the viewport was outside the content rectangle.
• DefaultGraph now calls the onRemovingEdge and onRemovingPort methods before their incident items are removed.
• The GroupingSupport.hasGroupNodes method 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.
• Undo units created by the execution of a layout algorithm are now correctly merged with undo units of the previously executed interactive gesture.
• The graph of IFoldingView.graph now raises the NodeCreated, EdgeCreated, PortAdded, LabelAdded, and BendAdded events 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.
• Sometimes, the GroupNodeDefaults.Labels.AutoAdjustPreferredSize property and the GroupNodeDefaults.Ports.AutoCleanup property were not considered for labels and ports of groups.
• The commands COPY, CUT, and DUPLICATE are no longer enabled if there are no elements to cut, copy, or duplicate.
• The ICommand.COPY command is no longer executed twice.
• The methods GraphClipboard.copy and GraphClipboard.cut don't copy items anymore which depend on items that are selected but not included in GraphClipboard.copyItems.
• The InteriorStretchLabelModel.getMinimumNodeSize method now uses the correct insets for width calculation. Previously the top insets were erroneously used for the width.
• Labels rendered using DefaultLabelStyle and TextRenderSupport now properly consider the ascent for the first line of text and are thus rendered in a slightly higher location than before.
• BevelNodeStyleRenderer, PanelNodeStyleRenderer, ShadowNodeStyleDecorator and ShinyPlateNodeStyleRenderer now consider the shadow in their isVisible and getBounds methods.
• GraphML serialization: Write the IconLabelStyle.wrapped property with the correct name.
• The GraphML compatibility layer can now deserialize ports placed with AnchoredPortLocationModel of yFiles for HTML 1.x.

Input

• GraphEditorInputMode and GraphViewerInputMode no longer ignore changes to their sub-input modes after having been installed once.
• The KeyEventRecognizers SHIFT_IS_DOWN, ALT_IS_DOWN and CTRL_IS_DOWN now also recognize the modifier for touch events.
• The following event recognizer of input modes and input-related classes can now also be used with touch gestures:
  • CreateBendInputMode.splitOrthogonalSegmentRecognizer.
  • ResizeStripeInputMode.resizeNeighborsRecognizer and ignoreContentRecognizer.
  • CreateEdgeInputMode.portCandidateResolutionRecognizer and enforceBendCreationRecognizer.
  • GraphInputMode.multiSelectionRecognizer.
  • TableEditorInputMode.multiSelectionRecognizer.
  • ReparentNodeHandler.reparentRecognizer.
  • PortRelocationHandle.portCandidateResolutionRecognizer.
• The hitTestRadius property of the following implementations of ICanvasContext now correctly contain the value in world coordinates instead of view coordinates:
  • The context created by ICanvasContext.createCanvasContext when passing a CanvasComponent but no hit test radius.
  • The context passed to IPositionHandlers by MoveInputMode.
  • The context passed to adjacent handles when moving a bend handle.
  • The context passed to callback parameter in the IRenderContext.setDisposeCallback method.
• Disabling MarqueeSelectionInputMode during the gesture via code left the marquee visible on the screen.
• Panning with two fingers held down does no longer change the zoom level.
• The Clicked and DoubleClicked events of ClickInputMode were sometimes missing when clicking on a node or edge. Now, they are always triggered unless the event was handled before.
• Changing the values of the CreateEdgeInputMode.dummyEdgeGraph.edgeDefaults property had no effect for some interactions.
• Node-to-edge snapping is now disabled by default which is the documented and intended value. For this, the initial value of the GraphSnapContext.nodeToEdgeDistance property is set to -1.0.
• Snap lines which indicate the same size are no longer shown for implicitly re-sized parent group nodes.
• The default implementation of IPortSnapResultProvider never returned any snap results.
• The LabelEditingEventArgs.context.parentInputMode property provided in the events GraphEditorInputMode.LabelAdding, GraphEditorInputMode.LabelEditing, TableEditorInputMode.LabelAdding and TableEditorInputMode.LabelEditing now contains the corresponding GraphEditorInputMode or TableEditorInputMode instance.
• The CreateEdgeInputMode.cancelGestureOnInvalidTarget property was sometimes ignored on touch-enabled devices.
• CreateEdgeInputMode: The validBeginCursor is now correctly hidden during edge creation when bend creation isn't allowed.
• Fixed an exception when enabling TextEditorInputMode.rotateTextBox.
• Pen input was not handled at all on Android devices. Now, it is treated as mouse input.

Table

• When a stripe is removed, ITable.LabelRemoved events for the implicitly removed associated labels are now raised, too.
• When a selected stripe label is edited its text box now is correctly placed.
• ReparentStripePositionHandler: The source and target ghost visualization was not always updated correctly when custom ghosts were used.
• 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.
• The implementations of IStripeHitTestHelper and IBoundsProvider in the lookup of an IStripe could neither be decorated nor overridden by the context lookup provided by a stripe style.

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.
• HierarchicLayout: Fixed problem that sometimes caused an unnecessarily large distance between adjacent layers.
• OrthogonalLayout now considers edge grouping also if there are no directed edges specified.

Incompatible Changes

See the Migration Guide document (of your local yFiles for HTML installation) for more details and advice on migrating.

Incompatible API Changes

• The IEnumerable.reduce method now uses the same argument order and semantics as the default Array.prototype.reduce method. This means the initialValue parameter is now the (optional) last parameter and the first element of the enumerable becomes the initialValue if that is undefined. Previously, the order of these two parameters was reversed.
• Renamed MouseEventRecognizers and TouchEventRecognizers to be in line with the common JavaScript notation.
• Renamed the values of the KeyEventType enum to match the corresponding JavaScript event type.
• The CanvasComponent.sizeChangedTimerInterval property now is a proper TimeSpan instead of a simple number.
• CanvasComponent: Removed the events MouseWheelZoomFactorChanged, MouseWheelScrollFactorChanged, AutoDragChanged and HitTestRadiusChanged. These events are unneeded since the corresponding properties are not changed by library code.
• CanvasComponent: Removed the events GotFocus and LostFocus. These just duplicated the focus and blur events on the CanvasComponent.div element. Use these events instead.
• The CanvasComponent.animateScrollTo method has been removed and is superseded by the new zoomToAnimated methods.
• GraphModelManager.useHierarchicNodeNesting has been removed. Set the new hierarchicNestingPolicy property to HierarchicNestingPolicy.NONE to disable node nesting or to either HierarchicNestingPolicy.NODES or HierarchicNestingPolicy.NODES_AND_EDGES to use nesting. Similarly, GraphModelManager.useHierarchicEdgeNesting has been removed. Use either HierarchicNestingPolicy.NODES_AND_EDGES to enable edge nesting or any other policy to disable it.
• ItemClickedEventArgs now extends ClickEventArgs.
• The GraphInputMode.canvasClicked event now provides the GraphEditorInputMode or the GraphViewerInputMode as parent input mode in the context property of its ClickEventArgs.
• The GraphEditorInputMode.createMoveUnselectedInputMode method has been removed. Use the property moveUnselectedInputMode instead.
• GraphEditorInputMode: Removed the shouldClickCreateNode protected method.
• CreateEdgeInputMode's edgeCreator might receive null as targetPortCandidate parameter. Callbacks must handle this case by either creating a target port of their own or canceling the edge creation by returning null.
• The CreateEdgeInputMode.showPortCandidates property has now the enum type ShowPortCandidates instead of boolean.
• The OverviewInputMode.autoMouseWheelZoom property is superseded by the new mouseWheelBehavior property.
• The protected factory method MoveLabelInputMode.createLabelHitTestable has been removed. Developers who want to set a custom instance need to set it directly to the hitTestable property.
• MoveViewportInputMode: The properties that controlled the inertia behavior have been removed since they no longer apply to the new algorithm. Instead, the new property inertiaDuration can be used to specify the duration of the inertia scrolling.
• Replaced overloaded methods that are intended to be overwritten with non-overloading sets of methods since the latter are easier to actually override one by one. See the migration guide for details. The following methods are affected.
  • CreateEdgeInputMode.createEdge.
  • CreateEdgeInputMode.getSourcePortCandidate.
  • CreateEdgeInputMode.getSourcePortCandidateProvider.
  • CreateEdgeInputMode.getTargetPortCandidateProvider.
  • IPortCandidateProvider.getSourcePortCandidates.
  • IPortCandidateProvider.getTargetPortCandidates.
  • GraphClipboard.paste.
  • GraphCopier.copyNode.
• Removed unnecessary Enabled parts from the following property names.
  • EdgeSegmentLabelModel.autoRotationEnabled is now autoRotation.
  • EdgePathLabelModel.autoRotationEnabled is now autoRotation.
  • LabelLayoutTranslator.autoFlippingEnabled is now autoFlipping.
  • SingleCycleLayout.fromSketchModeEnabled is now fromSketchMode.
  • SliderEdgeLabelLayoutModel.autoRotationEnabled is now autoRotation.
  • DiscreteEdgeLabelLayoutModel.autoRotationEnabled is now autoRotation.
  • CanvasComponent.mouseCaptureEnabled is now mouseCapture.
• ReparentStripePositionHandler: All callback methods dealing with ghost objects have been renamed consistently:
  • updateXyzVisualisation to updateXyzGhost.
  • updateTargetVisualizationBounds to updateTargetGhostBounds.
• Renamed all occurrences of cleanup to cleanUp in API names.
• Renamed the enumeration value ShowFocusPolicy.WHEN_FOCUSED to ONLY_WHEN_FOCUSED.
• Renamed the method SvgExport.getClip to createClip.
• Renamed the Animator.destroy method to stop.
• Renamed the methods CanvasComponent.globalToLocal to toViewFromPage and localToGlobal to toPageFromView.
• The ITable.relativeLocation property has been removed. Use ITable.insets with corresponding left and top values instead.
• The properties layerConstraintFactory and sequenceConstraintFactory of HierarchicLayoutData have been marked as obsolete. The new properties layerConstraints and sequenceConstraints should be used instead. Similarly, the extension methods HierarchicLayout.createLayerConstraintFactory(IGraph) and HierarchicLayout.createSequenceConstraintFactory(IGraph) have been marked as obsolete.

Changes of Default Behavior

• Previously, even if the GraphModelManager.useHierarchicEdgeNesting property was set to true, canvas objects for edges were added to the GraphModelManager.edgeGroup as long as no group nodes were part of the graph. The corresponding new HierarchicNestingPolicy NODES_AND_EDGES has no such behavior and thus, edgeGroup is empty by default. Use one of the other polices if canvas objects for edges should be part of edgeGroup.
• ClickInputMode now dispatches the more specific events LeftClicked, RightClicked, LeftDoubleClicked and RightDoubleClicked before the general Clicked and DoubleClicked events. Hence, Clicked and DoubleClicked will only be triggered if the event wasn't handled before.
• The CanvasComponent.dragSize property no longer applies to touch input. Use the new property dragSizeTouch for controlling the drag size for touch input.
• The CanvasComponent.hitTestRadius property no longer applies to touch input. Use the new property hitTestRadiusTouch for controlling the hit test radius of touch input.
• 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 LayoutExecutor.updateContentRect property is now enabled by default.
• GraphBuilder, TreeBuilder and AdjacentNodesGraphBuilder: The values returned by a node or edge ID binding must now be a string or number.
• If the TreeBuilder.idBinding property is specified, the childBinding must now resolve to values that contain the node IDs. Previously, it was fine if the values contained either the business objects or the IDs. If your childBinding resolves to values that contain the business objects, simply don't set an idBinding.
• The CreateEdgeInputMode.dummyEdge property 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 the visualization property to Visualization.GHOST to restore the old mode.
• In CreateEdgeInputMode the determination whether the mouse hovers over a valid end has changed. If forceSnapToCandidate is disabled, the endHitTestable now 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.
• GraphML: Duplicate properties on XAML input are now considered an error in accordance with the XAML specification.
• PolylineEdgeStyle defaults to an improved smoothing algorithm when using the smoothingLength property. This is especially apparent when using large values for smoothingLength.
• 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 default edge style of an IGraph now has a target arrowhead. This is in coherence with the default styling on other yFiles products.
• Brightened the color of the marquee and lasso selection visualization.
• By default, stripe labels that are programmatically selected or highlighted don't show a selection or highlight indicator anymore.
• Rect.isFinite and Size.isFinite now also consider empty instances as not finite.

Minor Incompatible Changes

The changes listed in this section are incompatible changes that we consider as unlikely to break customer code. For most of them it is unlikely that the corresponding API was used in customer code.

• The return type of the TextRenderSupport.measureText method is now Rect instead of Size.
• The AnchoredPortLocationModelExtension class has been moved to the GraphML compatibility demo where it was really needed.
• SolidColorFill, PatternFill, and all types related to gradients are now final. They were never intended to be extended. Brush is now abstract since it is pointless to instantiate this base class.
• There is no constructor that only takes a renderer in StringTemplateLabelStyle and StringTemplatePortStyle anymore. A renderer may still be specified in the existing constructor as second parameter together with an optional template string.
• The Property.defaultValue property has been removed since it was not intended to be part of the public API.
• Removed the GraphMLSupport.getGraphMLIOHandler protected method in favor of the graphMLIOHandler property.
• Removed the LayoutGraphAdapter.applyLayout static method which is the same as the IGraph.applyLayout method.
• Removed the TextDecorations enum since it was an unused duplicate of TextDecoration.
• Remove the unused InteractiveOrganicLayout.workingRatio property.
• The protected method CollapsibleNodeStyleDecorator.createSelectionInstaller has been removed.
• Error messages don't start with the error name anymore. The error name can be obtained through the dedicated name property of the error.
• The following static methods were available at two different types, one intended and documented and one unintended and undocumented. The undocumented methods have been removed:
  • yfiles.graph.TableAnimation.createTableAnimation, use yfiles.view.IAnimation.createTableAnimation.
  • yfiles.graph.Table.getCellBounds, use yfiles.graph.ITable.getCellBounds.
  • yfiles.graph.Table.placeNodeInCell, use yfiles.graph.ITable.placeNodeInCell.
  • yfiles.layout.PartitionLayout.createPolylineInterEdgeRouter, use yfiles.layout.IPartitionInterEdgeRouter.createPolylineInterEdgeRouter.

Most Notable Demo Improvements

• The renewed Angular demo demo shows how easy it is to integrate yFiles for HTML with Angular CLI. This is possible since this demo uses the ES6 module version of the library.
• The new Vue.js Node Template demo presents a template style for nodes powered by the Vue.js framework.
• Instead of an AMD loader, the TypeScript demo now uses import statements and webpack together with the ES6 module version of the library. Consequently, the previous version of the demo was renamed to TypeScript (AMD) demo.
• A new step for the Getting Started Tutorial demonstrates the minimal source code to add drag and drop to an application.
• The graph-to-JSON converter of the demos now supports labels. This enhances the data exchange with other services and with code that runs as a web worker.

This is the 4th bugfix release for 2.0.1. It includes more workarounds for browser bugs, brings support for passive event listeners, and corrects several errors. There is an incompatible change of the module dependencies.

Workarounds for Browser Issues

• SVG rendering in Firefox can be slow due to a problem in Firefox's SVG rendering engine. This can be prevented by enabling the already existing workaround yfiles.workaroundCR320635 which was originally added for a Chrome bug (more information on browser issue workarounds).

  In addition, the rendering of SVGs that contain nested <svg> elements is slow, too. Such nested <svg> elements are not used in library styles and should be replaced with <g> elements in custom styles whenever possible.

• In Edge 16 (Windows 10 Fall Creators Update), SVG <marker> elements may crash the current tab. The default demo styles use <path> elements instead of <marker> elements for arrows in this browser and custom styles should be changed in this way, too.

Find more details about these and other browser issues in the Known Issues document (of your local yFiles for HTML installation).

Improvements

• Event listeners that invoke preventDefault are now registered with the option passive: false to conform to the new DOM spec and to prevent warnings on the browser's console.
• Images which cannot be exported due to cross origin restriction are now replaced with a fallback image instead of throwing an error. Additionally, an optional 'strict' mode can be enabled which will cause the export to fail for these types of errors. The resulting errors can be caught in the export promise.

Bugfixes

• In rare cases, ES6 classes that extend a yFiles class did not initialize correctly and threw errors on member access.

View

• CanvasComponent: The value and the width of the scrollbar thumb sometimes were displayed incorrectly after the component was resized.
• Fixed missing drop shadow of PanelNodeStyle.
• ImageNodeStyle: The fallback image for an unresolved image is now correctly displayed in Internet Explorer.
• The NodeStyleStripeStyleAdapter.updateVisual method always created a new visual by delegating to the createVisual method.
• MoveViewportInputMode: The Dragging, Dragged, DragCanceling, DragCanceled, DragFinishing and DragFinished events did not fire reliably for touch input and when mouse inertia was active.
• The ICommand.COPY command is no longer executed twice.
• Fixed a bug in ViewportAnimation that sometimes moved the viewport a bit before the animation started.
• Pen input was not handled at all on Android devices. Now, it is treated as mouse input.
• In Internet Explorer, users could interact with the viewport indicator of the OverviewComponent even if the component was set to visibility="hidden".

Layout

• HierarchicLayout: Fixed an error that occurred when both layering constraints and edge directedness (with HierarchicLayout.EDGE_DIRECTEDNESS_DP_KEY) were specified.
• HierarchicLayout and SimplexNodePlacer: Fixed a rare error that could be triggered when the input graph had a partition grid and PortCandidates or PortConstraints.
• HierarchicLayout better adheres to the specified maximum duration by applying a suitable runtime restriction to class PortCandidateOptimizer. Previously, this class didn't have any runtime restrictions.
• HierarchicLayout creates better port assignments for edges incident to group nodes that are routed directly. Previously, such edges were often reversed.
• HierarchicLayout no longer violates the specified PortCandidates of edges with labels with preferred placement specifier LabelLayoutConstants.PLACE_AT_SOURCE_PORT or LabelLayoutConstants.PLACE_AT_TARGET_PORT when using an orientation other than top-to-bottom.
• HierarchicLayout with partition grid: Avoid unnecessarily large layer distances if an empty partition grid row with a minimum row height exists.
• HierarchicLayout with partition grid: Avoid an error when the layout algorithm is configured to stop after the layering or sequencing phase (see HierarchicLayout.stopAfterLayering and HierarchicLayout.stopAfterSequencing).
• EdgeRouter: Fixed an error that occurred for graphs with fixed edges and very short segments.
• OrthogonalLayout: Fixed a rare bug that caused node-edge overlaps.
• OrganicRemoveOverlapsStage better adheres to the specified maximum duration.
• SeriesParallelLayout no longer misplaces edge labels for graphs with only a single edge.

Incompatible Change

• The module yfiles/view-graphml no longer depends on yfiles/view-table and yfiles/view-editor. These dependencies were undocumented and unintended. If you use the GraphML feature and the table or editor feature, make sure to require the corresponding module(s) explicitly.

Notable Demo Improvements

• Optimized several styles used in demos for better rendering performance in Firefox and iOS browsers. See the performance notices in the documentation for details and tips.
• Context menus now open on iOS devices.
• Enabled a workaround in the default demo styles that avoids a fatal error in Edge 16 (Windows 10 Fall Creators Update) that ultimately prevented the loading of the web page. For more details, see the Known Issues document (of your local yFiles for HTML installation).

This is the 3rd bugfix release for 2.0.1. It includes two workarounds for browser bugs, brings support for TypeScript 2.5, corrects several errors, and contains two new demos. There are no incompatible changes since 2.0.1.2.

Additionally, we have released a TypeScript migration tool on GitHub that helps with the migration of TypeScript files that reference yFiles for HTML 1.x API to the yFiles for HTML 2.x API.

New Demos

Decision Tree

An interactive decision making app with automatic incremental layout. You can explore the existing samples, and create or load your own decision tree.

Partition Grid

An interactive explorer for the PartitionGrid class. A partition grid distributes the nodes into rows and/or columns during an automatic layout. This can be used, for example, to realize layouts of graphs with swimlanes or tables.

Workarounds for Browser Issues

• Safari 11 and all WebKit browsers on iOS 11 are affected by a rendering issue that causes missing or not correctly zoomed graph elements, seemingly broken user interaction, and other artifacts. This can be prevented by enabling the already existing workaround yfiles.workaroundCR320635 which was originally added for a Chrome bug. See the related Knowledge Base article for more information on enabling this workaround and the WebKit bug report for more details on the issue.
• Added a workaround for a bug in Internet Explorer's implementation of Array.isArray with GWT. To enable the workaround, set the yfiles.workaroundIE7766782 variable to true (more information on browser issue workarounds).

Find more details about these and other browser issues in the Known Issues document (of your local yFiles for HTML installation).

Improvements

• TypeScript: Made the typings provided by yfiles-api.d.ts compatible with TypeScript 2.5.
• yfiles.styles.IArrow.NONE and yfiles.input.HandleTypes.INVISIBLE insert an empty <g> element into the DOM instead of an empty <use> element. The latter resulted in validation errors with exported SVG images in some SVG validators.

Bugfixes

View

• In some cases, removing an event listener which was not created using yfiles.lang.delegate caused an error.
• Creating an ES6 subclass of a subclass with overridden yFiles members resulted in incorrect run-time behavior when the lower subclass was instantiated before its super classes.
• TouchEnter event: The value of the location property was not correct.
• LayoutExecutor.stop() did not immediately stop the layout animation as it is supposed to.
• MoveInputMode did not correctly recognize move interactions when triggered using touch gestures in Edge and Internet Explorer.
• CreateEdgeInputMode fired gesture cancel events even if it was not started before.
• DropInputMode: An error occurred if a DragEnter event was recognized while another drag action was still running.
• StripeDropInputMode no longer calls itemCreator twice.
• The StripeDropInputMode.ItemCreated event was not raised.
• GeneralPath.IsVisible often returned true for invisible paths.

Layout

• OrthogonalLayout: Fixed rare bug that caused overlapping nodes.
• OrthogonalLayout: Improved from-sketch mode in conjunction with node labels or node halos. Previously, in the presence of the mentioned elements, the layout results did not always correctly resemble the sketch drawing, even if it was a good sketch.
• HierarchicLayout: Fixed edge ports lying outside the node boundaries when using the edge thickness feature (i.e. edges with thickness greater than zero) together with a (rather large) grid spacing value and the default port assignment PortAssignmentMode.DEFAULT.

Notable Demo Improvements

• Improved printing support to prevent the initial print document from being empty in some browsers.
• Flowchart node style: The updateVisual() method now correctly handles changes of the flowchart type of a node.
• The demos use larger values for the dragSize and the hitTestRadius if the input device is a touch device.

This is the 2nd bugfix release for 2.0.1. It includes some improvements, corrects several errors, and brings a large number of new demos. There are two incompatible behavior changes since 2.0.1.1.

New Demos

Flowchart Editor

An editor for Flowchart diagrams that features interactive editing, tailored Flowchart node styles, and a specialized layout algorithm.

Tree Layout Demo

Shows how to use different node placers with the automatic tree layout.

Clustering Algorithms Demo

Showcases a selection of clustering algorithms:

• Edge Betweenness Clustering
• k-Means
• Hierarchical Clustering
• Biconnected Components Clustering

Neo4j Demo

Shows how to load data from a Neo4j database and display it with yFiles for HTML.

CSS3 Animations and Transition Demo

Shows how CSS3 transformations and animations can be applied to graph items.

Edge Bundling Demo

Shows edge bundling which reduces visual clutter in dense graphs.

Node Label Placement Demo

Shows how to place edge labels at the preferred location with a labeling algorithm.

Edge-to-edge Connections Demo

Shows how edge-to-edge connections can be realized. More precisely, it shows how to configure the input mode to allow edges to be connected not only to nodes but also to other edges.

Move Unselected Nodes Demo

Shows a special input mode that allows moving nodes without selecting them first.

Improvements

• Improved performance when the webcomponents.js polyfill for the Shadow DOM API is used.
• FilteredGraphWrapper can now deal with node and edge predicates that evaluate to truthy or falsy values. Previously, predicates that did not strictly return true or false resulted in an error with messages like "Node not in this graph".

• SvgExport: 'id' attributes are now copied to the wrapping <g> element of inlined images. This retains the possibility for the image to be referenced in the exported SVG document. This frequently occurs if the inlined image is part of the <defs> section of an <svg> element.

  By default, SvgExport modifies the copied 'id' attributes to make sure they are unique. This behavior can be switched off with the new property SvgExport.ensureUniqueIds.

• TypeScript: The static isInstance method of all yFiles classes and interfaces is now part of the typings and specified as user-defined type guard function to avoid superfluous type casts and improve coding experience in IDEs.
• TypeScript: The typings now use any instead of Object for property types and method parameters to allow usage of primitive types. Most prominently, the ITagOwner.tag property can now be set to a string value without explicitly casting it to any.
• Developer tool for type checking: Made error messages for wrong method parameters more clear.

Bugfixes

View

• During reparenting, the edges at reparenting nodes were drawn below the group(s) and thus they were not visible. If reparenting was canceled, these edges stayed behind the group(s) and remained invisible.
• The promise returned by GraphEditorInputMode.addLabel and TableEditorInputMode.addLabel now fulfills with null instead of the label if the editing was canceled or the text did not validate. This is the documented behavior.
• CreateEdgeInputMode did not always start correctly for quick gestures on slow devices.
• CreateEdgeInputMode did not trigger the EdgeCreationStarted event for programmatic initialization of the edge creation gesture.
• Setting CreateEdgeInputMode.cancelRecognizer could potentially get the input mode into a broken state.
• In the unusual case that a validBendHitTestable is used, CreateEdgeInputMode will no longer cancel edge creation when using touch and trying to create a bend at an invalid location. Therefore, touch input behaves now in the same way as mouse input.
• Fixed a possible error in NodeDropInputMode when snapping is enabled and preview is disabled.
• Drag and drop did not work if the GraphComponent was in a shadow DOM.
• Changing HandleInputMode.pressedRecognizerTouch had no effect if the input mode was already installed.
• HandleInputMode.currentHandle could not always be obtained during the DragFinished, DragFinishing, DragCanceling, and DragCanceled events.
• Switching the GraphComponent's inputMode in a key event handler threw an exception.
• The 'S' and 'T' keys are now correctly reported as these keys by the KeyEventArgs.key property. Previously, they were swapped, 'S' was reported as 'T' and vice versa.
• FreeLabelModel.INSTANCE, FreeEdgeLabelModel.INSTANCE, and FreeNodeLabelModel.INSTANCE are now serialized correctly to GraphML even when not used as part of their parameters (e.g. within CompositeLabelModel).
• Labels with NinePositionsEdgeLabelModel now disappear when the owner edge has no visible edge path. This can happen for example when nodes are moved onto each other. Previously they appeared at unexpected locations, including the origin (0,0) and the upper left corner of the source node.
• GeneralPath.getTangent now returns null if there is no tangent at the requested position. Previously, it returned a bogus tangent.
• Prevent errors with the message "TypeError:Attempting to change access mechanism for an unconfigurable property" in Safari 10. This error was thrown when a constructor was declared using the yFiles class framework in code that was not using "strict-mode".
• In Safari for macOS, changed the default shortcut for the Toggle Item Selection command from Command+Space to Control+Space. Command+Space is reserved for Spotlight.
• The last row and column of the grid were sometimes not display, especially after zooming and panning.
• Creating subclasses of subclasses with abstract yFiles members using the class framework resulted in incorrect runtime behavior when the lowest subclass was instantiated first.
• GraphMLSupport.openFile: After a user canceled the file open dialog once, promises returned by this method stayed always in pending state and were never fulfilled.
• GraphML: Writing an item's tag threw an error if a value was an array.
• GraphML: The TextTrimming enum was erroneously obfuscated by the deployment tool and, as a result, the obfuscated name could have been used in GraphML files in rare cases. Reading such a file with a new build of your app resulted in an error since the obfuscated name had likely changed.
• The following static methods internally called the wrong code and always threw an error: IAnimation.createTableAnimation, ITable.getCellBounds, and ITable.placeNodeInCell.

Layout

• HierarchicLayout: PropertyHierarchicLayout.componentArrangementPolicy was not correctly considered when there are undirected edges.
• Tree layout: DefaultNodePlacer.minLastSegmentLength erroneously returned the value of minFirstSegmentLength.
• Tree layout: Prevent a memory leak in DefaultPortAssignment.
• If PartialLayout.edgeRoutingStrategy was set to STRAIGHTLINE, all edges were rerouted in the graph, instead of just the ones that were required.
• EdgeRouter: The minimum first and last segment length were sometimes not respected if they were set to relatively large values.
• OrthogonalLayout: Fixed rare bug that caused non-orthogonal line segments and bad port locations.

Incompatible Changes

• CreateEdgeInputMode now triggers the EdgeCreationStarted event for programmatic edge creation with the doStartEdgeCreation method.
• The 'S' and 'T' keys are now correctly reported as these keys by the KeyEventArgs.key property. Previously, they were swapped, 'S' was reported as 'T' and vice versa.

This is the 1st bugfix release for 2.0.1. It includes some improvements, corrects several errors, and brings a large number of new demos. There are no incompatible changes since 2.0.1.

New and Improved Demos

Fraud Detection Demo

A demo application that shows how to detect fraud cases in time-dependent data.

Isometric Drawing Demo

Displays graphs in an isometric fashion to create the impression of a 3-dimensional view.

Logic Gates Demo

An editor for digital systems consisting of logic gates.

WebComponents and Vue.js Demos

Show how yFiles for HTML can be used with Web Components v1 and Vue.js, respectively.

Sankey Demo

Illustrates a diagram used for visualizing flow information in which the thickness of the edges is proportional to the flow quantity.

Maze Router Demo

Shows how the automatic edge routing finds routes through a maze.

Mixed Layout Demo

Shows how to apply different layouts to the contents of group nodes with the RecursiveGroupLayout.

Partial Layout Demo

Shows how to integrate (new) graph elements into an existing graph layout.

Layer and Sequence Constraints Demos

Show how to use layer and sequence constraints to prescribe and restrict the node layering and sequencing in hierarchic layouts.

Custom Label Model and Port Location Model Demos

Show how to create and use a custom label model and a custom port location model, respectively.

Label Editing and Label Handle Provider Demos

Show customizations of the interactive editing, resizing and rotating of labels.

Notable Demo Improvements

• Graph Viewer Demo: Added a search box to query the desired term within the labels of the nodes of the graph.
• BPMN Editor Demo: Prevent the creation of dangling edges when connecting to pool nodes with SHIFT pressed.
• Neighborhood View Demo: Prevent redundant layout calls when selecting multiple graph items.
• Context Menu Demo: Now supports the longpress event on iOS devices.
• Image Export Demo: Added two workarounds for problems with Internet Explorer and current Firefox versions, respectively.

Improvements

• Improved rendering performance mostly in Chrome. In bad case scenarios, the frame rate now is up to three times as high.
• InteractiveOrganicLayout: Significant performance improvements during interactive changes of the graph, for example when a user moves nodes.
• Input modes that use a combination of mouse gestures and modifier key(s) can now be started by the key press. Previously, such an input mode was only started by the first mouse event, e.g. a mouse move. The main benefit is that the cursor changes instantly with the key down to the input mode's one.
• CanvasComponent: Overridable methods maybePreventPointerDefault and maybePreventContextMenuDefault have been added to control which event's default behavior should be prevented by the component.
• Added the alias yfiles.lang.Interface for yfiles.lang.Trait. Interface is the intended name since 2.0 and most documentation was already referring to Interface instead of Trait. Note that we keep yfiles.lang.Trait for compatibility reasons for now.

Bugfixes

View

• The event StripeDropInputMode.StripeCreated always returned a wrong stripe instance.
• The EditLabel command was not working directly on labels when a TableEditorInputMode was active.
• TableLayoutConfigurator erroneously considered labels on the left side as top labels, and consequently might have created insets of incorrect size.
• GraphML: Fixed deserialization of empty XML label nodes.

Layout

• HierarchicLayout: Fixed bug that caused node-edge overlaps in conjunction with some complex edge grouping specifications.
• OrganicLayout, ClassicOrganicLayout and InteractiveOrganicLayout: Fixed error that was triggered due to NaN values that could occur in case the input graph had a very large number of nodes.
• EdgeRouter: Fixed bug that caused violations of minimum first/last segment lengths of grouped edges when using different edge layout descriptors and, second, made the layout algorithm remove a user-registered DataProvider with key EdgeRouter.EDGE_LAYOUT_DESCRIPTOR_DP_KEY.
• EdgeRouter: Fixed rare node overlaps in conjunction with monotonic path restrictions.
• RecursiveGroupLayout: Fixed bug that caused edges to share the same port even though they should have been assigned to different ports. Note that this problem only appeared if the core layout algorithm was an instance of class HierarchicLayout.
• IsolatedGroupComponentLayout: Fixed bug that caused edge labels that intersected with group nodes even though option ComponentLayout.considerLabels was enabled.
• ComponentLayout , IsolatedGroupComponentLayout, and BusRouter: Fix a problem with rounding that could result in erroneous layouts in rare cases.

Documentation Viewer Improvements

• The detailed descriptions of the methods for event registration and de-registration were not displayed.
• The inheritance hierarchy of a type was not properly displayed.
• In the code generator, corrected the generated code for events.
• Fixed the display of the sidebar in pinned mode.
• The documentation viewer can now be opened from the file system even if third-party cookies are disabled.