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

    Type Alias ISheetAttributes

    Attributes and methods available on the sheet element beyond the HTMLDivElement.

    type ISheetAttributes = {
        getColumnHeaderElement: () => ISheetHeaderElement;
        getGridSurface: () => IGridSurface;
        getRowHeaderElement: () => ISheetHeaderElement;
        getSheet: () => ISheet;
        invalidate: (coords?: ICell.Coords | null) => void;
        isSheetElement: () => true;
        contains(element: Node | null): boolean;
        focus(options?: FocusOptions): void;
        focusMovable(movable?: IMovable): Promise<boolean>;
        focusSheet(options?: FocusOptions): void;
    }

    Hierarchy (View Summary)

    Index
    getColumnHeaderElement getGridSurface getRowHeaderElement getSheet invalidate isSheetElement
    contains focus focusMovable focusSheet
    getColumnHeaderElement: () => ISheetHeaderElement
    getGridSurface: () => IGridSurface
    getRowHeaderElement: () => ISheetHeaderElement
    getSheet: () => ISheet

    Returns the attached ISheet.

    invalidate: (coords?: ICell.Coords | null) => void
    isSheetElement: () => true

    For runtime introspection.

    • Parameters

      • element: Node | null

      Returns boolean

    • Focus the sheet or the movable based on last focus.

      Parameters

      • Optionaloptions: FocusOptions

      Returns void

    • 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