diff --git a/README.md b/README.md new file mode 100644 index 0000000..ad81bd2 --- /dev/null +++ b/README.md @@ -0,0 +1,91 @@ +# ChartProgressBar + +Draw a chart with progress bar style + +![](https://i.imgur.com/bcb3jti.png) + +## Installation + +Add `jitpack` to your build.gradle (project) : + +``` +allprojects { + repositories { + ... + maven { url 'https://jitpack.io' } + } + } +``` + +Add the dependency to your build.gradle (app) : + +``` +compile 'com.github.hadiidbouk:ChartProgressBar:1.0.0' +``` + +## Usage + +1. Add `ChartProgressBar` to your layout : + +``` + +``` + +2. Add your Data to the chart : + +``` + ArrayList dataList = new ArrayList<>(); + + BarData data = new BarData("Sep", 3.4f, "3.4€"); + dataList.add(data); + + data = new BarData("Oct", 8f, "8€"); + dataList.add(data); + + data = new BarData("Nov", 1.8f, "1.8€"); + dataList.add(data); + + data = new BarData("Dec", 7.3f, "7.3€"); + dataList.add(data); + + data = new BarData("Jan", 6.2f, "6.2€"); + dataList.add(data); + + data = new BarData("Feb", 3.3f, "3.3€"); + dataList.add(data); + + mChart = (ChartProgressBar) findViewById(R.id.ChartProgressBar); + + mChart.setDataList(dataList); + mChart.build(); +``` + +## Useful methods + +1. `mChart.removeBarValues()` : Remove values of all progress bars in the chart. + +2. `mChart.resetBarValues()` : Set values to the chart ( it may used after `removeBarValues()`) . + +3. `mChart.removeClickedBar()` : Unselect the clicked bar. + +4. `isBarsEmpty()` : Check if bars values are empty.