webgpu-react-bitmap-viewport
    Preparing search index...

    Type Alias GridProps

    Properties for the Grid component.

    type GridProps = {
        canvasSize: { height: number; width: number };
        data: Float32Array | Uint32Array | GPUBuffer;
        focusedCellPosition: Uint32Array;
        headerOffset: { left: number; top: number };
        initialOverscroll?: { x: number; y: number };
        mode: GridShaderMode;
        numColumns: number;
        numRows: number;
        numViewports: number;
        onDataChange?: (sourceIndex: number) => void;
        onFocusedCellPositionChange?: (
            sourceIndex: number,
            columnIndex: number,
            rowIndex: number,
        ) => void;
        onSelectedStateChange?: (
            sourceIndex: number,
            columnIndex: number,
            rowIndex: number,
            keyboardModifier: KeyboardModifier,
        ) => void;
        onViewportStateChange?: (sourceIndex: number) => void;
        scrollBar?: { margin: number; radius: number };
        selectedStates: Uint32Array;
        viewportIndex: number;
        viewportStates: Float32Array;
    }
    Index
    canvasSize data focusedCellPosition headerOffset initialOverscroll? mode numColumns numRows numViewports onDataChange? onFocusedCellPositionChange? onSelectedStateChange? onViewportStateChange? scrollBar? selectedStates viewportIndex viewportStates
    canvasSize: { height: number; width: number }

    The size of the canvas.

    Type Declaration

    • height: number

      The height of the canvas in pixels.

    • width: number

      The width of the canvas in pixels.

    data: Float32Array | Uint32Array | GPUBuffer

    The data to be displayed in the grid, stored in a Float32Array for SingleValueGrid or Uint32Array for RGBAGrid.

    focusedCellPosition: Uint32Array

    The focused states of the grid, stored in a Uint32Array: notFocused=0, verticalFocused=1, horizontalFocused=2, verticalAndHorizontalFocused=3

    headerOffset: { left: number; top: number }

    The offset of the header in the grid.

    Type Declaration

    • left: number

      The left offset of the header.

    • top: number

      The top offset of the header.

    initialOverscroll?: { x: number; y: number }

    The initial overscroll settings for the grid.

    Type Declaration

    • x: number

      The horizontal overscroll value.

    • y: number

      The vertical overscroll value.

    mode: GridShaderMode

    The shader mode to use for the grid. ShaderMode.SINGLE_VALUE: Single value shader mode. ShaderMode.RGB: RGB shader mode.

    numColumns: number

    The number of columns in the grid.

    numRows: number

    The number of rows in the grid.

    numViewports: number
    onDataChange?: (sourceIndex: number) => void
    onFocusedCellPositionChange?: (
        sourceIndex: number,
        columnIndex: number,
        rowIndex: number,
    ) => void
    onSelectedStateChange?: (
        sourceIndex: number,
        columnIndex: number,
        rowIndex: number,
        keyboardModifier: KeyboardModifier,
    ) => void
    onViewportStateChange?: (sourceIndex: number) => void
    scrollBar?: { margin: number; radius: number }

    The settings for the scroll bar in the grid.

    Type Declaration

    • margin: number

      The margin around the scroll bar in pixels.

    • radius: number

      The radius of the scroll bar in pixels.

    selectedStates: Uint32Array

    The selected states of the grid, stored in a Uint32Array: notSelected=0, verticalSelected=1, horizontalSelected=2, verticalAndHorizontalSelected=3

    viewportIndex: number

    The ID of the canvas element.

    viewportStates: Float32Array

    The set of viewport left,top,right,bottom values for the grid in a Float32Array.

    Settings
    Member Visibility

    On This Page
    Properties