Excel.PivotTable class

Represents an Excel PivotTable.

[ API set: ExcelApi 1.3 ]

Extends

Properties

columnHierarchies

The Column Pivot Hierarchies of the PivotTable.

[ API set: ExcelApi 1.8 ]

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

dataHierarchies

The Data Pivot Hierarchies of the PivotTable.

[ API set: ExcelApi 1.8 ]

enableDataValueEditing

Specifies whether the PivotTable allows values in the data body to be edited by the user.

[ API set: ExcelApi 1.9 ]

filterHierarchies

The Filter Pivot Hierarchies of the PivotTable.

[ API set: ExcelApi 1.8 ]

hierarchies

The Pivot Hierarchies of the PivotTable.

[ API set: ExcelApi 1.8 ]

id

Id of the PivotTable. Read-only.

[ API set: ExcelApi 1.5 ]

layout

The PivotLayout describing the layout and visual structure of the PivotTable.

[ API set: ExcelApi 1.8 ]

name

Name of the PivotTable.

[ API set: ExcelApi 1.3 ]

rowHierarchies

The Row Pivot Hierarchies of the PivotTable.

[ API set: ExcelApi 1.8 ]

useCustomSortLists

Specifies whether the PivotTable uses custom lists when sorting.

[ API set: ExcelApi 1.9 ]

worksheet

The worksheet containing the current PivotTable.

[ API set: ExcelApi 1.3 ]

Methods

delete()

Deletes the PivotTable.

[ API set: ExcelApi 1.8 ]

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

refresh()

Refreshes the PivotTable.

[ API set: ExcelApi 1.3 ]

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.PivotTable object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PivotTableData) that contains shallow copies of any loaded child properties from the original object.

Property Details

columnHierarchies

The Column Pivot Hierarchies of the PivotTable.

[ API set: ExcelApi 1.8 ]

readonly columnHierarchies: Excel.RowColumnPivotHierarchyCollection;

Property Value

Examples

await Excel.run(async (context) => {
    const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");       

    // check if the PivotTable already has a column
    const column = pivotTable.columnHierarchies.getItemOrNullObject("Farm");
    column.load("id");
    await context.sync();

    if (column.isNullObject) {
        // ading the farm column to the column hierarchy automatically removes it from the row hierarchy
        pivotTable.columnHierarchies.add(pivotTable.hierarchies.getItem("Farm"));
    } else {
        pivotTable.columnHierarchies.remove(column);
    }

    await context.sync();
});

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

RequestContext

dataHierarchies

The Data Pivot Hierarchies of the PivotTable.

[ API set: ExcelApi 1.8 ]

readonly dataHierarchies: Excel.DataPivotHierarchyCollection;

Property Value

Examples

await Excel.run(async (context) => {
    const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
    pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold at Farm"));
    pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold Wholesale"));

    await context.sync();
});

enableDataValueEditing

Specifies whether the PivotTable allows values in the data body to be edited by the user.

[ API set: ExcelApi 1.9 ]

enableDataValueEditing: boolean;

Property Value

boolean

filterHierarchies

The Filter Pivot Hierarchies of the PivotTable.

[ API set: ExcelApi 1.8 ]

readonly filterHierarchies: Excel.FilterPivotHierarchyCollection;

Property Value

Examples

async function filter(functionType: Excel.AggregationFunction) {
    await Excel.run(async (context) => {
        const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
        const filters = pivotTable.filterHierarchies;
        const filter = filters.getItemOrNullObject("Classification");
        filter.load();
        await context.sync();

        // add the Classification hierarchy to the filter, if it's not already there
        if (filter.isNullObject) {
            filters.add(pivotTable.hierarchies.getItem("Classification"));
            await context.sync();
        }
    });
}

hierarchies

The Pivot Hierarchies of the PivotTable.

[ API set: ExcelApi 1.8 ]

readonly hierarchies: Excel.PivotHierarchyCollection;

Property Value

id

Id of the PivotTable. Read-only.

[ API set: ExcelApi 1.5 ]

readonly id: string;

Property Value

string

layout

The PivotLayout describing the layout and visual structure of the PivotTable.

[ API set: ExcelApi 1.8 ]

readonly layout: Excel.PivotLayout;

Property Value

Examples

await Excel.run(async (context) => {
    const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
    pivotTable.layout.load("layoutType");
    await context.sync();

    // cycle between the three layout types
    if (pivotTable.layout.layoutType === "Compact") {
        pivotTable.layout.layoutType = "Outline";
    } else if (pivotTable.layout.layoutType === "Outline") {
        pivotTable.layout.layoutType = "Tabular";
    } else {
        pivotTable.layout.layoutType = "Compact";
    }
    await context.sync();
    console.log("Pivot layout is now " + pivotTable.layout.layoutType);
});

name

Name of the PivotTable.

[ API set: ExcelApi 1.3 ]

name: string;

Property Value

string

rowHierarchies

The Row Pivot Hierarchies of the PivotTable.

[ API set: ExcelApi 1.8 ]

readonly rowHierarchies: Excel.RowColumnPivotHierarchyCollection;

Property Value

useCustomSortLists

Specifies whether the PivotTable uses custom lists when sorting.

[ API set: ExcelApi 1.9 ]

useCustomSortLists: boolean;

Property Value

boolean

worksheet

The worksheet containing the current PivotTable.

[ API set: ExcelApi 1.3 ]

readonly worksheet: Excel.Worksheet;

Property Value

Method Details

delete()

Deletes the PivotTable.

[ API set: ExcelApi 1.8 ]

delete(): void;

Returns

void

Examples

await Excel.run(async (context) => {
    context.workbook.worksheets.getItem("Pivot").pivotTables.getItem("Farm Sales").delete();

    await context.sync();
});

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

load(option?: Excel.Interfaces.PivotTableLoadOptions): Excel.PivotTable;

Parameters

Returns

Remarks

In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.PivotTable - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.PivotTable - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotTable - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Excel.PivotTable;

Parameters

propertyNames
string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.PivotTable;

Parameters

propertyNamesAndPaths
{ select?: string; expand?: string; }

Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

refresh()

Refreshes the PivotTable.

[ API set: ExcelApi 1.3 ]

refresh(): void;

Returns

void

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.PivotTableUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties
Interfaces.PivotTableUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

Remarks

This method has the following additional signature:

set(properties: Excel.PivotTable): void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.PivotTable): void;

Parameters

properties
Excel.PivotTable

Returns

void

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.PivotTable object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PivotTableData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.PivotTableData;

Returns