Class GradientCondition

GradientCondition

Accédez aux conditions du dégradé (couleur) dans ConditionalFormatRuleApis. Chaque règle de mise en forme conditionnelle ne peut contenir qu'une seule condition de dégradé. Une condition de dégradé est définie par trois points le long d'une échelle numérique (min, mid et max), chacun étant associé à une couleur, une valeur et une InterpolationType. Le contenu d'une cellule est comparé aux valeurs de l'échelle de nombres, et la couleur appliquée à la cellule est interpolée en fonction de la proximité du contenu de la cellule par rapport aux points minimal, moyen 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.
var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
for (int i = 0; i < rules.length; i++) {
  var gradient = rules[i].getGradientCondition();
  Logger.log("The conditional format gradient information for rule %d:\n
    MinColor %s, MinType %s, MinValue %s, \n
    MidColor %s, MidType %s, MidValue %s, \n
    MaxColor %s, MaxType %s, MaxValue %s \n", i,
    gradient.getMinColorObject().asRgbColor().asHexString(),
    gradient.getMinType(), gradient.getMinValue(),
    gradient.getMidColorObject().asRgbColor().asHexString(),
    gradient.getMidType(), gradient.getMidValue(),
    gradient.getMaxColorObject().asRgbColor().asHexString(),
    gradient.getMaxType(), gradient.getMaxValue());
}

Méthodes

MéthodeType renvoyéBrève description
getMaxColorObject()ColorRécupère le jeu de couleurs 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 gradient.
getMaxValue()StringRécupère la valeur maximale de cette condition de gradient.
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 du point médian de cette condition de gradient.
getMidValue()StringRécupère la valeur du point médian de cette condition de dégradé.
getMinColorObject()ColorRécupère le jeu de couleurs 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 gradient.

Documentation détaillée

getMaxColorObject()

Récupère le jeu de couleurs 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 gradient. Renvoie null si le type maximal du dégradé n'a pas été défini.

Renvois

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


getMaxValue()

Récupère la valeur maximale de cette condition de gradient. Renvoie une chaîne vide si InterpolationType est défini sur 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 du point médian de cette condition de dégradé ou null.


getMidType()

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

Renvois

InterpolationType : type d'interpolation pour la valeur du point médian de cette condition de gradient ou null


getMidValue()

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

Renvois

String : valeur du milieu ou chaîne vide


getMinColorObject()

Récupère le jeu de couleurs 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 valeur minimale du dégradé 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 gradient. Renvoie une chaîne vide si InterpolationType est défini sur 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