Skip to content

Added documentation for PieChart #442

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Hermanya merged 2 commits into from
Dec 6, 2020
Merged

Added documentation for PieChart #442

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae9ae08
Update README.md
alex-hladun Nov 28, 2020
3e4e3c1
Merge pull request #1 from alex-hladun/alex-hladun-patch-1
alex-hladun Nov 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ const data = {
| horizontalLabelRotation | number (degree) | Rotation angle of the horizontal labels - default 0 |
| verticalLabelRotation | number (degree) | Rotation angle of the vertical labels - default 0 |
| getDotColor | function => string | Defines the dot color function that is used to calculate colors of dots in a line chart and takes `(dataPoint, dataPointIndex)` |
| renderDotContent | Function | Render additional content for the dot. Takes `({x, y, index, indexData})` as arguments. |
| renderDotContent | Function | Render additional content for the dot. Takes `({x, y, index, indexData})` as arguments. |
| yLabelsOffset | number | Offset for Y axis labels |
| xLabelsOffset | number | Offset for X axis labels |
| hidePointsAtIndex | number[] | Indices of the data points you don't want to display |
Expand Down Expand Up @@ -368,9 +368,10 @@ const data = [
width={screenWidth}
height={220}
chartConfig={chartConfig}
accessor="population"
backgroundColor="transparent"
paddingLeft="15"
accessor={"population"}
backgroundColor={"transparent"}
paddingLeft={"15"}
center={[10, 50]}
absolute
/>
```
Expand All @@ -384,6 +385,7 @@ const data = [
| accessor | string | Property in the `data` object from which the number values are taken |
| bgColor | string | background color - if you want to set transparent, input `transparent` or `none`. |
| paddingLeft | string | left padding of the pie chart |
| center | array | offset x and y coordinates to position the chart |
| absolute | boolean | shows the values as absolute numbers |
| hasLegend | boolean | Defaults to `true`, set it to `false` to remove the legend |
| avoidFalseZero | boolean | Defaults to `false`, set it to `true` to display a "<1%" instead of a rounded value equal to "0%" |
Expand Down