Vaadin Charts

Vaadin Charts is a UI component add-on for Vaadin Framework 7+ which provides means to create multiple different types of charts in Vaadin applications.

License & Author

This Add-on is distributed under Vaadin Commercial License and Service Terms (VCL).

Vaadin Charts is written by Vaadin Ltd.

Setting up for development:

Clone the project in GitHub (or fork it if you plan on contributing) and required submodules

git clone git@github.com:vaadin/charts.git
git submodule init
git submodule update

To build and install the project into the local repository run

mvn install -DskipITs

in the root directory. -DskipITs will skip the integration tests, which require a TestBench license. If you want to run all tests as part of the build, run

mvn install

Demos

To view the included demos, run

mvn jetty:run

in the demo directory and navigate to http://localhost:8080

To run with Super Dev Mode, run

mvn vaadin:run-codeserver

in the demo directory.

You need to have the UI jetty running as well, then navigate to http://localhost:8080/?superdevmode

Running integration tests locally

1. run mvn jetty:run in the integration-tests directory
2. add -DlocalChrome=true (or similar for Phantom, Firefox, or Edge) as a JVM argument
3. run one of the test classes (e.g. BarWithDisabledStateTBTest) in integration-tests module as a JUnit test
4. OR navigate to http://localhost:9998// (e.g. http://localhost:9998/columnandbar/BarWithDisabledState) to test it manually

Things to take into account:

• If you use -DlocalPhantom=true, PhantomJS needs to be installed separately and added to PATH
• WebDriverManager takes care of Chrome, Firefox, and Edge drivers, no need to download those separately
• Any test that extends AbstractSimpleScreenShotTestBenchTest is likely to fail locally because different environments render things slightly differently

Project modules

• The demo module contains a web app that shows most of the integration tests in a simple demo app.
• The chart-export-demo module demonstrates how charts can be converted to SVG and via it used in e.g. PDF documents.
• The chart-plugin-demo shows how the underlying library version can be changed and how plugins can be used with Vaadin Charts.