Highcharts Orbit adds an analysis toolbar to Highcharts charts, maps and grids. These pages show its options, tools and modes one at a time.
How it works
- Load Orbit after Highcharts, from your deployment's own URL.
- Add
orbit: { enabled: true }to a chart to give it a toolbar. - Each chart shows only the tools its data supports.
1 · Add the script
Load Highcharts and the modules some tools need, then Orbit.
You need a deployment key. Orbit loads from
/module/<YOUR-DEPLOYMENT-KEY>/orbit.js. The key identifies your deployment,
authenticates its API calls and sets which tools and plugins are on. It only goes in this URL, so
there's no configure() call to make.
Get a key
<script src="https://code.highcharts.com/highcharts.js"></script> <script src="https://code.highcharts.com/modules/exporting.js"></script> <script src="https://code.highcharts.com/modules/annotations.js"></script> <!-- Orbit: replace <YOUR-DEPLOYMENT-KEY> with your deployment key --> <script src="/module/<YOUR-DEPLOYMENT-KEY>/orbit.js"></script>
These demos use the public
highcharts deployment key, which won't work on other deployments. A key loads Orbit only on its deployment's Sites, so use it on your own domains. On localhost it works only with a separate local deployment.2 · Opt a chart in
This chart uses one line of config and gets every tool the deployment offers.
Open Forecast, Summary or Insights from the toolbar, or use the
View picker to see the data as a distribution or KPI tiles.
See also: the Getting Started guide.