SheetXL - v1.0.2
    Preparing search index...

    Interface PivotFieldJSON

    One field of a pivot table: how the table uses a field of its cache.

    interface PivotFieldJSON {
        axis?: IPivotTable.Axis;
        blankRowAfter?: true;
        dataField?: true;
        form?: PivotForm;
        includeNewItemsInFilter?: true;
        items?: PivotItemJSON[];
        multipleItemSelection?: true;
        name?: string;
        numberFormat?: string | number;
        repeatLabels?: true;
        rest?: string;
        showItemsWithNoData?: true;
        sort?: {
            dataField?: number;
            order: "ascending" | "descending";
            scope?: PivotSortScopeJSON;
        };
        subtotalCaption?: string;
        subtotals?: PivotSubtotal[];
        subtotalsOnTop?: false;
    }
    Index
    axis? blankRowAfter? dataField? form? includeNewItemsInFilter? items? multipleItemSelection? name? numberFormat? repeatLabels? rest? showItemsWithNoData? sort? subtotalCaption? subtotals? subtotalsOnTop?
    axis?: IPivotTable.Axis
    blankRowAfter?: true

    A blank line follows each item.

    dataField?: true

    The field is summarized by a data field.

    form?: PivotForm

    How the field's items are laid out; absent, compact.

    includeNewItemsInFilter?: true

    Items new to the cache show after a refresh while the field is filtered.

    items?: PivotItemJSON[]

    The field's items in the table's order, which is state: a refresh keeps it.

    multipleItemSelection?: true

    A page field shows more than one item.

    name?: string

    The caption shown for the field.

    numberFormat?: string | number

    The number format of the items' labels: a format code, or a built-in format's id; absent, General.

    repeatLabels?: true

    Each item's label repeats on every line it spans.

    rest?: string

    The field's markup with what is modeled taken out.

    showItemsWithNoData?: true

    Items no record falls in show as well.

    sort?: {
        dataField?: number;
        order: "ascending" | "descending";
        scope?: PivotSortScopeJSON;
    }

    The items are sorted by label, or by the total of a data field (by index into JSON.dataFields); absent, they stay in items' order.

    Type Declaration

    • OptionaldataField?: number
    • order: "ascending" | "descending"
    • Optionalscope?: PivotSortScopeJSON

      Sorted by one line of the other axis rather than by its grand total; absent, the total.

    subtotalCaption?: string

    The whole caption of the field's automatic subtotal lines, in place of <item> Total.

    subtotals?: PivotSubtotal[]

    The subtotals shown for the field: default is the automatic one. Absent, the automatic subtotal alone; empty, none.

    subtotalsOnTop?: false

    false: the field's subtotals sit under its items rather than on their row.

    Settings
    Member Visibility

    On This Page
    Properties