ExcelScript.IconSetConditionalFormat interface

Пакет:

ExcelScript

Представляет критерии набора значков для условного форматирования.

Комментарии

Примеры

/**
 * 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
    }]);
}

Методы

getCriteria()	Массив критериев и наборов значков для правил и потенциальных настраиваемых значков для условных значков. Обратите внимание, что для первого критерия можно изменить только пользовательский значок, а тип, формула и оператор будут игнорироваться при установке.
getReverseIconOrder()	Если trueзначение , отменяет порядок значков для набора значков. Обратите внимание, что этот параметр нельзя задать, если используются пользовательские значки.
getShowIconOnly()	Если trueзначение , скрывает значения и отображает только значки.
getStyle()	Если задано значение , отображает параметр набора значков для условного формата.
setCriteria(criteria)	Массив критериев и наборов значков для правил и потенциальных настраиваемых значков для условных значков. Обратите внимание, что для первого критерия можно изменить только пользовательский значок, а тип, формула и оператор будут игнорироваться при установке.
setReverseIconOrder(reverseIconOrder)	Если trueзначение , отменяет порядок значков для набора значков. Обратите внимание, что этот параметр нельзя задать, если используются пользовательские значки.
setShowIconOnly(showIconOnly)	Если trueзначение , скрывает значения и отображает только значки.
setStyle(style)	Если задано значение , отображает параметр набора значков для условного формата.

Сведения о методе

getCriteria()

Массив критериев и наборов значков для правил и потенциальных настраиваемых значков для условных значков. Обратите внимание, что для первого критерия можно изменить только пользовательский значок, а тип, формула и оператор будут игнорироваться при установке.

getCriteria(): ConditionalIconCriterion[];

Возвращаемое значение

ExcelScript.ConditionalIconCriterion[]

getReverseIconOrder()

Если trueзначение , отменяет порядок значков для набора значков. Обратите внимание, что этот параметр нельзя задать, если используются пользовательские значки.

getReverseIconOrder(): boolean;

Возвращаемое значение

boolean

getShowIconOnly()

Если trueзначение , скрывает значения и отображает только значки.

getShowIconOnly(): boolean;

Возвращаемое значение

boolean

getStyle()

Если задано значение , отображает параметр набора значков для условного формата.

getStyle(): IconSet;

Возвращаемое значение

ExcelScript.IconSet

setCriteria(criteria)

Массив критериев и наборов значков для правил и потенциальных настраиваемых значков для условных значков. Обратите внимание, что для первого критерия можно изменить только пользовательский значок, а тип, формула и оператор будут игнорироваться при установке.

setCriteria(criteria: ConditionalIconCriterion[]): void;

Параметры

criteria

ExcelScript.ConditionalIconCriterion[]

Возвращаемое значение

void

setReverseIconOrder(reverseIconOrder)

Если trueзначение , отменяет порядок значков для набора значков. Обратите внимание, что этот параметр нельзя задать, если используются пользовательские значки.

setReverseIconOrder(reverseIconOrder: boolean): void;

Параметры

reverseIconOrder

boolean

Возвращаемое значение

void

setShowIconOnly(showIconOnly)

Если trueзначение , скрывает значения и отображает только значки.

setShowIconOnly(showIconOnly: boolean): void;

Параметры

showIconOnly

boolean

Возвращаемое значение

void

setStyle(style)

Если задано значение , отображает параметр набора значков для условного формата.

setStyle(style: IconSet): void;

Параметры

style

ExcelScript.IconSet

Возвращаемое значение

void