excel.sliceritem.yml

### YamlMime:TSType
name: Excel.SlicerItem
uid: 'excel!Excel.SlicerItem:class'
package: excel!
fullName: Excel.SlicerItem
summary: Represents a slicer item in a slicer.
remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
  - name: context
    uid: 'excel!Excel.SlicerItem#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: hasData
    uid: 'excel!Excel.SlicerItem#hasData:member'
    package: excel!
    fullName: hasData
    summary: Value is `true` if the slicer item has data.
    remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly hasData: boolean;'
      return:
        type: boolean
  - name: isSelected
    uid: 'excel!Excel.SlicerItem#isSelected:member'
    package: excel!
    fullName: isSelected
    summary: >-
      Value is `true` if the slicer item is selected. Setting this value will not clear the selected state of other
      slicer items. By default, if the slicer item is the only one selected, when it is deselected, all items will be
      selected.
    remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'isSelected: boolean;'
      return:
        type: boolean
  - name: key
    uid: 'excel!Excel.SlicerItem#key:member'
    package: excel!
    fullName: key
    summary: Represents the unique value representing the slicer item.
    remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly key: string;'
      return:
        type: string
  - name: name
    uid: 'excel!Excel.SlicerItem#name:member'
    package: excel!
    fullName: name
    summary: Represents the title displayed in the Excel UI.
    remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly name: string;'
      return:
        type: string
methods:
  - name: load(options)
    uid: 'excel!Excel.SlicerItem#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.SlicerItemLoadOptions): Excel.SlicerItem;'
      parameters:
        - id: options
          description: Provides options for which properties of the object to load.
          type: '<xref uid="excel!Excel.Interfaces.SlicerItemLoadOptions:interface" />'
      return:
        type: '<xref uid="excel!Excel.SlicerItem:class" />'
        description: ''
  - name: load(propertyNames)
    uid: 'excel!Excel.SlicerItem#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.SlicerItem;'
      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.SlicerItem:class" />'
        description: ''
  - name: load(propertyNamesAndPaths)
    uid: 'excel!Excel.SlicerItem#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.SlicerItem;
      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.SlicerItem:class" />'
        description: ''
  - name: 'set(properties, options)'
    uid: 'excel!Excel.SlicerItem#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.SlicerItemUpdateData, 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.SlicerItemUpdateData: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.SlicerItem#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.SlicerItem): void;'
      parameters:
        - id: properties
          description: ''
          type: '<xref uid="excel!Excel.SlicerItem:class" />'
      return:
        type: void
        description: ''
  - name: toJSON()
    uid: 'excel!Excel.SlicerItem#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.SlicerItem object is an API object, the `toJSON` method returns a plain
      JavaScript object (typed as `Excel.Interfaces.SlicerItemData`<!-- -->) that contains shallow copies of any loaded
      child properties from the original object.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'toJSON(): Excel.Interfaces.SlicerItemData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.SlicerItemData:interface" />'
        description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'