ExcelScript.IconSetConditionalFormat interface

Pacote:
ExcelScript

Representa critérios do conjunto de ícones para formatação condicional.

Comentários

Usada por

Exemplos

/**
 * This script applies icon set conditional formatting to a range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range "A1:A5" on the current worksheet.
  const sheet = workbook.getActiveWorksheet();
  const range = sheet.getRange("A1:A5");

  // Create icon set conditional formatting on the range.
  const conditionalFormatting = range.addConditionalFormat(ExcelScript.ConditionalFormatType.iconSet);
  const iconSetFormat: ExcelScript.IconSetConditionalFormat = conditionalFormatting.getIconSet();
  // Use the "3 Traffic Lights (Unrimmed)" set.
  iconSetFormat.setStyle(ExcelScript.IconSet.threeTrafficLights1);

  // Set the criteria to use a different icon for the bottom, middle, and top thirds of the values in the range.
  iconSetFormat.setCriteria([
    {
      formula:'=0',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
      type:ExcelScript.ConditionalFormatIconRuleType.percent
    },
    {
      formula:'=33',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
      type:ExcelScript.ConditionalFormatIconRuleType.percent},
    {
      formula:'=67',operator:ExcelScript.ConditionalIconCriterionOperator.greaterThanOrEqual,
      type:ExcelScript.ConditionalFormatIconRuleType.percent
    }]);
}

Métodos

getCriteria()

Uma matriz de critérios e conjuntos de ícones para as regras e possíveis ícones personalizados para ícones condicionais. Observe que, para o primeiro critério, apenas o ícone personalizado pode ser modificado, enquanto o tipo, a fórmula e o operador serão ignorados quando definidos.
getReverseIconOrder()

Se true, inverte as ordens dos ícones para o conjunto de ícones. Observe que isso não poderá ser definido se ícones personalizados forem usados.
getShowIconOnly()

Se true, oculta os valores e mostra apenas ícones.
getStyle()

Se definido, exibe a opção de conjunto de ícones para o formato condicional.
setCriteria(criteria)

Uma matriz de critérios e conjuntos de ícones para as regras e possíveis ícones personalizados para ícones condicionais. Observe que, para o primeiro critério, apenas o ícone personalizado pode ser modificado, enquanto o tipo, a fórmula e o operador serão ignorados quando definidos.
setReverseIconOrder(reverseIconOrder)

Se true, inverte as ordens dos ícones para o conjunto de ícones. Observe que isso não poderá ser definido se ícones personalizados forem usados.
setShowIconOnly(showIconOnly)

Se true, oculta os valores e mostra apenas ícones.
setStyle(style)

Se definido, exibe a opção de conjunto de ícones para o formato condicional.

Detalhes do método

getCriteria()

Uma matriz de critérios e conjuntos de ícones para as regras e possíveis ícones personalizados para ícones condicionais. Observe que, para o primeiro critério, apenas o ícone personalizado pode ser modificado, enquanto o tipo, a fórmula e o operador serão ignorados quando definidos.

getCriteria(): ConditionalIconCriterion[];

Retornos

ExcelScript.ConditionalIconCriterion[]

getReverseIconOrder()

Se true, inverte as ordens dos ícones para o conjunto de ícones. Observe que isso não poderá ser definido se ícones personalizados forem usados.

getReverseIconOrder(): boolean;

Retornos

boolean

getShowIconOnly()

Se true, oculta os valores e mostra apenas ícones.

getShowIconOnly(): boolean;

Retornos

boolean

getStyle()

Se definido, exibe a opção de conjunto de ícones para o formato condicional.

getStyle(): IconSet;

Retornos

ExcelScript.IconSet

setCriteria(criteria)

Uma matriz de critérios e conjuntos de ícones para as regras e possíveis ícones personalizados para ícones condicionais. Observe que, para o primeiro critério, apenas o ícone personalizado pode ser modificado, enquanto o tipo, a fórmula e o operador serão ignorados quando definidos.

setCriteria(criteria: ConditionalIconCriterion[]): void;

Parâmetros

criteria

ExcelScript.ConditionalIconCriterion[]

Retornos

void

setReverseIconOrder(reverseIconOrder)

Se true, inverte as ordens dos ícones para o conjunto de ícones. Observe que isso não poderá ser definido se ícones personalizados forem usados.

setReverseIconOrder(reverseIconOrder: boolean): void;

Parâmetros

reverseIconOrder

boolean

Retornos

void

setShowIconOnly(showIconOnly)

Se true, oculta os valores e mostra apenas ícones.

setShowIconOnly(showIconOnly: boolean): void;

Parâmetros

showIconOnly

boolean

Retornos

void

setStyle(style)

Se definido, exibe a opção de conjunto de ícones para o formato condicional.

setStyle(style: IconSet): void;

Parâmetros

style
ExcelScript.IconSet

Retornos

void