Skip to content

Commit 9a4d7d8

Browse files
committed
adds note about breaking changes to migration guide
1 parent 0cfbb7e commit 9a4d7d8

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/guide/migrationV2.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,10 @@
11
# 2.x Migration guide
2+
3+
`chartjs-plugin-annotation` plugin version 2 introduces a number of breaking changes. In order to improve performance, offer new features, and improve maintainability, it was necessary to break backwards compatibility, but we aimed to do so only when worth the benefit.
4+
5+
## Options
6+
7+
A number of changes were made to the configuration options passed to the plugin configuration. Those changes are documented below.
8+
9+
* `xScaleID` option default has been changed, now set to `undefined`. If the option is missing, the plugin will try to use the first scale of the chart, configured as `'x'` axis. If more than one scale has been defined in the chart as `'x'` axis, the option is mandatory to select the right scale.
10+
* `yScaleID` option default has been changed, now set to `undefined`. If the option is missing, the plugin will try to use the first scale of the chart, configured as `'y'` axis. If more than one scale has been defined in the chart as `'y'` axis, the option is mandatory to select the right scale.

0 commit comments

Comments
 (0)