HighchartsReact.d.ts

/*
 * Copyright (C) Highsoft AS
 */

import * as React from 'react';
import * as Highcharts from 'highcharts';

/**
 * Highcharts component for React
 */
declare const HighchartsReact: React.ForwardRefExoticComponent<
  React.PropsWithoutRef<HighchartsReactProps> &
    React.RefAttributes<HighchartsReactRefObject>
>;

interface HighchartsReactRefObject {
  chart: Highcharts.Chart;

  /**
   * React reference
   */
  container: React.RefObject<HTMLDivElement>;
}

interface HighchartsReactProps {
  /* *
   *
   *  Properties
   *
   * */

  /**
   * Indexer for custom properties
   */
  [key: string]: any;

  /**
   * Flag for `Chart.update` call (Default: true)
   */
  allowChartUpdate?: boolean;

  /**
   * Reference to the chart factory (Default: chart)
   */
  constructorType?: keyof typeof Highcharts;

  /**
   * Properties of the chart container
   */
  containerProps?: { [key: string]: any };

  /**
   * Highcharts namespace
   */
  highcharts?: typeof Highcharts;

  /**
   * Immutably recreates the chart on receiving new props
   */
  immutable?: boolean;

  /**
   * Highcharts options
   */
  options?: Highcharts.Options;

  /**
   * Flags for `Chart.update` call: redraw, oneToOne, and animation. (Default:
   * [true, true, true])
   */
  updateArgs?: [boolean] | [boolean, boolean] | [boolean, boolean, boolean];

  /* *
   *
   *  Functions
   *
   * */

  /**
   * Callback for the chart factory
   */
  callback?: Highcharts.ChartCallbackFunction;
}

declare namespace HighchartsReact {
  /**
   * Properties for a HighchartsReact component
   */
  interface RefObject extends HighchartsReactRefObject {}
  interface Props extends HighchartsReactProps {}
}

export { HighchartsReact, HighchartsReactRefObject, HighchartsReactProps };
export default HighchartsReact;