SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface SheetReferenceHeaderLayerProps

    Props for SheetReferenceHeaderLayer.

    interface SheetReferenceHeaderLayerProps {
        axis: Axis;
        children?: ReactNode;
        className?: string;
        entireCoords: RangeCoords;
        onBlur?: (event: FocusEvent) => void;
        onContextMenu?: (event: MouseEvent) => void;
        onDoubleClick?: (event: MouseEvent) => void;
        onFocus?: (event: FocusEvent) => void;
        onKeyDown?: (event: KeyboardEvent) => void;
        onKeyPress?: (event: KeyboardEvent) => void;
        onKeyUp?: (event: KeyboardEvent) => void;
        onMouseDown?: (event: MouseEvent) => void;
        onMouseEnter?: (event: MouseEvent) => void;
        onMouseLeave?: (event: MouseEvent) => void;
        onMouseMove?: (event: MouseEvent) => void;
        onMouseOut?: (event: MouseEvent) => void;
        onMouseOver?: (event: MouseEvent) => void;
        onMouseUp?: (event: MouseEvent) => void;
        onPointerDown?: (event: PointerEvent) => void;
        onPointerLeave?: (event: PointerEvent) => void;
        onPointerMove?: (event: PointerEvent) => void;
        onPointerUp?: (event: PointerEvent) => void;
        scrollIntoView?: (coords: Partial<CellCoords>) => void;
        style?: CSSProperties;
        zIndex?: number;
    }

    Hierarchy

    • LayerProps
      • SheetReferenceHeaderLayerProps
    Index
    axis children? className? entireCoords onBlur? onContextMenu? onDoubleClick? onFocus? onKeyDown? onKeyPress? onKeyUp? onMouseDown? onMouseEnter? onMouseLeave? onMouseMove? onMouseOut? onMouseOver? onMouseUp? onPointerDown? onPointerLeave? onPointerMove? onPointerUp? scrollIntoView? style? zIndex?
    axis: Axis

    The axis of the header this overlay sits on (row or column).

    children?: ReactNode

    The layer's content — VirtualDivs, RangeRects, floats — hosted inside the layer's boundary div. Children stack by DOM order within the layer (law 1).

    className?: string

    Class forwarded to the inner layer's host box (devtools identification).

    entireCoords: RangeCoords

    The body's entire range (full rows × full columns) — the header projects every pick across the opposite axis with it. Typically sheet.getEntireRange().getCoords().

    onBlur?: (event: FocusEvent) => void
    onContextMenu?: (event: MouseEvent) => void
    onDoubleClick?: (event: MouseEvent) => void
    onFocus?: (event: FocusEvent) => void
    onKeyDown?: (event: KeyboardEvent) => void
    onKeyPress?: (event: KeyboardEvent) => void
    onKeyUp?: (event: KeyboardEvent) => void
    onMouseDown?: (event: MouseEvent) => void
    onMouseEnter?: (event: MouseEvent) => void
    onMouseLeave?: (event: MouseEvent) => void
    onMouseMove?: (event: MouseEvent) => void
    onMouseOut?: (event: MouseEvent) => void
    onMouseOver?: (event: MouseEvent) => void
    onMouseUp?: (event: MouseEvent) => void
    onPointerDown?: (event: PointerEvent) => void
    onPointerLeave?: (event: PointerEvent) => void
    onPointerMove?: (event: PointerEvent) => void
    onPointerUp?: (event: PointerEvent) => void
    scrollIntoView?: (coords: Partial<CellCoords>) => void

    Scroll a header cell into view during a pick drag (incl. held-still auto-scroll) — routed through the sheet so the body scrolls. Supplied by SheetHeaderElement; see HeaderSelectionLayer.scrollIntoView.

    style?: CSSProperties

    Style for the layer's boundary div — e.g. display: 'none' or opacity to hide or fade a layer. The boundary's own placement (position, inset, pointer-events: none) comes from the grid; overriding it here breaks the layer's containment.

    zIndex?: number

    Explicit stacking override, read by normalizeLayers off the grid-child element to sort the layer list (higher sorts later = on top; omitted ⇒ declaration order). It is honored ONLY at the grid-children level — the layer's actual dispatch slot always comes from the resulting order index (via LayerOrderContext), never from this raw number, so paint order and event order can never disagree.

    Settings
    Member Visibility

    On This Page
    Properties