Type Alias GridProps

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

Properties for the Grid component.

Type declaration

  • canvasSize: {
        height: number;
        width: number;
    }

    The size of the canvas.

    • height: number

      The height of the canvas in pixels.

    • width: number

      The width of the canvas in pixels.

  • data: Float32Array | Uint32Array

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

  • focusedStates: 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.

    • left: number

      The left offset of the header.

    • top: number

      The top offset of the header.

  • OptionalinitialOverscroll?: {
        x: number;
        y: number;
    }

    The initial overscroll settings for the grid.

    • 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
  • OptionalonDataChange?: ((sourceIndex: number) => void)
      • (sourceIndex): void

      • Parameters

        • sourceIndex: number

        Returns void

  • OptionalonFocusedStateChange?: ((sourceIndex: number, columnIndex: number, rowIndex: number) => void)
      • (sourceIndex, columnIndex, rowIndex): void

      • Parameters

        • sourceIndex: number
        • columnIndex: number
        • rowIndex: number

        Returns void

  • OptionalonSelectedStateChange?: ((sourceIndex: number, columnIndex: number, rowIndex: number) => void)
      • (sourceIndex, columnIndex, rowIndex): void

      • Parameters

        • sourceIndex: number
        • columnIndex: number
        • rowIndex: number

        Returns void

  • OptionalonViewportStateChange?: ((sourceIndex: number) => void)
      • (sourceIndex): void

      • Parameters

        • sourceIndex: number

        Returns void

  • OptionalscrollBar?: {
        margin: number;
        radius: number;
    }

    The settings for the scroll bar in the grid.

    • 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