Class GradientCondition

GradientCondition

Acesse as condições de gradiente (cor) em ConditionalFormatRuleApis. Cada regra de formatação condicional pode conter uma única condição de gradiente. Uma condição de gradiente é definida por três pontos ao longo de uma escala numérica (mínima, média e máxima), cada uma com uma cor, um valor e um InterpolationType. O conteúdo de uma célula é comparado aos valores na escala numérica, e a cor aplicada à célula é interpolada com base na proximidade do conteúdo da célula aos pontos mínimo, médio e máximo da condição de gradiente.

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

Métodos

Método	Tipo de retorno	Breve descrição
getMaxColorObject()	Color	Recebe a cor definida para o valor máximo dessa condição de gradiente.
getMaxType()	InterpolationType	Recebe o tipo de interpolação para o valor máximo dessa condição de gradiente.
getMaxValue()	String	Retorna o valor máximo dessa condição de gradiente.
getMidColorObject()	Color	Extrai a cor definida para o valor do ponto médio dessa condição de gradiente.
getMidType()	InterpolationType	Recebe o tipo de interpolação para o valor do ponto médio dessa condição de gradiente.
getMidValue()	String	Recebe o valor do ponto médio dessa condição de gradiente.
getMinColorObject()	Color	Extrai a cor definida para o valor mínimo desta condição de gradiente.
getMinType()	InterpolationType	Recebe o tipo de interpolação para o valor mínimo dessa condição de gradiente.
getMinValue()	String	Retorna o valor mínimo dessa condição de gradiente.

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
getMaxColor()	String	Recebe a cor definida para o valor máximo dessa condição de gradiente.
getMidColor()	String	Extrai a cor definida para o valor de ponto médio dessa condição de gradiente.
getMinColor()	String	Extrai a cor definida para o valor mínimo desta condição de gradiente.

Documentação detalhada

getMaxColorObject()

Recebe a cor definida para o valor máximo dessa condição de gradiente. Retorna null se a cor não tiver sido definida.

Retornar

Color: a cor definida para o valor máximo desta condição de gradiente ou null.

---

getMaxType()

Recebe o tipo de interpolação para o valor máximo dessa condição de gradiente. Retorna null se o tipo máximo de gradiente não tiver sido definido.

Retornar

InterpolationType: o tipo de interpolação para o valor máximo dessa condição de gradiente ou null

---

getMaxValue()

Retorna o valor máximo dessa condição de gradiente. Retorna uma string vazia se InterpolationType for MAX ou se o valor máximo não tiver sido definido.

Retornar

String: o valor máximo, se especificado, ou uma string vazia.

---

getMidColorObject()

Extrai a cor definida para o valor do ponto médio dessa condição de gradiente. Retorna null se a cor não tiver sido definida.

Retornar

Color: a cor definida para o valor médio dessa condição de gradiente ou null.

---

getMidType()

Recebe o tipo de interpolação para o valor do ponto médio dessa condição de gradiente. Retorna null se o tipo de gradiente médio não tiver sido definido.

Retornar

InterpolationType: o tipo de interpolação para o valor do ponto médio dessa condição de gradiente ou null

---

getMidValue()

Recebe o valor do ponto médio dessa condição de gradiente. Retorna uma string vazia se o valor médio do gradiente não tiver sido definido.

Retornar

String: o valor do ponto médio ou uma string vazia

---

getMinColorObject()

Extrai a cor definida para o valor mínimo desta condição de gradiente. Retorna null se a cor não tiver sido definida.

Retornar

Color: a cor definida para o valor mínimo desta condição de gradiente ou null.

---

getMinType()

Recebe o tipo de interpolação para o valor mínimo dessa condição de gradiente. Retorna null se o tipo mínimo de gradiente não tiver sido definido.

Retornar

InterpolationType: o tipo de interpolação para o valor mínimo dessa condição de gradiente ou null

---

getMinValue()

Retorna o valor mínimo dessa condição de gradiente. Retorna uma string vazia se InterpolationType for MIN ou se o valor mínimo não tiver sido definido.

Retornar

String: o valor mínimo, se especificado, ou uma string vazia

Métodos obsoletos

getMaxColor()

Obsoleto. Substituído por getMaxColorObject()

Recebe a cor definida para o valor máximo dessa condição de gradiente. Retorna uma string vazia se a cor não tiver sido definida.

Retornar

String: a cor definida para o valor máximo dessa condição de gradiente ou uma string vazia.

---

getMidColor()

Obsoleto. Substituído por getMidColorObject()

Extrai a cor definida para o valor de ponto médio dessa condição de gradiente. Retorna uma string vazia se a cor não tiver sido definida.

Retornar

String: a cor definida para o valor do ponto médio dessa condição de gradiente ou uma string vazia.

---

getMinColor()

Obsoleto. Substituído por getMinColorObject()

Extrai a cor definida para o valor mínimo desta condição de gradiente. Retorna uma string vazia se a cor não tiver sido definida.

Retornar

String: a cor definida para o valor mínimo dessa condição de gradiente ou uma string vazia.