本頁面由 Cloud Translation API 翻譯而成。

Class ConditionalFormatRuleBuilder

條件式格式規則的建構工具。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they contain a number between 1 and 10.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenNumberBetween(1, 10)
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

方法

方法	傳回類型	簡短說明
`build()`	`ConditionalFormatRule`	根據套用至建構工具的設定，建構條件式格式規則。
`copy()`	`ConditionalFormatRuleBuilder`	傳回含有此規則設定的規則建構工具預設值。
`getBooleanCondition()`	`BooleanCondition`	如果這項規則使用布林值條件條件，則會擷取規則的 `BooleanCondition` 資訊。
`getGradientCondition()`	`GradientCondition`	如果此規則使用漸層條件條件，則會擷取規則的 `GradientCondition` 資訊。
`getRanges()`	`Range[]`	擷取要套用此條件式格式規則的範圍。
`setBackground(color)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則的格式背景顏色。
`setBackgroundObject(color)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則的格式背景顏色。
`setBold(bold)`	`ConditionalFormatRuleBuilder`	為條件式格式規則的格式設定文字粗體。
`setFontColor(color)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則的格式字型顏色。
`setFontColorObject(color)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則的格式字型顏色。
`setGradientMaxpoint(color)`	`ConditionalFormatRuleBuilder`	清除條件式格式規則的漸層 maxpoint 值，改為使用規則範圍中的最大值。
`setGradientMaxpointObject(color)`	`ConditionalFormatRuleBuilder`	清除條件式格式規則的漸層 maxpoint 值，改為使用規則範圍中的最大值。
`setGradientMaxpointObjectWithValue(color, type, value)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則的漸層 maxpoint 欄位。
`setGradientMaxpointWithValue(color, type, value)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則的漸層 maxpoint 欄位。
`setGradientMidpointObjectWithValue(color, type, value)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則的漸層中點欄位。
`setGradientMidpointWithValue(color, type, value)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則的漸層中點欄位。
`setGradientMinpoint(color)`	`ConditionalFormatRuleBuilder`	清除條件式格式規則的漸層 minpoint 值，改為使用規則範圍中的最小值。
`setGradientMinpointObject(color)`	`ConditionalFormatRuleBuilder`	清除條件式格式規則的漸層 minpoint 值，改為使用規則範圍中的最小值。
`setGradientMinpointObjectWithValue(color, type, value)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則的漸層 minpoint 欄位。
`setGradientMinpointWithValue(color, type, value)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則的漸層 minpoint 欄位。
`setItalic(italic)`	`ConditionalFormatRuleBuilder`	為條件式格式規則設定斜體文字格式。
`setRanges(ranges)`	`ConditionalFormatRuleBuilder`	設定要套用此條件式格式規則的一或多個範圍。
`setStrikethrough(strikethrough)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則的格式為文字刪除線。
`setUnderline(underline)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則的文字底線格式。
`whenCellEmpty()`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，在儲存格為空白時觸發。
`whenCellNotEmpty()`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，在儲存格非空白時觸發。
`whenDateAfter(date)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，在日期大於指定值時觸發。
`whenDateAfter(date)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，在日期大於指定相對日期時觸發。
`whenDateBefore(date)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，在日期早於指定日期時觸發。
`whenDateBefore(date)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，在日期早於指定相對日期時觸發。
`whenDateEqualTo(date)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，在日期等於指定日期時觸發。
`whenDateEqualTo(date)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，在日期等於指定相對日期時觸發。
`whenFormulaSatisfied(formula)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，在指定公式評估為 `true` 時觸發。
`whenNumberBetween(start, end)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，當數字介於兩個指定值之間，或等於其中一個值時觸發。
`whenNumberEqualTo(number)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，在數字等於指定值時觸發。
`whenNumberGreaterThan(number)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，在數字大於指定值時觸發。
`whenNumberGreaterThanOrEqualTo(number)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，在數字大於或等於指定值時觸發。
`whenNumberLessThan(number)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，在數字小於指定值時觸發。
`whenNumberLessThanOrEqualTo(number)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，在數字小於或等於指定值時觸發。
`whenNumberNotBetween(start, end)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，在數字不在兩個指定值之間，且不等於兩個指定值時觸發。
`whenNumberNotEqualTo(number)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，在數字不等於指定值時觸發。
`whenTextContains(text)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，在輸入內容包含指定值時觸發。
`whenTextDoesNotContain(text)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，在輸入內容不含指定值時觸發。
`whenTextEndsWith(text)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，在輸入內容結尾為指定值時觸發。
`whenTextEqualTo(text)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，在輸入值等於指定值時觸發。
`whenTextStartsWith(text)`	`ConditionalFormatRuleBuilder`	設定條件式格式規則，當輸入內容開頭為指定值時觸發。
`withCriteria(criteria, args)`	`ConditionalFormatRuleBuilder`	將條件式格式規則設為由 `BooleanCriteria` 值定義的條件，通常是從現有規則的 `criteria` 和 `arguments` 取得。

內容詳盡的說明文件

`build()`

根據套用至建構工具的設定，建構條件式格式規則。

回攻員

ConditionalFormatRule：代表條件式格式規則

`copy()`

傳回含有此規則設定的規則建構工具預設值。

回攻員

ConditionalFormatRuleBuilder：根據此規則的設定建立

`getBooleanCondition()`

如果這項規則使用布林值條件，就會擷取規則的 BooleanCondition 資訊。否則會傳回 null。

// Log the boolean criteria type of the first conditional format rules of a
// sheet.
const rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
const booleanCondition = rule.getBooleanCondition();
if (booleanCondition != null) {
  Logger.log(booleanCondition.getCriteriaType());
}

回攻員

BooleanCondition：布林值條件物件，如果規則未使用布林值條件，則為 null。

`getGradientCondition()`

如果此規則使用漸層條件條件，則會擷取規則的 GradientCondition 資訊。否則會傳回 null。

// Log the gradient minimum color of the first conditional format rule of a
// sheet.
const rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
const gradientCondition = rule.getGradientCondition();
if (gradientCondition != null) {
  // Assume the color has ColorType.RGB.
  Logger.log(gradientCondition.getMinColorObject().asRgbColor().asHexString());
}

回攻員

GradientCondition：漸層條件物件，如果規則未使用漸層條件，則為 null。

`getRanges()`

擷取要套用此條件式格式規則的範圍。

// Log each range of the first conditional format rule of a sheet.
const rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
const ranges = rule.getRanges();
for (let i = 0; i < ranges.length; i++) {
  Logger.log(ranges[i].getA1Notation());
}

回攻員

Range[]：套用此條件式格式規則的範圍。

`setBackground(color)`

設定條件式格式規則格式的背景顏色。傳入 null 會從規則中移除背景顏色格式設定。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// set their background color to red if the cell has text equal to "hello".

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenTextEqualTo('hello')
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`color`	`String`	所需顏色或 `null` 來清除。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`setBackgroundObject(color)`

設定條件式格式規則格式的背景顏色。傳入 null 會從規則中移除背景顏色格式設定。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// set their background color to theme background color if the cell has text
// equal to "hello".

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const color = SpreadsheetApp.newColor()
                  .setThemeColor(SpreadsheetApp.ThemeColorType.BACKGROUND)
                  .build();
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenTextEqualTo('hello')
                 .setBackground(color)
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`color`	`Color`	所需的顏色物件或 `null` 以清除。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具。

`setBold(bold)`

為條件式格式規則的格式設定文字粗體。如果 bold 為 true，則在符合條件時會將文字加粗；如果為 false，則在符合條件時會移除所有現有的加粗字體。傳入 null 會從規則中移除粗體格式設定。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn their text bold if the cell has text equal to "hello".

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenTextEqualTo('hello')
                 .setBold(true)
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`bold`	`Boolean`	如果符合格式條件，是否應將文字加粗；`null` 會移除這項設定。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`setFontColor(color)`

設定條件式格式規則格式的字型顏色。傳入 null 會從規則中移除字型顏色格式設定。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// set their font color to red if the cell has text equal to "hello".

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenTextEqualTo('hello')
                 .setFontColor('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`color`	`String`	所需顏色或 `null` 來清除。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`setFontColorObject(color)`

設定條件式格式規則格式的字型顏色。傳入 null 會從規則中移除字型顏色格式設定。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// set their font color to theme text color if the cell has text equal to
// "hello".

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const color = SpreadsheetApp.newColor()
                  .setThemeColor(SpreadsheetApp.ThemeColorType.TEXT)
                  .build();
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenTextEqualTo('hello')
                 .setFontColor(color)
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`color`	`Color`	所需的顏色物件或 `null` 以清除。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具。

`setGradientMaxpoint(color)`

清除條件式格式規則的漸層 maxpoint 值，改為使用規則範圍中的最大值。並將漸層的 maxpoint 顏色設為輸入顏色。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// set their background color somewhere between white and red, based on their
// values in comparison to the ranges minimum and maximum values.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .setGradientMaxpoint('#FF0000')
                 .setGradientMinpoint('#FFFFFF')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`color`	`String`	要設定的上限點顏色。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`setGradientMaxpointObject(color)`

清除條件式格式規則的漸層 maxpoint 值，改為使用規則範圍中的最大值。並將漸層的 maxpoint 顏色設為輸入顏色。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// set their background color somewhere between theme text and background
// colors, based on their values in comparison to the ranges minimum and maximum
// values.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const textColor = SpreadsheetApp.newColor()
                      .setThemeColor(SpreadsheetApp.ThemeColorType.TEXT)
                      .build();
const backgroundColor =
    SpreadsheetApp.newColor()
        .setThemeColor(SpreadsheetApp.ThemeColorType.BACKGROUND)
        .build();
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .setGradientMaxpoint(textColor)
                 .setGradientMinpoint(backgroundColor)
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`color`	`Color`	要設定的上限點顏色物件。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具。

`setGradientMaxpointObjectWithValue(color, type, value)`

設定條件式格式規則的漸層最大點數欄位。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// set their background color somewhere from theme accent 1, accent 2 to accent
// 3 colors, based on their values in comparison to the values 0, 50, and 100.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const color1 = SpreadsheetApp.newColor()
                   .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
                   .build();
const color2 = SpreadsheetApp.newColor()
                   .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
                   .build();
const color3 = SpreadsheetApp.newColor()
                   .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
                   .build();
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .setGradientMaxpointWithValue(
                     color1,
                     SpreadsheetApp.InterpolationType.NUMBER,
                     '100',
                     )
                 .setGradientMidpointWithValue(
                     color2,
                     SpreadsheetApp.InterpolationType.NUMBER,
                     '50',
                     )
                 .setGradientMinpointWithValue(
                     color3,
                     SpreadsheetApp.InterpolationType.NUMBER,
                     '0',
                     )
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`color`	`Color`	要設定的上限點顏色。
`type`	`InterpolationType`	要設定的 maxpoint 插補類型。
`value`	`String`	要設定的 maxpoint 值。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具。

`setGradientMaxpointWithValue(color, type, value)`

設定條件式格式規則的漸層最大點數欄位。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// set their background color somewhere from red green to blue, based on their
// values in comparison to the values 0, 50, and 100.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .setGradientMaxpointWithValue(
                     '#0000FF',
                     SpreadsheetApp.InterpolationType.NUMBER,
                     '100',
                     )
                 .setGradientMidpointWithValue(
                     '#00FF00',
                     SpreadsheetApp.InterpolationType.NUMBER,
                     '50',
                     )
                 .setGradientMinpointWithValue(
                     '#FF0000',
                     SpreadsheetApp.InterpolationType.NUMBER,
                     '0',
                     )
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`color`	`String`	要設定的上限點顏色。
`type`	`InterpolationType`	要設定的 maxpoint 插補類型。
`value`	`String`	要設定的 maxpoint 值。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`setGradientMidpointObjectWithValue(color, type, value)`

設定條件式格式規則的漸層中點欄位。如果插補類型為 null，則會清除所有中點欄位。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// set their background color somewhere from theme accent 1 to accent 2 to
// accent 3 colors, based on their values in comparison to the values 0, 50, and
// 100.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const color1 = SpreadsheetApp.newColor()
                   .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
                   .build();
const color2 = SpreadsheetApp.newColor()
                   .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
                   .build();
const color3 = SpreadsheetApp.newColor()
                   .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
                   .build();
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .setGradientMaxpointWithValue(
                     color1,
                     SpreadsheetApp.InterpolationType.NUMBER,
                     '100',
                     )
                 .setGradientMidpointWithValue(
                     color2,
                     SpreadsheetApp.InterpolationType.NUMBER,
                     '50',
                     )
                 .setGradientMinpointWithValue(
                     color3,
                     SpreadsheetApp.InterpolationType.NUMBER,
                     '0',
                     )
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`color`	`Color`	要設定的中點顏色。
`type`	`InterpolationType`	要設定的中點插補類型，或 `null` 用於清除。
`value`	`String`	要設定的中間值。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具。

`setGradientMidpointWithValue(color, type, value)`

設定條件式格式規則的漸層中點欄位。如果插補類型為 null，則會清除所有中點欄位。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// set their background color somewhere from red green to blue, based on their
// values in comparison to the values 0, 50, and 100.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .setGradientMaxpointWithValue(
                     '#0000FF',
                     SpreadsheetApp.InterpolationType.NUMBER,
                     '100',
                     )
                 .setGradientMidpointWithValue(
                     '#00FF00',
                     SpreadsheetApp.InterpolationType.NUMBER,
                     '50',
                     )
                 .setGradientMinpointWithValue(
                     '#FF0000',
                     SpreadsheetApp.InterpolationType.NUMBER,
                     '0',
                     )
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`color`	`String`	要設定的中點顏色。
`type`	`InterpolationType`	要設定的中點插補類型，或 `null` 用於清除。
`value`	`String`	要設定的中間值。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`setGradientMinpoint(color)`

清除條件式格式規則的漸層 minpoint 值，改為使用規則範圍中的最小值。並將漸層的 minpoint 顏色設為輸入顏色。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// set their background color somewhere between white and red, based on their
// values in comparison to the ranges minimum and maximum values.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .setGradientMaxpoint('#FF0000')
                 .setGradientMinpoint('#FFFFFF')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`color`	`String`	要設定的下限點顏色。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`setGradientMinpointObject(color)`

清除條件式格式規則的漸層 minpoint 值，改為使用規則範圍中的最小值。並將漸層的 minpoint 顏色設為輸入顏色。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// set their background color somewhere between theme text and background
// colors, based on their values in comparison to the ranges minimum and maximum
// values.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const textColor = SpreadsheetApp.newColor()
                      .setThemeColor(SpreadsheetApp.ThemeColorType.TEXT)
                      .build();
const backgroundColor =
    SpreadsheetApp.newColor()
        .setThemeColor(SpreadsheetApp.ThemeColorType.BACKGROUND)
        .build();
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .setGradientMaxpoint(textColor)
                 .setGradientMinpoint(backgroundColor)
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`color`	`Color`	要設定的 minpoint 顏色物件。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具。

`setGradientMinpointObjectWithValue(color, type, value)`

設定條件式格式規則的漸層最小點欄位。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// set their background color somewhere from theme accent 1 to accent 2 to
// accent 3 colors, based on their values in comparison to the values 0, 50, and
// 100.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const color1 = SpreadsheetApp.newColor()
                   .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
                   .build();
const color2 = SpreadsheetApp.newColor()
                   .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
                   .build();
const color3 = SpreadsheetApp.newColor()
                   .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
                   .build();
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .setGradientMaxpointWithValue(
                     color1,
                     SpreadsheetApp.InterpolationType.NUMBER,
                     '100',
                     )
                 .setGradientMidpointWithValue(
                     color2,
                     SpreadsheetApp.InterpolationType.NUMBER,
                     '50',
                     )
                 .setGradientMinpointWithValue(
                     color3,
                     SpreadsheetApp.InterpolationType.NUMBER,
                     '0',
                     )
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`color`	`Color`	要設定的下限點顏色。
`type`	`InterpolationType`	要設定的 minpoint 插補類型。
`value`	`String`	要設定的 minpoint 值。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具。

`setGradientMinpointWithValue(color, type, value)`

設定條件式格式規則的漸層最小點欄位。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// set their background color somewhere from red to green to blue, based on
// their values in comparison to the values 0, 50, and 100.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .setGradientMaxpointWithValue(
                     '#0000FF',
                     SpreadsheetApp.InterpolationType.NUMBER,
                     '100',
                     )
                 .setGradientMidpointWithValue(
                     '#00FF00',
                     SpreadsheetApp.InterpolationType.NUMBER,
                     '50',
                     )
                 .setGradientMinpointWithValue(
                     '#FF0000',
                     SpreadsheetApp.InterpolationType.NUMBER,
                     '0',
                     )
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`color`	`String`	要設定的下限點顏色。
`type`	`InterpolationType`	要設定的 minpoint 插補類型。
`value`	`String`	要設定的 minpoint 值。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`setItalic(italic)`

為條件式格式規則設定斜體文字格式。如果 italic 是 true，則在符合條件時，規則會將文字斜體；如果是 false，則在符合條件時，規則會移除任何現有的斜體字。傳入 null 會從規則中移除斜體格式設定。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn their text italic if the cell has text equal to "hello".

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenTextEqualTo('hello')
                 .setItalic(true)
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`italic`	`Boolean`	是否在符合格式條件時將文字斜體；`null` 會移除這項設定。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`setRanges(ranges)`

設定要套用此條件式格式規則的一或多個範圍。這項作業會取代任何現有的範圍。設定空陣列會清除所有現有範圍。規則至少須有一個範圍。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3
// and range D4:F6 to turn red if they contain a number between 1 and 10.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeOne = sheet.getRange('A1:B3');
const rangeTwo = sheet.getRange('D4:F6');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenNumberBetween(1, 10)
                 .setBackground('#FF0000')
                 .setRanges([rangeOne, rangeTwo])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`ranges`	`Range[]`	要套用此條件式格式規則的範圍。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`setStrikethrough(strikethrough)`

為條件式格式規則設定文字刪除線格式。如果 strikethrough 是 true，則在符合條件時，規則會在文字上加上刪除線；如果是 false，則在符合條件時，規則會移除任何現有的刪除線格式。傳入 null 會從規則中移除刪除線格式設定。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// strikethrough their text if the cell has text equal to "hello".

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenTextEqualTo('hello')
                 .setStrikethrough(true)
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`strikethrough`	`Boolean`	是否在符合格式條件時將文字劃掉；`null` 會移除這項設定。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`setUnderline(underline)`

設定條件式格式規則的格式底線文字。如果 underline 為 true，則在符合條件時會為文字加上底線；如果為 false，則在符合條件時會移除所有現有的底線。傳入 null 會從規則中移除底線格式設定。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// underline their text if the cell has text equal to "hello".

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenTextEqualTo('hello')
                 .setUnderline(true)
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`underline`	`Boolean`	是否在符合格式條件時為文字加上底線；`null` 會移除這項設定。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenCellEmpty()`

設定條件式格式規則，在儲存格為空白時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they are empty.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenCellEmpty()
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenCellNotEmpty()`

設定條件式格式規則，在儲存格不為空白時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they are not empty.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenCellNotEmpty()
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenDateAfter(date)`

設定條件式格式規則，在日期大於指定值時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they contain a date after 11/4/1993.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenDateAfter(new Date('11/4/1993'))
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`date`	`Date`	最新日期。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenDateAfter(date)`

設定條件式格式規則，在日期大於指定相對日期時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they contain a date after today.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenDateAfter(SpreadsheetApp.RelativeDate.TODAY)
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`date`	`RelativeDate`	相對於所選日期類型的最新日期。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenDateBefore(date)`

設定條件式格式規則，在日期早於指定日期時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they contain a date before 11/4/1993.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenDateBefore(new Date('11/4/1993'))
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`date`	`Date`	最早不可接受的日期。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenDateBefore(date)`

設定條件式格式規則，在日期早於指定相對日期時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they contain a date before today.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenDateBefore(SpreadsheetApp.RelativeDate.TODAY)
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`date`	`RelativeDate`	相對於所選日期類型的最新日期。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenDateEqualTo(date)`

設定條件式格式規則，在日期等於指定日期時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they contain the date 11/4/1993.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenDateEqualTo(new Date('11/4/1993'))
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`date`	`Date`	唯一可接受的日期。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenDateEqualTo(date)`

設定條件式格式規則，在日期等於指定相對日期時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they contain todays date.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenDateEqualTo(SpreadsheetApp.RelativeDate.TODAY)
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`date`	`RelativeDate`	相對於所選日期類型的最新日期。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenFormulaSatisfied(formula)`

設定條件式格式規則，在指定公式評估為 true 時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they satisfy the condition "=EQ(B4, C3)".

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenFormulaSatisfied('=EQ(B4, C3)')
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`formula`	`String`	如果輸入內容有效，這個自訂公式會評估為 `true`。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenNumberBetween(start, end)`

設定條件式格式規則，當數字介於兩個指定值之間，或為其中一個值時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they contain a number between 1 and 10.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenNumberBetween(1, 10)
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`start`	`Number`	可接受的最低值。
`end`	`Number`	可接受的最高值。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenNumberEqualTo(number)`

設定條件式格式規則，在數字等於指定值時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they contain the number 10.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenNumberEqualTo(10)
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`number`	`Number`	唯一可接受的值。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenNumberGreaterThan(number)`

設定條件式格式規則，在數字大於指定值時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they contain a number greater than 10.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenNumberGreaterThan(10)
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`number`	`Number`	最高不接受值。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenNumberGreaterThanOrEqualTo(number)`

設定條件式格式規則，在數字大於或等於指定值時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they contain a number greater than or equal to 10.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenNumberGreaterThanOrEqualTo(10)
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`number`	`Number`	可接受的最低值。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenNumberLessThan(number)`

設定條件式格式規則，在數字小於指定值時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they contain a number less than 10.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenNumberLessThan(10)
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`number`	`Number`	可接受的最低值。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenNumberLessThanOrEqualTo(number)`

設定條件式格式規則，在數字小於或等於指定值時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they contain a number less than or equal to 10.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenNumberLessThanOrEqualTo(10)
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`number`	`Number`	可接受的最高值。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenNumberNotBetween(start, end)`

設定條件式格式規則，在數字不在兩個指定值之間，且不等於兩個指定值時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they contain a number not between 1 and 10.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenNumberNotBetween(1, 10)
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`start`	`Number`	可接受的最低值。
`end`	`Number`	最高不接受值。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenNumberNotEqualTo(number)`

設定條件式格式規則，在數字不等於指定值時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they don't contain the number 10.

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenNumberNotEqualTo(10)
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`number`	`Number`	唯一不接受的值。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenTextContains(text)`

設定條件式格式規則，在輸入內容包含指定值時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they contain the text "hello".

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenTextContains('hello')
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`text`	`String`	輸入內容必須包含的值。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenTextDoesNotContain(text)`

設定條件式格式規則，在輸入內容不含指定值時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they don't contain the text "hello".

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenTextDoesNotContain('hello')
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`text`	`String`	輸入內容不得包含的值。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenTextEndsWith(text)`

設定條件式格式規則，在輸入內容結尾為指定值時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they end with the text "hello".

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenTextEndsWith('hello')
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`text`	`String`	與字串結尾進行比較的文字。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenTextEqualTo(text)`

設定條件式格式規則，在輸入值等於指定值時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they have text equal to "hello".

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenTextEqualTo('hello')
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`text`	`String`	唯一可接受的值。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`whenTextStartsWith(text)`

設定條件式格式規則，在輸入內容開頭為指定值時觸發。

// Adds a conditional format rule to a sheet that causes cells in range A1:B3 to
// turn red if they start with the text "hello".

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenTextStartsWith('hello')
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`text`	`String`	與字串開頭比對的文字。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具

`withCriteria(criteria, args)`

將條件式格式規則設為由 BooleanCriteria 值定義的條件，通常是從現有規則的 criteria 和 arguments 取得。

// Adds a new conditional format rule that is a copy of the first active
// conditional format rule, except it instead sets its cells to have a black
// background color.

const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
const booleanCondition = rules[0].getBooleanCondition();
if (booleanCondition != null) {
  const rule = SpreadsheetApp.newConditionalFormatRule()
                   .withCriteria(
                       booleanCondition.getCriteriaType(),
                       booleanCondition.getCriteriaValues(),
                       )
                   .setBackground('#000000')
                   .setRanges(rules[0].getRanges())
                   .build();
  rules.push(rule);
}
sheet.setConditionalFormatRules(rules);

參數

名稱	類型	說明
`criteria`	`BooleanCriteria`	條件式格式條件的類型。
`args`	`Object[]`	適合條件類型的引數陣列；引數數量和類型與上述對應的 `when...()` 方法相符。

回攻員

ConditionalFormatRuleBuilder：用於鏈結的建構工具