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条件付き書式ルールのグラデーションの最大ポイント値を消去し、代わりにルールの範囲内の最大値を使用します。
setGradientMaxpointObject(color)ConditionalFormatRuleBuilder条件付き書式ルールのグラデーションの最大ポイント値を消去し、代わりにルールの範囲内の最大値を使用します。
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条件付き書式ルールのグラデーションの最小ポイント値を消去し、代わりにルールの範囲の最小値を使用します。
setGradientMinpointObject(color)ConditionalFormatRuleBuilder条件付き書式ルールのグラデーションの最小ポイント値を消去し、代わりにルールの範囲の最小値を使用します。
setGradientMinpointObjectWithValue(color, type, value)ConditionalFormatRuleBuilder条件付き書式設定ルールのグラデーションの minpoint フィールドを設定します。
setGradientMinpointWithValue(color, type, value)ConditionalFormatRuleBuilder条件付き書式設定ルールのグラデーションの minpoint フィールドを設定します。
setItalic(italic)ConditionalFormatRuleBuilder条件付き書式設定ルールの書式にテキストの斜体設定を適用します。
setRanges(ranges)ConditionalFormatRuleBuilderこの条件付き書式ルールが適用される範囲を 1 つ以上設定します。
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指定した 2 つの値の範囲内にある数値またはそのいずれかの値に一致したときに、条件付き書式ルールがトリガーされるように設定します。
whenNumberEqualTo(number)ConditionalFormatRuleBuilder数値が指定された値と等しい場合にトリガーされるように、条件付き書式設定ルールを設定します。
whenNumberGreaterThan(number)ConditionalFormatRuleBuilder数値が指定された値より大きい場合にトリガーされるように、条件付き書式ルールを設定します。
whenNumberGreaterThanOrEqualTo(number)ConditionalFormatRuleBuilder数値が指定された値以上の場合にトリガーされる条件付き書式ルールを設定します。
whenNumberLessThan(number)ConditionalFormatRuleBuilder数値が指定された値未満の場合にトリガーされる条件付き書式設定ルールを設定します。
whenNumberLessThanOrEqualTo(number)ConditionalFormatRuleBuilder指定した値以下の数値がトリガーされるように条件付き書式設定ルールを設定します。
whenNumberNotBetween(start, end)ConditionalFormatRuleBuilder指定した 2 つの値の範囲内でも、どちらの値でもない数値がトリガーされるように、条件付き書式ルールを設定します。
whenNumberNotEqualTo(number)ConditionalFormatRuleBuilder数値が指定された値と等しくない場合にトリガーされる条件付き書式ルールを設定します。
whenTextContains(text)ConditionalFormatRuleBuilder入力に指定した値が含まれている場合にトリガーされる条件付き書式ルールを設定します。
whenTextDoesNotContain(text)ConditionalFormatRuleBuilder入力に指定された値が含まれていない場合にトリガーされる条件付き書式ルールを設定します。
whenTextEndsWith(text)ConditionalFormatRuleBuilder入力が指定された値で終わるときにトリガーされる条件付き書式ルールを設定します。
whenTextEqualTo(text)ConditionalFormatRuleBuilder入力が指定された値と等しい場合にトリガーされるように、条件付き書式ルールを設定します。
whenTextStartsWith(text)ConditionalFormatRuleBuilder入力が指定された値で始まるときにトリガーされる条件付き書式ルールを設定します。
withCriteria(criteria, args)ConditionalFormatRuleBuilder条件付き書式ルールを、BooleanCriteria 値で定義された条件に設定します。通常は、既存のルールの criteriaarguments から取得します。

詳細なドキュメント

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);

パラメータ

名前説明
colorString目的の色、または消去する場合は 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);

パラメータ

名前説明
colorColor目的のカラー オブジェクト、または消去する null

戻る

ConditionalFormatRuleBuilder - チェーン用のビルダー。


setBold(bold)

条件付き書式設定ルールの書式にテキストの太字を設定します。boldtrue の場合、条件が満たされるとルールによってテキストが太字になります。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);

パラメータ

名前説明
boldBoolean書式条件が満たされた場合にテキストを太字にするかどうか。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);

パラメータ

名前説明
colorString目的の色、または消去する場合は 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);

パラメータ

名前説明
colorColor目的のカラー オブジェクト、または消去する 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);

パラメータ

名前説明
colorString設定する最大値の色。

戻る

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);

パラメータ

名前説明
colorColor設定する最大値の色オブジェクト。

戻る

ConditionalFormatRuleBuilder - チェーン用のビルダー。


setGradientMaxpointObjectWithValue(color, type, value)

条件付き書式ルールのグラデーションの maxpoint フィールドを設定します。

// 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);

パラメータ

名前説明
colorColor設定する最大値の色。
typeInterpolationType設定する最大ポイントの補間タイプ。
valueString設定する maxpoint 値。

戻る

ConditionalFormatRuleBuilder - チェーン用のビルダー。


setGradientMaxpointWithValue(color, type, value)

条件付き書式ルールのグラデーションの maxpoint フィールドを設定します。

// 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);

パラメータ

名前説明
colorString設定する最大値の色。
typeInterpolationType設定する最大ポイントの補間タイプ。
valueString設定する 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);

パラメータ

名前説明
colorColor設定する中央値の色。
typeInterpolationType設定する中間点補間タイプ、またはクリアする null
valueString設定する中間値。

戻る

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);

パラメータ

名前説明
colorString設定する中央値の色。
typeInterpolationType設定する中間点補間タイプ、またはクリアする null
valueString設定する中間値。

戻る

ConditionalFormatRuleBuilder - チェーン用のビルダー


setGradientMinpoint(color)

条件付き書式ルールのグラデーションの最小ポイント値を消去し、代わりにルールの範囲の最小値を使用します。また、グラデーションの最小ポイントの色を入力色に設定します。

// 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);

パラメータ

名前説明
colorString設定する最小値の色。

戻る

ConditionalFormatRuleBuilder - チェーン用のビルダー


setGradientMinpointObject(color)

条件付き書式ルールのグラデーションの最小ポイント値を消去し、代わりにルールの範囲の最小値を使用します。また、グラデーションの最小ポイントの色を入力色に設定します。

// 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);

パラメータ

名前説明
colorColor設定する最小値の色オブジェクト。

戻る

ConditionalFormatRuleBuilder - チェーン用のビルダー。


setGradientMinpointObjectWithValue(color, type, value)

条件付き書式設定ルールのグラデーションの minpoint フィールドを設定します。

// 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);

パラメータ

名前説明
colorColor設定する最小値の色。
typeInterpolationType設定する最小ポイント補間タイプ。
valueString設定する minpoint 値。

戻る

ConditionalFormatRuleBuilder - チェーン用のビルダー。


setGradientMinpointWithValue(color, type, value)

条件付き書式設定ルールのグラデーションの minpoint フィールドを設定します。

// 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);

パラメータ

名前説明
colorString設定する最小値の色。
typeInterpolationType設定する最小ポイント補間タイプ。
valueString設定する minpoint 値。

戻る

ConditionalFormatRuleBuilder - チェーン用のビルダー


setItalic(italic)

条件付き書式設定ルールの書式にテキストの斜体設定を適用します。italictrue の場合、条件が満たされるとルールによってテキストが斜体になります。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);

パラメータ

名前説明
italicBoolean書式条件が満たされた場合にテキストを斜体にするかどうか。null は、この設定を削除します。

戻る

ConditionalFormatRuleBuilder - チェーン用のビルダー


setRanges(ranges)

この条件付き書式ルールが適用される範囲を 1 つ以上設定します。このオペレーションにより、既存の範囲が置き換えられます。空の配列を設定すると、既存の範囲がすべて消去されます。ルールには少なくとも 1 つの範囲が必要です。

// 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);

パラメータ

名前説明
rangesRange[]この条件付き書式ルールが適用される範囲。

戻る

ConditionalFormatRuleBuilder - チェーン用のビルダー


setStrikethrough(strikethrough)

条件付き書式設定ルールの書式にテキストの取り消し線を設定します。strikethroughtrue の場合、条件が満たされると、ルールによってテキストに取り消し線が引かれます。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);

パラメータ

名前説明
strikethroughBoolean書式条件が満たされた場合にテキストを取り消し線を引くかどうか。null は、この設定を削除します。

戻る

ConditionalFormatRuleBuilder - チェーン用のビルダー


setUnderline(underline)

条件付き書式設定ルールの書式にテキストの下線を設定します。underlinetrue の場合、条件が満たされるとテキストの下線が引かれます。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);

パラメータ

名前説明
underlineBoolean書式条件が満たされた場合にテキストを下線を引くかどうか。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);

パラメータ

名前説明
dateDate最新の日付。

戻る

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);

パラメータ

名前説明
dateRelativeDate選択した日付のタイプに関連する最新の日付。

戻る

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);

パラメータ

名前説明
dateDate最も早い不承認日。

戻る

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);

パラメータ

名前説明
dateRelativeDate選択した日付のタイプに関連する最新の日付。

戻る

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);

パラメータ

名前説明
dateDate唯一許容される日付。

戻る

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);

パラメータ

名前説明
dateRelativeDate選択した日付のタイプに関連する最新の日付。

戻る

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);

パラメータ

名前説明
formulaString入力が有効な場合、true と評価されるカスタム数式。

戻る

ConditionalFormatRuleBuilder - チェーン用のビルダー


whenNumberBetween(start, end)

指定した 2 つの値の範囲内にある数値またはそのいずれかの値に一致したときに、条件付き書式ルールがトリガーされるように設定します。

// 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);

パラメータ

名前説明
startNumber許容される最小値。
endNumber許容される最大値。

戻る

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);

パラメータ

名前説明
numberNumber許容される唯一の値。

戻る

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);

パラメータ

名前説明
numberNumber許容できない最大値。

戻る

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);

パラメータ

名前説明
numberNumber許容される最小値。

戻る

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);

パラメータ

名前説明
numberNumber許容できない最小値。

戻る

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);

パラメータ

名前説明
numberNumber許容される最大値。

戻る

ConditionalFormatRuleBuilder - チェーン用のビルダー


whenNumberNotBetween(start, end)

指定した 2 つの値の範囲内でも、2 つの値のいずれでもない数値がトリガーされるように、条件付き書式ルールを設定します。

// 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);

パラメータ

名前説明
startNumber許容できない最小値。
endNumber許容できない最大値。

戻る

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);

パラメータ

名前説明
numberNumber使用できない唯一の値。

戻る

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);

パラメータ

名前説明
textString入力に含める必要がある値。

戻る

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);

パラメータ

名前説明
textString入力に含めることができない値。

戻る

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);

パラメータ

名前説明
textString文字列の末尾と比較するテキスト。

戻る

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);

パラメータ

名前説明
textString許容される唯一の値。

戻る

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);

パラメータ

名前説明
textString文字列の先頭と比較するテキスト。

戻る

ConditionalFormatRuleBuilder - チェーン用のビルダー


withCriteria(criteria, args)

条件付き書式ルールを、BooleanCriteria 値で定義された条件に設定します。通常、既存のルールの criteriaarguments から取得します。

// 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);

パラメータ

名前説明
criteriaBooleanCriteria条件付き書式の条件のタイプ。
argsObject[]条件のタイプに適した引数の配列。引数の数と型は、上記の対応する when...() メソッドと一致します。

戻る

ConditionalFormatRuleBuilder - チェーン用のビルダー