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

    Interface SheetSelectionLayerProps

    interface SheetSelectionLayerProps {
        children?: ReactNode;
        className?: string;
        isActive?: boolean;
        onBlur?: (event: FocusEvent) => void;
        onContextMenu?: (event: MouseEvent) => void;
        onDoubleClick?: (event: MouseEvent) => void;
        onFillMenu?: (
            location: SheetLocation,
            menu: CommandContext.FillMenu,
        ) => 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;
        sheet: ISheet;
        style?: CSSProperties;
        zIndex?: number;
    }

    Hierarchy

    • LayerProps
      • SheetSelectionLayerProps
    Index
    children? className? isActive? onBlur? onContextMenu? onDoubleClick? onFillMenu? onFocus? onKeyDown? onKeyPress? onKeyUp? onMouseDown? onMouseEnter? onMouseLeave? onMouseMove? onMouseOut? onMouseOver? onMouseUp? onPointerDown? onPointerLeave? onPointerMove? onPointerUp? sheet style? zIndex?
    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 for the layer's boundary div (devtools identification).

    isActive?: boolean

    Whether this sheet/pane is the active one (gates move/fill interaction).

    onBlur?: (event: FocusEvent) => void
    onContextMenu?: (event: MouseEvent) => void
    onDoubleClick?: (event: MouseEvent) => void
    onFillMenu?: (location: SheetLocation, menu: CommandContext.FillMenu) => void

    A right-button drag of the fill handle was released: show the fill menu at location and run whatever menu entry is chosen. The menu is chrome, so the consumer renders it (MUI in the studio); menu answers every question it has. Call menu.cancel() when the menu closes, so a dismissal ends the drag (the dashed preview stays up until it does). Omit to leave the right-drag inert.

    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
    sheet: ISheet

    The sheet whose getSelection() this layer drives.

    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