Excel.ColorScaleConditionalFormat class

Represents an IconSet criteria for conditional formatting.

[ API set: ExcelApi 1.6 ]

Extends

Properties

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

criteria

The criteria of the color scale. Midpoint is optional when using a two point color scale.

[ API set: ExcelApi 1.6 ]

threeColorScale

If true the color scale will have three points (minimum, midpoint, maximum), otherwise it will have two (minimum, maximum).

[ API set: ExcelApi 1.6 ]

Methods

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ColorScaleConditionalFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ColorScaleConditionalFormatData) that contains shallow copies of any loaded child properties from the original object.

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

RequestContext

criteria

The criteria of the color scale. Midpoint is optional when using a two point color scale.

[ API set: ExcelApi 1.6 ]

criteria: Excel.ConditionalColorScaleCriteria;

Property Value

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B2:M5");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.colorScale);
    const criteria = {
        minimum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.lowestValue, color: "blue" },
        midpoint: { formula: "50", type: Excel.ConditionalFormatColorCriterionType.percent, color: "yellow" },
        maximum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.highestValue, color: "red" }
    };
    conditionalFormat.colorScale.criteria = criteria;

    await context.sync();
});

threeColorScale

If true the color scale will have three points (minimum, midpoint, maximum), otherwise it will have two (minimum, maximum).

[ API set: ExcelApi 1.6 ]

readonly threeColorScale: boolean;

Property Value

boolean

Method Details

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

load(option?: string | string[]): Excel.ColorScaleConditionalFormat;

Parameters

option
string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Remarks

In addition to this signature, this method has the following signatures:

load(option?: { select?: string; expand?: string; }): Excel.ColorScaleConditionalFormat - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ColorScaleConditionalFormat - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items.

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ColorScaleConditionalFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ColorScaleConditionalFormatData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ColorScaleConditionalFormatData;

Returns