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

    Interface FormulaBarSession

    interface FormulaBarSession {
        activeCoords: CellCoords;
        cancel: () => void;
        cellEditor:
            | ReactElement<unknown, string | JSXElementConstructor<any>>
            | null;
        commit: () => void;
        disabled: boolean;
        editorSpec: CommandScopeSpec<any> | null;
        isEditing: boolean;
        session: EditSession<() => ICell, string, EditCommitArgs> | null;
        sheet: ISheet;
    }
    Index
    activeCoords cancel cellEditor commit disabled editorSpec isEditing session sheet
    activeCoords: CellCoords

    The active cell's coordinates on FormulaBarSession.sheet.

    cancel: () => void

    Cancel the live session. Does not move focus.

    cellEditor: ReactElement<unknown, string | JSXElementConstructor<any>> | null

    The editor element: the shared EditorDiv + cell input bound to the active cell and restyled as chrome text. The host places it in its own box. null without an editable.

    commit: () => void

    Commit the live session. Does not move focus.

    disabled: boolean

    The bar cannot start an edit: the host said so, the cell is protected or the workbook is read-only.

    editorSpec: CommandScopeSpec<any> | null

    The formula:editor command scope, for the host's CommandScopeProvider. null without an editable.

    isEditing: boolean

    Whether an edit session is live.

    session: EditSession<() => ICell, string, EditCommitArgs> | null

    The live edit session, or null while idle.

    sheet: ISheet

    The selected sheet.

    Settings
    Member Visibility

    On This Page
    Properties