Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sljux committed Aug 12, 2015
1 parent 5189996 commit 4f32c53
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# angular-flow-charts

Real-time charts for Angular and FlowThings. Uses (Angular Flow Websocket)[https://github.com/Sljux/angular-flow-websocket]
Real-time charts for Angular and FlowThings. Uses [Angular Flow Websocket](https://github.com/Sljux/angular-flow-websocket)
for communication with FlowThings server.

Install via Bower `bower install angular-flow-charts --save`
Expand All @@ -11,11 +11,11 @@ Any actual chart is a plugin directive transcluded within the `<flow-chart></flo

### Options
- `flowId`: id of the source Flow
- `flowSocket`: (socket)[https://github.com/Sljux/angular-flow-websocket] to be used for communication
- `flowSocket`: [socket](https://github.com/Sljux/angular-flow-websocket) to be used for communication
- `limit`: max number od data points in the graph - used in initial data fetching and passed down to chart plugin

## Flow ChartJS
__flowChartJs__ is an example of chart plugin, using (ChartJS)[https://github.com/nnnick/Chart.js] via (Angular Chart)[http://jtblin.github.io/angular-chart.js/]
__flowChartJs__ is an example of chart plugin, using [ChartJS](https://github.com/nnnick/Chart.js) via [Angular Chart](http://jtblin.github.io/angular-chart.js/)

### Options
- `chartType`: string representing one of chart types supported by ChartJS (line, bar, radar, pie, polar-area, doughnut)
Expand All @@ -26,4 +26,4 @@ Defaults to `null`, resulting in graph point not being drawn
- `labelProperty`: path to property of the data point object to be used as chart label. Should be in `path.to.prop` form.
If nothing is passed, the labels are auto incremented integers starting at 0
- `labelDefault`: used if `labelProperty` is passed. Default label value if the data point object doesn't contain property in the given label path
- `series`, `click`, `hover`, `legend` and `colours` are directly passed to (Angular Chart)[http://jtblin.github.io/angular-chart.js/] directive
- `series`, `click`, `hover`, `legend` and `colours` are directly passed to [Angular Chart](http://jtblin.github.io/angular-chart.js/) directive

0 comments on commit 4f32c53

Please sign in to comment.