excel.conditionalformatpresetcriterion.yml

### YamlMime:TSEnum
name: Excel.ConditionalFormatPresetCriterion
uid: 'excel!Excel.ConditionalFormatPresetCriterion:enum'
package: excel!
fullName: Excel.ConditionalFormatPresetCriterion
summary: Represents the criteria of the preset criteria conditional format type.
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: aboveAverage
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.aboveAverage:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"AboveAverage"'
  - name: belowAverage
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.belowAverage:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"BelowAverage"'
  - name: blanks
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.blanks:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"Blanks"'
  - name: duplicateValues
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.duplicateValues:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"DuplicateValues"'
  - name: equalOrAboveAverage
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.equalOrAboveAverage:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"EqualOrAboveAverage"'
  - name: equalOrBelowAverage
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.equalOrBelowAverage:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"EqualOrBelowAverage"'
  - name: errors
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.errors:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"Errors"'
  - name: invalid
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.invalid:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"Invalid"'
  - name: lastMonth
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.lastMonth:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"LastMonth"'
  - name: lastSevenDays
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.lastSevenDays:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"LastSevenDays"'
  - name: lastWeek
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.lastWeek:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"LastWeek"'
  - name: nextMonth
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.nextMonth:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"NextMonth"'
  - name: nextWeek
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.nextWeek:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"NextWeek"'
  - name: nonBlanks
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.nonBlanks:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"NonBlanks"'
  - name: nonErrors
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.nonErrors:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"NonErrors"'
  - name: oneStdDevAboveAverage
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.oneStdDevAboveAverage:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"OneStdDevAboveAverage"'
  - name: oneStdDevBelowAverage
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.oneStdDevBelowAverage:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"OneStdDevBelowAverage"'
  - name: thisMonth
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.thisMonth:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"ThisMonth"'
  - name: thisWeek
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.thisWeek:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"ThisWeek"'
  - name: threeStdDevAboveAverage
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.threeStdDevAboveAverage:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"ThreeStdDevAboveAverage"'
  - name: threeStdDevBelowAverage
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.threeStdDevBelowAverage:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"ThreeStdDevBelowAverage"'
  - name: today
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.today:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"Today"'
  - name: tomorrow
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.tomorrow:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"Tomorrow"'
  - name: twoStdDevAboveAverage
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.twoStdDevAboveAverage:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"TwoStdDevAboveAverage"'
  - name: twoStdDevBelowAverage
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.twoStdDevBelowAverage:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"TwoStdDevBelowAverage"'
  - name: uniqueValues
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.uniqueValues:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"UniqueValues"'
  - name: yesterday
    uid: 'excel!Excel.ConditionalFormatPresetCriterion.yesterday:member'
    package: excel!
    summary: '* \[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    value: '"Yesterday"'