@mui/x-charts/context/ChartsProvider/ChartsProvider.types.d.ts

The community edition of MUI X Charts components.

import { type Store } from '@mui/x-internals/store';
import type { ChartAnyPluginSignature, ChartInstance, ChartPublicAPI, ChartSeriesConfig, ChartState, ConvertSignaturesIntoPlugins, MergeSignaturesProperty } from "../../internals/plugins/models/index.js";
import type { ChartCorePluginSignatures } from "../../internals/plugins/corePlugins/index.js";
import type { UseChartBaseProps } from "../../internals/store/useCharts.types.js";
import type { ChartSeriesType } from "../../models/seriesType/config.js";
export type ChartsContextValue<TSignatures extends readonly ChartAnyPluginSignature[], TOptionalSignatures extends readonly ChartAnyPluginSignature[] = []> = {
  /**
   * And object with all the methods needed to interact with the chart.
   */
  instance: ChartInstance<TSignatures, TOptionalSignatures>;
  /**
   * A subset of the `instance` method that are exposed to the developers.
   */
  publicAPI: ChartPublicAPI<TSignatures, TOptionalSignatures>;
  /**
   * The internal state of the chart.
   */
  store: Store<ChartState<TSignatures, TOptionalSignatures>>;
  /**
   * The ref to the <svg />.
   */
  svgRef: React.RefObject<SVGSVGElement | null>;
  /**
   * The ref to the chart root element.
   */
  chartRootRef: React.RefObject<HTMLDivElement | null>;
};
export type ChartsPluginParams<TSeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[]> = UseChartBaseProps<TSignatures> & MergeSignaturesProperty<[...ChartCorePluginSignatures<TSeriesType>, ...TSignatures], 'params'>;
export interface ChartsProviderProps<TSeriesType extends ChartSeriesType, TSignatures extends readonly ChartAnyPluginSignature[]> {
  /**
   * Array of plugins used to add features to the chart.
   */
  plugins?: ConvertSignaturesIntoPlugins<TSignatures>;
  pluginParams?: ChartsPluginParams<TSeriesType, TSignatures>;
  /**
   * The configuration helpers used to compute attributes according to the series type.
   * @ignore Unstable props for internal usage.
   */
  seriesConfig?: ChartSeriesConfig<TSeriesType>;
}