SheetXL - v0.3.20
    Preparing search index...

    Interface Events

    IListener interface for IWorkbook events.

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

    Methods

    onBeforeLoad? onBeforeSave? onClose? onInvalidated? onLoad? onProtectionChange? onRequestSelect? onSave? onScriptsChange? onSheetsChange? onThemeChange? onViewChange?

    Methods

    • 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 when the workbook protection has changed.

      Parameters

      Returns void

      This is different from the sheet protection.

    • 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 after save.

      Parameters

      Returns void

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

      Parameters

      Returns void

    • Called when the sheet collections has changed have changed.

      Parameters

      Returns void

    • Called when the workbook theme has changed.

      Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods