excel.datapivothierarchycollection.yml

### YamlMime:TSType
name: Excel.DataPivotHierarchyCollection
uid: 'excel!Excel.DataPivotHierarchyCollection:class'
package: excel!
fullName: Excel.DataPivotHierarchyCollection
summary: Represents a collection of DataPivotHierarchy items associated with the PivotTable.
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
  - name: context
    uid: 'excel!Excel.DataPivotHierarchyCollection#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.DataPivotHierarchyCollection#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.DataPivotHierarchy[];'
      return:
        type: '<xref uid="excel!Excel.DataPivotHierarchy:class" />[]'
methods:
  - name: add(pivotHierarchy)
    uid: 'excel!Excel.DataPivotHierarchyCollection#add:member(1)'
    package: excel!
    fullName: add(pivotHierarchy)
    summary: Adds the PivotHierarchy to the current axis.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'add(pivotHierarchy: Excel.PivotHierarchy): Excel.DataPivotHierarchy;'
      parameters:
        - id: pivotHierarchy
          description: ''
          type: '<xref uid="excel!Excel.PivotHierarchy:class" />'
      return:
        type: '<xref uid="excel!Excel.DataPivotHierarchy:class" />'
        description: ''
  - name: getCount()
    uid: 'excel!Excel.DataPivotHierarchyCollection#getCount:member(1)'
    package: excel!
    fullName: getCount()
    summary: Gets the number of pivot hierarchies in the collection.
    remarks: '\[ [API set: ExcelApi 1.8](/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.DataPivotHierarchyCollection#getItem:member(1)'
    package: excel!
    fullName: getItem(name)
    summary: Gets a DataPivotHierarchy by its name or ID.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getItem(name: string): Excel.DataPivotHierarchy;'
      parameters:
        - id: name
          description: Name of the DataPivotHierarchy to be retrieved.
          type: string
      return:
        type: '<xref uid="excel!Excel.DataPivotHierarchy:class" />'
        description: ''
  - name: getItemOrNullObject(name)
    uid: 'excel!Excel.DataPivotHierarchyCollection#getItemOrNullObject:member(1)'
    package: excel!
    fullName: getItemOrNullObject(name)
    summary: >-
      Gets a DataPivotHierarchy by name. If the DataPivotHierarchy 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.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getItemOrNullObject(name: string): Excel.DataPivotHierarchy;'
      parameters:
        - id: name
          description: Name of the DataPivotHierarchy to be retrieved.
          type: string
      return:
        type: '<xref uid="excel!Excel.DataPivotHierarchy:class" />'
        description: ''
  - name: load(options)
    uid: 'excel!Excel.DataPivotHierarchyCollection#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.DataPivotHierarchyCollectionLoadOptions &
        Excel.Interfaces.CollectionLoadOptions): Excel.DataPivotHierarchyCollection;
      parameters:
        - id: options
          description: Provides options for which properties of the object to load.
          type: >-
            <xref uid="excel!Excel.Interfaces.DataPivotHierarchyCollectionLoadOptions:interface" /> & <xref
            uid="excel!Excel.Interfaces.CollectionLoadOptions:interface" />
      return:
        type: '<xref uid="excel!Excel.DataPivotHierarchyCollection:class" />'
        description: ''
  - name: load(propertyNames)
    uid: 'excel!Excel.DataPivotHierarchyCollection#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.DataPivotHierarchyCollection;'
      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.DataPivotHierarchyCollection:class" />'
        description: ''
  - name: load(propertyNamesAndPaths)
    uid: 'excel!Excel.DataPivotHierarchyCollection#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.DataPivotHierarchyCollection;'
      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.DataPivotHierarchyCollection:class" />'
        description: ''
  - name: remove(DataPivotHierarchy)
    uid: 'excel!Excel.DataPivotHierarchyCollection#remove:member(1)'
    package: excel!
    fullName: remove(DataPivotHierarchy)
    summary: Removes the PivotHierarchy from the current axis.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'remove(DataPivotHierarchy: Excel.DataPivotHierarchy): void;'
      parameters:
        - id: DataPivotHierarchy
          description: ''
          type: '<xref uid="excel!Excel.DataPivotHierarchy:class" />'
      return:
        type: void
        description: ''
  - name: toJSON()
    uid: 'excel!Excel.DataPivotHierarchyCollection#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.DataPivotHierarchyCollection` object is an API object, the `toJSON`
      method returns a plain JavaScript object (typed as `Excel.Interfaces.DataPivotHierarchyCollectionData`<!-- -->)
      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.DataPivotHierarchyCollectionData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.DataPivotHierarchyCollectionData:interface" />'
        description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'