Vaadin Charts

Live Demo ↗ | API documentation ↗

Vaadin Charts is a Web Component for creating high quality charts, part of the Vaadin components.

<vaadin-chart type="pie">
  <vaadin-chart-series values='[
      ["Firefox", 45.0],
      ["IE", 26.8],
      ["Chrome", 12.8],
      ["Safari", 8.5],
      ["Opera", 6.2],
      ["Others", 0.7]]'>
  </vaadin-chart-series>
</vaadin-chart>

Relevant links

• Product page https://vaadin.com/charts
• Trial license https://vaadin.com/pro/licenses

Installation

Install vaadin-charts:

npm i @vaadin/vaadin-charts --save

Once installed, import it in your application:

import '@vaadin/vaadin-charts/vaadin-chart.js';

Install License Key

After one day using Vaadin Charts in a development environment you will see a pop-up that asks you to enter the license key. You can get your trial key from https://vaadin.com/pro/licenses. If the license is valid, it will be saved to the local storage of the browser and you will not see the pop-up again.

Running API docs and tests in a browser

1. Fork the vaadin-charts repository and clone it locally.

2. Make sure you have node.js 12.x installed.

3. Make sure you have npm installed.

4. When in the vaadin-charts directory, run npm install to install dependencies.

5. Run npm start, browser will automatically open the component API documentation.

6. You can also open visual tests, for example:

• http://localhost:8000/test/visual/default.html

Running tests from the command line

1. When in the vaadin-charts directory, run npm test

Debugging tests in the browser

1. Run npm run debug, then choose manual mode (M) and open the link in browser.

Following the coding style

We are using ESLint for linting JavaScript code. You can check if your code is following our standards by running npm run lint, which will automatically lint all .js files.

Contributing

To contribute to the component, please read the guideline first.

License

Vaadin Charts is distributed under the terms of Commercial Vaadin Developer License 4.0 ("CVDLv4"). A copy of the license is included as LICENSE.txt in this software package.

Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.