@jsfkit/types
    Preparing search index...

    Type Alias PivotAreaReference

    A reference within a pivot area, identifying specific field items that define the area's scope.

    type PivotAreaReference = {
        avgSubtotal?: boolean;
        byPosition?: boolean;
        countASubtotal?: boolean;
        countSubtotal?: boolean;
        defaultSubtotal?: boolean;
        field?: PivotFieldIndex;
        itemIndices?: integer[];
        maxSubtotal?: boolean;
        minSubtotal?: boolean;
        productSubtotal?: boolean;
        relative?: boolean;
        selected?: boolean;
        stdDevPSubtotal?: boolean;
        stdDevSubtotal?: boolean;
        sumSubtotal?: boolean;
        varPSubtotal?: boolean;
        varSubtotal?: boolean;
    }
    Index

    Properties

    avgSubtotal? byPosition? countASubtotal? countSubtotal? defaultSubtotal? field? itemIndices? maxSubtotal? minSubtotal? productSubtotal? relative? selected? stdDevPSubtotal? stdDevSubtotal? sumSubtotal? varPSubtotal? varSubtotal?

    Properties

    avgSubtotal?: boolean

    Whether the average subtotal is included.

    false
    byPosition?: boolean

    Whether item indices are positional (absolute row/column position) rather than field-item-based.

    false
    countASubtotal?: boolean

    Whether the countA subtotal is included.

    false
    countSubtotal?: boolean

    Whether the count subtotal is included.

    false
    defaultSubtotal?: boolean

    Whether the default subtotal is included.

    false
    field?: PivotFieldIndex

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

    itemIndices?: integer[]

    Indices of the field items included in this reference.

    maxSubtotal?: boolean

    Whether the max subtotal is included.

    false
    minSubtotal?: boolean

    Whether the min subtotal is included.

    false
    productSubtotal?: boolean

    Whether the product subtotal is included.

    false
    relative?: boolean

    Whether the reference is relative to the pivot table's origin.

    false
    selected?: boolean

    Whether this reference participates in the selection. When false, the reference constrains the area without being selected itself.

    true
    stdDevPSubtotal?: boolean

    Whether the population standard deviation subtotal is included.

    false
    stdDevSubtotal?: boolean

    Whether the standard deviation subtotal is included.

    false
    sumSubtotal?: boolean

    Whether the sum subtotal is included.

    false
    varPSubtotal?: boolean

    Whether the population variance subtotal is included.

    false
    varSubtotal?: boolean

    Whether the variance subtotal is included.

    false

    Settings

    Member Visibility

    On This Page

    Properties