Excel.DataBarConditionalFormat class
表示 Excel 条件数据条类型。
属性
| axis |
表示轴线颜色的 HTML 颜色代码，#RRGGBB (形式，例如“FFA500”) 或命名 HTML 颜色 (，例如“orange”) 。 如果不存在或设置了任何轴，则值为空字符串 () 为“”。 |
| 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 颜色 (，例如“orange”) 。 如果不存在或设置了任何轴，则值为空字符串 () 为“”。
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;