highcharts README

The project's README from github.com/highcharts/highcharts. As one markdown file: README.md.

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

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

Installing and using Highcharts

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.

Use our CDN

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>

Install from npm

See npm documentation on how to get started with npm.

npm install --save highcharts

ES6 modules, AMD, CommonJS and others

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

Native iOS integration

For native iOS apps, Highcharts is commonly used through the highcharts/highcharts-ios wrapper, which is currently community-maintained.

Create your own custom build of Highcharts

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.

Build and debug

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

Node setup for Apple Mx CPU

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:

Generate API docs

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

highcharts (highcharts/highcharts)

Searching Database…

Что это такое?Highcharts — это библиотека JavaScript для построения интерактивных диаграмм, карт и дашбордов. Отрисовка в основном выполняется через SVG, а также частично через canvas и WebGL.
Это фреймворк, на котором я строю проект, или библиотека, которую я добавляю в существующий проект?Это библиотека JavaScript для диаграмм, которую добавляют в существующий веб-проект через npm, CDN или модульные системы, а не самостоятельный фреймворк или приложение.
Как подключить Highcharts к моему проекту?Загрузите его с CDN Highcharts (code.highcharts.com), установите через npm или используйте как модуль ES6/AMD/CommonJS согласно документации по установке.
Нужны ли какие-то специальные инструменты, чтобы просто использовать Highcharts на странице?Нет, достаточно npm или тега script с CDN. Node и Gulp нужны только если вы хотите собрать Highcharts из исходников или создать собственную сборку.
Можно ли использовать Highcharts бесплатно?Это продукт с «source available» (доступным исходным кодом), а не полностью открытое ПО, поэтому перед использованием, особенно в коммерческих целях, нужно проверить условия лицензирования в магазине лицензий.
Работает ли это вне браузера, например в приложениях для iOS?Нативные приложения iOS обычно используют Highcharts через отдельную обёртку highcharts/highcharts-ios, которую поддерживает сообщество, а не через основной JS-репозиторий.
Зачем создавать собственную сборку Highcharts вместо полного пакета?Чтобы уменьшить размер файла или объединить модули в один файл и сократить задержки, можно создать собственную сборку с помощью встроенных в Highcharts инструментов сборки.
Могу ли я сам сгенерировать документацию API?Да, запуск генератора документации в репозитории собирает документацию API и открывает её на локальном сервере для просмотра.
Есть ли подводные камни при сборке Highcharts на Mac с Apple Silicon?Некоторые пакеты Node, например node-canvas, могут не компилироваться нативно на macOS ARM64. Перед этим нужно установить Homebrew и дополнительные нативные библиотеки (cairo, pango, libpng и др.).
What are similar projects?apexcharts.js, vega, G2, Vela, d3, plotly.js, uPlot, chartist
Creator
highcharts
Size
423.1 MB
Stars
12.5K
Updated
CommitOct 16
Age
16y
Commits · 90 Days