forked from imaNNeo/fl_chart
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request imaNNeo#597 from payam-zahedi/radar-documentation
Radar Chart documented
- Loading branch information
Showing
4 changed files
with
72 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| # RadarChart | ||
| <img src="https://github.com/imaNNeoFighT/fl_chart/raw/master/repo_files/images/radar_chart/radar_chart_sample_1.jpg" width="300" > | ||
|
|
||
| ### How to use | ||
| ```dart | ||
| RadarChart( | ||
| RadarChartData( | ||
| // read about it in the below section | ||
| ), | ||
| ); | ||
| ``` | ||
|
|
||
| ### RadarChartData | ||
| |PropName |Description |default value| | ||
| |:---------------|:---------------|:-------| | ||
| |dataSets| list of [RadarDataSet ](#RadarDataSet) that is shown on the radar chart|[]| | ||
| |radarBackgroundColor| This property fills the background of the radar with the specified color.| Colors.transparent| | ||
| |radarBorderData| shows a border for radar chart|BorderSide(color: Colors.black, width: 2)| | ||
| |getTitle| This function helps the radar chart to draw titles outside the chart.|null| | ||
| |titleTextStyle|TextStyle of the titles|TextStyle(color: Colors.black, fontSize: 12)| | ||
| |titlePositionPercentageOffset|this field is the place of showing title on the RadarChart. The higher the value of this field, the more titles move away from the chart. this field should be between 0 and 1.|0.2| | ||
| |tickCount|Defines the number of ticks that should be paint in RadarChart|1| | ||
| |ticksTextStyle|TextStyle of the tick titles|TextStyle(fontSize: 10, color: Colors.black)| | ||
| |tickBorderData|Style of the tick borders|BorderSide(color: Colors.black, width: 2)| | ||
| |gridBorderData|Style of the grid borders|BorderSide(color: Colors.black, width: 2)| | ||
| |radarTouchData|Handles touch behaviors and responses.|RadarTouchData()| | ||
|
|
||
| ### RadarDataSet | ||
| |PropName |Description |default value| | ||
| |:---------------|:---------------|:-------| | ||
| |dataEntries|Each RadarDataSet contains list of [RadarEntries ](#RadarEntry) that is shown in RadarChart.|[]| | ||
| |fillColor|fills the DataSet with the specified color.|Colors.black12| | ||
| |borderColor|Paint the DataSet border with the specified color.|Colors.blueAccent| | ||
| |borderWidth|defines the width of [RadarDataSet](#RadarDataSet) border.|2.0| | ||
| |entryRadius|defines the radius of each [RadarEntries ](#RadarEntry).|5.0| | ||
|
|
||
| ### RadarEntry | ||
| |PropName |Description |default value| | ||
| |:---------------|:---------------|:-------| | ||
| |value| RadarChart uses this field to render every point in chart.| null | | ||
|
|
||
| ### RadarTouchData ([read about touch handling](handle_touches.md)) | ||
| |PropName|Description|default value| | ||
| |:-------|:----------|:------------| | ||
| |enabled|determines to enable or disable touch behaviors|true| | ||
| |touchCallback| listen to this callback to retrieve touch events, it gives you a [RadarTouchResponse](#RadarTouchResponse)| null| | ||
| |touchSpotThreshold|the threshold of the touch accuracy. we find the nearest spots on touched position based on this field.|10| | ||
|
|
||
|
|
||
| ### RadarTouchResponse | ||
| |PropName|Description|default value| | ||
| |:-------|:----------|:------------| | ||
| |touchedSpot|the [RadarTouchedSpot](#RadarTouchedSpot) that user touched| null | | ||
|
|
||
| ### RadarTouchedSpot | ||
| |PropName|Description|default value| | ||
| |:-------|:----------|:------------| | ||
| |touchedDataSet|the [RadarDataSet](#RadarDataSet) that user touched| null | | ||
| |touchedDataSetIndex| index of the [RadarDataSet](#RadarDataSet) that user touched| null | | ||
| |touchedRadarEntry|the [RadarEntry](#RadarEntry) that user touched| null | | ||
| |touchedRadarEntryIndex| index of the [RadarEntry](#RadarEntry) that user touched| null | | ||
|
|
||
| ### some samples | ||
| ---- | ||
| ##### Sample 1 ([Source Code](example/lib/radar_chart/samples/radar_chart_sample1.dart)) | ||
| <img src="https://github.com/imaNNeoFighT/fl_chart/raw/master/repo_files/images/radar_chart/radar_chart_sample_1.jpg" width="300" > |