README.md

Quickstart Guide

Quickly add charts to your Angular application with our ZingChart component

This guide assumes some basic working knowledge of Angular and its Object Oriented interface.

1. Install

Install the zingchart-angular package via npm

npm install zingchart-angular

Note: If using the angular-cli to generate a project, you will need to use npm install zingchart-angular --legacy-peer-deps. Note: If using the Ivy compiler, add “postinstall”:”ngcc” to your package.json.

2. Include the zingchartAngular module in your project

You can import the module in your module declaration file. This is typically app.module.ts for many hello world examples.

import { ZingchartAngularModule } from 'zingchart-angular';

@NgModule({
  imports: [
    ...
    ZingchartAngularModule,
  ],
})

3. Define ZingChart in your component

Default Use Case

The simple use case is defining a config (ZingchartAngular.graphset) object in your .component.ts file:

import { Component } from '@angular/core';

@Component({
  templateUrl: '...',
})

export class AppComponent {
  config: ZingchartAngular.graphset = {
    type: 'line',
    series: [{
      values: [3,6,4,6,4,6,4,6]
    }],
  };
}

Then add the zingchart-angular tag in your .component.html file to tie it all together!

<zingchart-angular [config]="config" [height]="500"></zingchart-angular>

Import ZingChart Modules

You must EXPLICITLY IMPORT MODULES AND ZINGCHART. There is NO default export objects so just import them.

import { Component } from '@angular/core';
// EXPLICITLY IMPORT ZINGCHART AND MAPS MODULES from node_modules
import "zingchart";
import "zingchart/modules-es6/zingchart-maps.min.js";
import "zingchart/modules-es6/zingchart-maps-usa.min.js";

@Component({
  templateUrl: '...',
})

export class AppComponent {
  config: ZingchartAngular.graphset = {
    shapes: [
      {
        type: "zingchart.maps",
        options: {
          name: "usa",
          ignore: ["AK", "HI"]
        }
      }
    ]
  };
}

zingchart Global Objects

If you need access to the window.zingchart objects for licensing or development flags, import zingchart from zingchart/es6.

import { Component } from '@angular/core';
import zingchart from 'zingchart/es6';

// zingchart object for performance flags
zingchart.DEV.KEEPSOURCE = 0; // prevents lib from storing the original data package
zingchart.DEV.COPYDATA = 0; // prevents lib from creating a copy of the data package 

// ZC object for license key
zingchart.LICENSE = ['your_zingchart_license_key'];
// for enterprise licensing
zingchart.BUILDCODE = ['your_zingchart_license_buildcode'];

@Component({
  templateUrl: '...',
})

export class AppComponent {
  config: ZingchartAngular.graphset = {
    type: 'line',
    series: [{
      values: [3,6,4,6,4,6,4,6]
    }],
  };
}

Parameters

config [object]

The chart configuration (graphset)

config: ZingchartAngular.graphset = {
  type: 'line',
  series: [{
    values: [3,6,4,6,4,6,4,6]
  }],
};

<zingchart-angular [config]="config" [height]="500"></zingchart-angular>

id [string] (optional)

The id for the DOM element for ZingChart to attach to. If no id is specified, the id will be autogenerated in the form of zingchart-angular-#

series [array] (optional)

Accepts an array of series objects, and overrides a series if it was supplied into the config object. Varies by chart type used - Refer to the ZingChart documentation for more details.

series: ZingchartAngular.series = {
  values: [3,6,4,6,4,6,4,6]
}
config: ZingchartAngular.graphset = {
  type: 'line',
};

<zingchart-angular [config]="config" [height]="500" [series] = "[series]"></zingchart-angular>

width [string or number] (optional)

The width of the chart. Defaults to 100%

height [string or number] (optional)

The height of the chart. Defaults to 480px.

output [string] (optional)

The render type of the chart. The default is svg but you can also pass the string canvas to render the charts in canvas.

theme [object] (optional)

The theme or 'defaults' object defined by ZingChart. More information available here: https://www.zingchart.com/docs/api/themes

Events

All zingchart events are readily available on the component to listen to. For example, to listen for the 'complete' event when the chart is finished rendering:

.component.html file:

<zingchart-angular [config]="config" [height]="300" (node_click)="nodeClick($event)"></zingchart-angular>

.component.ts file:

export class AppComponent {
  nodeClick(event: Event) {
    console.log('zingchart node clicked test!', event);
  }
}

For a list of all the events that you can listen to, refer to the complete documentation on https://www.zingchart.com/docs/api/events

Methods

All zingchart methods are readily available on the component's instance to call. For example, to retrieve data from the chart:

.component.html file:

<zingchart-angular #chart1 [config]="config"></zingchart-angular></zingchart-angular>

<button (click)="getData(chart1)">Fetch Data</button>

.component.ts file:

import { Component } from '@angular/core';

export class AppComponent {
  ...
  getData(chartContext: any) {
    console.log('Fetching zingchart config object', chartContext.getdata());
  }
}

or alternatively you can use ViewChild to access the chart instead of passing a reference of it in the method.

<zingchart-angular #chart1 [config]="config"></zingchart-angular></zingchart-angular>

<button (click)="getData()">Fetch Data</button>

.component.ts file:

import { Component, ViewChild } from '@angular/core';

export class AppComponent {
  @ViewChild('chart1') chart1: any;
  ...
  getData() {
    console.log('Fetching zingchart config object', this.chart1.getdata());
  }
}

For a list of all the methods that you can call and the parameters each method can take, refer to the complete documentation on https://www.zingchart.com/docs/api/methods

Working Example

This repository contains a "Hello world" example to give you an easy way to see the component in action.

To start the sample application:

npm run start