excel.conditionalformattype.yml

### YamlMime:TSEnum
name: Excel.ConditionalFormatType
uid: 'excel!Excel.ConditionalFormatType:enum'
package: excel!
fullName: Excel.ConditionalFormatType
summary: ''
remarks: >-
  \[ [API set: ExcelApi 1.6](/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/14-conditional-formatting/conditional-formatting-advanced.yaml


  await Excel.run(async (context) => {
      const sheet = context.workbook.worksheets.getItem("Sample");
      queueCommandsToClearAllConditionalFormats(sheet);

      const temperatureDataRange = sheet.tables.getItem("TemperatureTable").getDataBodyRange();

      /* When the priority property of ConditionalFormat objects 
         is not explicitly set, they are prioritized in the order
         that they are added, with zero-based numbering: 0, 1, ...
         Contradictions are resolved in favor of the format with
         the lower priority number. In the example below, negative
         numbers will get a green background, but NOT a blue font,
         because priority goes to the format that gives them a red font.
      */

      // Set low numbers to bold, dark red font. This format will
      // get priority 0.
      const presetFormat = temperatureDataRange.conditionalFormats
          .add(Excel.ConditionalFormatType.presetCriteria);
      presetFormat.preset.format.font.color = "red";
      presetFormat.preset.format.font.bold = true;
      presetFormat.preset.rule = { criterion: Excel.ConditionalFormatPresetCriterion.oneStdDevBelowAverage };

       // Set negative numbers to blue font with green background. 
       // This format will get priority 1.
      const cellValueFormat = temperatureDataRange.conditionalFormats
          .add(Excel.ConditionalFormatType.cellValue);
      cellValueFormat.cellValue.format.font.color = "blue";
      cellValueFormat.cellValue.format.fill.color = "lightgreen";
      cellValueFormat.cellValue.rule = { formula1: "=0", operator: "LessThan" };

      await context.sync();
  });

  ```
isPreview: false
isDeprecated: false
fields:
  - name: cellValue
    uid: 'excel!Excel.ConditionalFormatType.cellValue:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"CellValue"'
  - name: colorScale
    uid: 'excel!Excel.ConditionalFormatType.colorScale:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"ColorScale"'
  - name: containsText
    uid: 'excel!Excel.ConditionalFormatType.containsText:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"ContainsText"'
  - name: custom
    uid: 'excel!Excel.ConditionalFormatType.custom:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"Custom"'
  - name: dataBar
    uid: 'excel!Excel.ConditionalFormatType.dataBar:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"DataBar"'
  - name: iconSet
    uid: 'excel!Excel.ConditionalFormatType.iconSet:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"IconSet"'
  - name: presetCriteria
    uid: 'excel!Excel.ConditionalFormatType.presetCriteria:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"PresetCriteria"'
  - name: topBottom
    uid: 'excel!Excel.ConditionalFormatType.topBottom:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"TopBottom"'