When we announce that a version of KeyLines, API, platform, database or framework is deprecated, it means that we intend to end support for it in the future and recommend that you stop using it now. For more details, see Deprecation Process.

For a list of supported devices, operating systems and browsers, see Compatibility & Supported Platforms. To share your feedback, contact [email protected].

Notice: End of support for Windows 10

• We are planning to end support for Windows 10 from 31 March 2026, following Microsoft ending support for Windows 10.

Deprecated APIs

• The KeyLines.getFontIcon() function is deprecated and should not be used. Instead, you can set the font icons directly in the t option on the fi property. Set the font icons directly also when using imageAlignment option.

Deprecated APIs

• The b option for glyphs is deprecated and should not be used. To achieve an identical effect, set the colour option in the border property.

Deprecated APIs

• Bubbles are now deprecated and should not be used. To achieve the same, and more, use annotations instead.
• The chart.toDataURL() function is now deprecated and should not be used. Use chart.export() instead.

Notice: Retirement of KeyLines 5.10 LTA and 6.13.1 LTA

• We have deprecated KeyLines version 5.10 LTA, which means that from 1 October 2025 this version will no longer be available and support for this version will end.
• We have also deprecated KeyLines version 6.13.1 LTA, which means that from 1 March 2026 this version will no longer be available and support for this version will end.

If you are using this version, we strongly recommend upgrading to the latest version so that you can make use of the full features of KeyLines.

Removed APIs

The following previously deprecated APIs have now been removed and are no longer supported:

• bind() events, deprecated since 6.0: replaced with on() events.

• The tidy option in chart.layout(), deprecated since 6.0: use packing instead.

• The dragPan chart option, deprecated since 5.5: use panAtBoundary instead.

• The element argument of KeyLines.create(), deprecated since 5.3: use container instead.

• The KeyLines.setSize() function, deprecated since 5.3: no longer needed when specifying a container in KeyLines.create().

• The du property on nodes, deprecated since 5.3: no longer used.

• The chart.getLastError() function, deprecated since 5.0: no longer relevant with the removal of bind and unbind events.

• The assets option for KeyLines.paths(), deprecated since 5.0: no longer used.

• The KeyLines.dashedLineSupport() function, deprecated in 4.8: no longer applicable to any supported browsers.

• chart.bind() and chart.unbind(): use chart.on() and chart.off() instead, see Chart Events.

• timebar.bind() and timebar.unbind(): use timebar.on() and timebar.off() instead, see Time Bar Events.

Deprecated APIs

• The path option for links in chart.options() is deprecated and should not be used. To achieve an identical effect, you can use the linkShape option in chart.layout().

Deprecated APIs

• The standard layout has been deprecated. Organic is now the new default layout.
• The tweak layout has been deprecated. Use the organic layout with mode set to 'adaptive' instead.
• The tc option has been deprecated. To position your label, nest your label inside a Node Label object and set the position option instead, e.g:

t:
{
t: 'Label',
position: 's'
}

Removing shapes from public API

We've removed shape nodes from the public API and deprecated the related APIs:

• The chart.contains() function has been deprecated.
• The re option has been deprecated.

Instead of using shape nodes, we strongly recommend using rectangular combos and rectangular nodes. See also Breaking Changes for more information.

Removing callbacks from async functions in KeyLines

We've removed callbacks for asynchronous functions in KeyLines and removed the related API:

• The KeyLines.promisify() function has been removed from the API and Typescript.

Instead of using callbacks, we strongly recommend using promises. See also Breaking Changes for more information.

Notice: Retirement of KeyLines 4.8 LTA

We have deprecated KeyLines version 4.8 LTA, which means that from 1st November 2022 this version will no longer be available and support for this version will end.

If you are using this version, we strongly recommend upgrading to the latest version so that you can make use of the full features of KeyLines.

Notice: End of support for Internet Explorer 11

We intend to end support for Internet Explorer 11 from 31 October 2021.

For a list of supported devices, operating systems and browsers, see Compatibility & Supported Platforms.

Deprecated APIs

• The tidy option in chart.layout() has been deprecated and should not be used. Use the packing option instead.

Events system deprecated

We've implemented a new events system that better matches native DOM events. As a result, the old events system has been deprecated. Although you will be able to continue to use the chart.bind() events for the full lifecycle of KeyLines 6.x, we recommend you consider migrating to chart.on().

• chart.bind() and chart.unbind() have been deprecated. Use chart.on() and chart.off() instead.
• timebar.bind() and timebar.unbind() have been deprecated. Use timebar.on() and timebar.off() instead.
• All events used by bind() have now been deprecated and replaced with new events used by on(). See the Chart Events API or the Time Bar Events API for more details.

Deprecated APIs

• The element argument of KeyLines.create() has been replaced with the container argument to improve life cycle management.
• KeyLines.setSize() is no longer necessary when specifying a container in KeyLines.create() and should not be used. See Resizing a Chart for more information.

Deprecated APIs

• The du property on nodes is deprecated and should not be used. To achieve an identical effect you can change node styles and bind to our drag events instead.

Deprecated APIs

• KeyLines.dashedLineSupport() is no longer necessary and should not be called. By default, you can now use dashed line drawing in all our supported browsers.
• KeyLines.charts() should not be used. Use KeyLines.components() instead.
• KeyLines.createChart() should not be used. Use KeyLines.create() instead.
• KeyLines.imageBasePath() and KeyLines.setCanvasPaths() should not be used. Use KeyLines.paths() to set image paths. KeyLines 5.0 and later doesn't require a specified assets path.
• chart.chartType() always returns 'LinkChart' and should no longer be used.
• chart.getLastError() should not be used. To handle errors trapped by other event handlers, bind to the error event instead.
• chart.displayOptions() and chart.interactionOptions() should not be used. Use chart.options() instead.