Excel.ShapeFill class
表示形状对象的填充格式。
注解
使用方
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-fill-and-line-formatting.yaml
await Excel.run(async (context) => {
// Set fill color and transparency together.
const sheet = context.workbook.worksheets.getItem("Sample");
const badge = sheet.shapes.getItem("Badge");
const shapeFill: Excel.ShapeFill = badge.fill;
shapeFill.foregroundColor = "#C00000";
shapeFill.transparency = 0.25;
await context.sync();
});
属性
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| foreground |
以 HTML 颜色格式表示形状填充前景色，形式 #RRGGBB (例如“FFA500”) 或命名 HTML 颜色 (例如“orange”) |
| transparency | 指定填充的透明度百分比，其值从 0.0 (不透明) 到 1.0 (透明) 。 如果形状类型不支持透明度或形状填充具有不一致的透明度（例如渐变填充类型），则返回 |
| type | 返回形状的填充类型。 有关详细信息，请参阅 |
方法
| clear() | 清除此形状的填充格式。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| set |
将形状的填充格式设置为统一颜色。 这样可将填充类型更改为“Solid”。 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
context
foregroundColor
以 HTML 颜色格式表示形状填充前景色，形式 #RRGGBB (例如“FFA500”) 或命名 HTML 颜色 (例如“orange”)
foregroundColor: string;属性值
string
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-create-and-delete.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Shapes");
const shape: Excel.Shape = sheet.shapes.addGeometricShape(Excel.GeometricShapeType.smileyFace);
shape.left = 300;
shape.top = 100;
shape.height = 100;
shape.width = 100;
shape.fill.foregroundColor = "yellow"
await context.sync();
});
transparency
指定填充的透明度百分比，其值从 0.0 (不透明) 到 1.0 (透明) 。 如果形状类型不支持透明度或形状填充具有不一致的透明度（例如渐变填充类型），则返回 null 。
transparency: number;属性值
number
注解
type
返回形状的填充类型。 有关详细信息，请参阅 Excel.ShapeFillType。
readonly type: Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed";属性值
Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed"
注解
方法详细信息
clear()
清除此形状的填充格式。
clear(): void;返回
void
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-fill-and-line-formatting.yaml
await Excel.run(async (context) => {
// Remove the shape's fill formatting.
const sheet = context.workbook.worksheets.getItem("Sample");
const badge = sheet.shapes.getItem("Badge");
const shapeFill: Excel.ShapeFill = badge.fill;
shapeFill.clear();
await context.sync();
});
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.ShapeFillLoadOptions): Excel.ShapeFill;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.ShapeFill;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ShapeFill;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。
set(properties: Interfaces.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Excel.Interfaces.ShapeFillUpdateData
一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止错误。
返回
void
set(properties)
基于现有加载的对象，同时在对象上设置多个属性。
set(properties: Excel.ShapeFill): void;参数
- properties
- Excel.ShapeFill
返回
void
setSolidColor(color)
将形状的填充格式设置为统一颜色。 这样可将填充类型更改为“Solid”。
setSolidColor(color: string): void;参数
- color
-
string
一个字符串，它以 HTML 颜色格式表示填充颜色，形式 #RRGGBB (例如“FFA500”) 或命名 HTML 颜色 (例如“orange”) 。
返回
void
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-fill-and-line-formatting.yaml
await Excel.run(async (context) => {
// Apply a solid fill color to the shape.
const sheet = context.workbook.worksheets.getItem("Sample");
const badge = sheet.shapes.getItem("Badge");
const shapeFill: Excel.ShapeFill = badge.fill;
shapeFill.setSolidColor("#FFE08A");
await context.sync();
});
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.ShapeFill 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Excel.Interfaces.ShapeFillData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Excel.Interfaces.ShapeFillData;