Excel.ChartLineFormat class

包:

excel

封装行元素的格式设置选项。

扩展

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.1 ]

属性

color	表示图表中的线条颜色的 HTML 颜色代码。
context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
lineStyle	表示线条样式。 有关详细信息，请参阅 Excel.ChartLineStyle。
weight	表示线条的粗细（以磅为单位）。

方法

clear()	清除图表元素的线条格式。
load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
set(properties, options)	同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties)	基于现有的已加载对象，同时对对象设置多个属性。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始Excel.ChartLineFormat对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.ChartLineFormatData) ，其中包含原始对象中任何已加载子属性的浅表副本。

属性详细信息

color

表示图表中的线条颜色的 HTML 颜色代码。

color: string;

属性值

string

注解

[ API 集：ExcelApi 1.1 ]

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Excel.RequestContext

lineStyle

表示线条样式。 有关详细信息，请参阅 Excel.ChartLineStyle。

lineStyle: Excel.ChartLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | "Grey75" | "Automatic" | "RoundDot";

属性值

Excel.ChartLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Grey25" | "Grey50" | "Grey75" | "Automatic" | "RoundDot"

注解

[ API 集：ExcelApi 1.7 ]

weight

表示线条的粗细（以磅为单位）。

weight: number;

属性值

number

注解

[ API 集：ExcelApi 1.7 ]

方法详细信息

clear()

清除图表元素的线条格式。

clear(): void;

返回

void

注解

[ API 集：ExcelApi 1.1 ]

示例

// Clear the format of the major gridlines on Chart1. 
await Excel.run(async (context) => { 
    const gridlines = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").axes.valueAxis.majorGridlines;
    gridlines.format.line.clear();
    await context.sync();
    
    console.log("Chart Major Gridlines Format Cleared");
});

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Excel.Interfaces.ChartLineFormatLoadOptions): Excel.ChartLineFormat;

参数

options

Excel.Interfaces.ChartLineFormatLoadOptions

提供要加载对象的属性的选项。

返回

Excel.ChartLineFormat

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): Excel.ChartLineFormat;

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

Excel.ChartLineFormat

示例

// Set chart major gridlines on value axis to be red.
await Excel.run(async (context) => {
    const gridlines = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").axes.valueAxis.majorGridlines;
    gridlines.format.line.color = "#FF0000";
    await context.sync()
    
    console.log("Chart Gridlines Color Updated");
});

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ChartLineFormat;

参数

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

返回

Excel.ChartLineFormat

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

set(properties: Interfaces.ChartLineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

properties

Excel.Interfaces.ChartLineFormatUpdateData

一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。

options

OfficeExtension.UpdateOptions

提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Excel.ChartLineFormat): void;

参数

properties

Excel.ChartLineFormat

返回

void

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始Excel.ChartLineFormat对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.ChartLineFormatData) ，其中包含原始对象中任何已加载子属性的浅表副本。

toJSON(): Excel.Interfaces.ChartLineFormatData;

返回

Excel.Interfaces.ChartLineFormatData