SheetXL - v0.3.20
    Preparing search index...

    Interface SheetRefProps

    For elements that also need the ref. Less common but some factory renderers

    interface SheetRefProps {
        cellRenderProps: Partial<SheetCellRendererProps>;
        columnHeaderProps?: Partial<SheetHeaderProps>;
        commands?: IGroup;
        getCellEditor?: (
            props: CellEditorProps<() => ICell, string> & CellEditorRefAttribute,
            coords: IRange.CellCoords,
        ) => ReactElement<
            CellEditorProps<() => ICell, string> & CellEditorRefAttribute,
        >;
        gridProps: GridProps;
        onElementLoad?: () => void;
        onMoveCell?: (
            from: IRange.CellCoords,
            to: IRange.CellCoords,
            cell?: Update,
        ) => Update;
        onRepeatCommandChange?: (command: ICommand<any, any>) => void;
        onSheetContextMenu?: (location: SheetLocation) => void;
        onShowTooltip?: (properties: IShowToolTipProperties) => void;
        onViewportChange?: (view: ScrollableViewport) => void;
        overlays?: ((view: GridView) => ReactNode)[];
        renderMovable?: (props: MovableElementProps) => ReactElement;
        rowHeaderProps?: Partial<SheetHeaderProps>;
        scrollPaneProps?: ScrollPaneProps;
        showColumnHeaders?: boolean;
        showRowHeaders?: boolean;
        showScrollbars?: boolean;
        viewportComponent?: ReactNode;
    }
    Index

    Properties

    cellRenderProps columnHeaderProps? commands? getCellEditor? gridProps onElementLoad? onMoveCell? onRepeatCommandChange? onSheetContextMenu? onShowTooltip? onViewportChange? overlays? renderMovable? rowHeaderProps? scrollPaneProps? showColumnHeaders? showRowHeaders? showScrollbars? viewportComponent?

    Properties

    cellRenderProps: Partial<SheetCellRendererProps>

    Allow for custom rendering of cell props.

    This is used to customize filterButton popup action and any other customizations desired. This does not invalidate the rendering

    columnHeaderProps?: Partial<SheetHeaderProps>

    Properties for the column headers

    commands?: IGroup

    Parent commands for the sheet

    getCellEditor?: (
        props: CellEditorProps<() => ICell, string> & CellEditorRefAttribute,
        coords: IRange.CellCoords,
    ) => ReactElement<
        CellEditorProps<() => ICell, string> & CellEditorRefAttribute,
    >

    Inject custom editors based on a cell. This should not return null but rather can canEdit. This is called during placement after scrolling and other bookkeeping has occurred

    gridProps: GridProps

    Customize the grid.

    Not all props are passed through.

    onElementLoad?: () => void

    Called once when the sheet has been loaded but before it is rendered.

    onMoveCell?: (
        from: IRange.CellCoords,
        to: IRange.CellCoords,
        cell?: Update,
    ) => Update

    Callback when a paste is executed

    onRepeatCommandChange?: (command: ICommand<any, any>) => void

    Notify that there is a new repeatable command

    onSheetContextMenu?: (location: SheetLocation) => void

    Fire when a contentMenu is requested

    onShowTooltip?: (properties: IShowToolTipProperties) => void

    To show the tooltip

    onViewportChange?: (view: ScrollableViewport) => void

    Fired when the view port changes. This is in pixel coordinates and slightly different then viewable cells because off screen location bounds could change

    overlays?: ((view: GridView) => ReactNode)[]

    Render an element directly onto a gridView.

    renderMovable?: (props: MovableElementProps) => ReactElement

    Render components for movable elements. If not provided movables will not be rendered.

    Type declaration

      • (props: MovableElementProps): ReactElement

      • Parameters

        • props: MovableElementProps

          MovableElementProps

        Returns ReactElement

        A React Element representing the IMovable.

    rowHeaderProps?: Partial<SheetHeaderProps>

    Properties for the row headers

    scrollPaneProps?: ScrollPaneProps

    Allow for customizations of scrollbar

    showColumnHeaders?: boolean

    Show the column headers

    showRowHeaders?: boolean

    Show the row headers

    showScrollbars?: boolean

    Show the scrollbars

    viewportComponent?: ReactNode

    Fixed component that is layered within the viewport.

    Useful for dialogs and items that you want to place relative to the grid.

    Settings

    Member Visibility

    On This Page

    Properties