Skip to content

Latest commit

 

History

History
255 lines (193 loc) · 10.8 KB

README.md

File metadata and controls

255 lines (193 loc) · 10.8 KB
Raw

Highcharts-Vue

The official Highcharts integration with Vue.

❗ IMPORTANT NOTE: From [email protected], this package offers support for Vue >= 3.0.0. If you'd like to use this package with Vue 2, you should stay with the latest versions of [email protected] (Note: Vue2 is getting officially deprecated❗

Table of Contents

  1. Getting started
    1. Requirements
    2. Installation
  2. Usage
    1. Registering globally as a plugin
    2. Registering locally in your component
    3. Implementing stockChart, mapChart and ganttChart
    4. Loading maps
    5. Changing global component tag name
    6. Chart callback parameter
    7. Chart object reference
    8. Using a specific Highcharts instance
  3. Demo apps
  4. Online demos
  5. Component Properties
  6. Useful links

Getting started

Requirements

  • Node.JS, NPM installed globally in your OS
  • Vue, Highcharts libraries (updated) installed in your project. Highcharts package version should be at least v5.0.11, but it is always better to keep it updated.

Installation

Install highcharts-vue package by:

npm install highcharts-vue

Usage

There are two ways of adding the Highcharts-Vue package to your project:

Registering globally as a plugin

The way described below is recommended when wanted to make the HighchartsVue component available from everywhere in your app. In your main app file should have Vue and Highcharts-Vue packages imported:

import Vue from 'vue';
import HighchartsVue from 'highcharts-vue';

Next, you can register it as a plugin (depending on the version of Vue):

// for Vue 2
Vue.use(HighchartsVue)

// for Vue 3
app.use(HighchartsVue)

Registering locally in your component

This option is recommended for direct use in specific components of your app. First, you should import the Chart component object from highcharts-vue package in your component file:

import { Chart } from 'highcharts-vue'

Then, you can use the Chart component in your Vue components.

NOTE: If you would like to use Highcharts-Vue integration by attaching it using <script> tag in your <head> section of HTML document, of course it is possible and you should use one of .js files from dist of this package directory. After that, the HighchartsVue object should be available from window scope. Here is the example with this way of implementation: JSFiddle example

Configure

Options parameter

If you've done one of the above (importing and registering the integration), it allows you to use the Highcharts-Vue component in your app, just by adding <highcharts> html element, and passing chart configuration object by its :options parameter, which is required:

<highcharts :options="chartOptions"></highcharts>

for example:

new Vue({
  data() {
    return {
      chartOptions: {
        series: [{
          data: [1,2,3] // sample data
        }]
      }
    }
  }
})

Importing Highcharts modules

To use any of Highcharts modules, you're obligated to import that module to your file, as well as Highcharts package itself and add that module by passing Highcharts to it, for example:

import Highcharts from 'highcharts'
import exportingInit from 'highcharts/modules/exporting'

exportingInit(Highcharts)

Demo: https://codesandbox.io/s/highcharts-vue-demo-fv7m6

Implementing stockChart, mapChart and ganttChart

Highcharts-Vue integration uses chart constructor by default, so if you need to implement stockChart, mapChart or ganttChart, just add stock, map or gantt module as described above and use :constructor-type parameter in your html component element:

import Highcharts from 'highcharts'
import stockInit from 'highcharts/modules/stock'

stockInit(Highcharts)
<highcharts :constructor-type="'stockChart'" :options="chartOptions"></highcharts>

Stock demo: https://codesandbox.io/s/highcharts-vue-demo-qkf43
Map demo: https://codesandbox.io/s/highcharts-vue-demo-cop9z
Gantt demo: https://codesandbox.io/s/highcharts-vue-demo-s8gcg

Loading maps

There are two ways of loading maps and using them with this package. You can install the @highcharts/map-collection` npm package with all maps included, and then import that maps which you would like to use in your project:

import Highcharts from 'highcharts'
import HighchartsMapModule from 'highcharts/modules/map'
import mapData from '@highcharts/map-collection/custom/world.geo.json'

HighchartsMapModule(Highcharts)

Highcharts.maps['myMapName'] = mapData

If you won't install a package with all maps, there is an option to choose necessary map from Highmaps collection collection and copy a map data into a new file in your project. Then just import it wherever you want, and use it in the same way like above.

The Demo apps included in this repository show the second approach.

Map demo: https://codesandbox.io/s/highcharts-vue-demo-cop9z

Changing global component tag name

If you would like to use global component tag name other than <highcharts>, you could achieve that by passing object with tagName: [TAG_NAME] pair as an option argument when registering the plugin, for example:

import { createApp } from 'vue'
import App from './App.vue'
import HighchartsVue from 'highcharts-vue'

const app = createApp(App)
app.use(HighchartsVue, { tagName: 'charts' })

It allows you to use:

<charts :options="chartOptions"></charts>

Chart callback parameter

If you need to use callback from Highcharts.chart(renderTo, options [, callback]) function, you could pass it by :callback parameter through HTML component element:

<highcharts :options="chartOptions" :callback="someFunction">

Then, someFunction will be called when chart is loaded.

Chart object reference

You can access the Chart object instance if necessary (e.g when need to get some data or use any of Chart.prototype functions), by calling specific Vue component instance chart field, but it is not supported to update the chart using its built-in functions, because that could cause a problems with data synchronization between your app and the chart itself (it disturbs conception of using integration packages). The most recommended way of implementing it, is to use it in the way presented in demo apps.

Using Highcharts setOptions() method

If you would like to use Highcharts.setOptions() method to define some parameters which would be set globally on all of charts, we recommend you to use it in the main file of your app, although there should be Highcharts package imported before.

import Highcharts from 'highcharts';

Highcharts.setOptions({
  // options here
})

Using a specific Highcharts instance

Occasionally you'll want to create your charts basing on specific Highcharts version for some reason. Then you can set it up in two different ways, depending on your individual needs.

The first one is by setting a Highcharts instance while registering the HighchartsVue component as a global plugin, by passing it through the options of Vue's install function, as below:

import { createApp } from 'vue'
import App from './App.vue';
import Highcharts from 'highcharts'
import HighchartsVue from 'highcharts-vue'

const app = createApp(App)
app.use(HighchartsVue, {
	highcharts: Highcharts
})

After doing it, all charts will be generated basing on passed instance.

A second way is to pass the Highcharts instance through the props of highcharts component. Then, as a result, only that chart will be generated basing on passed instance:

<highcharts :options="chartOptions" :highcharts="hcInstance"></highcharts>
import Highcharts from 'highcharts'

export default {
	name: 'app',
	data() {
		return {
			hcInstance: Highcharts,
			chartOptions: {
				series: [{
					data: [1, 2, 3]
				}]
			}
		}
	}
}

Note that both ways of usage are optional, because this package automatically uses available Highcharts instance by default from peer dependency.

Server always runs at http://localhost:8080, unless it's taken by another process. Then you need to manually copy & visit the address displayed in terminal.

Online demos

Component Properties

Here is the list of all available props allowed to pass directly to your <highcharts> component instance, which this integration is able to handle.

Parameter Type Required Description
:options Object yes Highcharts chart configuration object
:constructor-type String no Chart constructor type using to init specific chart. Allowed options: 'chart', 'stockChart', 'mapChart'. First one is set for default.
:callback Function no Function passed as a callback during chart init, and triggered when chart is loaded.
:updateArgs Array no Array of update()'s function optional arguments. Parameters should be defined in the same order like in native Highcharts function: [redraw, oneToOne, animation]. Here is a more specific description of the parameters.
:highcharts Object no A specific Highcharts instance. It's useful when required to build charts using different Highcharts versions.
:deepCopyOnUpdate Boolean no Whether to make a deep copy of object passed to Chart.update() function. In order to avoid passing references of arrays, it's set to true by default.

NOTE: That can cause a decrease of performance while processing a big amount of data, because copying source data is much expensive, and then it's recommended to disable that option by setting it to false.

Useful links

Highcharts General Documentation Highcharts API