@jsfkit/types
    Preparing search index...

    Type Alias PivotField

    Configuration for a single field in a pivot table. There is one PivotField per cache field, in the same order as the cache fields.

    type PivotField = {
        allDrilled?: boolean;
        autoShow?: boolean;
        autoSortScope?: PivotArea;
        axis?: PivotFieldAxis;
        compact?: boolean;
        dataField?: boolean;
        dataSourceSort?: boolean;
        defaultAttributeDrillState?: boolean;
        defaultSubtotal?: boolean;
        dragOff?: boolean;
        dragToCol?: boolean;
        dragToData?: boolean;
        dragToPage?: boolean;
        dragToRow?: boolean;
        hiddenLevel?: boolean;
        hideNewItems?: boolean;
        includeNewItemsInFilter?: boolean;
        insertBlankRow?: boolean;
        insertPageBreak?: boolean;
        itemPageCount?: integer;
        items?: PivotFieldItem[];
        measureFilter?: boolean;
        multipleItemSelectionAllowed?: boolean;
        name?: string;
        nonAutoSortDefault?: boolean;
        numFmt?: string;
        outline?: boolean;
        rankBy?: integer;
        serverField?: boolean;
        showAll?: boolean;
        showDropDowns?: boolean;
        showPropAsCaption?: boolean;
        showPropCell?: boolean;
        showPropTip?: boolean;
        sortType?: "manual" | "ascending" | "descending";
        subtotalCaption?: string;
        subtotalFunctions?: PivotSubtotalFunction[];
        subtotalTop?: boolean;
        topAutoShow?: boolean;
        uniqueMemberProperty?: string;
    }
    Index

    Properties

    allDrilled? autoShow? autoSortScope? axis? compact? dataField? dataSourceSort? defaultAttributeDrillState? defaultSubtotal? dragOff? dragToCol? dragToData? dragToPage? dragToRow? hiddenLevel? hideNewItems? includeNewItemsInFilter? insertBlankRow? insertPageBreak? itemPageCount? items? measureFilter? multipleItemSelectionAllowed? name? nonAutoSortDefault? numFmt? outline? rankBy? serverField? showAll? showDropDowns? showPropAsCaption? showPropCell? showPropTip? sortType? subtotalCaption? subtotalFunctions? subtotalTop? topAutoShow? uniqueMemberProperty?

    Properties

    allDrilled?: boolean

    Whether all items in this field are drilled down.

    false
    autoShow?: boolean

    Whether the auto-show (top/bottom N) filter is enabled.

    false
    autoSortScope?: PivotArea

    Pivot area defining the sort key when sortType is 'ascending' or 'descending'. Specifies which data field's values to sort by (via a reference with field: -2), and may include additional references to constrain the scope. Absent when sorting is alphabetical (by the field's own labels).

    axis?: PivotFieldAxis

    Which axis this field is placed on. Absent if the field is not placed on a row, column, or page axis (e.g. fields used only as data fields, or fields not used in the layout at all).

    compact?: boolean

    Whether the field uses compact layout (labels in the same column as child fields).

    true
    dataField?: boolean

    Whether this field is used as a data field. Data fields appear in the pivot table's PivotDataField list; this flag indicates that the field participates as a value source rather than being placed on a row/col/page axis.

    false
    dataSourceSort?: boolean

    Whether sorting is deferred to the data source.

    defaultAttributeDrillState?: boolean

    Default drill state for member properties.

    false
    defaultSubtotal?: boolean

    Whether to show the default subtotal for this field.

    true
    dragOff?: boolean

    Whether the field can be dragged off the pivot table (removed).

    true
    dragToCol?: boolean

    Whether the field can be dragged to the column axis.

    true
    dragToData?: boolean

    Whether the field can be dragged to the data area.

    true
    dragToPage?: boolean

    Whether the field can be dragged to the page (filter) axis.

    true
    dragToRow?: boolean

    Whether the field can be dragged to the row axis.

    true
    hiddenLevel?: boolean

    Whether this field's hierarchy level is hidden.

    false
    hideNewItems?: boolean

    Whether newly added items are hidden by default.

    false
    includeNewItemsInFilter?: boolean

    Whether new items are included in the field's manual filter.

    false
    insertBlankRow?: boolean

    Whether to insert a blank row after each group in this field.

    false
    insertPageBreak?: boolean

    Whether a page break is inserted after each group in this field.

    false
    itemPageCount?: integer

    Number of items to display when auto-show is enabled.

    10
    items?: PivotFieldItem[]

    The items in this field, representing unique values and special entries.

    measureFilter?: boolean

    Whether the field supports measure filtering (OLAP).

    false
    multipleItemSelectionAllowed?: boolean

    Whether multiple items can be selected in this field's filter.

    false
    name?: string

    Display name override for this field. When present, this replaces the cache field name in the pivot table's UI. Distinct from PivotFieldItem.name which overrides individual item labels.

    nonAutoSortDefault?: boolean

    Whether the field defaults to no auto-sort (manual sort).

    false
    numFmt?: string

    The number format code for this field's data (e.g. "General", "#,##0").

    outline?: boolean

    Whether the field uses outline layout (labels on their own row, above child data).

    true
    rankBy?: integer

    Index of the data field used for ranking.

    serverField?: boolean

    Whether this is a server-based field.

    false
    showAll?: boolean

    Whether to show all items for this field, including those with no data.

    true
    showDropDowns?: boolean

    Whether filter dropdowns are shown for this field.

    true
    showPropAsCaption?: boolean

    Whether member property values are used as captions.

    false
    showPropCell?: boolean

    Whether member property values are shown in cells.

    false
    showPropTip?: boolean

    Whether member property values are shown in tooltips.

    false
    sortType?: "manual" | "ascending" | "descending"

    The sort order for this field's items.

    'manual'
    subtotalCaption?: string

    Custom caption for the subtotal row.

    subtotalFunctions?: PivotSubtotalFunction[]

    The subtotal functions to show. When absent or empty, the default subtotal (typically sum or count) is used.

    subtotalTop?: boolean

    Whether subtotals appear at the top of each group (only meaningful in outline mode).

    true
    topAutoShow?: boolean

    Whether auto-show displays the top N items (true) or bottom N items (false).

    true
    uniqueMemberProperty?: string

    The unique member property for this field (OLAP).

    Settings

    Member Visibility

    On This Page

    Properties