Skip to content

Latest commit

 

History

History
110 lines (78 loc) · 4.32 KB

README.md

File metadata and controls

110 lines (78 loc) · 4.32 KB
Raw

Highcharts Editor

Stand-alone and embeddable chart editor for Highcharts

This is beta software!

screenshots/customize.png

Click here for live demos

Introduction

highcharts-editor is a lightweight chart editor for highcharts that can be embedded into existing frameworks and libraries, or used stand-alone. It requires no back-end service to operate.

Features

  • Light on dependencies: requires only Highcharts, FontAwesome, and (optionally) two Google Fonts
  • Lightweight: weighs in at ~40kb minified and gzipped
  • 100% client-side
  • Outputs embeddable HTML, JavaScript, and JSON
  • Optional wizard-style interface
  • Highly configurable
  • Plug-in system

Installing and Building

Pre-built

We strongly encourage you to use the pre-built stable versions of the editor.

You can find these here.

Cloning and building the repository

git clone https://github.com/highcharts/highcharts-editor
cd highcharts-editor
npm install
gulp

Build options

  • gulp: Builds distribution packages for the editor and the bundled integrations and plugins
  • gulp electron: Builds Electron packages for Windows/Linux/OSX
  • gulp with-advanced: Builds packages for the advanced editor which exposes all API settings

Notice for windows users: You need 7zip installed and added to your path for gulp electron to work!

This will put a built version in the dist folder.

Running from unminified sources locally

If extending/modifying the editor code itself (or adding themes etc.), use the bundled express server. This server uses the source files directly without minifying/concatenating which makes it easier to debug and test things. It also bakes the Less files for each request.

Run node bin/www to start it, then head to http://127.0.0.1:3005 for further instructions.

If you want to add new source files, add it to res/filelist.json, and it should be picked up in both the build script and the server. Note that the include order matters, so be sure to add it at the bottom, or before any other files that might depend on its content.

Embedding Hello World

<!DOCTYPE html>
<html>
	<head>
  <link href="highcharts-editor.min.css" type="text/css" rel="stylesheet"/>
  <script src="highcharts-editor.min.js" type="text/javascript" charset="utf-8"></script>
	</head>
	<body>
	</body>
	<script>
		//Create an editor widget and attach it to the document body      
		highed.Editor(document.body).on('ChartChange', function (data) {
      //Do something with the modified chart here.
  });
	</script>
</html>

Integrations

A number of example integrations are included in the editor:

API Reference & General Documentation

Documentation can also be generated offline by running js-skald in the project root, which outputs the API reference in the docs/.

js-skald is a simple doc generator that outputs markdown files and JSON trees representing the code. It can be installed by running npm install -g js-skald.

License

The editor is licensed under MIT.

Note that the use of Highcharts itself (which the editor depends on) falls under the Highcharts License.