Class GradientCondition

GradientCondition

Acesse 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 em relação aos pontos mínimo, médio e máximo da 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 de gradiente.
getMaxValue()StringRecebe o valor máximo dessa condição de gradiente.
getMidColorObject()ColorRecebe a cor definida para o valor do ponto médio dessa condição de gradiente.
getMidType()InterpolationTypeRecebe o tipo de interpolação para o valor do ponto médio dessa condição de gradiente.
getMidValue()StringRecebe o valor do ponto médio dessa condição do gradiente.
getMinColorObject()ColorRecebe a cor definida para o valor mínimo dessa condição de gradiente.
getMinType()InterpolationTypeRecebe o tipo de interpolação para o valor mínimo dessa condição de gradiente.
getMinValue()StringRecebe o valor mínimo dessa condição de 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.

Retorno

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


getMaxType()

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

Retorno

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


getMaxValue()

Recebe 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.

Retorno

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


getMidColorObject()

Recebe 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.

Retorno

Color: a cor definida para o valor do ponto médio dessa condição do 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 intermediário não tiver sido definido.

Retorno

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 do gradiente. Retornará uma string vazia se o valor do gradiente médio não tiver sido definido.

Retorno

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


getMinColorObject()

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

Retorno

Color: a cor definida para o valor mínimo dessa condição do 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 do gradiente não tiver sido definido.

Retorno

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


getMinValue()

Recebe 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.

Retorno

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

Métodos obsoletos