SheetXL - v1.0.2
    Preparing search index...

    Interface IPersistScope

    One save or load of the rich values cells name. Ids are positions in the saved table, not the collection's own.

    interface IPersistScope {
        add(value: IRichData): number;
        at(id: number): IRichData | null;
        endPersist(): void;
        fromJSON(
            json: readonly JSON[] | undefined,
            ctx: IRichDataKind.Context,
            kinds?: readonly JSON[],
        ): void;
        toJSONAsync(toResourceId?: ToResourceId): Promise<JSON[]>;
        toKindsJSON(): JSON[];
    }
    Index
    add at endPersist fromJSON toJSONAsync toKindsJSON

    • The saved id of value, added to the table when new.

      Parameters

      • value: IRichData

      Returns number

    • The value a loaded id names, or null.

      Parameters

      • id: number

      Returns IRichData | null

    • Ends the scope. The last to end lets the table go.

      Returns void

    • Loads a saved table: each entry made by its kind, its ids then answered by at.

      Parameters

      • json: readonly JSON[] | undefined
      • ctx: IRichDataKind.Context

        What the values are made for: the workbook's resources, and the file's resource ids.

      • Optionalkinds: readonly JSON[]

        The kinds saved with the table (toKindsJSON), made before the values that name them.

      Returns void

    • The table, in id order.

      Parameters

      • OptionaltoResourceId: ToResourceId

        The saved id of a resource a value holds.

      Returns Promise<JSON[]>

    • The kinds the table's values name, nested values included, that are not registered in code and so are saved with it.

      Returns JSON[]

    Settings
    Member Visibility

    On This Page
    Methods