https://github.com/whyour/ng-hcharts
Responsive highcharts for Angular2+ base on highcharts used attribute
https://github.com/whyour/ng-hcharts
Last synced: 6 months ago
JSON representation
Responsive highcharts for Angular2+ base on highcharts used attribute
- Host: GitHub
- URL: https://github.com/whyour/ng-hcharts
- Owner: whyour
- License: mit
- Created: 2018-05-28T09:08:06.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-06-04T10:02:41.000Z (over 7 years ago)
- Last Synced: 2025-02-08T22:15:13.613Z (8 months ago)
- Language: TypeScript
- Homepage:
- Size: 487 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ng-hcharts [](https://img.shields.io/npm/v/ng-hcharts.svg) [](https://npmjs.org/ng-hcharts)
Responsive highcharts for Angular2+ base on highcharts used attibute
- - -
### Installation
1. You can install ***ng-hcharts*** using npm
```bash
npm install ng-hcharts --save
```
2. You need to install and include `highcharts.js` library in application via `html` or `webpack bundler` (more options can be found in official `highcharts.js`
```bash
npm install highcharts --save
```
### Usage & Demo
Make a chart!
```typescript
import { NgHChartsModule } from 'ng-hcharts';
@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
NgHChartsModule
],
providers: [],
bootstrap: [AppComponent]
})
```
```html
```
### Properties
**Note**: For more information about possible options please refer to original [highcharts](https://www.highcharts.com/docs) documentation
- `ng-hcharts` (`?any`) - chart options (as from [highcharts documentation](https://www.highcharts.com/docs))
- `oneToOne` (`?Boolean`) - When true, the series, xAxis and yAxis collections will be updated one to one, and items will be either added or removed to match the new updated options. For example, if the chart has two series and we call chart.update with a configuration containing three series, one will be added. If we call chart.update with one series, one will be removed. Setting an empty series array will remove all series, but leaving out the series property will leave all series untouched. If the series have id's, the new series options will be matched by id, and the remaining ones removed.
## Troubleshooting
Please follow this guidelines when reporting bugs and feature requests:
1. Use [GitHub Issues](https://github.com/whyour/ng-hcharts/issues) board to report bugs and feature requests (not our email address)
2. Please **always** write steps to reproduce the error. That way we can focus on fixing the bug, not scratching our heads trying to reproduce it.
Thanks for understanding!
### License
This library is available under the MIT license. However it and is a wrapper for Highcharts. Highcharts itself has an own license. So make sure to follow their license as well (https://github.com/highcharts/highcharts/blob/master/license.txt)