From 526c16a604dfe72532d6352f62833845ece5e579 Mon Sep 17 00:00:00 2001 From: Xavier H Date: Thu, 28 Mar 2024 22:32:33 +0100 Subject: [PATCH] Add migration guide --- .../0.67.0/MIGRATION_00_67_00.md | 85 +++++++++++++++++++ .../documentations/migration_guides/INDEX.md | 4 +- 2 files changed, 88 insertions(+), 1 deletion(-) create mode 100644 repo_files/documentations/migration_guides/0.67.0/MIGRATION_00_67_00.md diff --git a/repo_files/documentations/migration_guides/0.67.0/MIGRATION_00_67_00.md b/repo_files/documentations/migration_guides/0.67.0/MIGRATION_00_67_00.md new file mode 100644 index 000000000..9ece3775a --- /dev/null +++ b/repo_files/documentations/migration_guides/0.67.0/MIGRATION_00_67_00.md @@ -0,0 +1,85 @@ +# Migrate to new version + +## Replaced tooltipBgColor + +**Breaking: [#1595](https://github.com/imaNNeo/fl_chart/pull/1595)** + +We added the ability to customize the tooltip background color for each point. + +The property `Color tooltipBgColor` from Bar, Line and Scatter Charts is replaced with a callback `Color Function(spot) getTooltipColor` + +#### BarChartData + +Previously: +```dart +BarChartData( + barTouchData: BarTouchData( + touchTooltipData: BarTouchTooltipData( + tooltipBgColor: Colors.blueGrey, + ) + ) +) +``` + +Now in new version: + +```dart +BarChartData( + barTouchData: BarTouchData( + touchTooltipData: BarTouchTooltipData( + getTooltipColor: (BarChartGroupData group) => Colors.blueGrey, + ) + ) +) +``` + +#### LineChartData + +Previously: +```dart +LineChartData( + lineTouchData: LineTouchData( + touchTooltipData: LineTouchTooltipData( + tooltipBgColor: Colors.blueGrey, + ) + ) +) +``` + +Now in new version: + +```dart +LineChartData( + lineTouchData: LineTouchData( + touchTooltipData: LineTouchTooltipData( + getTooltipColor: (LineBarSpot touchedSpot) => Colors.blueGrey, + ) + ) +) +``` + +#### ScatterChartData + +Previously: +```dart +ScatterChartData( + scatterTouchData: ScatterTouchData( + touchTooltipData: ScatterTouchTooltipData( + tooltipBgColor: Colors.blueGrey, + ) + ) +) +``` + +Now in new version: + +```dart +ScatterChartData( + scatterTouchData: ScatterTouchData( + touchTooltipData: ScatterTouchTooltipData( + getTooltipColor: (ScatterSpot touchedBarSpot) => Colors.blueGrey, + ) + ) +) +``` + diff --git a/repo_files/documentations/migration_guides/INDEX.md b/repo_files/documentations/migration_guides/INDEX.md index c9a6df6c8..026e7eeec 100644 --- a/repo_files/documentations/migration_guides/INDEX.md +++ b/repo_files/documentations/migration_guides/INDEX.md @@ -2,4 +2,6 @@ Here are fl_chart's migration guides: #### [Migrate to 0.50.0](https://github.com/imaNNeo/fl_chart/blob/main/repo_files/documentations/migration_guides/0.50.0/MIGRATION_00_50_00.md) -#### [Migrate to 0.55.0](https://github.com/imaNNeo/fl_chart/blob/main/repo_files/documentations/migration_guides/0.55.0/MIGRATION_00_55_00.md) \ No newline at end of file +#### [Migrate to 0.55.0](https://github.com/imaNNeo/fl_chart/blob/main/repo_files/documentations/migration_guides/0.55.0/MIGRATION_00_55_00.md) + +#### [Migrate to 0.67.0](https://github.com/imaNNeo/fl_chart/blob/main/repo_files/documentations/migration_guides/0.67.0/MIGRATION_00_67_00.md) \ No newline at end of file