Mirrors/Chart.js
1
0
Fork 0
mirror of https://github.com/chartjs/Chart.js.git synced 2024-10-06 12:19:08 +02:00
Code Issues Packages Projects Releases Wiki Activity
83a41c2e0c
Chart.js/docs/migration/v4-migration.md
Dan Onoshko 0c51ecd451
fix: respect aspect ratio with container height (#10646) 
* fix: respect aspect ratio with container height

* docs: add info into migration guide
2022-09-02 08:03:41 -04:00

2.1 KiB
Raw Blame History

4.x Migration Guide

Chart.js 4.0 introduces a number of breaking changes. We tried keeping the amount of breaking changes to a minimum. For some features and bug fixes it was necessary to break backwars compatibility, but we aimed to do so only when worth the benefit.

End user migration

Charts

  • Charts don't override the default tooltip callbacks, so all chart types have the same-looking tooltips.
  • Default scale override has been removed if the configured scale starts with x/y. Defining xAxes in your config will now create a second scale instead of overriding the default x axis.

Options

A number of changes were made to the configuration options passed to the Chart constructor. Those changes are documented below.

Specific changes

  • The radialLinear grid indexable and scriptable options don't decrease the index of the specified grid line anymore.
  • The destroy plugin hook has been removed and replaced with afterDestroy.
  • Ticks callback on time scale now receives timestamp instead of a formatted label.
  • scales[id].grid.drawBorder has been renamed to scales[id].border.display.
  • scales[id].grid.borderWidth has been renamed to scales[id].border.width.
  • scales[id].grid.borderColor has been renamed to scales[id].border.color.
  • scales[id].grid.borderDash has been renamed to scales[id].border.dash.
  • scales[id].grid.borderDashOffset has been renamed to scales[id].border.dashOffset.
  • The z index for the border of a scale is now configurable instead of being 1 higher as the grid z index.
  • Linear scales now add and subtracts 5% of the max value to the range if the min and max are the same instead of 1.
  • If the tooltip callback returns undefined, then the default callback will be used.
  • maintainAspectRatio respects container height.

Type changes

  • The order of the ChartMeta parameters have been changed from <Element, DatasetElement, Type> to <Type, Element, DatasetElement>.

General

  • Removed fallback to fontColor for the legend text and strikethrough color.
  • Removed config._chart fallback for this.chart in the filler plugin.
  • Removed this._chart in the filler plugin.