Excel.ConditionalFormat class

Пакет:

excel

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

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.6 ]

Свойства

cellValue	Возвращает свойства условного формата значения ячейки, если текущий условный формат является типом CellValue .
cellValueOrNullObject	Возвращает свойства условного формата значения ячейки, если текущий условный формат является типом CellValue .
colorScale	Возвращает свойства условного формата цветовой шкалы, если текущий условный формат является типом ColorScale .
colorScaleOrNullObject	Возвращает свойства условного формата цветовой шкалы, если текущий условный формат является типом ColorScale .
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
custom	Возвращает свойства пользовательского условного формата, если текущий условный формат является пользовательским типом.
customOrNullObject	Возвращает свойства пользовательского условного формата, если текущий условный формат является пользовательским типом.
dataBar	Возвращает свойства панели данных, если текущий условный формат является панелью данных.
dataBarOrNullObject	Возвращает свойства панели данных, если текущий условный формат является панелью данных.
iconSet	Возвращает свойства условного формата набора значков, если текущий условный формат является типом IconSet .
iconSetOrNullObject	Возвращает свойства условного формата набора значков, если текущий условный формат является типом IconSet .
id	Приоритет условного формата в текущем ConditionalFormatCollection.
preset	Возвращает предустановленный условный формат условия. Дополнительные сведения см. в разделе Excel.PresetCriteriaConditionalFormat.
presetOrNullObject	Возвращает предустановленный условный формат условия. Дополнительные сведения см. в разделе Excel.PresetCriteriaConditionalFormat.
priority	Приоритет (или индекс) в коллекции условного формата, в которую в настоящее время существует этот условный формат. Это изменение также изменяет приоритеты других условных форматов, чтобы обеспечить непрерывный порядок приоритетов. Используйте отрицательный приоритет, чтобы начать с обратной стороны. Приоритеты, превышающие границы, получат и установят максимальный (или минимальный, если отрицательный) приоритет. Кроме того, обратите внимание, что при изменении приоритета необходимо повторно получить новую копию объекта в этом новом расположении приоритета, если вы хотите внести в нее дальнейшие изменения.
stopIfTrue	Если выполняются условия этого условного форматирования, форматы с более низким приоритетом не будут применяться в этой ячейке. Значение находится null на гистограммах, наборах значков и цветовых шкалах, так как для них нет концепции StopIfTrue .
textComparison	Возвращает определенные свойства условного формата текста, если текущий условный формат является текстовым типом. Например, для форматирования ячеек, соответствующих слову "Текст".
textComparisonOrNullObject	Возвращает определенные свойства условного формата текста, если текущий условный формат является текстовым типом. Например, для форматирования ячеек, соответствующих слову "Текст".
topBottom	Возвращает свойства верхнего или нижнего условного формата, если текущий условный формат является типом TopBottom . Например, чтобы отформатировать верхние 10 % или нижние 10 элементов.
topBottomOrNullObject	Возвращает свойства верхнего или нижнего условного формата, если текущий условный формат является типом TopBottom . Например, чтобы отформатировать верхние 10 % или нижние 10 элементов.
type	Тип условного формата. Одновременно можно задать только одну.

Методы

delete()	Удаляет это условное форматирование.
getRange()	Возврат диапазона, к которому применено условное форматирование. Выдает ошибку, если условный формат применяется к нескольким диапазонам.
getRangeOrNullObject()	Возвращает диапазон, к которому применяется кондитональный формат. Если условный формат применяется к нескольким диапазонам, то этот метод возвращает объект со свойством isNullObject .true Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getRanges()	Возвращает значение , состоящее RangeAreasиз одного или нескольких прямоугольных диапазонов, к которым применяется кондитональный формат.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.ConditionalFormat объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.ConditionalFormatData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

Сведения о свойстве

cellValue

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

readonly cellValue: Excel.CellValueConditionalFormat;

Значение свойства

Excel.CellValueConditionalFormat

Комментарии

[ Набор API: ExcelApi 1.6 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B21:E23");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.cellValue);
    conditionalFormat.cellValue.format.font.color = "red";
    conditionalFormat.cellValue.rule = { formula1: "=0", operator: "LessThan" };

    await context.sync();
});

cellValueOrNullObject

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

readonly cellValueOrNullObject: Excel.CellValueConditionalFormat;

Значение свойства

Excel.CellValueConditionalFormat

Комментарии

[ Набор API: ExcelApi 1.6 ]

colorScale

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

readonly colorScale: Excel.ColorScaleConditionalFormat;

Значение свойства

Excel.ColorScaleConditionalFormat

Комментарии

[ Набор API: ExcelApi 1.6 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B2:M5");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.colorScale);
    const criteria = {
        minimum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.lowestValue, color: "blue" },
        midpoint: { formula: "50", type: Excel.ConditionalFormatColorCriterionType.percent, color: "yellow" },
        maximum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.highestValue, color: "red" }
    };
    conditionalFormat.colorScale.criteria = criteria;

    await context.sync();
});

colorScaleOrNullObject

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

readonly colorScaleOrNullObject: Excel.ColorScaleConditionalFormat;

Значение свойства

Excel.ColorScaleConditionalFormat

Комментарии

[ Набор API: ExcelApi 1.6 ]

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

custom

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

readonly custom: Excel.CustomConditionalFormat;

Значение свойства

Excel.CustomConditionalFormat

Комментарии

[ Набор API: ExcelApi 1.6 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B8:E13");
    const conditionalFormat = range.conditionalFormats.add(Excel.ConditionalFormatType.custom);
    conditionalFormat.custom.rule.formula = '=IF(B8>INDIRECT("RC[-1]",0),TRUE)';
    conditionalFormat.custom.format.font.color = "green";

    await context.sync();
});

customOrNullObject

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

readonly customOrNullObject: Excel.CustomConditionalFormat;

Значение свойства

Excel.CustomConditionalFormat

Комментарии

[ Набор API: ExcelApi 1.6 ]

dataBar

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

readonly dataBar: Excel.DataBarConditionalFormat;

Значение свойства

Excel.DataBarConditionalFormat

Комментарии

[ Набор API: ExcelApi 1.6 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B8:E13");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.dataBar);
    conditionalFormat.dataBar.barDirection = Excel.ConditionalDataBarDirection.leftToRight;

    await context.sync();
});

dataBarOrNullObject

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

readonly dataBarOrNullObject: Excel.DataBarConditionalFormat;

Значение свойства

Excel.DataBarConditionalFormat

Комментарии

[ Набор API: ExcelApi 1.6 ]

iconSet

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

readonly iconSet: Excel.IconSetConditionalFormat;

Значение свойства

Excel.IconSetConditionalFormat

Комментарии

[ Набор API: ExcelApi 1.6 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B8:E13");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.iconSet);
    const iconSetCF = conditionalFormat.iconSet;
    iconSetCF.style = Excel.IconSet.threeTriangles;

    /*
        The iconSetCF.criteria array is automatically prepopulated with
        criterion elements whose properties have been given default settings.
        You can't write to each property of a criterion directly. Instead,
        replace the whole criteria object.

        With a "three*" icon set style, such as "threeTriangles", the third
        element in the criteria array (criteria[2]) defines the "top" icon;
        e.g., a green triangle. The second (criteria[1]) defines the "middle"
        icon. The first (criteria[0]) defines the "low" icon, but it
        can often be left empty as the following object shows, because every
        cell that does not match the other two criteria always gets the low
        icon.            
    */
    iconSetCF.criteria = [
        {} as any,
        {
            type: Excel.ConditionalFormatIconRuleType.number,
            operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual,
            formula: "=700"
        },
        {
            type: Excel.ConditionalFormatIconRuleType.number,
            operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual,
            formula: "=1000",
        }
    ];

    await context.sync();
});

iconSetOrNullObject

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

readonly iconSetOrNullObject: Excel.IconSetConditionalFormat;

Значение свойства

Excel.IconSetConditionalFormat

Комментарии

[ Набор API: ExcelApi 1.6 ]

id

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

readonly id: string;

Значение свойства

string

Комментарии

[ Набор API: ExcelApi 1.6 ]

preset

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

readonly preset: Excel.PresetCriteriaConditionalFormat;

Значение свойства

Excel.PresetCriteriaConditionalFormat

Комментарии

[ Набор API: ExcelApi 1.6 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B2:M5");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.presetCriteria);
    conditionalFormat.preset.format.font.color = "white";
    conditionalFormat.preset.rule = { criterion: Excel.ConditionalFormatPresetCriterion.oneStdDevAboveAverage };

    await context.sync();
});

presetOrNullObject

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

readonly presetOrNullObject: Excel.PresetCriteriaConditionalFormat;

Значение свойства

Excel.PresetCriteriaConditionalFormat

Комментарии

[ Набор API: ExcelApi 1.6 ]

priority

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

priority: number;

Значение свойства

number

Комментарии

[ Набор API: ExcelApi 1.6 ]

stopIfTrue

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

stopIfTrue: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.6 ]

textComparison

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

readonly textComparison: Excel.TextConditionalFormat;

Значение свойства

Excel.TextConditionalFormat

Комментарии

[ Набор API: ExcelApi 1.6 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B16:D18");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.containsText);
    conditionalFormat.textComparison.format.font.color = "red";
    conditionalFormat.textComparison.rule = { operator: Excel.ConditionalTextOperator.contains, text: "Delayed" };

    await context.sync();
});

textComparisonOrNullObject

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

readonly textComparisonOrNullObject: Excel.TextConditionalFormat;

Значение свойства

Excel.TextConditionalFormat

Комментарии

[ Набор API: ExcelApi 1.6 ]

topBottom

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

readonly topBottom: Excel.TopBottomConditionalFormat;

Значение свойства

Excel.TopBottomConditionalFormat

Комментарии

[ Набор API: ExcelApi 1.6 ]

topBottomOrNullObject

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

readonly topBottomOrNullObject: Excel.TopBottomConditionalFormat;

Значение свойства

Excel.TopBottomConditionalFormat

Комментарии

[ Набор API: ExcelApi 1.6 ]

type

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

readonly type: Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue";

Значение свойства

Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"

Комментарии

[ Набор API: ExcelApi 1.6 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const worksheetRange = sheet.getRange();
    worksheetRange.conditionalFormats.load("type");

    await context.sync();

    let cfRangePairs: { cf: Excel.ConditionalFormat, range: Excel.Range }[] = [];
    worksheetRange.conditionalFormats.items.forEach(item => {
        cfRangePairs.push({
            cf: item,
            range: item.getRange().load("address")
        });
    });

    await context.sync();

    if (cfRangePairs.length > 0) {
        cfRangePairs.forEach(item => {
            console.log(item.cf.type);
        });
    } else {
        console.log("No conditional formats applied.");
    }
});

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

delete()

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

delete(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.6 ]

getRange()

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

getRange(): Excel.Range;

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

Excel.Range

Комментарии

[ Набор API: ExcelApi 1.6 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const worksheetRange = sheet.getRange();
    worksheetRange.conditionalFormats.load("type");

    await context.sync();

    let cfRangePairs: { cf: Excel.ConditionalFormat, range: Excel.Range }[] = [];
    worksheetRange.conditionalFormats.items.forEach(item => {
        cfRangePairs.push({
            cf: item,
            range: item.getRange().load("address")
        });
    });

    await context.sync();

    if (cfRangePairs.length > 0) {
        cfRangePairs.forEach(item => {
            console.log(item.cf.type);
        });
    } else {
        console.log("No conditional formats applied.");
    }
});

getRangeOrNullObject()

Возвращает диапазон, к которому применяется кондитональный формат. Если условный формат применяется к нескольким диапазонам, то этот метод возвращает объект со свойством isNullObject .true Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getRangeOrNullObject(): Excel.Range;

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

Excel.Range

Комментарии

[ Набор API: ExcelApi 1.6 ]

getRanges()

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

getRanges(): Excel.RangeAreas;

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

Excel.RangeAreas

Комментарии

[ Набор API: ExcelApi 1.9 ]

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.ConditionalFormatLoadOptions): Excel.ConditionalFormat;

Параметры

options

Excel.Interfaces.ConditionalFormatLoadOptions

Предоставляет параметры свойств объекта для загрузки.

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

Excel.ConditionalFormat

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Excel.ConditionalFormat;

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

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

Excel.ConditionalFormat

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ConditionalFormat;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

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

Excel.ConditionalFormat

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.ConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties

Excel.Interfaces.ConditionalFormatUpdateData

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

options

OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

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

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Excel.ConditionalFormat): void;

Параметры

properties

Excel.ConditionalFormat

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

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.ConditionalFormat объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.ConditionalFormatData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Excel.Interfaces.ConditionalFormatData;

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

Excel.Interfaces.ConditionalFormatData