Migration Tool

When upgrading yFiles for HTML to a newer major version, it is usually not a drop-in replacement. There are major breaking API changes that will make your current code not work with the new library. However, porting your code is feasible and our automatic source code conversion tool can assist you with this task and will reduce the time you’ll need to migrate your code. It is available from our GitHub page: https://github.com/yWorks/migrate-yfiles-app. The tool works on JavaScript, as well as TypeScript files.

The migration tool analyzes the yFiles API usages in your code. Usages of yFiles API that have changed but have a direct replacement in the new version will be changed automatically. Other usages will be output to your console with suggested changes to help you getting familiar with the new API.

Please visit the GitHub page for detailed usage instructions.

The tool will be updated in parallel to new releases. Please tell us if you find that it could work better for your use-case. Your feedback helps us improving the tool.

The remainder of this chapter gives an overview of the design and API changes and describes the changes in detail subsequently.