@mui/x-charts/internals/plugins/featurePlugins/useChartCartesianAxis/useChartCartesianAxis.types.d.ts

The community edition of MUI X Charts components.

import type { ChartPluginSignature } from "../../models/index.js";
import type { ChartSeriesType, DatasetType } from "../../../../models/seriesType/config.js";
import type { ComputedAxis, ScaleName, AxisId, ChartsAxisData, YAxis, XAxis, DefaultedXAxis, DefaultedYAxis } from "../../../../models/axis.js";
import type { UseChartSeriesSignature } from "../../corePlugins/useChartSeries/index.js";
import type { ZoomData, ZoomOptions, ZoomSliderShowTooltip } from "./zoom.types.js";
import type { UseChartInteractionSignature } from "../useChartInteraction/index.js";
import type { ChartsAxisProps } from "../../../../ChartsAxis/index.js";
/**
 * The axes' configuration after computing.
 * An axis in this state already contains a scale function and all the necessary properties to be rendered.
 */
export type ComputedAxisConfig<AxisProps extends ChartsAxisProps> = {
  [axisId: AxisId]: ComputedAxis<ScaleName, any, AxisProps>;
};
export interface UseChartCartesianAxisParameters<S extends ScaleName = ScaleName> {
  /**
   * The configuration of the x-axes.
   * If not provided, a default axis config is used.
   * An array of [[AxisConfig]] objects.
   */
  xAxis?: ReadonlyArray<XAxis<S>>;
  /**
   * The configuration of the y-axes.
   * If not provided, a default axis config is used.
   * An array of [[AxisConfig]] objects.
   */
  yAxis?: ReadonlyArray<YAxis<S>>;
  /**
   * An array of objects that can be used to populate series and axes data using their `dataKey` property.
   */
  dataset?: Readonly<DatasetType>;
  /**
   * The function called for onClick events.
   * The second argument contains information about all line/bar elements at the current mouse position.
   * @param {MouseEvent} event The mouse event recorded on the `<svg/>` element.
   * @param {null | ChartsAxisData} data The data about the clicked axis and items associated with it.
   */
  onAxisClick?: (event: MouseEvent, data: null | ChartsAxisData) => void;
  /**
   * If `true`, the charts will not listen to the mouse move event.
   * It might break interactive features, but will improve performance.
   * @default false
   */
  disableAxisListener?: boolean;
}
export type UseChartCartesianAxisDefaultizedParameters<S extends ScaleName = ScaleName> = UseChartCartesianAxisParameters<S> & {
  defaultizedXAxis: DefaultedXAxis<S>[];
  defaultizedYAxis: DefaultedYAxis<S>[];
};
export interface DefaultedZoomSliderOptions extends Omit<NonNullable<Required<ZoomOptions['slider']>>, 'showTooltip'> {
  showTooltip: ZoomSliderShowTooltip;
}
export interface DefaultizedZoomOptions extends Required<Omit<ZoomOptions, 'slider'>> {
  axisId: AxisId;
  axisDirection: 'x' | 'y';
  slider: DefaultedZoomSliderOptions;
}
export interface UseChartCartesianAxisState {
  /**
   * @ignore - state populated by the useChartProZoomPlugin
   */
  zoom?: {
    isInteracting: boolean;
    zoomData: readonly ZoomData[];
  };
  cartesianAxis: {
    x: DefaultedXAxis[];
    y: DefaultedYAxis[];
  };
}
export type ExtremumFilter = (value: {
  x: number | Date | string | null;
  y: number | Date | string | null;
}, dataIndex: number) => boolean;
export type UseChartCartesianAxisSignature<SeriesType extends ChartSeriesType = ChartSeriesType> = ChartPluginSignature<{
  params: UseChartCartesianAxisParameters;
  defaultizedParams: UseChartCartesianAxisDefaultizedParameters;
  state: UseChartCartesianAxisState;
  dependencies: [UseChartSeriesSignature<SeriesType>];
  optionalDependencies: [UseChartInteractionSignature];
}>;