ExcelScript.ConditionalFormat interface

Пакет:

ExcelScript

Объект, инкапсулирующий диапазон, формат, правило и другие свойства условного формата.

Методы

delete()	Удаляет это условное форматирование.
getCellValue()	Возвращает свойства условного формата значения ячейки, если текущий условный формат является типом CellValue .
getColorScale()	Возвращает свойства условного формата цветовой шкалы, если текущий условный формат является типом ColorScale .
getCustom()	Возвращает свойства пользовательского условного формата, если текущий условный формат является пользовательским типом.
getDataBar()	Возвращает свойства панели данных, если текущий условный формат является панелью данных.
getIconSet()	Возвращает свойства условного формата набора значков, если текущий условный формат является типом IconSet .
getId()	Приоритет условного формата в текущем ConditionalFormatCollection.
getPreset()	Возвращает предустановленный условный формат условия. Дополнительные сведения см. в разделе ExcelScript.PresetCriteriaConditionalFormat.
getPriority()	Приоритет (или индекс) в коллекции условного формата, в которую в настоящее время существует этот условный формат. Это изменение также изменяет приоритеты других условных форматов, чтобы обеспечить непрерывный порядок приоритетов. Используйте отрицательный приоритет, чтобы начать с обратной стороны. Приоритеты, превышающие границы, получат и установят максимальный (или минимальный, если отрицательный) приоритет. Кроме того, обратите внимание, что при изменении приоритета необходимо повторно получить новую копию объекта в этом новом расположении приоритета, если вы хотите внести в нее дальнейшие изменения.
getRange()	Возвращает диапазон, к которому применяется условный формат. Если условный формат применяется к нескольким диапазонам, то этот метод возвращает undefined.
getRanges()	Возвращает объект , состоящий RangeAreasиз одного или нескольких прямоугольных диапазонов, к которым применяется условный формат.
getStopIfTrue()	Если выполняются условия этого условного форматирования, форматы с более низким приоритетом не будут применяться в этой ячейке. Значение находится null на гистограммах, наборах значков и цветовых шкалах, так как для них нет концепции StopIfTrue .
getTextComparison()	Возвращает определенные свойства условного формата текста, если текущий условный формат является текстовым типом. Например, для форматирования ячеек, соответствующих слову "Текст".
getTopBottom()	Возвращает свойства верхнего или нижнего условного формата, если текущий условный формат является типом TopBottom . Например, чтобы отформатировать верхние 10 % или нижние 10 элементов.
getType()	Тип условного формата. Одновременно можно задать только одну.
setPriority(priority)	Приоритет (или индекс) в коллекции условного формата, в которую в настоящее время существует этот условный формат. Это изменение также изменяет приоритеты других условных форматов, чтобы обеспечить непрерывный порядок приоритетов. Используйте отрицательный приоритет, чтобы начать с обратной стороны. Приоритеты, превышающие границы, получат и установят максимальный (или минимальный, если отрицательный) приоритет. Кроме того, обратите внимание, что при изменении приоритета необходимо повторно получить новую копию объекта в этом новом расположении приоритета, если вы хотите внести в нее дальнейшие изменения.
setStopIfTrue(stopIfTrue)	Если выполняются условия этого условного форматирования, форматы с более низким приоритетом не будут применяться в этой ячейке. Значение находится null на гистограммах, наборах значков и цветовых шкалах, так как для них нет концепции StopIfTrue .

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

delete()

Удаляет это условное форматирование.

delete(): void;

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

void

getCellValue()

Возвращает свойства условного формата значения ячейки, если текущий условный формат является типом CellValue .

getCellValue(): CellValueConditionalFormat | undefined;

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

ExcelScript.CellValueConditionalFormat | undefined

Примеры

/**
 * This script applies conditional formatting to a range.
 * That formatting is conditional upon the cell's numerical value.
 * Any value between 50 and 75 will have the cell fill color changed and the font made italic.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range to format.
  const sheet = workbook.getActiveWorksheet();
  const ratingColumn = sheet.getRange("D2:D20");

  // Add cell value conditional formatting.
  const cellValueConditionalFormatting =
    ratingColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();
  
  // Create the condition, in this case when the cell value is between 50 and 75.
  let rule: ExcelScript.ConditionalCellValueRule = {
    formula1: "50",
    formula2: "75",
    operator: ExcelScript.ConditionalCellValueOperator.between
  };
  cellValueConditionalFormatting.setRule(rule);

  // Set the format to apply when the condition is met.
  let format = cellValueConditionalFormatting.getFormat();
  format.getFill().setColor("yellow");
  format.getFont().setItalic(true);

}

getColorScale()

Возвращает свойства условного формата цветовой шкалы, если текущий условный формат является типом ColorScale .

getColorScale(): ColorScaleConditionalFormat | undefined;

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

ExcelScript.ColorScaleConditionalFormat | undefined

Примеры

/**
 * This script applies a red, white, and blue color scale to the selected range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected range.
  let selectedRange = workbook.getSelectedRange();

  // Create a new conditional formatting object by adding one to the range.
  let conditionalFormatting = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.colorScale);

  // Set the colors for the three parts of the scale: minimum, midpoint, and maximum.
  conditionalFormatting.getColorScale().setCriteria({
    minimum: {
      color:"#F8696B", /* A pale red. */
      type:ExcelScript.ConditionalFormatColorCriterionType.lowestValue
    },
    midpoint: {
      color: "#FCFCFF", /* Slightly off-white. */
      formula:'=50',type:ExcelScript.ConditionalFormatColorCriterionType.percentile
    },
    maximum: {
      color: "#5A8AC6", /* A pale blue. */
      type:ExcelScript.ConditionalFormatColorCriterionType.highestValue
    }
  });
}

getCustom()

Возвращает свойства пользовательского условного формата, если текущий условный формат является пользовательским типом.

getCustom(): CustomConditionalFormat | undefined;

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

ExcelScript.CustomConditionalFormat | undefined

Примеры

/**
 * This script applies a custom conditional formatting to the selected range.
 * A light-green fill is applied to a cell if the value is larger than the value in the row's previous column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected cells.
  let selectedRange = workbook.getSelectedRange();

  // Apply a rule for positive change from the previous column.
  let positiveChange = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom);
  positiveChange.getCustom().getFormat().getFill().setColor("lightgreen");
  positiveChange.getCustom().getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}>${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`);
}

getDataBar()

Возвращает свойства панели данных, если текущий условный формат является панелью данных.

getDataBar(): DataBarConditionalFormat | undefined;

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

ExcelScript.DataBarConditionalFormat | undefined

Примеры

/**
 * This script creates data bar conditional formatting on the selected range.
 * The scale of the data bar goes from 0 to 1000.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected range.
  const selected = workbook.getSelectedRange();
  
  // Create new conditional formatting on the range.
  const format = selected.addConditionalFormat(ExcelScript.ConditionalFormatType.dataBar);
  const dataBarFormat = format.getDataBar();

  // Set the lower bound of the data bar formatting to be 0.
  const lowerBound: ExcelScript.ConditionalDataBarRule = {
    type: ExcelScript.ConditionalFormatRuleType.number,
    formula: "0"
  };
  dataBarFormat.setLowerBoundRule(lowerBound);

  // Set the upper bound of the data bar formatting to be 1000.
  const upperBound: ExcelScript.ConditionalDataBarRule = {
    type: ExcelScript.ConditionalFormatRuleType.number,
    formula: "1000"
  };
  dataBarFormat.setUpperBoundRule(upperBound);
}

getIconSet()

Возвращает свойства условного формата набора значков, если текущий условный формат является типом IconSet .

getIconSet(): IconSetConditionalFormat | undefined;

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

ExcelScript.IconSetConditionalFormat | undefined

Примеры

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

  // Use the "3 Traffic Lights (Unrimmed)" set.
  conditionalFormatting.getIconSet().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.
  conditionalFormatting.getIconSet().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
    }]);
}

getId()

Приоритет условного формата в текущем ConditionalFormatCollection.

getId(): string;

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

string

getPreset()

Возвращает предустановленный условный формат условия. Дополнительные сведения см. в разделе ExcelScript.PresetCriteriaConditionalFormat.

getPreset(): PresetCriteriaConditionalFormat | undefined;

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

ExcelScript.PresetCriteriaConditionalFormat | undefined

Примеры

/**
 * This script applies a conditional format that uses a preset criterion.
 * Any cell in row 1 will have the color fill set to green if it is a duplicate value
 * (of anything else in row 1).
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range for row 1.
  const sheet = workbook.getActiveWorksheet();
  const formattedRange = sheet.getRange("1:1");

  // Add new conditional formatting to that range.
  const conditionalFormat = formattedRange.addConditionalFormat(
    ExcelScript.ConditionalFormatType.presetCriteria);

  // Set the conditional formatting to apply a green fill.
  const presetFormat = conditionalFormat.getPreset();
  presetFormat.getFormat().getFill().setColor("green");

  // Set a rule to apply the conditional format when values are duplicated in the range.
  const duplicateRule: ExcelScript.ConditionalPresetCriteriaRule = {
    criterion: ExcelScript.ConditionalFormatPresetCriterion.duplicateValues
  };
  presetFormat.setRule(duplicateRule);
}

getPriority()

Приоритет (или индекс) в коллекции условного формата, в которую в настоящее время существует этот условный формат. Это изменение также изменяет приоритеты других условных форматов, чтобы обеспечить непрерывный порядок приоритетов. Используйте отрицательный приоритет, чтобы начать с обратной стороны. Приоритеты, превышающие границы, получат и установят максимальный (или минимальный, если отрицательный) приоритет. Кроме того, обратите внимание, что при изменении приоритета необходимо повторно получить новую копию объекта в этом новом расположении приоритета, если вы хотите внести в нее дальнейшие изменения.

getPriority(): number;

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

number

getRange()

Возвращает диапазон, к которому применяется условный формат. Если условный формат применяется к нескольким диапазонам, то этот метод возвращает undefined.

getRange(): Range;

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

ExcelScript.Range

getRanges()

Возвращает объект , состоящий RangeAreasиз одного или нескольких прямоугольных диапазонов, к которым применяется условный формат.

getRanges(): RangeAreas;

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

ExcelScript.RangeAreas

getStopIfTrue()

Если выполняются условия этого условного форматирования, форматы с более низким приоритетом не будут применяться в этой ячейке. Значение находится null на гистограммах, наборах значков и цветовых шкалах, так как для них нет концепции StopIfTrue .

getStopIfTrue(): boolean;

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

boolean

getTextComparison()

Возвращает определенные свойства условного формата текста, если текущий условный формат является текстовым типом. Например, для форматирования ячеек, соответствующих слову "Текст".

getTextComparison(): TextConditionalFormat | undefined;

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

ExcelScript.TextConditionalFormat | undefined

Примеры

/**
 * This script adds conditional formatting to the first column in the worksheet.
 * This formatting gives the cells a green fill if they have text starting with "Excel".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first column in the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const firstColumn = currentSheet.getRange("A:A");

  // Add conditional formatting based on the text in the cells.
  const textConditionFormat = 
    firstColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.containsText).getTextComparison();

  // Set the conditional format to provide a green fill.
  textConditionFormat.getFormat().getFill().setColor("green");

  // Apply the condition rule that the text begins with "Excel".
  const textRule: ExcelScript.ConditionalTextComparisonRule = {
    operator: ExcelScript.ConditionalTextOperator.beginsWith,
    text: "Excel"
  };
  textConditionFormat.setRule(textRule);
}

getTopBottom()

Возвращает свойства верхнего или нижнего условного формата, если текущий условный формат является типом TopBottom . Например, чтобы отформатировать верхние 10 % или нижние 10 элементов.

getTopBottom(): TopBottomConditionalFormat | undefined;

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

ExcelScript.TopBottomConditionalFormat | undefined

Примеры

/**
 * This script applies top/bottom conditional formatting to a range.
 * The top 2 values in the range will have the cell fill color changed to green.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range to format.
  const sheet = workbook.getWorksheet("TopBottom");
  const dataRange = sheet.getRange("B2:D5");

  // Set the fill color to green for the top 2 values in the range.
  const topBottomFormat = dataRange.addConditionalFormat(
    ExcelScript.ConditionalFormatType.topBottom).getTopBottom();
  topBottomFormat.getFormat().getFill().setColor("green");
  topBottomFormat.setRule({
    rank: 2, /* The numeric threshold. */
    type: ExcelScript.ConditionalTopBottomCriterionType.topItems /* The type of the top/bottom condition. */
  });
}

getType()

Тип условного формата. Одновременно можно задать только одну.

getType(): ConditionalFormatType;

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

ExcelScript.ConditionalFormatType

setPriority(priority)

Приоритет (или индекс) в коллекции условного формата, в которую в настоящее время существует этот условный формат. Это изменение также изменяет приоритеты других условных форматов, чтобы обеспечить непрерывный порядок приоритетов. Используйте отрицательный приоритет, чтобы начать с обратной стороны. Приоритеты, превышающие границы, получат и установят максимальный (или минимальный, если отрицательный) приоритет. Кроме того, обратите внимание, что при изменении приоритета необходимо повторно получить новую копию объекта в этом новом расположении приоритета, если вы хотите внести в нее дальнейшие изменения.

setPriority(priority: number): void;

Параметры

priority

number

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

void

setStopIfTrue(stopIfTrue)

Если выполняются условия этого условного форматирования, форматы с более низким приоритетом не будут применяться в этой ячейке. Значение находится null на гистограммах, наборах значков и цветовых шкалах, так как для них нет концепции StopIfTrue .

setStopIfTrue(stopIfTrue: boolean): void;

Параметры

stopIfTrue

boolean

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

void