Interface UseHeaderSelectionOptions

this hook manages the header selections.

TODO - When dragging a selection that already exist it should drag for reorder. (Not supported yet)

interface UseHeaderSelectionOptions {
    alwaysScrollToActiveCoords?: boolean;
    canSelectionSpanMergedCells?: ((start, end) => boolean);
    direction?: HeaderDirection;
    gridMainRef: MutableRefObject<GridElement>;
    gridRef: MutableRefObject<GridElement>;
    headerCount?: number;
    newSelectionMode?: NewHeaderSelectionMode;
    onDragEnd?: (() => void);
    onDragStart?: (() => void);
    onPointerUp?: ((e) => void);
    pointerDownInterceptor?: ((e, coords) => boolean);
    pointerMoveInterceptor?: ((e, coords) => boolean);
    selectionMain: SelectionResults;
    selectionPolicy?: SelectionPolicy;
}

Properties

alwaysScrollToActiveCoords? canSelectionSpanMergedCells? direction? gridMainRef gridRef headerCount? newSelectionMode? onDragEnd? onDragStart? onPointerUp? pointerDownInterceptor? pointerMoveInterceptor? selectionMain selectionPolicy?

Properties

Optional alwaysScrollToActiveCoords

alwaysScrollToActiveCoords?: boolean

scroll to active cell when

Optional canSelectionSpanMergedCells

canSelectionSpanMergedCells?: ((start, end) => boolean)

Return true if the coordinate span can overlap merged ranges.

Type declaration

Returns

Optional direction

direction?: HeaderDirection

The direction the header is oriented

gridMainRef

gridMainRef: MutableRefObject<GridElement>

Access grid functions

gridRef

gridRef: MutableRefObject<GridElement>

Access grid functions

Optional headerCount

headerCount?: number

No of headers in the grid

Optional newSelectionMode

newSelectionMode?: NewHeaderSelectionMode

New selection mode

Optional onDragEnd

onDragEnd?: (() => void)

Callback when drag ends

Type declaration

    • (): void

    • Returns void

Optional onDragStart

onDragStart?: (() => void)

Callback when drag starts

Type declaration

    • (): void

    • Returns void

Optional onPointerUp

onPointerUp?: ((e) => void)

Pointer Up Listener

Type declaration

    • (e): void

    • Parameters

      • e: PointerEvent

      Returns void

Optional pointerDownInterceptor

pointerDownInterceptor?: ((e, coords) => boolean)

Pointerdown Interceptor

Type declaration

    • (e, coords): boolean

    • Parameters

      Returns boolean

Optional pointerMoveInterceptor

pointerMoveInterceptor?: ((e, coords) => boolean)

Pointer Move Interceptor

Type declaration

    • (e, coords): boolean

    • Parameters

      Returns boolean

selectionMain

selectionMain: SelectionResults

The results of the selection

Optional selectionPolicy

selectionPolicy?: SelectionPolicy

Selection policy

Settings

Member Visibility

Theme

On This Page

alwaysScrollToActiveCoordscanSelectionSpanMergedCellsdirectiongridMainRefgridRefheaderCountnewSelectionModeonDragEndonDragStartonPointerUppointerDownInterceptorpointerMoveInterceptorselectionMainselectionPolicy