@jsfkit/types
    Preparing search index...

    Type Alias PivotCacheBase

    Shared properties for all pivot cache source types.

    type PivotCacheBase = {
        enableRefresh?: boolean;
        fields: PivotCacheField[];
        invalid?: boolean;
        records?: PivotCacheRecord[];
        refreshedBy?: string;
        refreshedDate?: number;
        refreshOnLoad?: boolean;
        uid?: string;
        upgradeOnRefresh?: boolean;
    }
    Index

    Properties

    enableRefresh? fields invalid? records? refreshedBy? refreshedDate? refreshOnLoad? uid? upgradeOnRefresh?

    Properties

    enableRefresh?: boolean

    Whether refresh is enabled for this cache.

    true
    fields: PivotCacheField[]

    The fields (columns) in the cache, in source-data order. Each entry parallels the corresponding pivot table's fields array by index.

    invalid?: boolean

    Whether the cache needs to be refreshed. When true, the pivot table's cached data is out of date with respect to its source.

    false
    records?: PivotCacheRecord[]

    The cached data records. Each record is an array of values corresponding to the cache fields. When absent, the pivot table relies on the source data directly.

    refreshedBy?: string

    Name of the user who last refreshed the cache.

    refreshedDate?: number

    When the cache was last refreshed, as a serial date number (e.g. 39536.657).

    refreshOnLoad?: boolean

    Whether the cache is refreshed on file open.

    false
    uid?: string

    Revision-tracking unique identifier. A GUID string like "{93AACE53-8F3A-A04A-893A-A439866B3165}" assigned by Excel 2014+ for revision tracking.

    upgradeOnRefresh?: boolean

    Whether the cache definition is upgraded when refreshed.

    false

    Settings

    Member Visibility

    On This Page

    Properties