excel.interfaces.conditionalformatdata.yml

### YamlMime:TSType
name: Excel.Interfaces.ConditionalFormatData
uid: 'excel!Excel.Interfaces.ConditionalFormatData:interface'
package: excel!
fullName: Excel.Interfaces.ConditionalFormatData
summary: An interface describing the data returned by calling `conditionalFormat.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: cellValue
    uid: 'excel!Excel.Interfaces.ConditionalFormatData#cellValue:member'
    package: excel!
    fullName: cellValue
    summary: Returns the cell value conditional format properties if the current conditional format is a `CellValue` type.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'cellValue?: Excel.Interfaces.CellValueConditionalFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.CellValueConditionalFormatData:interface" />'
  - name: cellValueOrNullObject
    uid: 'excel!Excel.Interfaces.ConditionalFormatData#cellValueOrNullObject:member'
    package: excel!
    fullName: cellValueOrNullObject
    summary: Returns the cell value conditional format properties if the current conditional format is a `CellValue` type.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'cellValueOrNullObject?: Excel.Interfaces.CellValueConditionalFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.CellValueConditionalFormatData:interface" />'
  - name: colorScale
    uid: 'excel!Excel.Interfaces.ConditionalFormatData#colorScale:member'
    package: excel!
    fullName: colorScale
    summary: Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'colorScale?: Excel.Interfaces.ColorScaleConditionalFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ColorScaleConditionalFormatData:interface" />'
  - name: colorScaleOrNullObject
    uid: 'excel!Excel.Interfaces.ConditionalFormatData#colorScaleOrNullObject:member'
    package: excel!
    fullName: colorScaleOrNullObject
    summary: Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'colorScaleOrNullObject?: Excel.Interfaces.ColorScaleConditionalFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ColorScaleConditionalFormatData:interface" />'
  - name: custom
    uid: 'excel!Excel.Interfaces.ConditionalFormatData#custom:member'
    package: excel!
    fullName: custom
    summary: Returns the custom conditional format properties if the current conditional format is a custom type.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'custom?: Excel.Interfaces.CustomConditionalFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.CustomConditionalFormatData:interface" />'
  - name: customOrNullObject
    uid: 'excel!Excel.Interfaces.ConditionalFormatData#customOrNullObject:member'
    package: excel!
    fullName: customOrNullObject
    summary: Returns the custom conditional format properties if the current conditional format is a custom type.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'customOrNullObject?: Excel.Interfaces.CustomConditionalFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.CustomConditionalFormatData:interface" />'
  - name: dataBar
    uid: 'excel!Excel.Interfaces.ConditionalFormatData#dataBar:member'
    package: excel!
    fullName: dataBar
    summary: Returns the data bar properties if the current conditional format is a data bar.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'dataBar?: Excel.Interfaces.DataBarConditionalFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.DataBarConditionalFormatData:interface" />'
  - name: dataBarOrNullObject
    uid: 'excel!Excel.Interfaces.ConditionalFormatData#dataBarOrNullObject:member'
    package: excel!
    fullName: dataBarOrNullObject
    summary: Returns the data bar properties if the current conditional format is a data bar.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'dataBarOrNullObject?: Excel.Interfaces.DataBarConditionalFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.DataBarConditionalFormatData:interface" />'
  - name: iconSet
    uid: 'excel!Excel.Interfaces.ConditionalFormatData#iconSet:member'
    package: excel!
    fullName: iconSet
    summary: Returns the icon set conditional format properties if the current conditional format is an `IconSet` type.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'iconSet?: Excel.Interfaces.IconSetConditionalFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.IconSetConditionalFormatData:interface" />'
  - name: iconSetOrNullObject
    uid: 'excel!Excel.Interfaces.ConditionalFormatData#iconSetOrNullObject:member'
    package: excel!
    fullName: iconSetOrNullObject
    summary: Returns the icon set conditional format properties if the current conditional format is an `IconSet` type.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'iconSetOrNullObject?: Excel.Interfaces.IconSetConditionalFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.IconSetConditionalFormatData:interface" />'
  - name: id
    uid: 'excel!Excel.Interfaces.ConditionalFormatData#id:member'
    package: excel!
    fullName: id
    summary: The priority of the conditional format in the current `ConditionalFormatCollection`<!-- -->.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'id?: string;'
      return:
        type: string
  - name: preset
    uid: 'excel!Excel.Interfaces.ConditionalFormatData#preset:member'
    package: excel!
    fullName: preset
    summary: Returns the preset criteria conditional format. See `Excel.PresetCriteriaConditionalFormat` for more details.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'preset?: Excel.Interfaces.PresetCriteriaConditionalFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.PresetCriteriaConditionalFormatData:interface" />'
  - name: presetOrNullObject
    uid: 'excel!Excel.Interfaces.ConditionalFormatData#presetOrNullObject:member'
    package: excel!
    fullName: presetOrNullObject
    summary: Returns the preset criteria conditional format. See `Excel.PresetCriteriaConditionalFormat` for more details.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'presetOrNullObject?: Excel.Interfaces.PresetCriteriaConditionalFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.PresetCriteriaConditionalFormatData:interface" />'
  - name: priority
    uid: 'excel!Excel.Interfaces.ConditionalFormatData#priority:member'
    package: excel!
    fullName: priority
    summary: >-
      The priority (or index) within the conditional format collection that this conditional format currently exists in.
      Changing this also changes other conditional formats' priorities, to allow for a contiguous priority order. Use a
      negative priority to begin from the back. Priorities greater than the bounds will get and set to the maximum (or
      minimum if negative) priority. Also note that if you change the priority, you have to re-fetch a new copy of the
      object at that new priority location if you want to make further changes to it.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'priority?: number;'
      return:
        type: number
  - name: stopIfTrue
    uid: 'excel!Excel.Interfaces.ConditionalFormatData#stopIfTrue:member'
    package: excel!
    fullName: stopIfTrue
    summary: >-
      If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell.
      Value is `null` on data bars, icon sets, and color scales as there's no concept of `StopIfTrue` for these.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'stopIfTrue?: boolean;'
      return:
        type: boolean
  - name: textComparison
    uid: 'excel!Excel.Interfaces.ConditionalFormatData#textComparison:member'
    package: excel!
    fullName: textComparison
    summary: >-
      Returns the specific text conditional format properties if the current conditional format is a text type. For
      example, to format cells matching the word "Text".
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'textComparison?: Excel.Interfaces.TextConditionalFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.TextConditionalFormatData:interface" />'
  - name: textComparisonOrNullObject
    uid: 'excel!Excel.Interfaces.ConditionalFormatData#textComparisonOrNullObject:member'
    package: excel!
    fullName: textComparisonOrNullObject
    summary: >-
      Returns the specific text conditional format properties if the current conditional format is a text type. For
      example, to format cells matching the word "Text".
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'textComparisonOrNullObject?: Excel.Interfaces.TextConditionalFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.TextConditionalFormatData:interface" />'
  - name: topBottom
    uid: 'excel!Excel.Interfaces.ConditionalFormatData#topBottom:member'
    package: excel!
    fullName: topBottom
    summary: >-
      Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type. For
      example, to format the top 10% or bottom 10 items.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'topBottom?: Excel.Interfaces.TopBottomConditionalFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.TopBottomConditionalFormatData:interface" />'
  - name: topBottomOrNullObject
    uid: 'excel!Excel.Interfaces.ConditionalFormatData#topBottomOrNullObject:member'
    package: excel!
    fullName: topBottomOrNullObject
    summary: >-
      Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type. For
      example, to format the top 10% or bottom 10 items.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'topBottomOrNullObject?: Excel.Interfaces.TopBottomConditionalFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.TopBottomConditionalFormatData:interface" />'
  - name: type
    uid: 'excel!Excel.Interfaces.ConditionalFormatData#type:member'
    package: excel!
    fullName: type
    summary: A type of conditional format. Only one can be set at a time.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        type?: Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" |
        "PresetCriteria" | "ContainsText" | "CellValue";
      return:
        type: >-
          <xref uid="excel!Excel.ConditionalFormatType:enum" /> | "Custom" | "DataBar" | "ColorScale" | "IconSet" |
          "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"