Module adapters/highcharts

Public Highcharts adapter API for MAIDR.

Provides the highchartsToMaidr function to convert Highcharts chart instances into MAIDR-compatible data (including multi-pane charts, which become MAIDR subplot grids), highchartsGridToMaidr to combine several chart instances into one figure with subplot navigation, and createHighchartsSync for bidirectional visual synchronization (tooltip and point highlighting).

Remarks

Highcharts is not bundled — users must provide their own Highcharts installation. This module only reads from the Highcharts chart API and generates a plain JSON descriptor that MAIDR understands.

The trace types Highcharts draws with a series type it shares with something else are declared in the maidr block of a series' custom subspace, which is why MaidrTraceDeclaration and the variants this adapter reads are re-exported here.

Example

import Highcharts from 'highcharts';
import { createHighchartsSync, highchartsToMaidr } from 'maidr/highcharts';

const chart = Highcharts.chart('container', {
  chart: { type: 'column' },
  title: { text: 'Fruit Consumption' },
  xAxis: { categories: ['Apples', 'Bananas', 'Oranges'] },
  series: [{ name: 'Sales', data: [1, 4, 3] }],
});

const maidrData = highchartsToMaidr(chart);
const sync = createHighchartsSync(chart);

References

ChoroplethDeclaration → ChoroplethDeclaration
FieldRef → FieldRef
ForestDeclaration → ForestDeclaration
MaidrTraceDeclaration → MaidrTraceDeclaration
SeriesRef → SeriesRef
SurvivalDeclaration → SurvivalDeclaration
highchartsToMaidr → highchartsToMaidr
highchartsGridToMaidr → highchartsGridToMaidr
createHighchartsSync → createHighchartsSync
HighchartsSync → HighchartsSync
HighchartsAdapterOptions → HighchartsAdapterOptions
HighchartsAxis → HighchartsAxis
HighchartsChart → HighchartsChart
HighchartsGridOptions → HighchartsGridOptions
HighchartsPoint → HighchartsPoint
HighchartsSeries → HighchartsSeries

src

Module adapters/highcharts

Remarks

Example

References

Settings

On This Page