@jsfkit/types
    Preparing search index...

    Type Alias PivotPageField

    Describes a page (filter) field in a pivot table. Page fields allow the user to filter the entire pivot table to show only data matching a selected item.

    type PivotPageField = {
        caption?: string;
        fieldIndex: integer;
        hierarchy?: integer;
        name?: string;
        selectedItem?: integer;
    }
    Index

    Properties

    caption? fieldIndex hierarchy? name? selectedItem?

    Properties

    caption?: string

    Display caption for the page field. Shown in the pivot table UI but not used for programmatic field identification.

    fieldIndex: integer

    Index into the pivot table's PivotField array (and the cache's field array).

    hierarchy?: integer

    Hierarchy index for OLAP page fields.

    -1
    name?: string

    An optional name override for the page field. Identifies the field in formulas and programmatic access (e.g. GETPIVOTDATA).

    selectedItem?: integer

    The index of the currently selected item in the field's items list. When absent, all items are shown (no filter applied).

    Settings

    Member Visibility

    On This Page

    Properties