Class GradientCondition

ГрадиентУсловие

Доступ к условиям градиента (цвета) осуществляется через ConditionalFormatRuleApis . Каждое правило условного форматирования может содержать одно условие градиента. Условие градиента определяется тремя точками на числовой шкале (мин, мид и макс), каждая из которых имеет цвет, значение и тип InterpolationType ). Содержимое ячейки сравнивается со значениями на числовой шкале, и цвет, применяемый к ячейке, интерполируется на основе близости содержимого ячейки к точкам мин, мид и макс условия градиента.

// Logs all the information inside gradient conditional format rules on a sheet.
// The below snippet assumes all colors have ColorType.RGB.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
for (let i = 0; i < rules.length; i++) {
  const gradient = rules[i].getGradientCondition();

  const minColor = gradient.getMinColorObject().asRgbColor().asHexString();
  const minType = gradient.getMinType();
  const minValue = gradient.getMinValue();
  const midColor = gradient.getMidColorObject().asRgbColor().asHexString();
  const midType = gradient.getMidType();
  const midValue = gradient.getMidValue();
  const maxColor = gradient.getMaxColorObject().asRgbColor().asHexString();
  const maxType = gradient.getMaxType();
  const maxValue = gradient.getMaxValue();

  Logger.log(`The conditional format gradient information for rule ${i}:
    MinColor ${minColor}, MinType ${minType}, MinValue ${minValue},
    MidColor ${midColor}, MidType ${midType}, MidValue ${midValue},
    MaxColor ${maxColor}, MaxType ${maxType}, MaxValue ${maxValue}`);
}

Методы

Метод Тип возвращаемого значения Краткое описание
get Max Color Object() Color |null Получает цвет, заданный для максимального значения данного градиентного условия.
get Max Type() Interpolation Type |null Получает тип интерполяции для максимального значения данного условия градиента.
get Max Value() String Получает максимальное значение этого градиентного условия.
get Mid Color Object() Color |null Получает цвет, заданный для средней точки этого градиентного условия.
get Mid Type() Interpolation Type |null Получает тип интерполяции для значения средней точки данного градиентного условия.
get Mid Value() String Получает значение середины этого градиентного условия.
get Min Color Object() Color |null Получает цвет, соответствующий минимальному значению данного градиентного условия.
get Min Type() Interpolation Type |null Получает тип интерполяции для минимального значения данного условия градиента.
get Min Value() String Получает минимальное значение этого градиентного условия.

Подробная документация

getMaxColorObject()

Получает цвет, заданный для максимального значения этого градиентного условия. Возвращает null если цвет не был задан.

Возвращаться

Color |null — Цвет, заданный для максимального значения этого условия градиента, или null .


getMaxType()

Получает тип интерполяции для максимального значения этого условия градиента. Возвращает null если тип максимального значения градиента не задан.

Возвращаться

InterpolationType |null — Тип интерполяции для максимального значения этого условия градиента или null .


getMaxValue()

Получает максимальное значение этого градиентного условия. Возвращает пустую строку, если InterpolationType равно MAX или если максимальное значение не задано.

Возвращаться

String — максимальное значение, если оно указано, или пустая строка.


getMidColorObject()

Получает цвет, заданный для средней точки этого градиентного условия. Возвращает null если цвет не был задан.

Возвращаться

Color |null — Цвет, заданный для среднего значения этого градиентного условия, или null .


getMidType()

Получает тип интерполяции для значения середины градиентного условия. Возвращает null если тип середины градиента не задан.

Возвращаться

InterpolationType |null — Тип интерполяции для значения средней точки этого градиентного условия или null .


getMidValue()

Получает среднее значение условия градиента. Возвращает пустую строку, если среднее значение градиента не задано.

Возвращаться

String — значение середины строки или пустая строка.


getMinColorObject()

Получает цвет, заданный для минимального значения этого градиентного условия. Возвращает null если цвет не был задан.

Возвращаться

Color |null — Цвет, заданный для минимального значения этого градиентного условия, или null .


getMinType()

Получает тип интерполяции для минимального значения этого условия градиента. Возвращает null если тип минимального значения градиента не задан.

Возвращаться

InterpolationType |null — Тип интерполяции для минимального значения этого условия градиента или null .


getMinValue()

Получает минимальное значение этого градиентного условия. Возвращает пустую строку, если InterpolationType равно MIN или если минимальное значение не задано.

Возвращаться

String — минимальное значение, если оно указано, или пустая строка.

Устаревшие методы