Excel.DataBarConditionalFormat class
表示 Excel 条件数据条类型。
- 扩展
注解
属性
| 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
lowerBoundRule
有关构成下限 (以及如何计算下限的规则（如果适用），) 数据条。 对象 ConditionalDataBarRule 必须设置为 JSON 对象， (使用 x.lowerBoundRule = {...} 而不是 x.lowerBoundRule.formula = ...) 。
lowerBoundRule: Excel.ConditionalDataBarRule;属性值
注解
negativeFormat
Excel 数据栏中轴左侧所有值的表示形式。
readonly negativeFormat: Excel.ConditionalDataBarNegativeFormat;属性值
注解
positiveFormat
Excel 数据栏中轴右侧所有值的表示形式。
readonly positiveFormat: Excel.ConditionalDataBarPositiveFormat;属性值
注解
showDataBarOnly
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;