@mui/x-charts/internals/plugins/featurePlugins/useChartCartesianAxis/useChartCartesianHighlight.selectors.d.mts

The community edition of MUI X Charts components.

import type { AxisId, AxisItemIdentifier, ChartsAxisProps } from "../../../../models/axis.mjs";
/**
 * The return type of the `selectAxisHighlightWithValue`.
 */
export type AxisHighlightWithValue = {
  /**
   * The id of the axis.
   */
  axisId: AxisId;
  /**
   * The index of the highlighted data point.
   * If the axis is continuous, this value is not available.
   */
  dataIndex?: number;
  /**
   * The value of the highlighted data point if available.
   */
  value: number | Date;
};
export declare const selectorChartsHighlightXAxisIndex: (args_0: import("../../corePlugins/useChartId/useChartId.types.mjs").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.mjs").UseChartSeriesConfigState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.mjs").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.mjs").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.mjs").UseChartSeriesState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.mjs").UseChartAnimationState & import("../../../index.mjs").UseChartInteractionListenerState & Partial<import("../useChartInteraction/useChartInteraction.types.mjs").UseChartInteractionState> & {
  cacheKey: import("../../models/index.mjs").ChartStateCacheKey;
}) => AxisItemIdentifier[];
export declare const selectorChartsHighlightYAxisIndex: (args_0: import("../../corePlugins/useChartId/useChartId.types.mjs").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.mjs").UseChartSeriesConfigState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.mjs").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.mjs").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.mjs").UseChartSeriesState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.mjs").UseChartAnimationState & import("../../../index.mjs").UseChartInteractionListenerState & Partial<import("../useChartInteraction/useChartInteraction.types.mjs").UseChartInteractionState> & {
  cacheKey: import("../../models/index.mjs").ChartStateCacheKey;
}) => AxisItemIdentifier[];
export declare const selectorChartsHighlightXAxisValue: (args_0: import("../../corePlugins/useChartId/useChartId.types.mjs").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.mjs").UseChartSeriesConfigState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.mjs").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.mjs").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.mjs").UseChartSeriesState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.mjs").UseChartAnimationState & import("../../../index.mjs").UseChartInteractionListenerState & Partial<import("../useChartInteraction/useChartInteraction.types.mjs").UseChartInteractionState> & {
  cacheKey: import("../../models/index.mjs").ChartStateCacheKey;
}) => {
  value: any;
  axisId: AxisId;
  dataIndex: number;
}[] | AxisHighlightWithValue[];
export declare const selectorChartsHighlightYAxisValue: (args_0: import("../../corePlugins/useChartId/useChartId.types.mjs").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.mjs").UseChartSeriesConfigState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.mjs").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.mjs").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.mjs").UseChartSeriesState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.mjs").UseChartAnimationState & import("../../../index.mjs").UseChartInteractionListenerState & Partial<import("../useChartInteraction/useChartInteraction.types.mjs").UseChartInteractionState> & {
  cacheKey: import("../../models/index.mjs").ChartStateCacheKey;
}) => {
  value: any;
  axisId: AxisId;
  dataIndex: number;
}[] | AxisHighlightWithValue[];
export declare const selectorChartsHighlightXAxis: (args_0: import("../../corePlugins/useChartId/useChartId.types.mjs").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.mjs").UseChartSeriesConfigState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.mjs").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.mjs").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.mjs").UseChartSeriesState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.mjs").UseChartAnimationState & import("../../../index.mjs").UseChartInteractionListenerState & Partial<import("./useChartCartesianAxis.types.mjs").UseChartCartesianAxisState> & {
  cacheKey: import("../../models/index.mjs").ChartStateCacheKey;
}) => ((Omit<Omit<import("../../../index.mjs").DefaultedAxis<keyof import("../../../index.mjs").AxisScaleConfig, any, ChartsAxisProps>, "scaleType">, "offset"> & Required<Pick<Omit<import("../../../index.mjs").DefaultedAxis<keyof import("../../../index.mjs").AxisScaleConfig, any, ChartsAxisProps>, "scaleType">, "offset">> & (({
  scaleType: "linear";
  scale: import("@mui/x-charts-vendor/d3-scale").ScaleLinear<number, number>;
  colorMap?: import("../../../../models/colorMapping.mjs").ContinuousColorConfig | import("../../../../models/colorMapping.mjs").PiecewiseColorConfig;
} | {
  scaleType: "time";
  scale: import("@mui/x-charts-vendor/d3-scale").ScaleTime<number, number>;
  colorMap?: import("../../../../models/colorMapping.mjs").ContinuousColorConfig | import("../../../../models/colorMapping.mjs").PiecewiseColorConfig;
} | {
  scaleType: "log";
  scale: import("@mui/x-charts-vendor/d3-scale").ScaleLogarithmic<number, number>;
  colorMap?: import("../../../../models/colorMapping.mjs").ContinuousColorConfig | import("../../../../models/colorMapping.mjs").PiecewiseColorConfig;
} | ({
  scaleType: "band";
  ordinalTimeTicks?: import("../../../../index.mjs").OrdinalTimeTicks;
  scale: import("@mui/x-charts-vendor/d3-scale").ScaleBand<{
    toString(): string;
  }>;
  categoryGapRatio: number;
  barGapRatio: number;
  colorMap?: import("../../../../models/colorMapping.mjs").OrdinalColorConfig | import("../../../../models/colorMapping.mjs").ContinuousColorConfig | import("../../../../models/colorMapping.mjs").PiecewiseColorConfig;
} & import("../../../index.mjs").AxisGroups & Pick<import("../../../../hooks/useTicks.mjs").TickParams, "tickPlacement" | "tickLabelPlacement">) | ({
  scaleType: "point";
  ordinalTimeTicks?: import("../../../../index.mjs").OrdinalTimeTicks;
  scale: import("@mui/x-charts-vendor/d3-scale").ScalePoint<{
    toString(): string;
  }>;
  colorMap?: import("../../../../models/colorMapping.mjs").OrdinalColorConfig | import("../../../../models/colorMapping.mjs").ContinuousColorConfig | import("../../../../models/colorMapping.mjs").PiecewiseColorConfig;
} & import("../../../index.mjs").AxisGroups) | {
  scaleType: "symlog";
  scale: import("@mui/x-charts-vendor/d3-scale").ScaleSymLog<number, number>;
  colorMap?: import("../../../../models/colorMapping.mjs").ContinuousColorConfig | import("../../../../models/colorMapping.mjs").PiecewiseColorConfig;
  constant?: number;
} | {
  scaleType: "pow";
  scale: import("@mui/x-charts-vendor/d3-scale").ScalePower<number, number>;
  colorMap?: import("../../../../models/colorMapping.mjs").ContinuousColorConfig | import("../../../../models/colorMapping.mjs").PiecewiseColorConfig;
} | {
  scaleType: "sqrt";
  scale: import("@mui/x-charts-vendor/d3-scale").ScalePower<number, number>;
  colorMap?: import("../../../../models/colorMapping.mjs").ContinuousColorConfig | import("../../../../models/colorMapping.mjs").PiecewiseColorConfig;
} | {
  scaleType: "utc";
  scale: import("@mui/x-charts-vendor/d3-scale").ScaleTime<number, number>;
  colorMap?: import("../../../../models/colorMapping.mjs").ContinuousColorConfig | import("../../../../models/colorMapping.mjs").PiecewiseColorConfig;
}) & ({
  colorScale?: import("@mui/x-charts-vendor/d3-scale").ScaleSequential<string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleThreshold<number, string | null>;
} | {
  colorScale?: import("@mui/x-charts-vendor/d3-scale").ScaleSequential<string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleThreshold<number | Date, string | null>;
} | {
  colorScale?: import("@mui/x-charts-vendor/d3-scale").ScaleSequential<string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleThreshold<number, string | null>;
} | {
  colorScale?: import("@mui/x-charts-vendor/d3-scale").ScaleOrdinal<string | number | Date, string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleOrdinal<number, string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleSequential<string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleThreshold<number | Date, string | null>;
} | {
  colorScale?: import("@mui/x-charts-vendor/d3-scale").ScaleOrdinal<string | number | Date, string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleOrdinal<number, string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleSequential<string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleThreshold<number | Date, string | null>;
} | {
  colorScale?: import("@mui/x-charts-vendor/d3-scale").ScaleSequential<string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleThreshold<number, string | null>;
} | {
  colorScale?: import("@mui/x-charts-vendor/d3-scale").ScaleSequential<string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleThreshold<number, string | null>;
} | {
  colorScale?: import("@mui/x-charts-vendor/d3-scale").ScaleSequential<string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleThreshold<number, string | null>;
} | {
  colorScale?: import("@mui/x-charts-vendor/d3-scale").ScaleSequential<string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleThreshold<number | Date, string | null>;
}))) & {
  tickNumber: number;
  triggerTooltip?: boolean;
  isFullCircle?: boolean;
} & ChartsAxisProps & {
  position?: "none" | "bottom" | "left" | "right" | "top" | undefined;
  height?: number | "auto" | undefined;
  width?: number | "auto" | undefined;
} & {
  height: number;
} & {
  width: number;
})[];
export declare const selectorChartsHighlightYAxis: (args_0: import("../../corePlugins/useChartId/useChartId.types.mjs").UseChartIdState & import("../../corePlugins/useChartSeriesConfig/useChartSeriesConfig.types.mjs").UseChartSeriesConfigState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartExperimentalFeature/useChartExperimentalFeature.types.mjs").UseChartExperimentalFeaturesState & import("../../corePlugins/useChartDimensions/useChartDimensions.types.mjs").UseChartDimensionsState & import("../../corePlugins/useChartSeries/useChartSeries.types.mjs").UseChartSeriesState<keyof import("../../../index.mjs").ChartsSeriesConfig> & import("../../corePlugins/useChartAnimation/useChartAnimation.types.mjs").UseChartAnimationState & import("../../../index.mjs").UseChartInteractionListenerState & Partial<import("./useChartCartesianAxis.types.mjs").UseChartCartesianAxisState> & {
  cacheKey: import("../../models/index.mjs").ChartStateCacheKey;
}) => ((Omit<Omit<import("../../../index.mjs").DefaultedAxis<keyof import("../../../index.mjs").AxisScaleConfig, any, ChartsAxisProps>, "scaleType">, "offset"> & Required<Pick<Omit<import("../../../index.mjs").DefaultedAxis<keyof import("../../../index.mjs").AxisScaleConfig, any, ChartsAxisProps>, "scaleType">, "offset">> & (({
  scaleType: "linear";
  scale: import("@mui/x-charts-vendor/d3-scale").ScaleLinear<number, number>;
  colorMap?: import("../../../../models/colorMapping.mjs").ContinuousColorConfig | import("../../../../models/colorMapping.mjs").PiecewiseColorConfig;
} | {
  scaleType: "time";
  scale: import("@mui/x-charts-vendor/d3-scale").ScaleTime<number, number>;
  colorMap?: import("../../../../models/colorMapping.mjs").ContinuousColorConfig | import("../../../../models/colorMapping.mjs").PiecewiseColorConfig;
} | {
  scaleType: "log";
  scale: import("@mui/x-charts-vendor/d3-scale").ScaleLogarithmic<number, number>;
  colorMap?: import("../../../../models/colorMapping.mjs").ContinuousColorConfig | import("../../../../models/colorMapping.mjs").PiecewiseColorConfig;
} | ({
  scaleType: "band";
  ordinalTimeTicks?: import("../../../../index.mjs").OrdinalTimeTicks;
  scale: import("@mui/x-charts-vendor/d3-scale").ScaleBand<{
    toString(): string;
  }>;
  categoryGapRatio: number;
  barGapRatio: number;
  colorMap?: import("../../../../models/colorMapping.mjs").OrdinalColorConfig | import("../../../../models/colorMapping.mjs").ContinuousColorConfig | import("../../../../models/colorMapping.mjs").PiecewiseColorConfig;
} & import("../../../index.mjs").AxisGroups & Pick<import("../../../../hooks/useTicks.mjs").TickParams, "tickPlacement" | "tickLabelPlacement">) | ({
  scaleType: "point";
  ordinalTimeTicks?: import("../../../../index.mjs").OrdinalTimeTicks;
  scale: import("@mui/x-charts-vendor/d3-scale").ScalePoint<{
    toString(): string;
  }>;
  colorMap?: import("../../../../models/colorMapping.mjs").OrdinalColorConfig | import("../../../../models/colorMapping.mjs").ContinuousColorConfig | import("../../../../models/colorMapping.mjs").PiecewiseColorConfig;
} & import("../../../index.mjs").AxisGroups) | {
  scaleType: "symlog";
  scale: import("@mui/x-charts-vendor/d3-scale").ScaleSymLog<number, number>;
  colorMap?: import("../../../../models/colorMapping.mjs").ContinuousColorConfig | import("../../../../models/colorMapping.mjs").PiecewiseColorConfig;
  constant?: number;
} | {
  scaleType: "pow";
  scale: import("@mui/x-charts-vendor/d3-scale").ScalePower<number, number>;
  colorMap?: import("../../../../models/colorMapping.mjs").ContinuousColorConfig | import("../../../../models/colorMapping.mjs").PiecewiseColorConfig;
} | {
  scaleType: "sqrt";
  scale: import("@mui/x-charts-vendor/d3-scale").ScalePower<number, number>;
  colorMap?: import("../../../../models/colorMapping.mjs").ContinuousColorConfig | import("../../../../models/colorMapping.mjs").PiecewiseColorConfig;
} | {
  scaleType: "utc";
  scale: import("@mui/x-charts-vendor/d3-scale").ScaleTime<number, number>;
  colorMap?: import("../../../../models/colorMapping.mjs").ContinuousColorConfig | import("../../../../models/colorMapping.mjs").PiecewiseColorConfig;
}) & ({
  colorScale?: import("@mui/x-charts-vendor/d3-scale").ScaleSequential<string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleThreshold<number, string | null>;
} | {
  colorScale?: import("@mui/x-charts-vendor/d3-scale").ScaleSequential<string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleThreshold<number | Date, string | null>;
} | {
  colorScale?: import("@mui/x-charts-vendor/d3-scale").ScaleSequential<string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleThreshold<number, string | null>;
} | {
  colorScale?: import("@mui/x-charts-vendor/d3-scale").ScaleOrdinal<string | number | Date, string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleOrdinal<number, string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleSequential<string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleThreshold<number | Date, string | null>;
} | {
  colorScale?: import("@mui/x-charts-vendor/d3-scale").ScaleOrdinal<string | number | Date, string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleOrdinal<number, string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleSequential<string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleThreshold<number | Date, string | null>;
} | {
  colorScale?: import("@mui/x-charts-vendor/d3-scale").ScaleSequential<string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleThreshold<number, string | null>;
} | {
  colorScale?: import("@mui/x-charts-vendor/d3-scale").ScaleSequential<string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleThreshold<number, string | null>;
} | {
  colorScale?: import("@mui/x-charts-vendor/d3-scale").ScaleSequential<string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleThreshold<number, string | null>;
} | {
  colorScale?: import("@mui/x-charts-vendor/d3-scale").ScaleSequential<string, string | null> | import("@mui/x-charts-vendor/d3-scale").ScaleThreshold<number | Date, string | null>;
}))) & {
  tickNumber: number;
  triggerTooltip?: boolean;
  isFullCircle?: boolean;
} & ChartsAxisProps & {
  position?: "none" | "bottom" | "left" | "right" | "top" | undefined;
  height?: number | "auto" | undefined;
  width?: number | "auto" | undefined;
} & {
  height: number;
} & {
  width: number;
})[];