Excel.DataBarConditionalFormat class

Ссылка

Пакет:: excel

Представляет тип условной панели данных Excel.

Extends: OfficeExtension.ClientObject

Свойства

axisColor	Код цвета HTML, представляющий цвет линии оси в виде #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый"). Значение равно "" (пустая строка), если ось отсутствует или не задано.
axisFormat	Представление определения оси для панели данных Excel.
barDirection	Указывает направление, на котором должен основываться рисунок панели данных.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
lowerBoundRule	Правило для того, что составляет нижнюю границу (и как ее вычислить, если применимо) для панели данных. Объект `ConditionalDataBarRule` должен быть задан как объект JSON (используйте `x.lowerBoundRule = {...}` вместо `x.lowerBoundRule.formula = ...`).
negativeFormat	Представление всех значений слева от оси на панели данных Excel.
positiveFormat	Представление всех значений справа от оси на панели данных Excel.
showDataBarOnly	Если `true`значение , то скрывает значения из ячеек, в которых применяется панель данных.
upperBoundRule	Правило для верхней границы гистограммы (и как ее вычислить). Объект `ConditionalDataBarRule` должен быть задан как объект JSON (используйте `x.upperBoundRule = {...}` вместо `x.upperBoundRule.formula = ...`).

Методы

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.DataBarConditionalFormat является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Excel.Interfaces.DataBarConditionalFormatData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

axisColor

Код цвета HTML, представляющий цвет линии оси в виде #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый"). Значение равно "" (пустая строка), если ось отсутствует или не задано.

axisColor: string;

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

string

axisFormat

Представление определения оси для панели данных Excel.

axisFormat: Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | "CellMidPoint";

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

Excel.ConditionalDataBarAxisFormat | "Automatic" | "None" | "CellMidPoint"

barDirection

Указывает направление, на котором должен основываться рисунок панели данных.

barDirection: Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft";

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

Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft"

Примеры

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

context

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

context: RequestContext;

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

Excel.RequestContext

lowerBoundRule

Правило для того, что составляет нижнюю границу (и как ее вычислить, если применимо) для панели данных. Объект ConditionalDataBarRule должен быть задан как объект JSON (используйте x.lowerBoundRule = {...} вместо x.lowerBoundRule.formula = ...).

lowerBoundRule: Excel.ConditionalDataBarRule;

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

Excel.ConditionalDataBarRule

negativeFormat

Представление всех значений слева от оси на панели данных Excel.

readonly negativeFormat: Excel.ConditionalDataBarNegativeFormat;

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

Excel.ConditionalDataBarNegativeFormat

positiveFormat

Представление всех значений справа от оси на панели данных Excel.

readonly positiveFormat: Excel.ConditionalDataBarPositiveFormat;

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

Excel.ConditionalDataBarPositiveFormat

showDataBarOnly

Если trueзначение , то скрывает значения из ячеек, в которых применяется панель данных.

showDataBarOnly: boolean;

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

boolean

upperBoundRule

Правило для верхней границы гистограммы (и как ее вычислить). Объект ConditionalDataBarRule должен быть задан как объект JSON (используйте x.upperBoundRule = {...} вместо x.upperBoundRule.formula = ...).

upperBoundRule: Excel.ConditionalDataBarRule;

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

Excel.ConditionalDataBarRule

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

load(options)

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

load(options?: Excel.Interfaces.DataBarConditionalFormatLoadOptions): Excel.DataBarConditionalFormat;

Параметры

options: Excel.Interfaces.DataBarConditionalFormatLoadOptions

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

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

Excel.DataBarConditionalFormat

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Excel.DataBarConditionalFormat

load(propertyNamesAndPaths)

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

Параметры

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

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

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

Excel.DataBarConditionalFormat

set(properties, options)

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

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

Параметры

properties: Excel.Interfaces.DataBarConditionalFormatUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.DataBarConditionalFormat): void;

Параметры

properties: Excel.DataBarConditionalFormat

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

void

toJSON()

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

toJSON(): Excel.Interfaces.DataBarConditionalFormatData;

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

Excel.Interfaces.DataBarConditionalFormatData

Excel.DataBarConditionalFormat class

Комментарии

Свойства

Методы

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

axisColor

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

Комментарии

axisFormat

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

Комментарии

barDirection

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

Комментарии

Примеры

context

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

lowerBoundRule

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

Комментарии

negativeFormat

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

Комментарии

positiveFormat

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

Комментарии

showDataBarOnly

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

Комментарии

upperBoundRule

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

Комментарии

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

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

toJSON()

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

Обратная связь

Дополнительные ресурсы