Excel.DataBarConditionalFormat class
Представляет тип условного гистограммы Excel.
- Extends
Комментарии
Используется
Свойства
| axis |
Цветовой код HTML, представляющий цвет линии оси, в форме #RRGGBB (например, "FFA500") или в виде именованного цвета HTML (например, "оранжевый"). Значение: "" (пустая строка), если ось отсутствует или не задана. |
| axis |
Представление того, как определяется ось для гистограммы Excel. |
| bar |
Направление гистограммы. |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| lower |
Правило определения нижнего предела гистограммы (и способ его вычисления, если применимо). Объект |
| negative |
Представление всех значений слева от оси на гистограмме Excel. |
| positive |
Представление всех значений на гистограмме Excel справа от оси. |
| show |
Если |
| upper |
Правило для верхней границы гистограммы (и как ее вычислить). Объект |
Методы
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
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;Значение свойства
lowerBoundRule
Правило определения нижнего предела гистограммы (и способ его вычисления, если применимо). Объект ConditionalDataBarRule должен быть установлен как объект JSON (используйте x.lowerBoundRule = {...} вместо x.lowerBoundRule.formula = ...).
lowerBoundRule: Excel.ConditionalDataBarRule;Значение свойства
Комментарии
negativeFormat
Представление всех значений слева от оси на гистограмме Excel.
readonly negativeFormat: Excel.ConditionalDataBarNegativeFormat;Значение свойства
Комментарии
positiveFormat
Представление всех значений на гистограмме Excel справа от оси.
readonly positiveFormat: Excel.ConditionalDataBarPositiveFormat;Значение свойства
Комментарии
showDataBarOnly
Если true, скрывает значения в ячейках, к которым применен гистограмма.
showDataBarOnly: boolean;Значение свойства
boolean
Комментарии
upperBoundRule
Правило для верхней границы гистограммы (и как ее вычислить). Объект ConditionalDataBarRule должен быть установлен как объект JSON (используйте x.upperBoundRule = {...} вместо x.upperBoundRule.formula = ...).
upperBoundRule: Excel.ConditionalDataBarRule;Значение свойства
Комментарии
Сведения о методе
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.DataBarConditionalFormatLoadOptions): Excel.DataBarConditionalFormat;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.DataBarConditionalFormat;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.DataBarConditionalFormat;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.DataBarConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
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;