Class GradientCondition

DégradéCondition

Accédez aux conditions de dégradé (couleur) dans ConditionalFormatRuleApis. Chaque règle de format conditionnel ne peut contenir qu'une seule condition de dégradé. Une condition de dégradé est définie par trois points sur une échelle numérique (min, milieu et max), chacun ayant une couleur, une valeur et un InterpolationType. Le contenu d'une cellule est comparé aux valeurs de l'échelle numérique, et la couleur appliquée à la cellule est interpolée en fonction de la proximité du contenu de la cellule avec les points minimum, médian et maximal de la condition de dégradé. 

// 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éthodes

MéthodeType renvoyéBrève description
getMaxColorObject()ColorRécupère la couleur définie pour la valeur maximale de cette condition de dégradé.
getMaxType()InterpolationTypeRécupère le type d'interpolation pour la valeur maximale de cette condition de dégradé.
getMaxValue()StringRécupère la valeur maximale de cette condition de dégradé.
getMidColorObject()ColorRécupère la couleur définie pour la valeur du point médian de cette condition de dégradé.
getMidType()InterpolationTypeRécupère le type d'interpolation pour la valeur médiane de cette condition de dégradé.
getMidValue()StringRécupère la valeur médiane de cette condition de dégradé.
getMinColorObject()ColorRécupère la couleur définie pour la valeur minimale de cette condition de dégradé.
getMinType()InterpolationTypeRécupère le type d'interpolation pour la valeur minimale de cette condition de gradient.
getMinValue()StringRécupère la valeur minimale de cette condition de dégradé.

Documentation détaillée

getMaxColorObject()

Récupère la couleur définie pour la valeur maximale de cette condition de dégradé. Renvoie null si la couleur n'a pas été définie.

Renvois

Color : couleur définie pour la valeur maximale de cette condition de dégradé ou null.

getMaxType()

Récupère le type d'interpolation pour la valeur maximale de cette condition de dégradé. Renvoie null si le type de gradient maximal n'a pas été défini.

Renvois

InterpolationType : type d'interpolation pour la valeur maximale de cette condition de dégradé ou null

getMaxValue()

Récupère la valeur maximale de cette condition de dégradé. Renvoie une chaîne vide si InterpolationType est MAX ou si la valeur maximale n'a pas été définie.

Renvois

String : valeur maximale si spécifiée ou chaîne vide

getMidColorObject()

Récupère la couleur définie pour la valeur du point médian de cette condition de dégradé. Renvoie null si la couleur n'a pas été définie.

Renvois

Color : couleur définie pour la valeur médiane de cette condition de dégradé ou null.

getMidType()

Récupère le type d'interpolation pour la valeur médiane de cette condition de dégradé. Renvoie null si le type de milieu du dégradé n'a pas été défini.

Renvois

InterpolationType : type d'interpolation pour la valeur médiane de cette condition de dégradé ou null

getMidValue()

Récupère la valeur médiane de cette condition de dégradé. Renvoie une chaîne vide si la valeur médiane du dégradé n'a pas été définie.

Renvois

String : valeur médiane ou chaîne vide

getMinColorObject()

Récupère la couleur définie pour la valeur minimale de cette condition de dégradé. Renvoie null si la couleur n'a pas été définie.

Renvois

Color : couleur définie pour la valeur minimale de cette condition de dégradé ou null.

getMinType()

Récupère le type d'interpolation pour la valeur minimale de cette condition de gradient. Renvoie null si le type de gradient minimal n'a pas été défini.

Renvois

InterpolationType : type d'interpolation pour la valeur minimale de cette condition de gradient ou null

getMinValue()

Récupère la valeur minimale de cette condition de dégradé. Renvoie une chaîne vide si InterpolationType est MIN ou si la valeur minimale n'a pas été définie.

Renvois

String : valeur minimale si spécifiée ou chaîne vide

Méthodes obsolètes