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

    Interface OriginProvider

    Supplies a workbook's current IWorkbookIO.Origin — the file it lives in now.

    An origin names one file for its whole life; which file a workbook lives in changes when a save resolves a new destination (a first save, a Save As). The workbook reads its origin through this and follows onOriginChange, so the same workbook moves to the new file while the origin it held keeps naming the old one.

    Read-only by design: the workbook consumes it and never sets it. Whoever implements it decides when it moves. The default implementation (WorkbookOriginProvider) is moved by the IO layer after a successful save; a host with its own save flow can pass its own implementation through IWorkbook.ConstructorOptions.origin and move it on IWorkbookIO.Events.onWrite.

    interface OriginProvider {
        addListeners(
            listeners: Callbacks<SOURCE, EVENTS>,
            options?: IListener.Options,
        ): Remove;
        getOrigin(): IWorkbookIO.Origin;
    }

    Hierarchy (View Summary)

    Index