SheetXL - v1.0.2
    Preparing search index...

    Interface CellInsertLayerProps

    interface CellInsertLayerProps {
        axis?: Axis;
        className?: string;
        onBlur?: (event: FocusEvent) => void;
        onContextMenu?: (event: MouseEvent) => void;
        onDoubleClick?: (event: MouseEvent) => void;
        onFocus?: (event: FocusEvent) => void;
        onInsert?: (range: ICellRange) => 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;
        renderButton?: (props: CellInsertButtonProps) => ReactNode;
        resolve?: (range: ICellRange) => ICellRange | null;
        size?: number;
        style?: CSSProperties;
        zIndex?: number;
    }

    Hierarchy

    • Omit<LayerProps, "children">
      • CellInsertLayerProps
    Index
    axis? className? onBlur? onContextMenu? onDoubleClick? onFocus? onInsert? onKeyDown? onKeyPress? onKeyUp? onMouseDown? onMouseEnter? onMouseLeave? onMouseMove? onMouseOut? onMouseOver? onMouseUp? onPointerDown? onPointerLeave? onPointerMove? onPointerUp? renderButton? resolve? size? style? zIndex?
    axis?: Axis

    Whether the button inserts rows, from the row headers, or columns, from the column headers. A host that wants both declares one layer for each.

    'row'
    className?: string

    Class for the layer.

    onBlur?: (event: FocusEvent) => void
    onContextMenu?: (event: MouseEvent) => void
    onDoubleClick?: (event: MouseEvent) => void
    onFocus?: (event: FocusEvent) => void
    onInsert?: (range: ICellRange) => void

    Called when the button is pressed. Defaults to range.insert(axis).

    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
    renderButton?: (props: CellInsertButtonProps) => ReactNode

    Renders the button, filling the square it is placed in. Defaults to CellInsertButton.

    resolve?: (range: ICellRange) => ICellRange | null

    The cells to insert at the header border nearest the pointer, or null for no button. The preview line runs along the returned range. Called on every pointer move, so it should be cheap.

    Type Declaration

      • (range: ICellRange): ICellRange | null

      • Parameters

        • range: ICellRange

          The entire row (column) just past the border: below it for rows, right of it for columns. A host usually narrows it, e.g. range.getIntersect(table.getRange()).

          Defaults to range when the sheet's protection allows inserting rows (columns).

        Returns ICellRange | null

    size?: number

    Edge (px, unzoomed) of the button.

    16
    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