excel.pivottablecollection.yml

### YamlMime:TSType
name: Excel.PivotTableCollection
uid: 'excel!Excel.PivotTableCollection:class'
package: excel!
fullName: Excel.PivotTableCollection
summary: Represents a collection of all the PivotTables that are part of the workbook or worksheet.
remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
  - name: context
    uid: 'excel!Excel.PivotTableCollection#context:member'
    package: excel!
    fullName: context
    summary: >-
      The request context associated with the object. This connects the add-in's process to the Office host
      application's process.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'context: RequestContext;'
      return:
        type: '<xref uid="excel!Excel.RequestContext:class" />'
  - name: items
    uid: 'excel!Excel.PivotTableCollection#items:member'
    package: excel!
    fullName: items
    summary: Gets the loaded child items in this collection.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly items: Excel.PivotTable[];'
      return:
        type: '<xref uid="excel!Excel.PivotTable:class" />[]'
methods:
  - name: getCount()
    uid: 'excel!Excel.PivotTableCollection#getCount:member(1)'
    package: excel!
    fullName: getCount()
    summary: Gets the number of pivot tables in the collection.
    remarks: '\[ [API set: ExcelApi 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getCount(): OfficeExtension.ClientResult<number>;'
      return:
        type: '<xref uid="office!OfficeExtension.ClientResult:class" />&lt;number&gt;'
        description: ''
  - name: getItem(name)
    uid: 'excel!Excel.PivotTableCollection#getItem:member(1)'
    package: excel!
    fullName: getItem(name)
    summary: Gets a PivotTable by name.
    remarks: >-
      \[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-refresh.yaml


      // This function refreshes the "Farm Sales" PivotTable,

      // which updates the PivotTable with changes made to the source table.

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

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getItem(name: string): Excel.PivotTable;'
      parameters:
        - id: name
          description: Name of the PivotTable to be retrieved.
          type: string
      return:
        type: '<xref uid="excel!Excel.PivotTable:class" />'
        description: ''
  - name: getItemOrNullObject(name)
    uid: 'excel!Excel.PivotTableCollection#getItemOrNullObject:member(1)'
    package: excel!
    fullName: getItemOrNullObject(name)
    summary: >-
      Gets a PivotTable by name. If the PivotTable does not exist, then this method returns an object with its
      `isNullObject` property set to `true`<!-- -->. For further information, see [*OrNullObject methods and
      properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)<!--
      -->.
    remarks: '\[ [API set: ExcelApi 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getItemOrNullObject(name: string): Excel.PivotTable;'
      parameters:
        - id: name
          description: Name of the PivotTable to be retrieved.
          type: string
      return:
        type: '<xref uid="excel!Excel.PivotTable:class" />'
        description: ''
  - name: load(options)
    uid: 'excel!Excel.PivotTableCollection#load:member(1)'
    package: excel!
    fullName: load(options)
    summary: >-
      Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
      the properties.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        load(options?: Excel.Interfaces.PivotTableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions):
        Excel.PivotTableCollection;
      parameters:
        - id: options
          description: Provides options for which properties of the object to load.
          type: >-
            <xref uid="excel!Excel.Interfaces.PivotTableCollectionLoadOptions:interface" /> & <xref
            uid="excel!Excel.Interfaces.CollectionLoadOptions:interface" />
      return:
        type: '<xref uid="excel!Excel.PivotTableCollection:class" />'
        description: ''
  - name: load(propertyNames)
    uid: 'excel!Excel.PivotTableCollection#load:member(2)'
    package: excel!
    fullName: load(propertyNames)
    summary: >-
      Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
      the properties.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'load(propertyNames?: string | string[]): Excel.PivotTableCollection;'
      parameters:
        - id: propertyNames
          description: A comma-delimited string or an array of strings that specify the properties to load.
          type: 'string | string[]'
      return:
        type: '<xref uid="excel!Excel.PivotTableCollection:class" />'
        description: ''
  - name: load(propertyNamesAndPaths)
    uid: 'excel!Excel.PivotTableCollection#load:member(3)'
    package: excel!
    fullName: load(propertyNamesAndPaths)
    summary: >-
      Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
      the properties.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotTableCollection;'
      parameters:
        - id: propertyNamesAndPaths
          description: >-
            `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.
          type: '<xref uid="office!OfficeExtension.LoadOption:interface" />'
      return:
        type: '<xref uid="excel!Excel.PivotTableCollection:class" />'
        description: ''
  - name: refreshAll()
    uid: 'excel!Excel.PivotTableCollection#refreshAll:member(1)'
    package: excel!
    fullName: refreshAll()
    summary: Refreshes all the pivot tables in the collection.
    remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'refreshAll(): void;'
      return:
        type: void
        description: ''
  - name: toJSON()
    uid: 'excel!Excel.PivotTableCollection#toJSON:member(1)'
    package: excel!
    fullName: toJSON()
    summary: >-
      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.PivotTableCollection` object is an API object, the `toJSON` method
      returns a plain JavaScript object (typed as `Excel.Interfaces.PivotTableCollectionData`<!-- -->) that contains an
      "items" array with shallow copies of any loaded properties from the collection's items.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'toJSON(): Excel.Interfaces.PivotTableCollectionData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.PivotTableCollectionData:interface" />'
        description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'