MAIDR JavaScript API
    Preparing search index...

    Interface GridNavigable

    Interface for traces that support grid-based navigation. Implemented by trace types that can divide their plot area into navigable cells (e.g., ScatterTrace with grid config).

    interface GridNavigable {
        setGridMode: (enabled: boolean) => void;
        supportsGridMode: () => boolean;
        isGridModeActive: () => boolean;
        moveGridUp: () => boolean;
        moveGridDown: () => boolean;
        moveGridLeft: () => boolean;
        moveGridRight: () => boolean;
        getGridDimensions: () => { rows: number; cols: number } | null;
        getGridPosition: () => { row: number; col: number } | null;
        isInCellMode: () => boolean;
        enterGridCell: () => boolean;
        exitGridCell: () => void;
        moveCellPointLeft: () => boolean;
        moveCellPointRight: () => boolean;
    }

    Implemented by

    Index

    Properties

    setGridMode supportsGridMode isGridModeActive moveGridUp moveGridDown moveGridLeft moveGridRight getGridDimensions getGridPosition isInCellMode enterGridCell exitGridCell moveCellPointLeft moveCellPointRight

    Properties

    setGridMode: (enabled: boolean) => void
    supportsGridMode: () => boolean
    isGridModeActive: () => boolean

    Whether the reader is navigating by grid cells now (the rotor's grid mode).

    moveGridUp: () => boolean
    moveGridDown: () => boolean
    moveGridLeft: () => boolean
    moveGridRight: () => boolean
    getGridDimensions: () => { rows: number; cols: number } | null
    getGridPosition: () => { row: number; col: number } | null
    isInCellMode: () => boolean
    enterGridCell: () => boolean
    exitGridCell: () => void
    moveCellPointLeft: () => boolean
    moveCellPointRight: () => boolean

    Settings

    Member Visibility

    On This Page

    Properties