@jsfkit/types
    Preparing search index...

    Type Alias PivotArea

    Describes a region of a pivot table, used to target formatting, conditional formatting, and other area-specific features.

    type PivotArea = {
        axis?: PivotAreaAxis;
        cacheIndex?: boolean;
        collapsedLevelsAreSubtotals?: boolean;
        dataOnly?: boolean;
        field?: PivotFieldIndex;
        fieldPosition?: integer;
        grandCol?: boolean;
        grandRow?: boolean;
        labelOnly?: boolean;
        offset?: string;
        outline?: boolean;
        references?: PivotAreaReference[];
        type?: PivotAreaType;
    }
    Index

    Properties

    axis? cacheIndex? collapsedLevelsAreSubtotals? dataOnly? field? fieldPosition? grandCol? grandRow? labelOnly? offset? outline? references? type?

    Properties

    axis?: PivotAreaAxis

    The axis this area targets.

    cacheIndex?: boolean

    Whether item indices refer to cache field items rather than pivot field items.

    false
    collapsedLevelsAreSubtotals?: boolean

    Whether collapsed hierarchy levels are treated as subtotals.

    false
    dataOnly?: boolean

    Whether the area applies only to data cells (excluding labels).

    true
    field?: PivotFieldIndex

    The field this area applies to. See PivotFieldIndex for valid values.

    fieldPosition?: integer

    The position of the field on its axis (0-based).

    grandCol?: boolean

    Whether the column grand total is included.

    false
    grandRow?: boolean

    Whether the row grand total is included.

    false
    labelOnly?: boolean

    Whether the area applies only to label cells (excluding data).

    false
    offset?: string

    A cell reference offset relative to the pivot table's top-left corner.

    outline?: boolean

    Whether the area includes outline-mode items.

    true
    references?: PivotAreaReference[]

    References that narrow the area to specific field items.

    type?: PivotAreaType

    The type of area.

    'normal'

    Settings

    Member Visibility

    On This Page

    Properties