diff --git a/README.md b/README.md index 7c7ab89..89b8391 100755 --- a/README.md +++ b/README.md @@ -113,22 +113,50 @@ The parent component renders the charts as follows :pie-chart-model="$pieChartModel" /> ``` - + When the parent component changes their respective models, charts will automatically re-render itself. ![reactive charts example](https://github.com/asantibanez/livewire-charts/raw/master/reactive-charts-example.gif) - - ## Charts API -### Testing +#### LivewireLineChart + +| Method | Description | +|--------|-------------| +| setTitle(string $title) | Sets chart title | +| setAnimated(boolean $animated) | Enables/disables animation | +| addPoint(string $title, double $value, array $extras = []) | Adds a point to the line chart. `$extras` is forwarded on click event | +| addMarker(string $title, double $value) | Adds a marker point to the line chart. Markers are used to emphasize particular points in the chart | +| withOnPointClickEvent(string $eventName) | Event Name that will be fired when a point/marker of the chart is clicked | + +#### LivewireColumnChart + +| Method | Description | +|--------|-------------| +| setTitle(string $title) | Sets chart title | +| setAnimated(boolean $animated) | Enables/disables animation | +| setOpacity(int $opacity) | Sets columns' opacity | +| addColumn(string $title, double $value, string $color, array $extras = []) | Adds a column to the chart with the specified color. `$extras` is forwarded on click event | +| onColumnClickEventName(string $eventName) | Event Name that will be fired when a column of the chart is clicked | + +#### LivewirePieChart + +| Method | Description | +|--------|-------------| +| setTitle(string $title) | Sets chart title | +| setAnimated(boolean $animated) | Enables/disables animation | +| setOpacity(int $opacity) | Sets slices' opacity | +| addSlice(string $title, double $value, string $color, array $extras = []) | Adds a slice to the chart with the specified color. `$extras` is forwarded on click event | +| withOnSliceClickEvent(string $eventName) | Event Name that will be fired when a column of the chart is clicked | + +## Testing ``` bash composer test ``` -### Changelog +## Changelog Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.