MAIDR Documentation - v3.69.0
    Preparing search index...

    Module adapters/highcharts

    Public Highcharts adapter API for MAIDR.

    Provides the highchartsToMaidr function to convert Highcharts chart instances into MAIDR-compatible data, and createHighchartsSync for bidirectional visual synchronization (tooltip and point highlighting).

    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.

    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

    highchartsToMaidr → highchartsToMaidr
    createHighchartsSync → createHighchartsSync
    HighchartsSync → HighchartsSync
    HighchartsAdapterOptions → HighchartsAdapterOptions
    HighchartsAxis → HighchartsAxis
    HighchartsChart → HighchartsChart
    HighchartsPoint → HighchartsPoint
    HighchartsSeries → HighchartsSeries

    Settings

    Member Visibility

    On This Page

    References