FL Chart

https://pub.dev/documentation/fl_chart/latest/
Admin
FL Chart is a highly customizable Flutter chart library that supports Line Chart, Bar Chart, Pie...
Tokens:204,808
Snippets:1,819
Trust Score:9.9
Update:15 hours ago
Show doc for...
Tokens:
Raw
### defaultGetTouchLineStart

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/

Default implementation for the touch line start.

```APIDOC
## Function: defaultGetTouchLineStart

### Description
Default implementation for the touch line start.

### Signature
`double defaultGetTouchLineStart(LineChartBarData barData, int spotIndex)`

### Parameters
- **barData** (LineChartBarData) - The line chart bar data.
- **spotIndex** (int) - The index of the spot.

### Returns
- **double** - The start value of the touch line.
```

--------------------------------

### defaultGetTouchLineStart implementation

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/defaultGetTouchLineStart.html

Returns -double.infinity by default, indicating the line starts from the bottom of the chart.

```dart
double defaultGetTouchLineStart(LineChartBarData barData, int spotIndex) {
  return -double.infinity;
}
```

--------------------------------

### defaultGetTouchLineStart

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/defaultGetTouchLineStart.html

Returns the default touch line start position for a line chart. By default, the line starts from the bottom of the chart, so this function returns negative infinity.

```APIDOC
## defaultGetTouchLineStart

### Description
Returns the default touch line start position for a line chart. By default, the line starts from the bottom of the chart, so this function returns negative infinity.

### Function Signature
```dart
double defaultGetTouchLineStart(LineChartBarData barData, int spotIndex)
```

### Parameters
- **barData** (LineChartBarData) - Required - The line chart bar data.
- **spotIndex** (int) - Required - The index of the spot.

### Return Value
- **double** - The default touch line start position, which is `-double.infinity`.

### Implementation
```dart
double defaultGetTouchLineStart(LineChartBarData barData, int spotIndex) {
  return -double.infinity;
}
```
```

--------------------------------

### showingSpots property

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/ShowingTooltipIndicators-class.html

Gets the list of LineBarSpot objects that determine the spots where each tooltip should be shown.

```APIDOC
## showingSpots property

### Description
Determines the spots that each tooltip should be shown. This is a final property that is set during construction.

### Type
`List<LineBarSpot>`

### Access
Read-only (final)

### Example
```dart
final spots = showingTooltipIndicators.showingSpots;
```
```

--------------------------------

### Load SVG and create SizedPicture

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/SizedPicture-class.html

Example of loading an SVG string and creating a SizedPicture with width and height 14. Uses the vector_graphics library's svg.fromSvgString and DrawableRoot.

```dart
Future<SizedPicture> loadSvg() async {
   const String rawSvg = 'your svg string';
   final DrawableRoot svgRoot = await svg.fromSvgString(rawSvg, rawSvg);
   final sizedPicture = SizedPicture(svgRoot.toPicture(), 14, 14);
   return sizedPicture;
 }
```

--------------------------------

### FlLongPressStart constructor

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/FlLongPressStart-class.html

Creates a FlLongPressStart instance with the given LongPressStartDetails.

```APIDOC
## FlLongPressStart(LongPressStartDetails details)

### Description
Creates a FlLongPressStart instance with the given LongPressStartDetails.

### Constructor
FlLongPressStart(LongPressStartDetails details)

### Parameters
- **details** (LongPressStartDetails) - Required - Contains information of happened touch gesture.

### Properties
- **details** (LongPressStartDetails) - final - Contains information of happened touch gesture.
- **localPosition** (Offset) - override - Represents the position of happened touch/pointer event.
- **isInterestedForInteractions** (bool) - inherited - Excludes exit or up events to show interactions on charts.

```

--------------------------------

### hitTest(FlSpot spot, Offset touched, Offset center, double extraThreshold) → bool

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/FlDotPainter-class.html

Used to implement touch behaviour of this dot. For example, it behaves like a square of getSize. Check FlDotCirclePainter.hitTest for an example of an implementation.

```APIDOC
## hitTest(FlSpot spot, Offset touched, Offset center, double extraThreshold) → bool

### Description
Used to implement touch behaviour of this dot, for example, it behaves like a square of getSize. Check FlDotCirclePainter.hitTest for an example of an implementation.

### Method
bool hitTest(FlSpot spot, Offset touched, Offset center, double extraThreshold)

### Parameters
- **spot** (FlSpot) - Required - The spot data of the dot.
- **touched** (Offset) - Required - The touched position.
- **center** (Offset) - Required - The center of the dot.
- **extraThreshold** (double) - Required - An extra threshold for hit testing.

### Return Value
bool - Whether the touch is within the dot.
```

--------------------------------

### BarAreaSpotsLine constructor

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/BarAreaSpotsLine-class.html

Creates a BarAreaSpotsLine instance with optional parameters to control the display and styling of lines on spots.

```APIDOC
## BarAreaSpotsLine({bool show = false, FlLine flLineStyle = const FlLine(), CheckToShowSpotLine checkToShowSpotLine = showAllSpotsBelowLine, bool applyCutOffY = true})

### Description
If `show` is true, LineChart draws some lines on above or below the spots, you can customize the appearance of the lines using `flLineStyle` and you can decide to show or hide the lines on each spot using `checkToShowSpotLine`.

### Parameters
- **show** (bool) - Optional - Determines to show or hide all the lines. Defaults to `false`.
- **flLineStyle** (FlLine) - Optional - Holds appearance of drawing line on the spots. Defaults to `const FlLine()`.
- **checkToShowSpotLine** (CheckToShowSpotLine) - Optional - Checks to show or hide lines on the spots. Defaults to `showAllSpotsBelowLine`.
- **applyCutOffY** (bool) - Optional - Determines to inherit the cutOff properties from its parent BarAreaData. Defaults to `true`.
```

--------------------------------

### GetTitleWidgetFunction

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/

It gives you the axis value and gets a String value based on it.

```APIDOC
## GetTitleWidgetFunction

### Description
It gives you the axis value and gets a String value based on it.

### Signature
`Widget Function(double value, TitleMeta meta)`

### Parameters
- **value** (double) - The axis value.
- **meta** (TitleMeta) - The title metadata.

### Returns
- **Widget** - The widget to display as the title.
```

--------------------------------

### ScatterLabelSettings.getLabelFunction

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/ScatterLabelSettings-class.html

Gets the function that returns the label for a given spot index.

```APIDOC
## getLabelFunction → GetLabelFunction

### Description
This function gives you the index value of the spot in the list and returns the label.

### Type
GetLabelFunction

### Remarks
This property is final.
```

--------------------------------

### FlGridData constructor

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/FlGridData-class.html

Creates a FlGridData instance to configure grid lines. The `show` parameter determines whether all grids are visible. Other parameters control horizontal and vertical line drawing, intervals, and custom line drawing/showing callbacks.

```APIDOC
## FlGridData constructor

### Description
Creates a FlGridData instance to configure grid lines. The `show` parameter determines whether all grids are visible. Other parameters control horizontal and vertical line drawing, intervals, and custom line drawing/showing callbacks.

### Constructor
`FlGridData({bool show = true, bool drawHorizontalLine = true, double? horizontalInterval, GetDrawingGridLine getDrawingHorizontalLine = defaultGridLine, CheckToShowGrid checkToShowHorizontalLine = showAllGrids, bool drawVerticalLine = true, double? verticalInterval, GetDrawingGridLine getDrawingVerticalLine = defaultGridLine, CheckToShowGrid checkToShowVerticalLine = showAllGrids})`

### Parameters
- **show** (bool) - Optional - Determines showing or hiding all grids. Defaults to `true`.
- **drawHorizontalLine** (bool) - Optional - Whether to draw horizontal grid lines. Defaults to `true`.
- **horizontalInterval** (double?) - Optional - Interval for horizontal grid lines.
- **getDrawingHorizontalLine** (GetDrawingGridLine) - Optional - Callback to customize horizontal line drawing. Defaults to `defaultGridLine`.
- **checkToShowHorizontalLine** (CheckToShowGrid) - Optional - Callback to determine whether to show a horizontal line. Defaults to `showAllGrids`.
- **drawVerticalLine** (bool) - Optional - Whether to draw vertical grid lines. Defaults to `true`.
- **verticalInterval** (double?) - Optional - Interval for vertical grid lines.
- **getDrawingVerticalLine** (GetDrawingGridLine) - Optional - Callback to customize vertical line drawing. Defaults to `defaultGridLine`.
- **checkToShowVerticalLine** (CheckToShowGrid) - Optional - Callback to determine whether to show a vertical line. Defaults to `showAllGrids`.

### Remarks
This constructor is `const`.
```

--------------------------------

### begin property

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/CandlestickChartDataTween-class.html

The value this variable has at the beginning of the animation. Inherited from Tween.

```APIDOC
## begin ↔ CandlestickChartData?

### Description
The value this variable has at the beginning of the animation. Inherited from Tween.

### Type
CandlestickChartData? (nullable)

### Getter/Setter
This property is a getter/setter pair, inherited from Tween.
```

--------------------------------

### touchLocation property (inherited)

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/AxisBaseTouchResponse-class.html

Gets the location of the touch in pixels on the screen.

```APIDOC
## touchLocation → Offset

### Description
The location of the touch in pixels on the screen.

### Type
Offset

### Attributes
final, inherited
```

--------------------------------

### BarTouchResponse constructor

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/BarTouchResponse-class.html

Creates a BarTouchResponse instance with the required touch location, chart coordinate, and spot.

```APIDOC
## BarTouchResponse({required Offset touchLocation, required Offset touchChartCoordinate, required BarTouchedSpot? spot})

### Description
If touch happens, BarChart processes it internally and passes out a BarTouchedSpot that contains a `spot`, it gives you information about the touched spot.

### Parameters
- **touchLocation** (Offset) - Required - The location of the touch in pixels on the screen.
- **touchChartCoordinate** (Offset) - Required - The axis coordinate of the touch in chart's coordinate system.
- **spot** (BarTouchedSpot?) - Required - Gives information about the touched spot.
```

--------------------------------

### ScatterLabelSettings.getLabelTextStyleFunction

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/ScatterLabelSettings-class.html

Gets the function that returns the text style for a given spot index.

```APIDOC
## getLabelTextStyleFunction → GetLabelTextStyleFunction

### Description
This function gives you the index value of the spot in the list and returns the text style.

### Type
GetLabelTextStyleFunction

### Remarks
This property is final.
```

--------------------------------

### BaseTouchResponse constructor

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/BaseTouchResponse-class.html

Creates a BaseTouchResponse instance with the required touch location.

```APIDOC
## BaseTouchResponse({required Offset touchLocation})

### Description
Creates a BaseTouchResponse instance with the required touch location.

### Parameters
- **touchLocation** (Offset) - Required - The location of the touch in pixels on the screen.

### Example
```dart
BaseTouchResponse(
  touchLocation: Offset(100, 200),
);
```
```

--------------------------------

### LineTouchTooltipData constructor

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/LineTouchTooltipData-class.html

Creates a LineTouchTooltipData instance with configurable properties for tooltip styling and behavior.

```APIDOC
## LineTouchTooltipData constructor

### Description
Creates a LineTouchTooltipData instance that holds representation data for showing a tooltip popup on top of spots in a LineChart. The tooltip appears automatically when touch happens if LineTouchData.handleBuiltInTouches is true, otherwise it can be shown manually using LineChartData.showingTooltipIndicators.

### Constructor
`LineTouchTooltipData({BorderRadius? tooltipBorderRadius, EdgeInsets tooltipPadding = const EdgeInsets.symmetric(horizontal: 16, vertical: 8), double tooltipMargin = 16, FLHorizontalAlignment tooltipHorizontalAlignment = FLHorizontalAlignment.center, double tooltipHorizontalOffset = 0, double maxContentWidth = 120, GetLineTooltipItems getTooltipItems = defaultLineTooltipItem, GetLineTooltipColor getTooltipColor = defaultLineTooltipColor, bool fitInsideHorizontally = false, bool fitInsideVertically = false, bool showOnTopOfTheChartBoxArea = false, double rotateAngle = 0.0, BorderSide tooltipBorder = BorderSide.none})`

### Parameters
- **tooltipBorderRadius** (BorderRadius?) - Optional - The corner radius of the tooltip.
- **tooltipPadding** (EdgeInsets) - Optional - Padding inside the tooltip. Defaults to `const EdgeInsets.symmetric(horizontal: 16, vertical: 8)`.
- **tooltipMargin** (double) - Optional - Bottom margin of the tooltip. Defaults to `16`.
- **tooltipHorizontalAlignment** (FLHorizontalAlignment) - Optional - Horizontal alignment of the tooltip. Defaults to `FLHorizontalAlignment.center`.
- **tooltipHorizontalOffset** (double) - Optional - Horizontal offset of the tooltip. Defaults to `0`.
- **maxContentWidth** (double) - Optional - Maximum width of the tooltip content. Defaults to `120`.
- **getTooltipItems** (GetLineTooltipItems) - Optional - Callback to provide custom tooltip items. Defaults to `defaultLineTooltipItem`.
- **getTooltipColor** (GetLineTooltipColor) - Optional - Callback to provide the tooltip background color. Defaults to `defaultLineTooltipColor`.
- **fitInsideHorizontally** (bool) - Optional - If true, forces the tooltip to shift inside the chart horizontally. Defaults to `false`.
- **fitInsideVertically** (bool) - Optional - If true, forces the tooltip to shift inside the chart vertically. Defaults to `false`.
- **showOnTopOfTheChartBoxArea** (bool) - Optional - If true, shows the tooltip on top of the chart box area. Defaults to `false`.
- **rotateAngle** (double) - Optional - Rotation angle of the tooltip. Defaults to `0.0`.
- **tooltipBorder** (BorderSide) - Optional - Border of the tooltip. Defaults to `BorderSide.none`.

### Usage
This constructor is used to configure the tooltip appearance and behavior for a LineChart. The tooltip shows on top of rods with the background color from `getTooltipColor`. The content is provided via the `getTooltipItems` callback. The tooltip can be constrained in width using `maxContentWidth` and can be forced to fit inside the chart using `fitInsideHorizontally` and `fitInsideVertically`.
```

--------------------------------

### verticalRangeAnnotations property

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/RangeAnnotations-class.html

Gets the list of vertical range annotations. This property is final and read-only.

```APIDOC
## verticalRangeAnnotations property

### Description
Gets the list of vertical range annotations. This property is final and read-only.

### Property
List<VerticalRangeAnnotation> get verticalRangeAnnotations

### Type
List<VerticalRangeAnnotation>

### Remarks
This property is final and has no setter.
```

--------------------------------

### BarTooltipItem constructor

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/BarTooltipItem-class.html

Creates a BarTooltipItem with the given text, textStyle, and optional parameters for textAlign, textDirection, and children.

```APIDOC
## BarTooltipItem Constructor

### Description
Creates a BarTooltipItem instance that holds the content and styling for a custom tooltip in a bar chart.

### Constructor
`BarTooltipItem(String text, TextStyle textStyle, {TextAlign textAlign = TextAlign.center, TextDirection textDirection = TextDirection.ltr, List<TextSpan>? children})`

### Parameters
- **text** (String) - Required - The text content of the tooltip.
- **textStyle** (TextStyle) - Required - The style of the text.
- **textAlign** (TextAlign) - Optional - Alignment of the text, defaults to `TextAlign.center`.
- **textDirection** (TextDirection) - Optional - Direction of the text, defaults to `TextDirection.ltr`.
- **children** (List<TextSpan>?) - Optional - Additional text spans for further styling.

### Usage Example
```dart
BarTooltipItem(
  'Tooltip text',
  TextStyle(color: Colors.white),
  textAlign: TextAlign.center,
  textDirection: TextDirection.ltr,
  children: [TextSpan(text: ' extra')],
)
```
```

--------------------------------

### FlPanStartEvent constructor

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/FlPanStartEvent-class.html

Creates a FlPanStartEvent instance with the given DragStartDetails.

```APIDOC
## FlPanStartEvent(DragStartDetails details)

### Description
Creates a FlPanStartEvent instance. The constructor is const.

### Constructor
FlPanStartEvent(DragStartDetails details)

### Parameters
- **details** (DragStartDetails) - Required - Contains information of the happened touch gesture.

### Example
```dart
FlPanStartEvent(
  DragStartDetails(globalPosition: Offset(10, 20)),
)
```
```

--------------------------------

### horizontalRangeAnnotations property

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/RangeAnnotations-class.html

Gets the list of horizontal range annotations. This property is final and read-only.

```APIDOC
## horizontalRangeAnnotations property

### Description
Gets the list of horizontal range annotations. This property is final and read-only.

### Property
List<HorizontalRangeAnnotation> get horizontalRangeAnnotations

### Type
List<HorizontalRangeAnnotation>

### Remarks
This property is final and has no setter.
```

--------------------------------

### FlTransformationConfig constructor

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/FlTransformationConfig-class.html

Creates a configuration for chart transformation with optional parameters for scale axis, min/max scale, pan/scale enablement, trackpad scroll behavior, and a transformation controller.

```APIDOC
## FlTransformationConfig({FlScaleAxis scaleAxis = FlScaleAxis.none, double minScale = 1, double maxScale = 2.5, bool panEnabled = true, bool scaleEnabled = true, bool trackpadScrollCausesScale = false, TransformationController? transformationController})

### Description
Creates a configuration for chart transformation. All parameters are optional and have default values.

### Parameters
- **scaleAxis** (FlScaleAxis) - Optional - Determines what axis of the chart should be scaled. Defaults to FlScaleAxis.none.
- **minScale** (double) - Optional - The minimum scale of the chart. Defaults to 1.
- **maxScale** (double) - Optional - The maximum scale of the chart. Defaults to 2.5.
- **panEnabled** (bool) - Optional - If false, the user will be prevented from panning. Defaults to true.
- **scaleEnabled** (bool) - Optional - If false, the user will be prevented from scaling. Defaults to true.
- **trackpadScrollCausesScale** (bool) - Optional - Whether trackpad scroll causes scale. Defaults to false.
- **transformationController** (TransformationController?) - Optional - The transformation controller to control the transformation of the chart. Defaults to null.
```

--------------------------------

### touchChartCoordinate property

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/AxisBaseTouchResponse-class.html

Gets the axis coordinate of the touch in chart's coordinate system.

```APIDOC
## touchChartCoordinate → Offset

### Description
The axis coordinate of the touch in chart's coordinate system.

### Type
Offset

### Attributes
final
```

--------------------------------

### LineBarSpot constructor

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/LineBarSpot-class.html

Creates a LineBarSpot instance with the given bar, barIndex, and spot. The bar is the LineChartBarData that this spot is inside of, barIndex is the index of the bar in the LineChartData.lineBarsData list, and spot is the targeted FlSpot.

```APIDOC
## LineBarSpot(LineChartBarData bar, int barIndex, FlSpot spot)

### Description
Creates a LineBarSpot instance representing a targeted spot inside a line bar.

### Parameters
- **bar** (LineChartBarData) - Required - The LineChartBarData that this spot is inside of.
- **barIndex** (int) - Required - The index of the bar in the LineChartData.lineBarsData list.
- **spot** (FlSpot) - Required - The targeted spot. The spotIndex is the index of this FlSpot in the LineChartBarData.spots list.

```

--------------------------------

### getSize

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/FlDotCirclePainter-class.html

Implementation of the parent class to get the size of the circle. This method returns the size of the dot.

```APIDOC
## getSize

### Description
Implementation of the parent class to get the size of the circle.

### Method Signature
`Size getSize(FlSpot spot)`

### Parameters
- **spot** (FlSpot) - The spot data associated with the dot.

### Returns
Size - The size of the circle.
```

--------------------------------

### GetSpotRangeErrorPainter

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/

A callback that allows you to return a FlSpotErrorRangePainter based on the provided specific data point (for example FlSpot in LineChart).

```APIDOC
## GetSpotRangeErrorPainter

### Description
A callback that allows you to return a FlSpotErrorRangePainter based on the provided specific data point (for example FlSpot in LineChart).

### Signature
`FlSpotErrorRangePainter Function(T input)` where T extends FlSpotErrorRangeCallbackInput

### Parameters
- **input** (T) - The specific data point input.

### Returns
- **FlSpotErrorRangePainter** - The painter for the error range.
```

--------------------------------

### GetDotPainterCallback typedef implementation

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/GetDotPainterCallback.html

Defines the callback signature for getting a FlDotPainter. It takes a FlSpot, a double, LineChartBarData, and an int index, and returns a FlDotPainter.

```dart
typedef GetDotPainterCallback = FlDotPainter Function(
  FlSpot,
  double,
  LineChartBarData,
  int,
);
```

--------------------------------

### BarTouchTooltipData Constructor

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/BarTouchTooltipData-class.html

Creates a BarTouchTooltipData instance with optional parameters to customize the tooltip's border radius, padding, margin, alignment, offset, max width, content callbacks, color callback, fit-inside flags, direction, rotation angle, and border.

```APIDOC
## BarTouchTooltipData Constructor

### Description
Creates a BarTouchTooltipData instance to configure the tooltip popup shown on top of bar chart rods. All parameters are optional and can be used to customize the tooltip's appearance and behavior.

### Constructor Signature
```dart
BarTouchTooltipData({
  BorderRadius? tooltipBorderRadius,
  EdgeInsets? tooltipPadding,
  double? tooltipMargin,
  FLHorizontalAlignment? tooltipHorizontalAlignment,
  double? tooltipHorizontalOffset,
  double? maxContentWidth,
  GetBarTooltipItem? getTooltipItem,
  GetBarTooltipColor? getTooltipColor,
  bool? fitInsideHorizontally,
  bool? fitInsideVertically,
  TooltipDirection? direction,
  double? rotateAngle,
  BorderSide? tooltipBorder
})
```

### Parameters
- **tooltipBorderRadius** (BorderRadius?) - Optional - The corner radius for the tooltip. If both `tooltipRoundedRadius` and `tooltipBorderRadius` are set, the value from `tooltipBorderRadius` is used.
- **tooltipPadding** (EdgeInsets?) - Optional - Padding inside the tooltip.
- **tooltipMargin** (double?) - Optional - Bottom margin for the tooltip.
- **tooltipHorizontalAlignment** (FLHorizontalAlignment?) - Optional - Horizontal alignment of the tooltip.
- **tooltipHorizontalOffset** (double?) - Optional - Horizontal offset for the tooltip.
- **maxContentWidth** (double?) - Optional - Restricts the tooltip's width.
- **getTooltipItem** (GetBarTooltipItem?) - Optional - Callback to provide custom content for the tooltip.
- **getTooltipColor** (GetBarTooltipColor?) - Optional - Callback to provide the background color of the tooltip.
- **fitInsideHorizontally** (bool?) - Optional - If true, forces the tooltip to shift inside the chart horizontally.
- **fitInsideVertically** (bool?) - Optional - If true, forces the tooltip to shift inside the chart vertically.
- **direction** (TooltipDirection?) - Optional - Direction of the tooltip.
- **rotateAngle** (double?) - Optional - Rotation angle of the tooltip.
- **tooltipBorder** (BorderSide?) - Optional - Custom border for the tooltip.

### Usage Notes
- If `BarTouchData.handleBuiltInTouches` is true, the tooltip is shown automatically on touch. Otherwise, you can show it manually using `BarChartGroupData.showingTooltipIndicators`.
- The tooltip shows on top of rods with `getTooltipColor` as the background color.
- Content is provided via the `getTooltipItem` callback.

```

--------------------------------

### getSize(FlSpot spot) → Size

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/FlDotCrossPainter-class.html

Implementation of the parent class to get the size of the cross. This method returns the size of the cross-shaped dot.

```APIDOC
## getSize(FlSpot spot) → Size

### Description
Implementation of the parent class to get the size of the cross. This method returns the size of the cross-shaped dot.

### Method
`getSize`

### Parameters
- **spot** (FlSpot) - Required - The spot data associated with the dot.

### Returns
`Size`
```

--------------------------------

### PieTouchResponse constructor

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/PieTouchResponse-class.html

Creates a PieTouchResponse instance with the given touch location and touched section.

```APIDOC
## PieTouchResponse({required Offset touchLocation, required PieTouchedSection? touchedSection})

### Description
If touch happens, PieChart processes it internally and passes out a PieTouchResponse.

### Parameters
- **touchLocation** (Offset) - Required - The location of the touch in pixels on the screen.
- **touchedSection** (PieTouchedSection?) - Required - Contains information about touched section, like index, angle, radius, ...

```

--------------------------------

### BarChartAlignment enum values

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/BarChartAlignment.html

The BarChartAlignment enum defines the arrangement of barGroups. It includes the following values: start, end, center, spaceEvenly, spaceAround, and spaceBetween.

```APIDOC
## BarChartAlignment enum

### Description
Defines arrangement of `barGroups`, check [MainAxisAlignment](https://api.flutter.dev/flutter/rendering/MainAxisAlignment.html) for more details.

### Values
- `start` - const BarChartAlignment
- `end` - const BarChartAlignment
- `center` - const BarChartAlignment
- `spaceEvenly` - const BarChartAlignment
- `spaceAround` - const BarChartAlignment
- `spaceBetween` - const BarChartAlignment

### Properties
- `hashCode` (int) - The hash code for this object. (inherited)
- `index` (int) - A numeric identifier for the enumerated value. (inherited)
- `name` (String) - The name of the enum value. (provided by EnumName extension)
- `runtimeType` (Type) - A representation of the runtime type of the object. (inherited)

### Methods
- `noSuchMethod(Invocation invocation)` → dynamic - Invoked when a nonexistent method or property is accessed. (inherited)
- `toString()` → String - A string representation of this object. (inherited)

### Operators
- `operator ==(Object other)` → bool - The equality operator. (inherited)

### Constants
- `values` → const List<BarChartAlignment> - A constant List of the values in this enum, in order of their declaration.
```

--------------------------------

### FlPanEndEvent.details Property

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/FlPanEndEvent-class.html

Gets the DragEndDetails object that contains information about the touch gesture that ended, including the velocity at which the pointer was moving when it stopped contacting the screen.

```APIDOC
## FlPanEndEvent.details Property

### Description
Contains information of happened touch gesture. The velocity at which the pointer was moving when it stopped contacting the screen is available in this property.

### Property
`DragEndDetails get details`

### Returns
- **details** (DragEndDetails) - The details of the ended pan gesture.

### Usage
```dart
DragEndDetails details = event.details;
```
```

--------------------------------

### BarTooltipItem methods and operators

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/BarTooltipItem-class.html

Methods and operators inherited from Object and EquatableMixin.

```APIDOC
## BarTooltipItem Methods and Operators

### Description
Inherited methods and operators for object comparison and string representation.

### Methods
- **noSuchMethod(Invocation invocation)** → dynamic - inherited - Invoked when a nonexistent method or property is accessed.
- **toString()** → String - inherited - A string representation of this object.

### Operators
- **operator ==(Object other)** → bool - inherited - The equality operator.

### Usage Example
```dart
final item1 = BarTooltipItem('a', TextStyle());
final item2 = BarTooltipItem('a', TextStyle());
print(item1 == item2); // true if props are equal
print(item1.toString()); // string representation
```
```

--------------------------------

### GetLabelTextStyleFunction typedef

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/GetLabelTextStyleFunction.html

Defines a function type that takes an integer spot index and a ScatterSpot, and returns a TextStyle or null. It is used to get the text style of a label.

```APIDOC
## GetLabelTextStyleFunction typedef

### Description
Defines a function type that takes an integer spot index and a ScatterSpot, and returns a TextStyle or null. It is used to get the text style of a label.

### Signature
```dart
typedef GetLabelTextStyleFunction = TextStyle? Function(
  int spotIndex,
  ScatterSpot spot,
);
```

### Parameters
- **spotIndex** (int) - The index of the spot.
- **spot** (ScatterSpot) - The scatter spot for which the label text style is needed.

### Returns
- **TextStyle?** - The text style of the label, or null if no style is applied.
```

--------------------------------

### BarTouchTooltipData Properties

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/BarTouchTooltipData-class.html

Lists all properties of the BarTouchTooltipData class with their types and descriptions.

```APIDOC
## BarTouchTooltipData Properties

### direction
- Type: TooltipDirection
- Description: Controls showing tooltip on top or bottom, default is auto.
- Final: true

### fitInsideHorizontally
- Type: bool
- Description: Forces the tooltip to shift horizontally inside the chart, if overflow happens.
- Final: true

### fitInsideVertically
- Type: bool
- Description: Forces the tooltip to shift vertically inside the chart, if overflow happens.
- Final: true

### getTooltipColor
- Type: GetBarTooltipColor
- Description: Retrieves data for setting background color of the tooltip.
- Final: true

### getTooltipItem
- Type: GetBarTooltipItem
- Description: Retrieves data for showing content inside the tooltip.
- Final: true

### maxContentWidth
- Type: double
- Description: Restricts the tooltip's width.
- Final: true

### rotateAngle
- Type: double
- Description: Controls the rotation of the tooltip (in degrees).
- Final: true

### tooltipBorder
- Type: BorderSide
- Description: The tooltip border color.
- Final: true

### tooltipBorderRadius
- Type: BorderRadius
- Description: Sets a rounded radius for the tooltip.
- Final: false

### tooltipHorizontalAlignment
- Type: FLHorizontalAlignment
- Description: Controls showing tooltip on left side, right side or center aligned with rod, default is center.
- Final: true

### tooltipHorizontalOffset
- Type: double
- Description: Applies horizontal offset for showing tooltip, default is zero.
- Final: true

### tooltipMargin
- Type: double
- Description: Applies a bottom margin for showing tooltip on top of rods.
- Final: true

### tooltipPadding
- Type: EdgeInsets
- Description: Applies a padding for showing contents inside the tooltip.
- Final: true

### Inherited Properties
- hashCode: int - The hash code for this object. (no setter, inherited)
- runtimeType: Type - A representation of the runtime type of the object. (no setter, inherited)
- stringify: bool? - If set to true, the toString method will be overridden to output this instance's props. (no setter, inherited)
- props: List<Object?> - Used for equality check, see EquatableMixin. (no setter)
```

--------------------------------

### LineChartBarData constructor

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/LineChartBarData-class.html

Creates a LineChartBarData instance with parameters to configure the line's spots, appearance, curve behavior, and error indicators.

```APIDOC
## LineChartBarData constructor

### Description
Creates a LineChartBarData instance that holds data for drawing a single line in a LineChart. It allows customization of spots, visibility, color, gradient, curve properties, and error indicators.

### Constructor
`LineChartBarData({List<FlSpot> spots = const [], bool show = true, Color? color, Gradient? gradient, LineChartGradientArea gradientArea = LineChartGradientArea.rectAroundTheLine, double barWidth = 2.0, bool isCurved = false, double curveSmoothness = 0.35, bool preventCurveOverShooting = false, double preventCurveOvershootingThreshold = 10.0, bool isStrokeCapRound = false, bool isStrokeJoinRound = false, BarAreaData? belowBarData, BarAreaData? aboveBarData, FlDotData dotData = const FlDotData(), FlErrorIndicatorData<LineChartSpotErrorRangeCallbackInput> errorIndicatorData = const FlErrorIndicatorData<LineChartSpotErrorRangeCallbackInput>(), List<int> showingIndicators = const [], List<int>? dashArray, Shadow shadow = const Shadow(color: Colors.transparent), bool isStepLineChart = false, LineChartStepData lineChartStepData = const LineChartStepData()})`

### Parameters
- **spots** (List<FlSpot>) - Optional - The list of spots that define the line's points. Defaults to an empty list.
- **show** (bool) - Optional - Whether to show the line. Defaults to true.
- **color** (Color?) - Optional - The color of the line.
- **gradient** (Gradient?) - Optional - The gradient to use for the line.
- **gradientArea** (LineChartGradientArea) - Optional - The area for the gradient. Defaults to LineChartGradientArea.rectAroundTheLine.
- **barWidth** (double) - Optional - The width of the line. Defaults to 2.0.
- **isCurved** (bool) - Optional - Whether the line is curved. Defaults to false.
- **curveSmoothness** (double) - Optional - The smoothness of the curve. Defaults to 0.35.
- **preventCurveOverShooting** (bool) - Optional - Whether to prevent curve overshooting. Defaults to false.
- **preventCurveOvershootingThreshold** (double) - Optional - The threshold for preventing curve overshooting. Defaults to 10.0.
- **isStrokeCapRound** (bool) - Optional - Whether the stroke cap is round. Defaults to false.
- **isStrokeJoinRound** (bool) - Optional - Whether the stroke join is round. Defaults to false.
- **belowBarData** (BarAreaData?) - Optional - Data for the area below the line.
- **aboveBarData** (BarAreaData?) - Optional - Data for the area above the line.
- **dotData** (FlDotData) - Optional - Configuration for dots on the line. Defaults to const FlDotData().
- **errorIndicatorData** (FlErrorIndicatorData<LineChartSpotErrorRangeCallbackInput>) - Optional - Configuration for error indicators. Defaults to const FlErrorIndicatorData<LineChartSpotErrorRangeCallbackInput>().
- **showingIndicators** (List<int>) - Optional - List of indices for showing indicators. Defaults to an empty list.
- **dashArray** (List<int>?) - Optional - Dash pattern for the line.
- **shadow** (Shadow) - Optional - Shadow for the line. Defaults to const Shadow(color: Colors.transparent).
- **isStepLineChart** (bool) - Optional - Whether the line is a step line chart. Defaults to false.
- **lineChartStepData** (LineChartStepData) - Optional - Data for step line chart. Defaults to const LineChartStepData().

### Usage
BarChart draws some lines and overlaps them in the chart's view. You can have multiple lines by splitting them, put a FlSpot.nullSpot between each section. Each line passes through `spots`, with hard edges by default, `isCurved` makes it curve for drawing, and `curveSmoothness` determines the curve smoothness.
```

--------------------------------

### GetDotColorCallback typedef implementation

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/GetDotColorCallback.html

Defines the GetDotColorCallback as a function that takes a FlSpot, a double (percentage along the bar line), and a LineChartBarData, and returns a Color. This callback is used to get the color for drawing a target spot.

```dart
typedef GetDotColorCallback = Color Function(FlSpot, double, LineChartBarData);
```

--------------------------------

### LineTouchResponse constructor

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/LineTouchResponse-class.html

Creates a LineTouchResponse instance with the given touch location, chart coordinate, and optional line bar spots.

```APIDOC
## LineTouchResponse({required Offset touchLocation, required Offset touchChartCoordinate, List<TouchLineBarSpot>? lineBarSpots})

### Description
If touch happens, LineChart processes it internally and passes out a list of `lineBarSpots` it gives you information about the touched spot. They are sorted based on their distance to the touch event.

### Parameters
- **touchLocation** (Offset) - Required - The location of the touch in pixels on the screen.
- **touchChartCoordinate** (Offset) - Required - The axis coordinate of the touch in chart's coordinate system.
- **lineBarSpots** (List<TouchLineBarSpot>?) - Optional - Touch happened on these spots (if a single line provided on the chart, lineBarSpots's length will be 1 always).
```

--------------------------------

### PieChartDataTween constructor

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/PieChartDataTween-class.html

Creates a PieChartDataTween with required begin and end PieChartData values.

```APIDOC
## PieChartDataTween

### Description
Creates a PieChartDataTween instance that lerps between two PieChartData objects.

### Constructor
PieChartDataTween({required PieChartData begin, required PieChartData end})

### Parameters
- **begin** (PieChartData) - Required - The value at the beginning of the animation.
- **end** (PieChartData) - Required - The value at the end of the animation.

### Inherited Properties
- **begin** (PieChartData?) - The value at the beginning of the animation. Getter/setter pair.
- **end** (PieChartData?) - The value at the end of the animation. Getter/setter pair.
- **hashCode** (int) - The hash code for this object. No setter.
- **runtimeType** (Type) - A representation of the runtime type of the object. No setter.
```

--------------------------------

### BackgroundBarChartRodData constructor

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/BackgroundBarChartRodData-class.html

Creates a BackgroundBarChartRodData instance with optional parameters for fromY, toY, show, color, and gradient.

```APIDOC
## BackgroundBarChartRodData constructor

### Description
Creates a BackgroundBarChartRodData instance that holds values to draw a rod in rear of the main rod.

### Constructor
`BackgroundBarChartRodData({double? fromY, double? toY, bool? show, Color? color, Gradient? gradient})`

### Parameters
- **fromY** (double?) - Optional - The Y value where the background starts to show.
- **toY** (double?) - Optional - The Y value where the background ends.
- **show** (bool?) - Optional - Determines whether to show or hide the background.
- **color** (Color?) - Optional - The color used to draw the background. Must provide either color or gradient, not both.
- **gradient** (Gradient?) - Optional - The gradient used to draw the background. Must provide either color or gradient, not both.

### Usage
It will be rendered in rear of the main rod, background starts to show from `fromY` to `toY`. It draws with `color` or `gradient`. You must provide one of them, and you can prevent showing it using the `show` property.
```

--------------------------------

### showAllSpotsBelowLine implementation

Source: https://pub.dev/documentation/fl_chart/latest/fl_chart/showAllSpotsBelowLine.html

The implementation of the showAllSpotsBelowLine function, which always returns true, indicating that all spot lines should be shown for any given FlSpot.

```dart
content_copybool showAllSpotsBelowLine(FlSpot spot) => true;
```
Tokens:
Raw