highcharts / highcharts-declarations-generator Goto Github PK

Highcharts JS is a JavaScript charting library based on SVG and some canvas/WebGL.

• Official website: www.highcharts.com
• Download page: www.highcharts.com/download
• Licensing: shop.highcharts.com
• Support: www.highcharts.com/support
• Issues: Repo guidelines

Highcharts is a source available product. Please refer to shop.highcharts.com for details on licensing.

This is the working repo for Highcharts code. If you simply want to include Highcharts into a project, use the distribution package instead, or read the download page.

Please note that there are several ways to use Highcharts. For general installation instructions, see the docs.

Instead of downloading, you can use our CDN to access files directly. See code.highcharts.com for details.

<script src="https://code.highcharts.com/highcharts.js"></script>

See npm documentation on how to get started with npm.

npm install --save highcharts

For other ways to use Highcharts in your projects, please refer to our installation docs.

To reduce file size, or combine modules into one file to reduce latency, you may want to create your own build of the Highcharts modules. See Creating custom Highcharts files for more information.

If you want to do modifications to Highcharts or fix issues, you may build your own files. Highcharts uses Gulp as the build system. After npm install in the root folder, run gulp, which will set up a watch task for the JavaScript and CSS files. Now any changes in the files of the /js or /css folders will result in new files being built and saved in the code folder. Other tasks are also available, like gulp lint.

npm install
gulp

When running Node natively on ARM64 MacOS, some Node packages like node-canvas with integrated compiling might fail. Install additional tools to resolve the problem:

• Homebrew and run brew install pkg-config cairo pango libpng jpeg giflib librsvg pixman

Run in this highcharts repository the doc generator with npx gulp jsdoc-watch, which also starts a new server with the generated API documentation.