Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/LocusEnergy/ember-sparkles
Collection of composable D3 components built with ember-d3-helpers
https://github.com/LocusEnergy/ember-sparkles
d3 data-visualization ember-addon
Last synced: about 1 month ago
JSON representation
Collection of composable D3 components built with ember-d3-helpers
- Host: GitHub
- URL: https://github.com/LocusEnergy/ember-sparkles
- Owner: LocusEnergy
- License: mit
- Created: 2016-04-11T22:39:16.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-04-13T18:08:44.000Z (over 4 years ago)
- Last Synced: 2024-11-10T19:02:12.755Z (about 1 month ago)
- Topics: d3, data-visualization, ember-addon
- Language: JavaScript
- Homepage: http://locusenergy.github.io/ember-sparkles/#/line-chart
- Size: 2.31 MB
- Stars: 56
- Watchers: 7
- Forks: 9
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-ember - ember-sparkles - Collection of composable D3 components built with ember-d3-helpers. (Packages / Charts)
README
# ember-sparkles
[](https://travis-ci.org/LocusEnergy/ember-sparkles)
[](http://badge.fury.io/js/ember-sparkles)
[](https://david-dm.org/locusenergy/ember-sparkles)
[](http://emberobserver.com/addons/ember-sparkles)
`ember-sparkles` is a collection of composable D3 charts built with [`ember-d3-helpers`](https://github.com/LocusEnergy/ember-d3-helpers) library. It aims to provide reactive and highly performant D3-based data visualizations through simple template-bound configurations.
This library currently includes the following charts:
- [Bar Chart](http://locusenergy.github.io/ember-sparkles/#/bar-chart)
- [Grouped Bar Chart](http://locusenergy.github.io/ember-sparkles/#/grouped-bar-chart)
- [Line Chart](http://locusenergy.github.io/ember-sparkles/#/line-chart)
- [Pie Chart](http://locusenergy.github.io/ember-sparkles/#/pie-chart)
Note: This library is still in beta, please use carefully, and file issues as discovered. Pull requests for additional charts always welcome!
## Install
First install `ember-sparkles` to your application:
```bash
ember install ember-sparkles
```
Then add default `ember-resize` configuration into `config/environment.js` file, these properties can be changed to suit your needs. For more information, please see the documentation for [ember-resize](https://github.com/mike-north/ember-resize):
```js
resizeServiceDefaults: {
widthSensitive: true,
heightSensitive: true,
debounceTimeout: 200,
injectionFactories: ['view', 'component']
},
```
## How to use
This addon includes an `{{ember-sparkles}}`, which renders a responsive SVG container element. D3-based graphs, axes, and legend components are contextually yielded from this component.
### example
```hbs
{{#ember-sparkles
data=your-data
input-key='ts'
output-key='value'
scale-type='band'
y-scale-type='linear'
x-domain=(map (r/get 'ts') data)
y-domain=(append 0 outputMax)
as |chart|
}}
{{!render your charts here}}
{{/ember-sparkles}}
```
### Properties (WIP)
* `data {Array}` **required**
Array containing data, structure depending on data visualization type.
* `input-key {String}` **required**
Key by which to obtain independent variable from array or object. Defaults to zeroth index of array.
* `output-key {String}` **required**
Key by which to obtain dependent variable from array or object. Defaults to first index of array.
* `x-scale-type {String}` **optional**
Type of D3 scale function to use for horizontal axis (`linear`, `band`, or `time`).
_default:_ `linear`
### Axis
To render an axis, add `{{chart.y-axis}}` or `{{chart.x-axis}}` to the `{{#ember-sparkles}}` block.
```hbs
{{#ember-sparkles as |chart|}}
{{chart.x-axis
tick-format=(d3-time-format '%Y-%m-%d')
label='date'
dy=100
dx=-100
}}
{{chart.y-axis
label='kWh'
position='right'
ticks=5
tick-format=(d3-format '.2s')
gridlines=true
dx=100
dy=-30
}}
{{/ember-sparkles}}
```
Similar to the `y-axis` example, the `x-axis` contextual component can take a `position` property, set to `top` (by default these are set to `left` and `bottom`), respectively).
For more information on configuring tick formats using the `d3-time-format` and `d3-format` helpers, please see
[d3-format](https://github.com/d3/d3-format) and [d3-time-format](https://github.com/d3/d3-time-format), respectively.
### Legend
To show a legend, add `{{chart.legend}}` to the `{{#ember-sparkles}}` block.
```hbs
{{#ember-sparkles as |chart|}}
{{chart.legend
dx=50
}}
{{/ember-sparkles}}
```
## Installation
```
ember install ember-sparkles
```
## Helpful Links
- ### [Live Demo](http://locusenergy.github.io/ember-sparkles/)
- ### [Changelog](CHANGELOG.md)
## Looking for help?
If it is a bug [please open an issue on GitHub](http://github.com/LocusEnergy/ember-sparkles/issues).
## Usage
## Updating the Demo site
```
ember github-pages:commit --message
git push origin master
```