angular-highcharts-chart

Minimal Highcharts wrapper for Angular (AOT Build and Angular 6 Compatible)

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
angular-highcharts-chart
1.0.24 years ago4 years agoMinified + gzip package size for angular-highcharts-chart in KB

Readme

Highcharts Angular
Minimal Highcharts wrapper for Angular (AOT Build and Angular 6 Compatible). Credits: Thanks to highcharts for their original angular wrapper named highcharts-angular. Almost all of the documentation ported form the original repo as underlying opitons & usage guide remains the same, excpet that this package exports module instead of component. So, go through the usage guide once after installing the package.

Table of Contents

  1. Getting started
1. [General prerequisites](#general-prerequisites)
2. [Installing](#installing)
3. [Usage](#usage)
3. [Hello world demo](#hello-world-demo)
  1. Options details
  1. Highcharts instance details
1. [Core](#core)
2. [To load a module](#to-load-a-module)
3. [To load a plugin](#to-load-a-plugin)
4. [To load a map for Highmaps](#to-load-a-map-for-highmaps)
5. [To load a wrapper](#to-load-a-wrapper)
6. [To use setOptions](#to-use-setoptions)
  1. Demo app
1. [Play with the app](#play-with-the-app)
2. [Files to play with](#files-to-play-with)

Getting started

General prerequisites

Make sure you have node, NPM and Angular up to date. Tested and required versions:
  • node 8.9.4+
  • npm 6.1.0+
  • @angular/cli 6.0.0+ (Ideally, it should work with earlier versions of Angular too)

Installing

In a component that will be building your Highcharts charts you will need to import Highcharts first, so in system console, while in your Angular app: ```cli npm install highcharts --save ``` Get package from NPM in your Angular app: ```cli npm install angular-highcharts-chart --save ```

Usage

Next, code sample assumes you are integrating chart in the root module for your applictaion i.e. app.module.ts. But process holds true for any other module of applictaion where you need highchart functionality. In your app.module.ts, import the AngularHighchartsChartModule: ```ts ... import { AngularHighchartsChartModule } from 'angular-highcharts-chart'; @NgModule({ imports:
AngularHighchartsChartModule,
...
``` Next, in the app.component.ts, in top lines where other imports are add another one for Highcharts: ```ts import as Highcharts from 'highcharts'; ``` In the same file (app.component.ts) add to the template component selector lib-highcharts-angular: ```html Highcharts
="Highcharts" constructorType="chartConstructor" options="chartOptions" callbackFunction="chartCallback" (update)="updateFlag" oneToOne="oneToOneFlag" style="width: 100%; height: 400px; display: block;" > ``` Right side names, in double quotes, are just names of variables you are going to set next, so you could name then whatever you like. Style at the bottom of the selector is optional, but browsers do not know how to display <lib-highcharts-angular>, so you should set some styles. In the same file (app.component.ts) all variables should be set in export class AppComponent { like: ```ts export class AppComponent { Highcharts = Highcharts; // required chartConstructor = 'chart'; // optional string, defaults to 'chart' chartOptions = { ... }; // required chartCallback = function (chart) { ... } // optional function, defaults to null updateFlag = false; // optional boolean oneToOneFlag = true; // optional boolean, defaults to false ... ``` Used options are explained below.

Hello world demo

To create a simple demo start with installing. Next for app.component.ts's HTML template use: ```html Highcharts="Highcharts" options="chartOptions" style="width: 100%; height: 400px; display: block;" > ``` and export variables: ```ts export class AppComponent { Highcharts = Highcharts; chartOptions = {
series: [{
data: [1, 2, 3]
}]
}; ... ``` Build and run your Angular app to see a basic line chart.

Options details

  1. [Highcharts]="Highcharts"
The option is required. This is a Highcharts instance with required core and optional modules, plugin, maps, wrappers and set global options using setOptions. More detail for the option in the next documentation section.
  1. [constructorType]="chartConstructor"
The option is optional. This is a string for constructor method. Possible values:
  • 'chart' - for standard Highcharts constructor - for any Highcharts instance, this is default value
  • 'stockChart' - for Highstock constructor - Highstock is required
  • 'mapChart' - for Highmaps constructor - Highmaps or map module is required
  1. [options]="chartOptions"
The option is required. Possible chart options could be found in Highcharts API reference. Minimal working object that could be set for basic testing is { series:[{ data:[1, 2] }] }.
  1. [callbackFunction]="chartCallback"
The option is optional. A callback function for the created chart. First argument for the function will hold the created chart. Default this in the function points to the chart.
  1. [(update)]="updateFlag"
The option is optional. A boolean to trigger update on a chart as Angular is not detecting nested changes in a object passed to a component. Set corresponding variable (updateFlag in the example) to true and after update on a chart is done it will be changed asynchronously to false by Highcharts-angular component.
  1. [oneToOne]="oneToOneFlag"
The option is optional, defaults to false. The oneToOne parameter for updates. 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 (and this is called on each chart's data change or if updateFlag is set to true) 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. The options is presented in the demo in the first chart - try setting new chart options with different amounts of series in the textarea input to see this options in action.

Highcharts instance details

This is a Highcharts instance optionally with initialized modules, plugins, maps, wrappers and set global options using setOptions. The core is required.

Core

As core you could load
Highcharts, Highstock or Highmaps.
  • For Highcharts:
```ts import as Highcharts from 'highcharts'; ```
  • For Highstock:
```ts import
as Highcharts from 'highcharts/highstock'; ```
  • For Highmaps:
```ts import as Highcharts from 'highcharts/highmaps'; ``` or as Highcharts with map module: ```ts import as Highcharts from 'highcharts'; import as HCmap from 'highcharts/modules/map'; HCmap(Highcharts); ```

To load a module

A module is a Highcharts official addon. After Highcharts is imported using Highcharts, Highstock or Highmaps use require and initialize each module on the Highcharts variable. ```ts import
as Highcharts from 'highcharts'; require('highcharts/modules/exporting')(Highcharts); ``` This could be done without require
, but the initialization is still needed. ```ts import as Highcharts from 'highcharts'; import as HCexporting from 'highcharts/modules/exporting'; HCexporting(Highcharts); ```

To load a plugin

A plugin is a third party/community made Highcharts addon (plugins are listed in the Highcharts plugin registry). First, make sure that a plugin support loading over NPM and load the required files. In example Custom-Events supports NPM loading, so after installing the package you could initialize it like: ```ts import as Highcharts from 'highcharts'; import as HCcustomEvents from 'highcharts-custom-events'; HCcustomEvents(Highcharts); ``` If a plugin doesn't support loading through NPM you could treat it as a wrapper - see instructions below.

To load a map for Highmaps

A map is JSON type file containing mapData code used when a chart is created. Download a map from official Highcharts map collection in Javascript format or use a custom map and add it to your app. Edit the map file, so it could be loaded like a module by adding to beginning and end of a file code below: ```js (function (factory) {
if (typeof module === 'object' && module.exports) {
module.exports = factory;
} else {
factory(Highcharts);
}
}(function (Highcharts) { ... / map file data / ... })); ``` In case of using a GeoJSON map file format you should add the above code and additionally, between the added beginning and the map file data, the below code: ```js Highcharts.maps"myMapName" = ``` Where "myMapName" is yours map name that will be used when creating charts. Next, you will be loading a local .js file, so you should add in tsconfig.json in your app allowJs: true: ```js ... "compilerOptions": {
"allowJs": true,
...
``` Notice: this is not required for all Typescript / Angular versions - you can build the demo app with allowJs set to false for some cases. This part of the documentation will be revisited after Typescript / Angular further changes regarding this issue. The map is ready to be imported to your app. Use require instead of import to prevent TS5055 errors. ```ts import as Highcharts from 'highcharts/highmaps'; require('./relative-path-to-the-map-file/map-file-name')(Highcharts); ``` Where relative-path-to-the-map-file should be relative (for the module importing the map) path to the map file and map-file-name should be the name of the map file. The file should be placed in a directory that is not checked by typeScript. See example in this repository:
  • config in 'tsconfig.json'
  • map file in 'js' directory

To load a wrapper

A wrapper is a custom extension
for Highcharts. To load a wrapper the same way as a module you could save it as a Javascript file and edit it by adding to beginning and end of a file same code as for a map: ```js (function (factory) {
if (typeof module === 'object' && module.exports) {
module.exports = factory;
} else {
factory(Highcharts);
}
}(function (Highcharts) { ... / wrapper code / ... })); ``` Next, you will be loading a local .js file, so you should add in tsconfig.json in your app allowJs: true: ```js ... "compilerOptions": {
"allowJs": true,
...
``` The wrapper is ready to be imported to your app. Use require instead of import to prevent TS5055 errors. ```ts import as Highcharts from 'highcharts'; require('./relative-path-to-the-wrapper-file/wrapper-file-name')(Highcharts); ``` Where relative-path-to-the-wrapper-file should be relative (for the module importing the wrapper) path to the wrapper file and wrapper-file-name should be the name of the wrapper file. The file should be placed in a directory that is not checked by typeScript. See example in this repository:
  • config in 'tsconfig.json'
  • map file in 'js' directory

To use setOptions

The best place to use setOptions is afer your Highcharts instance is ready and before Highcharts variable is set in the main component. Example: ``` import
as Highcharts from 'highcharts/highstock'; import as HCmap from 'highcharts/modules/map'; HCmap(Highcharts); Highcharts.setOptions({ title: {
style: {
color: 'orange'
}
} }); ... export class AppComponent { Highcharts = Highcharts; ```