SheetXL - v1.0.2
    Preparing search index...

    Interface IWorksheetElement

    Type returned via ref property

    interface IWorksheetElement {
        getColumnHeaderElement: () => ISheetHeaderElement;
        getGridSurface: () => IGridSurface;
        getRowHeaderElement: () => ISheetHeaderElement;
        getWorksheet: () => IWorksheet;
        invalidate: (coords?: CellCoords | null) => void;
        isSheetElement: () => true;
        focusMovable(movable?: IMovable): Promise<boolean>;
        focusSheet(options?: FocusOptions): void;
    }

    Hierarchy (View Summary)

    Index
    getColumnHeaderElement getGridSurface getRowHeaderElement getWorksheet invalidate isSheetElement
    focusMovable focusSheet
    getColumnHeaderElement: () => ISheetHeaderElement
    getGridSurface: () => IGridSurface
    getRowHeaderElement: () => ISheetHeaderElement
    getWorksheet: () => IWorksheet

    Returns the attached IWorksheet.

    invalidate: (coords?: CellCoords | null) => void
    isSheetElement: () => true

    For runtime introspection.

    • Focus a specific float. If not provided will focus the first selected float.

      Parameters

      • Optionalmovable: IMovable

      Returns Promise<boolean>

      The focusMovable does not scroll. TODO - have this honor GridPanes scroll options.

    • Focus the sheet.

      Parameters

      • Optionaloptions: FocusOptions

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods