Class GradientCondition

GradientCondition

Acessar 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 definidos por três pontos ao longo de uma escala numérica (mín., média e máxima), cada qual com uma cor, um 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 em relação aos pontos mínimo, médio e máximo de condição do gradiente.

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

MétodoTipo de retornoBreve descrição
getMaxColorObject()ColorRecebe a cor definida para o valor máximo desta condição de gradiente.
getMaxType()InterpolationTypeRecebe o tipo de interpolação para o valor máximo desta condição do gradiente.
getMaxValue()StringRecebe o valor máximo da condição do gradiente.
getMidColorObject()ColorRecebe a cor definida para o valor do ponto médio da condição do gradiente.
getMidType()InterpolationTypeRecebe o tipo de interpolação para o valor do ponto médio da condição do gradiente.
getMidValue()StringRecebe o valor do ponto médio da condição do gradiente.
getMinColorObject()ColorRecebe a cor definida para o valor mínimo desta condição de gradiente.
getMinType()InterpolationTypeRecebe o tipo de interpolação para o valor mínimo desta condição do gradiente.
getMinValue()StringRecebe o valor mínimo da condição do gradiente.

Documentação detalhada

getMaxColorObject()

Recebe a cor definida para o valor máximo desta 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 desta condição do gradiente. Retornará 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()

Recebe o valor máximo da condição do 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()

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

Retornar

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


getMidType()

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

Retornar

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


getMidValue()

Recebe o valor do ponto médio da condição do gradiente. Retorna uma string vazia se o gradiente o valor médio não foi definido.

Retornar

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


getMinColorObject()

Recebe 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 dessa condição de gradiente ou null.


getMinType()

Recebe o tipo de interpolação para o valor mínimo desta condição do gradiente. Retornará 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()

Recebe o valor mínimo da condição do 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