excelscript.iconsetconditionalformat.yml

### YamlMime:TSType
name: ExcelScript.IconSetConditionalFormat
uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat:interface'
package: ExcelScript!
fullName: ExcelScript.IconSetConditionalFormat
summary: Represents an icon set criteria for conditional formatting.
remarks: |-


  #### Examples

  ```TypeScript
  /**
   * This script applies icon set conditional formatting to a range.
   */
  function main(workbook: ExcelScript.Workbook) {
    // Get the range "A1:A5" on the current worksheet.
    const sheet = workbook.getActiveWorksheet();
    const range = sheet.getRange("A1:A5");

    // Create icon set conditional formatting on the range.
    const conditionalFormatting = range.addConditionalFormat(ExcelScript.ConditionalFormatType.iconSet);
    const iconSetFormat: ExcelScript.IconSetConditionalFormat = conditionalFormatting.getIconSet();
    // Use the "3 Traffic Lights (Unrimmed)" set.
    iconSetFormat.setStyle(ExcelScript.IconSet.threeTrafficLights1);

    // Set the criteria to use a different icon for the bottom, middle, and top thirds of the values in the range.
    iconSetFormat.setCriteria([
      {
        formula:'=0',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
        type:ExcelScript.ConditionalFormatIconRuleType.percent
      },
      {
        formula:'=33',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
        type:ExcelScript.ConditionalFormatIconRuleType.percent},
      {
        formula:'=67',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
        type:ExcelScript.ConditionalFormatIconRuleType.percent
      }]);
  }
  ```
isPreview: false
isDeprecated: false
type: interface
methods:
  - name: getCriteria()
    uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#getCriteria:member(1)'
    package: ExcelScript!
    fullName: getCriteria()
    summary: >-
      An array of criteria and icon sets for the rules and potential custom icons for conditional icons. Note that for
      the first criterion only the custom icon can be modified, while type, formula, and operator will be ignored when
      set.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getCriteria(): ConditionalIconCriterion[];'
      return:
        type: '<xref uid="ExcelScript!ExcelScript.ConditionalIconCriterion:interface" />[]'
        description: ''
  - name: getReverseIconOrder()
    uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#getReverseIconOrder:member(1)'
    package: ExcelScript!
    fullName: getReverseIconOrder()
    summary: >-
      If `true`<!-- -->, reverses the icon orders for the icon set. Note that this cannot be set if custom icons are
      used.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getReverseIconOrder(): boolean;'
      return:
        type: boolean
        description: ''
  - name: getShowIconOnly()
    uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#getShowIconOnly:member(1)'
    package: ExcelScript!
    fullName: getShowIconOnly()
    summary: 'If `true`<!-- -->, hides the values and only shows icons.'
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getShowIconOnly(): boolean;'
      return:
        type: boolean
        description: ''
  - name: getStyle()
    uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#getStyle:member(1)'
    package: ExcelScript!
    fullName: getStyle()
    summary: 'If set, displays the icon set option for the conditional format.'
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'getStyle(): IconSet;'
      return:
        type: '<xref uid="ExcelScript!ExcelScript.IconSet:enum" />'
        description: ''
  - name: setCriteria(criteria)
    uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#setCriteria:member(1)'
    package: ExcelScript!
    fullName: setCriteria(criteria)
    summary: >-
      An array of criteria and icon sets for the rules and potential custom icons for conditional icons. Note that for
      the first criterion only the custom icon can be modified, while type, formula, and operator will be ignored when
      set.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'setCriteria(criteria: ConditionalIconCriterion[]): void;'
      parameters:
        - id: criteria
          description: ''
          type: '<xref uid="ExcelScript!ExcelScript.ConditionalIconCriterion:interface" />[]'
      return:
        type: void
        description: ''
  - name: setReverseIconOrder(reverseIconOrder)
    uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#setReverseIconOrder:member(1)'
    package: ExcelScript!
    fullName: setReverseIconOrder(reverseIconOrder)
    summary: >-
      If `true`<!-- -->, reverses the icon orders for the icon set. Note that this cannot be set if custom icons are
      used.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'setReverseIconOrder(reverseIconOrder: boolean): void;'
      parameters:
        - id: reverseIconOrder
          description: ''
          type: boolean
      return:
        type: void
        description: ''
  - name: setShowIconOnly(showIconOnly)
    uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#setShowIconOnly:member(1)'
    package: ExcelScript!
    fullName: setShowIconOnly(showIconOnly)
    summary: 'If `true`<!-- -->, hides the values and only shows icons.'
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'setShowIconOnly(showIconOnly: boolean): void;'
      parameters:
        - id: showIconOnly
          description: ''
          type: boolean
      return:
        type: void
        description: ''
  - name: setStyle(style)
    uid: 'ExcelScript!ExcelScript.IconSetConditionalFormat#setStyle:member(1)'
    package: ExcelScript!
    fullName: setStyle(style)
    summary: 'If set, displays the icon set option for the conditional format.'
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'setStyle(style: IconSet): void;'
      parameters:
        - id: style
          description: ''
          type: '<xref uid="ExcelScript!ExcelScript.IconSet:enum" />'
      return:
        type: void
        description: ''