Edit

Share via

Excel.Interfaces.ConditionalFormatData interface

  • Reference
Package:
excel

Warning

This API is now deprecated.

An interface describing the data returned by calling conditionalFormat.toJSON().

Properties

cellValue

Returns the cell value conditional format properties if the current conditional format is a CellValue type.
cellValueOrNullObject

Returns the cell value conditional format properties if the current conditional format is a CellValue type.
colorScale

Returns the color scale conditional format properties if the current conditional format is a ColorScale type.
colorScaleOrNullObject

Returns the color scale conditional format properties if the current conditional format is a ColorScale type.
custom

Returns the custom conditional format properties if the current conditional format is a custom type.
customOrNullObject

Returns the custom conditional format properties if the current conditional format is a custom type.
dataBar

Returns the data bar properties if the current conditional format is a data bar.
dataBarOrNullObject

Returns the data bar properties if the current conditional format is a data bar.
iconSet

Returns the icon set conditional format properties if the current conditional format is an IconSet type.
iconSetOrNullObject

Returns the icon set conditional format properties if the current conditional format is an IconSet type.
id

The priority of the conditional format in the current ConditionalFormatCollection.
preset

Returns the preset criteria conditional format. See Excel.PresetCriteriaConditionalFormat for more details.
presetOrNullObject

Returns the preset criteria conditional format. See Excel.PresetCriteriaConditionalFormat for more details.
priority

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.
stopIfTrue

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.
textComparison

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".
textComparisonOrNullObject

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".
topBottom

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.
topBottomOrNullObject

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.
type

A type of conditional format. Only one can be set at a time.

Property Details

cellValue

Warning

This API is now deprecated.

Returns the cell value conditional format properties if the current conditional format is a CellValue type.

cellValue?: Excel.Interfaces.CellValueConditionalFormatData;

Property Value

Excel.Interfaces.CellValueConditionalFormatData

Remarks

[ API set: ExcelApi 1.6 ]

cellValueOrNullObject

Warning

This API is now deprecated.

Returns the cell value conditional format properties if the current conditional format is a CellValue type.

cellValueOrNullObject?: Excel.Interfaces.CellValueConditionalFormatData;

Property Value

Excel.Interfaces.CellValueConditionalFormatData

Remarks

[ API set: ExcelApi 1.6 ]

colorScale

Warning

This API is now deprecated.

Returns the color scale conditional format properties if the current conditional format is a ColorScale type.

colorScale?: Excel.Interfaces.ColorScaleConditionalFormatData;

Property Value

Excel.Interfaces.ColorScaleConditionalFormatData

Remarks

[ API set: ExcelApi 1.6 ]

colorScaleOrNullObject

Warning

This API is now deprecated.

Returns the color scale conditional format properties if the current conditional format is a ColorScale type.

colorScaleOrNullObject?: Excel.Interfaces.ColorScaleConditionalFormatData;

Property Value

Excel.Interfaces.ColorScaleConditionalFormatData

Remarks

[ API set: ExcelApi 1.6 ]

custom

Warning

This API is now deprecated.

Returns the custom conditional format properties if the current conditional format is a custom type.

custom?: Excel.Interfaces.CustomConditionalFormatData;

Property Value

Excel.Interfaces.CustomConditionalFormatData

Remarks

[ API set: ExcelApi 1.6 ]

customOrNullObject

Warning

This API is now deprecated.

Returns the custom conditional format properties if the current conditional format is a custom type.

customOrNullObject?: Excel.Interfaces.CustomConditionalFormatData;

Property Value

Excel.Interfaces.CustomConditionalFormatData

Remarks

[ API set: ExcelApi 1.6 ]

dataBar

Warning

This API is now deprecated.

Returns the data bar properties if the current conditional format is a data bar.

dataBar?: Excel.Interfaces.DataBarConditionalFormatData;

Property Value

Excel.Interfaces.DataBarConditionalFormatData

Remarks

[ API set: ExcelApi 1.6 ]

dataBarOrNullObject

Warning

This API is now deprecated.

Returns the data bar properties if the current conditional format is a data bar.

dataBarOrNullObject?: Excel.Interfaces.DataBarConditionalFormatData;

Property Value

Excel.Interfaces.DataBarConditionalFormatData

Remarks

[ API set: ExcelApi 1.6 ]

iconSet

Warning

This API is now deprecated.

Returns the icon set conditional format properties if the current conditional format is an IconSet type.

iconSet?: Excel.Interfaces.IconSetConditionalFormatData;

Property Value

Excel.Interfaces.IconSetConditionalFormatData

Remarks

[ API set: ExcelApi 1.6 ]

iconSetOrNullObject

Warning

This API is now deprecated.

Returns the icon set conditional format properties if the current conditional format is an IconSet type.

iconSetOrNullObject?: Excel.Interfaces.IconSetConditionalFormatData;

Property Value

Excel.Interfaces.IconSetConditionalFormatData

Remarks

[ API set: ExcelApi 1.6 ]

id

Warning

This API is now deprecated.

The priority of the conditional format in the current ConditionalFormatCollection.

id?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.6 ]

preset

Warning

This API is now deprecated.

Returns the preset criteria conditional format. See Excel.PresetCriteriaConditionalFormat for more details.

preset?: Excel.Interfaces.PresetCriteriaConditionalFormatData;

Property Value

Excel.Interfaces.PresetCriteriaConditionalFormatData

Remarks

[ API set: ExcelApi 1.6 ]

presetOrNullObject

Warning

This API is now deprecated.

Returns the preset criteria conditional format. See Excel.PresetCriteriaConditionalFormat for more details.

presetOrNullObject?: Excel.Interfaces.PresetCriteriaConditionalFormatData;

Property Value

Excel.Interfaces.PresetCriteriaConditionalFormatData

Remarks

[ API set: ExcelApi 1.6 ]

priority

Warning

This API is now deprecated.

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.

priority?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.6 ]

stopIfTrue

Warning

This API is now deprecated.

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.

stopIfTrue?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.6 ]

textComparison

Warning

This API is now deprecated.

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".

textComparison?: Excel.Interfaces.TextConditionalFormatData;

Property Value

Excel.Interfaces.TextConditionalFormatData

Remarks

[ API set: ExcelApi 1.6 ]

textComparisonOrNullObject

Warning

This API is now deprecated.

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".

textComparisonOrNullObject?: Excel.Interfaces.TextConditionalFormatData;

Property Value

Excel.Interfaces.TextConditionalFormatData

Remarks

[ API set: ExcelApi 1.6 ]

topBottom

Warning

This API is now deprecated.

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.

topBottom?: Excel.Interfaces.TopBottomConditionalFormatData;

Property Value

Excel.Interfaces.TopBottomConditionalFormatData

Remarks

[ API set: ExcelApi 1.6 ]

topBottomOrNullObject

Warning

This API is now deprecated.

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.

topBottomOrNullObject?: Excel.Interfaces.TopBottomConditionalFormatData;

Property Value

Excel.Interfaces.TopBottomConditionalFormatData

Remarks

[ API set: ExcelApi 1.6 ]

type

Warning

This API is now deprecated.

A type of conditional format. Only one can be set at a time.

type?: Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue";

Property Value

Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"

Remarks

[ API set: ExcelApi 1.6 ]