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

    Interface IWorkbookElement

    Type returned via ref property

    interface IWorkbookElement {
        getCommandScope: () => CommandScope | null;
        getSheetElement: () => ISheetElement | null;
        getViewportElement: () => HTMLElement | null;
        getWorkbook: () => IWorkbook;
        isWorkbookElement: () => true;
    }

    Hierarchy (View Summary)

    Index
    getCommandScope getSheetElement getViewportElement getWorkbook isWorkbookElement
    getCommandScope: () => CommandScope | null

    The per-workbook workbook command scope this element owns (per GRID-BUFFERING-PLAN: each WorkbookElement owns its own scope + undo manager for safe double-mount). Exposed so an out-of-tree host — e.g. a hoisted task-pane area, which no longer renders inside this element's scope — can bridge it via CommandScopeContext and resolve the workbook commands (insertFunction / executeScript / undo / redo) against the SHOWN workbook.

    null until the scope is created (or for a bare chromeless grid with no ambient command root).

    getSheetElement: () => ISheetElement | null

    Retrieve the sheet element associated with this workbook element. null before the sheet has mounted.

    getViewportElement: () => HTMLElement | null

    Retrieve the viewport element associated with this workbook element. null before the viewport has mounted.

    getWorkbook: () => IWorkbook

    Retrieve the workbook model associated with this workbook element.

    isWorkbookElement: () => true

    For runtime type checking

    Settings
    Member Visibility

    On This Page
    Properties