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

    Interface Events

    IListener interface for IWorkbook events.

    interface Events {
        onBeforeLoad?(source: IWorkbook, json: IWorkbook.JSON): void;
        onBeforeSave?(source: IWorkbook): void | Promise<void>;
        onClose?(source: IWorkbook): void;
        onInvalidated?(source: IWorkbook): void;
        onLoad?(source: IWorkbook): void;
        onNameChange?(source: IWorkbook): void;
        onOriginChange?(source: IWorkbook): void;
        onProtectionChange?(source: IWorkbook): void;
        onRegionalChange?(source: IWorkbook): void;
        onRequestSelect?(source: IWorkbook, sheet: ISheet): Promise<boolean>;
        onSave?(source: IWorkbook, json: IWorkbook.JSON): void;
        onScriptsChange?(source: IWorkbook): void;
        onSelectedSheetChange?(source: IWorkbook): void;
        onSelectionChange?(source: IWorkbook): void;
        onSheetsChange?(source: IWorkbook): void;
        onSheetsChange?(source: IWorkbook): void;
        onThemeChange?(source: IWorkbook): void;
        onViewChange?(source: IWorkbook): void;
    }
    Index
    onBeforeLoad? onBeforeSave? onClose? onInvalidated? onLoad? onNameChange? onOriginChange? onProtectionChange? onRegionalChange? onRequestSelect? onSave? onScriptsChange? onSelectedSheetChange? onSelectionChange? onSheetsChange? onThemeChange? onViewChange?

    • Called before load. If any exception is thrown this exception will be returned to the client and delete will fail.

      Parameters

      Returns void

    • Called before load. If any exception is thrown this exception will be returned to the client and delete will be aborted.

      Parameters

      Returns void | Promise<void>

    • Called when the workbook is closed.

      Parameters

      Returns void

    • Called when the state has been updated due to a undo/redo and a rerender is required.

      Parameters

      Returns void

    • Called after load.

      Parameters

      Returns void

    • Called when the display name changes — a rename of the origin, or a move to a new one (see onOriginChange). Non-transactional; renames are not model edits and never enter the undo stack.

      Parameters

      Returns void

    • Called when the workbook moves to a different origin — a save that resolved a new destination (a first save, a Save As). Non-transactional.

      Parameters

      Returns void

      Changes within the current origin (its size after a save, a rename) are that origin's own onChange; a listener on the old origin hears nothing further about this workbook.

    • Called when the workbook protection has changed.

      Parameters

      Returns void

      This is different from the sheet protection.

    • Called when a workbook setting that governs how values are PRESENTED has changed - the locale, its overrides, or the date system.

      Parameters

      Returns void

      Nothing a cell holds has moved; what it paints for what it holds has. A consumer that has measured rendered text - a fitted column width, a cached layout - has to re-derive it.

      The active UI language does the same thing from outside the workbook, and is announced by DefaultLanguagePackService rather than here.

    • Request that the sheet become brought to the front.

      Parameters

      Returns Promise<boolean>

      A promise indicating that the sheet has been rendered.

      This should only be handled by one consumer.

    • Called when the scripts associated with the workbook have change.

      Parameters

      Returns void

    • Called when the selected sheet has changed.

      Parameters

      Returns void

    • Called when the cell selection has changed.

      Parameters

      Returns void

    • Called when the sheet collections has changed have changed.

      Parameters

      Returns void

    • Called when the sheets have change.

      Parameters

      Returns void

    • Called when the workbook theme has changed.

      Parameters

      Returns void

    Settings
    Member Visibility

    On This Page
    Methods