Interface AxisXYUserInteractionsBeta

Introduced in v7.0.0. API may change according to user feedback.

Hierarchy

  • AxisXYUserInteractions

Properties

chartInteractions? pan? rectangleZoom? restoreDefault? zoom?

Properties

Optional chartInteractions

chartInteractions?: false | {
    paginate?: boolean;
    pan?: boolean;
    rectangleZoom?: boolean;
    restoreDefault?: boolean;
    restorePrevious?: boolean;
    zoom?: boolean;
}

Axis specific flags which can be used to individually disable axes from being affected by chart-level interactions e.g. panning inside chart area, rather than on a specific axis.

This is NOT intended for activating desired interactions on any axis. Rather, it should be specifically used to DISABLE interactions on very specific axis, in use cases where some axis need interactions and others don't.

Optional pan

pan?: false | InteractionConfigWithOverrides<{
    sensitivity?: number;
    stopScroll?: boolean;
}, "drag" | "wheel", "shift" | "ctrl" | "alt" | "lmb" | "rmb" | "mmb">

Optional rectangleZoom

rectangleZoom?: false | InteractionConfigWithOverrides<{
    animationsEnabled?: boolean;
    start?: ((args: {
        event: undefined | Event;
    }) => unknown);
    stopScroll?: boolean;
}, "drag", "shift" | "ctrl" | "alt" | "lmb" | "rmb" | "mmb">

Optional restoreDefault

restoreDefault?: false | InteractionConfigWithOverrides<{
    animationsEnabled?: boolean;
    doubleClick?: boolean;
    stopScroll?: boolean;
}, never, "shift" | "ctrl" | "alt">

Optional zoom

zoom?: false | InteractionConfigWithOverrides<{
    mode?: "toward-pointer" | "centered" | "keep-start" | "keep-end";
    sensitivity?: number;
    stopScroll?: boolean;
}, "drag" | "wheel", "shift" | "ctrl" | "alt" | "lmb" | "rmb" | "mmb">

Settings

Member Visibility

Theme