sphericalkat/flutter_circular_chart
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Add chart data entries section to readme

Browse Source
This commit is contained in:
Victor Choueiri 2017-11-03 05:31:49 +02:00 committed by GitHub
parent 002a95b96b
commit f4084f9d1d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -11,6 +11,12 @@ Create easily animated pie charts and radial charts by providing them with data
Check the examples folder for the source code for the above screenshots.
## Contents:
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Details](#details)
- [Chart data entries](#chart-data-entries)
## Installation
@ -82,4 +88,17 @@ void _cycleSamples() {
}
```
## Details
### Chart data entries:
Charts expect a list of `CircularStackEntry` objects containing the data they need to be drawn.
Each `CircularStackEntry` corresponds to a complete circle in the chart. For radial charts that is one of the rings, for pie charts it is the whole pie.
Radial charts with multiple `CircularStackEntry`s will display them as concentric circles.
Each `CircularStackEntry` is composed of multiple `CircularSegmentEntry`s containing the value of a data point. In radial charts a segment corresponds to an arc segment of the current ring, for pie charts it is an individual slice.