SheetXL - v1.0.2
    Preparing search index...

    Interface CacheFieldGroupJSON

    How a cache field groups the values of another, or its own.

    A table lists a grouping field's items, not its cache items. With neither range nor discrete the field groups nothing itself and only names its parent: a date field grouped by months.

    interface CacheFieldGroupJSON {
        base: number;
        dateItems?: number[];
        discrete?: number[];
        items: JSON[];
        parent?: number;
        range?: {
            by:
                | "months"
                | "years"
                | "days"
                | "hours"
                | "numbers"
                | "seconds"
                | "minutes"
                | "quarters";
            end: number;
            fixedEnd?: true;
            fixedStart?: true;
            interval?: number;
            start: number;
        };
    }
    Index
    base dateItems? discrete? items parent? range?
    base: number

    The cache field whose values are grouped: this field, for a number range in place.

    dateItems?: number[]

    The items that are dates, by index.

    discrete?: number[]

    Groups by hand: for each cache item of the base, its index in items.

    items: JSON[]

    Each group's caption. A range's first and last hold what falls before and after it. An item of the base that no group holds is its own group here, as itself: a number, a date's serial number (dateItems), a boolean, or the items' spelling of a blank or an error (CacheJSON.items).

    parent?: number

    The next coarser field grouping the same values (Date to Months to Years).

    range?: {
        by:
            | "months"
            | "years"
            | "days"
            | "hours"
            | "numbers"
            | "seconds"
            | "minutes"
            | "quarters";
        end: number;
        fixedEnd?: true;
        fixedStart?: true;
        interval?: number;
        start: number;
    }

    Groups by range of the base's values.

    Type Declaration

    • by:
          | "months"
          | "years"
          | "days"
          | "hours"
          | "numbers"
          | "seconds"
          | "minutes"
          | "quarters"
    • end: number

      The last value; a date range's whole-day end is the day after the last.

    • OptionalfixedEnd?: true

      The end stays when the source changes, rather than following its greatest value.

    • OptionalfixedStart?: true

      The start stays when the source changes, rather than following its least value.

    • Optionalinterval?: number

      The width of each step, in values or days; absent, 1.

    • start: number

      The first value; a date is its serial number.

    Settings
    Member Visibility

    On This Page
    Properties