Excel.ShapeLineFormat class
表示形状对象的线条格式。 对于图像和几何形状，线条格式表示形状的边框。
属性
| color | 以 HTML 颜色格式表示线条颜色，形式 #RRGGBB (例如“FFA500”) 或命名 HTML 颜色 (例如“orange”) 。 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| dash |
表示形状的线条样式。 在线条不可见或存在不一致的虚线样式时返回 |
| style | 表示形状的线条样式。 线条不可见或样式不一致时返回 |
| transparency | 将指定线条的透明度表示为从 0.0（不透明）到 1.0（清晰）的值。 当形状具有不一致的透明度时返回 |
| visible | 指定形状元素的线条格式是否可见。 当形状具有不一致的可见性时返回 |
| weight | 表示线条的粗细（以磅为单位）。 当线条不可见或线条粗细不一致时返回 |
方法
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
color
以 HTML 颜色格式表示线条颜色，形式 #RRGGBB (例如“FFA500”) 或命名 HTML 颜色 (例如“orange”) 。
color: string;属性值
string
注解
context
dashStyle
表示形状的线条样式。 在线条不可见或存在不一致的虚线样式时返回 null 。 有关详细信息，请参阅 Excel.ShapeLineDashStyle。
dashStyle: Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";属性值
Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot"
注解
style
表示形状的线条样式。 线条不可见或样式不一致时返回 null 。 有关详细信息，请参阅 Excel.ShapeLineStyle。
style: Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";属性值
Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"
注解
transparency
将指定线条的透明度表示为从 0.0（不透明）到 1.0（清晰）的值。 当形状具有不一致的透明度时返回 null 。
transparency: number;属性值
number
注解
visible
指定形状元素的线条格式是否可见。 当形状具有不一致的可见性时返回 null 。
visible: boolean;属性值
boolean
注解
示例
// 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) => {
// Hide the shape's outline.
const sheet = context.workbook.worksheets.getItem("Sample");
const badge = sheet.shapes.getItem("Badge");
const lineFormat: Excel.ShapeLineFormat = badge.lineFormat;
lineFormat.visible = false;
await context.sync();
});
weight
方法详细信息
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.ShapeLineFormatLoadOptions): Excel.ShapeLineFormat;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.ShapeLineFormat;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ShapeLineFormat;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。
set(properties: Interfaces.ShapeLineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Excel.Interfaces.ShapeLineFormatUpdateData
一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止错误。
返回
void
set(properties)
基于现有加载的对象，同时在对象上设置多个属性。
set(properties: Excel.ShapeLineFormat): void;参数
- properties
- Excel.ShapeLineFormat
返回
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 outline formatting to the shape.
const sheet = context.workbook.worksheets.getItem("Sample");
const badge = sheet.shapes.getItem("Badge");
const lineFormat: Excel.ShapeLineFormat = badge.lineFormat;
lineFormat.set({
color: "#C55A11",
dashStyle: Excel.ShapeLineDashStyle.dashDotDot,
style: Excel.ShapeLineStyle.thinThick,
transparency: 0.2,
visible: true,
weight: 4
});
await context.sync();
});
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.ShapeLineFormat 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Excel.Interfaces.ShapeLineFormatData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Excel.Interfaces.ShapeLineFormatData;