Skip to content

Commit

Permalink
Update the markdown documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
imaNNeo committed Jan 13, 2025
1 parent 5b160bd commit 3af5175
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 3 deletions.
3 changes: 2 additions & 1 deletion repo_files/documentations/bar_chart.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ When you change the chart's state, it animates to the new state internally (usin
|baselineY| defines the baseline of y-axis | 0|
|extraLinesData| allows extra horizontal lines to be drawn on the chart. Vertical lines are ignored when used with BarChartData, please see [#1149](https://github.com/imaNNeo/fl_chart/issues/1149), check [ExtraLinesData](base_chart.md#ExtraLinesData)|ExtraLinesData()|
|rotationQuarterTurns|Rotates the chart 90 degrees (clockwise) in every quarter turns. This feature works like the [RotatedBox](https://api.flutter.dev/flutter/widgets/RotatedBox-class.html) widget. You can have horizontal BarChart by changing this value to |0|
|errorIndicatorData|Holds data for representing an error indicator (you see the error indicators if you provide the `toYErrorRange` in the [BarChartRodData](#BarChartRodData))|[ErrorIndicatorData()](base_chart.md#FlErrorIndicatorData)|

### BarChartGroupData
|PropName |Description |default value|
Expand Down Expand Up @@ -59,7 +60,7 @@ enum values {`start`, `end`, `center`, `spaceEvenly`, `spaceAround`, `spaceBetwe
|borderSide|Determines the border stroke around of the bar, see [BorderSide](https://api.flutter.dev/flutter/painting/BorderSide-class.html). When `null`, it defaults to draw no stroke. |null|
|backDrawRodData|if provided, draws a rod in the background of the line bar, check the [BackgroundBarChartRodData](#BackgroundBarChartRodData)|null|
|rodStackItem|if you want to have stacked bar chart, provide a list of [BarChartRodStackItem](#BarChartRodStackItem), it will draw over your rod.|[]|

|toYErrorRange|If you want to show an error range on the rod, provide [FlErrorRange](base_chart.md#FlErrorRange)|null|

### BackgroundBarChartRodData
|PropName|Description|default value|
Expand Down
16 changes: 15 additions & 1 deletion repo_files/documentations/base_chart.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@
|:-------|:----------|:------------|
|x|represents x on the coordinate system (x starts from left)|null|
|y|represents y on the coordinate system (y starts from bottom)|null|

|xError| Determines the error range of the data point using (FlErrorRange)[#FlErrorRange] (which ontains `lowerBy` and `upperValue`) for the x-axis|null|
|yError| Determines the error range of the data point using (FlErrorRange)[#FlErrorRange] (which ontains `upperBy` and `upperValue`) for the y-axis|null|


### FlLine
Expand Down Expand Up @@ -186,3 +187,16 @@ Base class for all supported touch/pointer events.

### FLHorizontalAlignment
enum values {`center`, `left`, `right`}


### FlErrorIndicatorData
|PropName| Description | default value |
|:-------|:------------------------------------------------------------|:-----------------------|
|show| Determines showing or not showing error indicator/threshold | true |
|painter| A callback that allows you to provide a custom painter for the error indicator| FlSimpleErrorPainter() |

### FlErrorRange
|PropName| Description | default value |
|:-------|:-------------------------------------------------------------------------------|:-----------------------|
|lowerBy| Lower value of the error range. It is subtracted from the spot value and shoul be positive| null|
|upperBy| Upper value of the error range. It is added to the spot value and shoul be positive| null|
1 change: 1 addition & 0 deletions repo_files/documentations/line_chart.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ When you change the chart's state, it animates to the new state internally (usin
|shadow|It drops a shadow behind your bar, see [Shadow](https://api.flutter.dev/flutter/dart-ui/Shadow-class.html).|Shadow()|
|isStepLineChart|If sets true, it draws the chart in Step Line Chart style, using `lineChartStepData`.|false|
|lineChartStepData|Holds data for representing a Step Line Chart, and works only if [isStepChart] is true.|[LineChartStepData](#LineChartStepData)()|
|errorIndicatorData|Holds data for representing an error indicator (you see the error indicators if you provide the `xError` or `yError` in the [FlSpot](base_chart.md#FlSpot)).|[ErrorIndicatorData()](base_chart.md#FlErrorIndicatorData)|

### LineChartStepData
|PropName|Description|default value|
Expand Down
4 changes: 3 additions & 1 deletion repo_files/documentations/scatter_chart.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ When you change the chart's state, it animates to the new state internally (usin
|scatterTouchData| [ScatterTouchData](#scattertouchdata-read-about-touch-handling) holds the touch interactivity details| ScatterTouchData()|
|showingTooltipIndicators| indices of showing tooltip, The point is that you need to disable touches to show these tooltips manually|[]|
|rotationQuarterTurns|Rotates the chart 90 degrees (clockwise) in every quarter turns. This feature works like the [RotatedBox](https://api.flutter.dev/flutter/widgets/RotatedBox-class.html) widget|0|

|errorIndicatorData|Holds data for representing an error indicator (you see the error indicators if you provide the `xError` or `yError` in the [ScatterSpot](#ScatterSpot))|[ErrorIndicatorData()](base_chart.md#FlErrorIndicatorData)|

### ScatterSpot
|PropName |Description |default value|
Expand All @@ -34,6 +34,8 @@ When you change the chart's state, it animates to the new state internally (usin
|radius| radius of the showing spot| [8]
|color| colors of the spot|// a color based on the values|
|renderPriority| sort by this to manage overlap|0|
|xError| Determines the error range of the data point using (FlErrorRange)[base_chart.md#FlErrorRange] (which ontains `lowerBy` and `upperValue`) for the x-axis|null|
|yError| Determines the error range of the data point using (FlErrorRange)[base_chart.md#FlErrorRange] (which ontains `upperBy` and `upperValue`) for the y-axis|null|


### ScatterTouchData ([read about touch handling](handle_touches.md))
Expand Down

0 comments on commit 3af5175

Please sign in to comment.