During Development
We suggest using a modern IDE with support for the web platform, such as JetBrains WebStorm, JetBrains IntelliJ IDEA, Microsoft Visual Studio Code, or Microsoft Visual Studio.
The Getting Started chapter has detailed descriptions and tips for developing with yFiles for HTML in these IDEs.
To run the demo server included in the package, Node.js version 18 or newer and npm version 10 or newer are required.
The default heap size limit for Node is 4GB. While this is sufficient for most cases, some toolkit demos may require a larger heap size.To permanently set a specific value, use the following commands in PowerShell on Windows:
[Environment]::SetEnvironmentVariable("NODE_OPTIONS", "--max-old-space-size=8192","User")~/.bashrc:export NODE_OPTIONS=--max-old-space-size=8192TypeScript Typings
The TypeScript type definitions included with yFiles for HTML require at least TypeScript version 5.0.
Deployed Applications
Running yFiles for HTML applications, including the provided demo applications, requires a common, standards-compliant browser. These include Chrome, Safari, Firefox, and Edge on Windows, macOS, iOS, and Android operating systems.
The demos included in the yFiles for HTML package make use of modern ECMAScript features for developer convenience.
Supported Browsers
At the time of this release, this version of yFiles for HTML has been tested with the following browsers:
- Google Chrome 110 and newer
- Mozilla Firefox 115 and newer
- Apple Safari 16 and newer
- Microsoft Edge 110 and newer
In general, yFiles for HTML works in all common, standards-compliant browsers.
The WebGL-based features of the library work on all modern browsers with WebGL support. WebGL performance depends strongly on good driver support from the OS, and there may be minor rendering artifacts on older devices and browsers. More details and known issues for WebGL rendering are listed in the WebGL section.
Server-Side Requirements
Since yFiles for HTML runs exclusively on the client side, for example, in a web browser, there are no special server-side requirements. Any solution that can deliver JavaScript to a web browser is sufficient to run yFiles for HTML applications. For instance, any web server that can serve content over HTTPS will work.