excel.filterpivothierarchy.yml

### YamlMime:TSType
name: Excel.FilterPivotHierarchy
uid: 'excel!Excel.FilterPivotHierarchy:class'
package: excel!
fullName: Excel.FilterPivotHierarchy
summary: Represents the Excel FilterPivotHierarchy.
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.FilterPivotHierarchy#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: enableMultipleFilterItems
    uid: 'excel!Excel.FilterPivotHierarchy#enableMultipleFilterItems:member'
    package: excel!
    fullName: enableMultipleFilterItems
    summary: Determines whether to allow multiple filter items.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'enableMultipleFilterItems: boolean;'
      return:
        type: boolean
  - name: fields
    uid: 'excel!Excel.FilterPivotHierarchy#fields:member'
    package: excel!
    fullName: fields
    summary: Returns the PivotFields associated with the FilterPivotHierarchy.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly fields: Excel.PivotFieldCollection;'
      return:
        type: '<xref uid="excel!Excel.PivotFieldCollection:class" />'
  - name: id
    uid: 'excel!Excel.FilterPivotHierarchy#id:member'
    package: excel!
    fullName: id
    summary: ID of the FilterPivotHierarchy.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly id: string;'
      return:
        type: string
  - name: name
    uid: 'excel!Excel.FilterPivotHierarchy#name:member'
    package: excel!
    fullName: name
    summary: Name of the FilterPivotHierarchy.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'name: string;'
      return:
        type: string
  - name: position
    uid: 'excel!Excel.FilterPivotHierarchy#position:member'
    package: excel!
    fullName: position
    summary: Position of the FilterPivotHierarchy.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'position: number;'
      return:
        type: number
methods:
  - name: load(options)
    uid: 'excel!Excel.FilterPivotHierarchy#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.FilterPivotHierarchyLoadOptions): Excel.FilterPivotHierarchy;'
      parameters:
        - id: options
          description: Provides options for which properties of the object to load.
          type: '<xref uid="excel!Excel.Interfaces.FilterPivotHierarchyLoadOptions:interface" />'
      return:
        type: '<xref uid="excel!Excel.FilterPivotHierarchy:class" />'
        description: ''
  - name: load(propertyNames)
    uid: 'excel!Excel.FilterPivotHierarchy#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.FilterPivotHierarchy;'
      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.FilterPivotHierarchy:class" />'
        description: ''
  - name: load(propertyNamesAndPaths)
    uid: 'excel!Excel.FilterPivotHierarchy#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?: {
                    select?: string;
                    expand?: string;
                }): Excel.FilterPivotHierarchy;
      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: |-
            {
                        select?: string;
                        expand?: string;
                    }
      return:
        type: '<xref uid="excel!Excel.FilterPivotHierarchy:class" />'
        description: ''
  - name: 'set(properties, options)'
    uid: 'excel!Excel.FilterPivotHierarchy#set:member(1)'
    package: excel!
    fullName: 'set(properties, options)'
    summary: >-
      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.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'set(properties: Interfaces.FilterPivotHierarchyUpdateData, options?: OfficeExtension.UpdateOptions): void;'
      parameters:
        - id: properties
          description: >-
            A JavaScript object with properties that are structured isomorphically to the properties of the object on
            which the method is called.
          type: '<xref uid="excel!Excel.Interfaces.FilterPivotHierarchyUpdateData:interface" />'
        - id: options
          description: Provides an option to suppress errors if the properties object tries to set any read-only properties.
          type: '<xref uid="office!OfficeExtension.UpdateOptions:interface" />'
      return:
        type: void
        description: ''
  - name: set(properties)
    uid: 'excel!Excel.FilterPivotHierarchy#set:member(2)'
    package: excel!
    fullName: set(properties)
    summary: 'Sets multiple properties on the object at the same time, based on an existing loaded object.'
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'set(properties: Excel.FilterPivotHierarchy): void;'
      parameters:
        - id: properties
          description: ''
          type: '<xref uid="excel!Excel.FilterPivotHierarchy:class" />'
      return:
        type: void
        description: ''
  - name: setToDefault()
    uid: 'excel!Excel.FilterPivotHierarchy#setToDefault:member(1)'
    package: excel!
    fullName: setToDefault()
    summary: Reset the FilterPivotHierarchy back to its default values.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'setToDefault(): void;'
      return:
        type: void
        description: ''
  - name: toJSON()
    uid: 'excel!Excel.FilterPivotHierarchy#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.FilterPivotHierarchy object is an API object, the `toJSON` method
      returns a plain JavaScript object (typed as `Excel.Interfaces.FilterPivotHierarchyData`<!-- -->) that contains
      shallow copies of any loaded child properties from the original object.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'toJSON(): Excel.Interfaces.FilterPivotHierarchyData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.FilterPivotHierarchyData:interface" />'
        description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'