Add missing changelog, test coverage, documentation for tooltip horizontal alignment

Author: tamasapps

CHANGELOG.md

@@ -2,6 +2,7 @@
 * **IMPROVEMENT** (by @imaNNeo) Remove assertion to check to provide only one of `color` or `gradient` property in the [BarChartRodData](https://github.com/imaNNeo/fl_chart/blob/master/repo_files/documentations/bar_chart.md#barchartroddata) and [BackgroundBarChartRodData](https://github.com/imaNNeo/fl_chart/blob/master/repo_files/documentations/bar_chart.md#backgroundbarchartroddata), #1121.
 * **IMPROVEMENT** (by @imaNNeo) Make `drawBehindEverything` property default to `true` in [AxisTitles](https://github.com/imaNNeo/fl_chart/blob/master/repo_files/documentations/base_chart.md#axistitle) class, #1097.
 * **BUGFIX** (by @imaNNeo) Show `0` instead of `-0` in some edge-cases in the default titles 
+* **FEATURE** (by @tamasapps): Add `tooltipAlignment` and `tooltipHorizontalOffset` property in [LineTouchTooltipData], [BarTouchTooltipData], [ScatterTouchTooltipData].
 
 ## 0.60.0
 * **IMPROVEMENT** (by @lsaudon) Replace flutter_lints by very_good_analysis

example/lib/presentation/samples/bar/bar_chart_sample1.dart

@@ -163,7 +163,7 @@ class BarChartSample1State extends State<BarChartSample1> {
  barTouchData: BarTouchData(
  touchTooltipData: BarTouchTooltipData(
  tooltipBgColor: Colors.blueGrey,
- tooltipAlign: FLTooltipAlign.right,
+ tooltipAlignment: FLHorizontalAlignment.right,
  tooltipMargin: -10,
  getTooltipItem: (group, groupIndex, rod, rodIndex) {
  String weekDay;

lib/src/chart/bar_chart/bar_chart_data.dart

@@ -700,7 +700,7 @@ class BarTouchTooltipData with EquatableMixin {
  double? tooltipRoundedRadius,
  EdgeInsets? tooltipPadding,
  double? tooltipMargin,
- FLTooltipAlign? tooltipAlign,
+ FLHorizontalAlignment? tooltipAlignment,
  double? tooltipHorizontalOffset,
  double? maxContentWidth,
  GetBarTooltipItem? getTooltipItem,
@@ -714,7 +714,7 @@ class BarTouchTooltipData with EquatableMixin {
  tooltipPadding = tooltipPadding ??
  const EdgeInsets.symmetric(horizontal: 16, vertical: 8),
  tooltipMargin = tooltipMargin ?? 16,
- tooltipAlign = tooltipAlign ?? FLTooltipAlign.center,
+ tooltipAlignment = tooltipAlignment ?? FLHorizontalAlignment.center,
  tooltipHorizontalOffset = tooltipHorizontalOffset ?? 0,
  maxContentWidth = maxContentWidth ?? 120,
  getTooltipItem = getTooltipItem ?? defaultBarTooltipItem,
@@ -738,7 +738,7 @@ class BarTouchTooltipData with EquatableMixin {
  final double tooltipMargin;
 
  /// Controls showing tooltip on left side, right side or center aligned with rod, default is center
- final FLTooltipAlign tooltipAlign;
+ final FLHorizontalAlignment tooltipAlignment;
 
  /// Applies horizontal offset for showing tooltip, default is zero.
  final double tooltipHorizontalOffset;
@@ -771,6 +771,8 @@ class BarTouchTooltipData with EquatableMixin {
  tooltipRoundedRadius,
  tooltipPadding,
  tooltipMargin,
+ tooltipAlignment,
+ tooltipHorizontalOffset,
  maxContentWidth,
  getTooltipItem,
  fitInsideHorizontally,

lib/src/chart/bar_chart/bar_chart_painter.dart

@@ -392,16 +392,16 @@ class BarChartPainter extends AxisChartPainter<BarChartData> {
  : barBottomY + tooltipData.tooltipMargin;
 
  double tooltipLeft;
- switch (tooltipData.tooltipAlign) {
- case FLTooltipAlign.center:
+ switch (tooltipData.tooltipAlignment) {
+ case FLHorizontalAlignment.center:
  tooltipLeft = barOffset.dx -
  (tooltipWidth / 2) +
  tooltipData.tooltipHorizontalOffset;
  break;
- case FLTooltipAlign.right:
+ case FLHorizontalAlignment.right:
  tooltipLeft = barOffset.dx + tooltipData.tooltipHorizontalOffset;
  break;
- case FLTooltipAlign.left:
+ case FLHorizontalAlignment.left:
  tooltipLeft =
  barOffset.dx - tooltipWidth + tooltipData.tooltipHorizontalOffset;
  break;

lib/src/chart/base/base_chart/base_chart_data.dart

@@ -191,14 +191,14 @@ abstract class BaseTouchResponse {
  BaseTouchResponse();
 }
 
-/// Controls showing tooltip horizontal alignment relative to the rod/spot.
-enum FLTooltipAlign {
- /// Tooltip shows horizontally center aligned with the rod/spot.
+/// Controls an element horizontal alignment to given point.
+enum FLHorizontalAlignment {
+ /// Element shown horizontally center aligned to a given point.
  center,
 
- /// Tooltip shows on the left side of the rod/spot.
+ /// Element shown on the left side of the given point.
  left,
 
- /// Tooltip shows on the right side of the rod/spot.
+ /// Element shown on the right side of the given point.
  right,
 }

lib/src/chart/line_chart/line_chart_data.dart

@@ -1292,7 +1292,7 @@ class LineTouchTooltipData with EquatableMixin {
  double? tooltipRoundedRadius,
  EdgeInsets? tooltipPadding,
  double? tooltipMargin,
- FLTooltipAlign? tooltipAlign,
+ FLHorizontalAlignment? tooltipAlignment,
  double? tooltipHorizontalOffset,
  double? maxContentWidth,
  GetLineTooltipItems? getTooltipItems,
@@ -1306,7 +1306,7 @@ class LineTouchTooltipData with EquatableMixin {
  tooltipPadding = tooltipPadding ??
  const EdgeInsets.symmetric(horizontal: 16, vertical: 8),
  tooltipMargin = tooltipMargin ?? 16,
- tooltipAlign = tooltipAlign ?? FLTooltipAlign.center,
+ tooltipAlignment = tooltipAlignment ?? FLHorizontalAlignment.center,
  tooltipHorizontalOffset = tooltipHorizontalOffset ?? 0,
  maxContentWidth = maxContentWidth ?? 120,
  getTooltipItems = getTooltipItems ?? defaultLineTooltipItem,
@@ -1330,7 +1330,7 @@ class LineTouchTooltipData with EquatableMixin {
  final double tooltipMargin;
 
  /// Controls showing tooltip on left side, right side or center aligned with spot, default is center
- final FLTooltipAlign tooltipAlign;
+ final FLHorizontalAlignment tooltipAlignment;
 
  /// Applies horizontal offset for showing tooltip, default is zero.
  final double tooltipHorizontalOffset;
@@ -1363,6 +1363,8 @@ class LineTouchTooltipData with EquatableMixin {
  tooltipRoundedRadius,
  tooltipPadding,
  tooltipMargin,
+ tooltipAlignment,
+ tooltipHorizontalOffset,
  maxContentWidth,
  getTooltipItems,
  fitInsideHorizontally,

lib/src/chart/line_chart/line_chart_painter.dart

@@ -1038,16 +1038,16 @@ class LineChartPainter extends AxisChartPainter<LineChartData> {
  }
 
  double tooltipLeft;
- switch (tooltipData.tooltipAlign) {
- case FLTooltipAlign.center:
+ switch (tooltipData.tooltipAlignment) {
+ case FLHorizontalAlignment.center:
  tooltipLeft = mostTopOffset.dx -
  (tooltipWidth / 2) +
  tooltipData.tooltipHorizontalOffset;
  break;
- case FLTooltipAlign.right:
+ case FLHorizontalAlignment.right:
  tooltipLeft = mostTopOffset.dx + tooltipData.tooltipHorizontalOffset;
  break;
- case FLTooltipAlign.left:
+ case FLHorizontalAlignment.left:
  tooltipLeft = mostTopOffset.dx -
  tooltipWidth +
  tooltipData.tooltipHorizontalOffset;

lib/src/chart/scatter_chart/scatter_chart_data.dart

@@ -398,7 +398,7 @@ class ScatterTouchTooltipData with EquatableMixin {
  Color? tooltipBgColor,
  double? tooltipRoundedRadius,
  EdgeInsets? tooltipPadding,
- FLTooltipAlign? tooltipAlign,
+ FLHorizontalAlignment? tooltipAlignment,
  double? tooltipHorizontalOffset,
  double? maxContentWidth,
  GetScatterTooltipItems? getTooltipItems,
@@ -410,7 +410,7 @@ class ScatterTouchTooltipData with EquatableMixin {
  tooltipRoundedRadius = tooltipRoundedRadius ?? 4,
  tooltipPadding = tooltipPadding ??
  const EdgeInsets.symmetric(horizontal: 16, vertical: 8),
- tooltipAlign = tooltipAlign ?? FLTooltipAlign.center,
+ tooltipAlignment = tooltipAlignment ?? FLHorizontalAlignment.center,
  tooltipHorizontalOffset = tooltipHorizontalOffset ?? 0,
  maxContentWidth = maxContentWidth ?? 120,
  getTooltipItems = getTooltipItems ?? defaultScatterTooltipItem,
@@ -430,7 +430,7 @@ class ScatterTouchTooltipData with EquatableMixin {
  final EdgeInsets tooltipPadding;
 
  /// Controls showing tooltip on left side, right side or center aligned with spot, default is center
- final FLTooltipAlign tooltipAlign;
+ final FLHorizontalAlignment tooltipAlignment;
 
  /// Applies horizontal offset for showing tooltip, default is zero.
  final double tooltipHorizontalOffset;
@@ -459,6 +459,8 @@ class ScatterTouchTooltipData with EquatableMixin {
  tooltipBgColor,
  tooltipRoundedRadius,
  tooltipPadding,
+ tooltipAlignment,
+ tooltipHorizontalOffset,
  maxContentWidth,
  getTooltipItems,
  fitInsideHorizontally,
@@ -473,6 +475,8 @@ class ScatterTouchTooltipData with EquatableMixin {
  Color? tooltipBgColor,
  double? tooltipRoundedRadius,
  EdgeInsets? tooltipPadding,
+ FLHorizontalAlignment? tooltipAlignment,
+ double? tooltipHorizontalOffset,
  double? maxContentWidth,
  GetScatterTooltipItems? getTooltipItems,
  bool? fitInsideHorizontally,
@@ -484,6 +488,9 @@ class ScatterTouchTooltipData with EquatableMixin {
  tooltipBgColor: tooltipBgColor ?? this.tooltipBgColor,
  tooltipRoundedRadius: tooltipRoundedRadius ?? this.tooltipRoundedRadius,
  tooltipPadding: tooltipPadding ?? this.tooltipPadding,
+ tooltipAlignment: tooltipAlignment ?? this.tooltipAlignment,
+ tooltipHorizontalOffset:
+ tooltipHorizontalOffset ?? this.tooltipHorizontalOffset,
  maxContentWidth: maxContentWidth ?? this.maxContentWidth,
  getTooltipItems: getTooltipItems ?? this.getTooltipItems,
  fitInsideHorizontally:

lib/src/chart/scatter_chart/scatter_chart_painter.dart

@@ -1,7 +1,6 @@
 import 'package:fl_chart/fl_chart.dart';
 import 'package:fl_chart/src/chart/base/axis_chart/axis_chart_painter.dart';
 import 'package:fl_chart/src/chart/base/base_chart/base_chart_painter.dart';
-import 'package:fl_chart/src/chart/scatter_chart/scatter_chart_data.dart';
 import 'package:fl_chart/src/utils/canvas_wrapper.dart';
 import 'package:fl_chart/src/utils/utils.dart';
 import 'package:flutter/material.dart';
@@ -252,16 +251,16 @@ class ScatterChartPainter extends AxisChartPainter<ScatterChartData> {
  final tooltipHeight = height + tooltipData.tooltipPadding.vertical;
 
  double tooltipLeft;
- switch (tooltipData.tooltipAlign) {
- case FLTooltipAlign.center:
+ switch (tooltipData.tooltipAlignment) {
+ case FLHorizontalAlignment.center:
  tooltipLeft = mostTopOffset.dx -
  (tooltipWidth / 2) +
  tooltipData.tooltipHorizontalOffset;
  break;
- case FLTooltipAlign.right:
+ case FLHorizontalAlignment.right:
  tooltipLeft = mostTopOffset.dx + tooltipData.tooltipHorizontalOffset;
  break;
- case FLTooltipAlign.left:
+ case FLHorizontalAlignment.left:
  tooltipLeft = mostTopOffset.dx -
  tooltipWidth +
  tooltipData.tooltipHorizontalOffset;

repo_files/documentations/bar_chart.md

@@ -99,6 +99,8 @@ enum values {`start`, `end`, `center`, `spaceEvenly`, `spaceAround`, `spaceBetwe
  |tooltipRoundedRadius|background corner radius of the tooltip bubble|4|
  |tooltipPadding|padding of the tooltip|EdgeInsets.symmetric(horizontal: 16, vertical: 8)|
  |tooltipMargin|margin between the tooltip and the touched spot|16|
+ |tooltipAlignment|horizontal alginment of tooltip relative to the bar|FLHorizontalAlignment.center|
+ |tooltipHorizontalOffset|horizontal offset of tooltip|0|
  |maxContentWidth|maximum width of the tooltip (if a text row is wider than this, then the text breaks to a new line|120|
  |getTooltipItems|a callback that retrieve [BarTooltipItem](#BarTooltipItem) by the given [BarChartGroupData](#BarChartGroupData), groupIndex, [BarChartRodData](#BarChartRodData) and rodIndex |defaultBarTooltipItem|
  |fitInsideHorizontally| forces tooltip to horizontally shift inside the chart's bounding box| false|