Class GradientCondition

GradientCondition

Accede a las condiciones de gradiente (color) en ConditionalFormatRuleApis. Cada regla de formato condicional puede contener una sola condición de gradiente. Una condición de gradiente se define mediante tres puntos a lo largo de una escala numérica (mín., medio y máx.), cada uno de los cuales tiene un color, un valor y un InterpolationType. El contenido de una celda se compara con los valores de la escala numérica, y el color aplicado a la celda se interpola en función de la proximidad del contenido de la celda a los puntos mínimo, medio y máximo de la condición 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 datos que se devuelve	Descripción breve
getMaxColorObject()	Color|null	Obtiene el color establecido para el valor máximo de esta condición de gradiente.
getMaxType()	InterpolationType|null	Obtiene el tipo de interpolación para el valor máximo de esta condición de gradiente.
getMaxValue()	String	Obtiene el valor máximo de esta condición de gradiente.
getMidColorObject()	Color|null	Obtiene el color establecido para el valor medio de esta condición de gradiente.
getMidType()	InterpolationType|null	Obtiene el tipo de interpolación para el valor medio de esta condición de gradiente.
getMidValue()	String	Obtiene el valor medio de esta condición de gradiente.
getMinColorObject()	Color|null	Obtiene el color establecido para el valor mínimo de esta condición de gradiente.
getMinType()	InterpolationType|null	Obtiene el tipo de interpolación para el valor mínimo de esta condición de gradiente.
getMinValue()	String	Obtiene el valor mínimo de esta condición de gradiente.

Métodos obsoletos

Método	Tipo de datos que se devuelve	Descripción breve
getMaxColor()	String	Obtiene el color establecido para el valor máximo de esta condición de gradiente.
getMidColor()	String	Obtiene el color establecido para el valor medio de esta condición de gradiente.
getMinColor()	String	Obtiene el color establecido para el valor mínimo de esta condición de gradiente.

Documentación detallada

getMaxColorObject()

Obtiene el color establecido para el valor máximo de esta condición de gradiente. Devuelve null si no se estableció el color.

Devuelve

Color|null — El color establecido para el valor máximo de esta condición de gradiente o null.

---

getMaxType()

Obtiene el tipo de interpolación para el valor máximo de esta condición de gradiente. Devuelve null si no se estableció el tipo máximo de gradiente.

Devuelve

InterpolationType|null — El tipo de interpolación para el valor máximo de esta condición de gradiente o null.

---

getMaxValue()

Obtiene el valor máximo de esta condición de gradiente. Devuelve una cadena vacía si el InterpolationType es MAX o si no se estableció el valor máximo.

Devuelve

String: El valor máximo si se especifica o una cadena vacía.

---

getMidColorObject()

Obtiene el color establecido para el valor medio de esta condición de gradiente. Devuelve null si no se estableció el color.

Devuelve

Color|null — El color establecido para el valor medio de esta condición de gradiente o null.

---

getMidType()

Obtiene el tipo de interpolación para el valor medio de esta condición de gradiente. Devuelve null si no se estableció el tipo medio de gradiente.

Devuelve

InterpolationType|null: El tipo de interpolación para el valor medio de esta condición de gradiente o null.

---

getMidValue()

Obtiene el valor medio de esta condición de gradiente. Devuelve una cadena vacía si no se estableció el valor medio de gradiente.

Devuelve

String: El valor medio o una cadena vacía.

---

getMinColorObject()

Obtiene el color establecido para el valor mínimo de esta condición de gradiente. Devuelve null si no se estableció el color.

Devuelve

Color|null — El color establecido para el valor mínimo de esta condición de gradiente o null.

---

getMinType()

Obtiene el tipo de interpolación para el valor mínimo de esta condición de gradiente. Devuelve null si no se estableció el tipo mínimo de gradiente.

Devuelve

InterpolationType|null: El tipo de interpolación para el valor mínimo de esta condición de gradiente o null.

---

getMinValue()

Obtiene el valor mínimo de esta condición de gradiente. Devuelve una cadena vacía si el InterpolationType es MIN o si no se estableció el valor mínimo.

Devuelve

String: El valor mínimo si se especifica o una cadena vacía.

Métodos obsoletos

getMaxColor()

Obsoleto. Se reemplazó por getMaxColorObject()

Obtiene el color establecido para el valor máximo de esta condición de gradiente. Devuelve una cadena vacía si no se estableció el color.

Devuelve

String: El color establecido para el valor máximo de esta condición de gradiente o una cadena vacía.

---

getMidColor()

Obsoleto. Se reemplazó por getMidColorObject()

Obtiene el color establecido para el valor medio de esta condición de gradiente. Devuelve una cadena vacía si no se estableció el color.

Devuelve

String: El color establecido para el valor medio de esta condición de gradiente o una cadena vacía.

---

getMinColor()

Obsoleto. Se reemplazó por getMinColorObject()

Obtiene el color establecido para el valor mínimo de esta condición de gradiente. Devuelve una cadena vacía si no se estableció el color.

Devuelve

String: El color establecido para el valor mínimo de esta condición de gradiente o una cadena vacía.