SheetXL - v1.0.2
    Preparing search index...

    Interface Pivot

    The records of a range grouped by rows and by columns — see IFormulaContext.createPivot.

    interface Pivot {
        getAggregate?(
            values: IRange,
            fn: IFunction,
            row?: PivotGroup,
            column?: PivotGroup,
        ): Scalar | undefined;
        getColumns(): PivotAxis;
        getMembers(
            values: IRange,
            row?: PivotGroup,
            column?: PivotGroup,
        ): IRange<Scalar> | null;
        getRecordCount(): number;
        getRows(): PivotAxis;
    }
    Index
    getAggregate? getColumns getMembers getRecordCount getRows

    • What fn returns over the members getMembers would give, computed without them.

      Parameters

      Returns Scalar | undefined

      null when no kept record is in both groups, undefined when the pivot does not compute fn this way: call fn over getMembers instead.

      Optional. Where it is present it answers for the built-in aggregates it knows (SUM, COUNT, AVERAGE, ...) with exactly the value the call would return, the first error member included.

    • The members of values in both a row group and a column group, as one column in record order.

      Parameters

      • values: IRange

        One column, as tall as the keys.

      • Optionalrow: PivotGroup

        A group of this pivot's rows; omit it, or pass the root, for every row.

      • Optionalcolumn: PivotGroup

        A group of this pivot's columns; omit it, or pass the root, for every column.

      Returns IRange<Scalar> | null

      An array, never a reference, or null when no kept record is in both groups.

    • The number of records kept by the filter.

      Returns number

    Settings
    Member Visibility

    On This Page
    Methods