Excel.ChartLegend class
表示图表中的图例。
- 扩展
注解
属性
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| format | 表示图表图例的格式，包括填充和字体格式。 |
| height | 指定图表上图例的高度（以磅为单位）。
|
| left | 指定图表上图例的左值（以磅为单位）。
|
| legend |
表示图例中 legendEntries 的集合。 |
| overlay | 指定图表图例是否应与图表的主体重叠。 |
| position | 指定图例在图表上的位置。 有关详细信息，请参阅 |
| show |
指定图例在图表上是否有阴影。 |
| top | 指定图表图例的顶部。 |
| visible | 指定图表图例是否可见。 |
| width | 指定图表上图例的宽度（以磅为单位）。
|
方法
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。 |
| set(properties) | 基于现有的已加载对象，同时对对象设置多个属性。 |
| toJSON() | 重写 JavaScript |
属性详细信息
context
format
表示图表图例的格式，包括填充和字体格式。
readonly format: Excel.ChartLegendFormat;属性值
注解
height
left
legendEntries
表示图例中 legendEntries 的集合。
readonly legendEntries: Excel.ChartLegendEntryCollection;属性值
注解
overlay
position
指定图例在图表上的位置。 有关详细信息，请参阅 Excel.ChartLegendPosition。
position: Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom";属性值
Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom"
注解
showShadow
top
visible
width
方法详细信息
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.ChartLegendLoadOptions): Excel.ChartLegend;参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.ChartLegend;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
示例
// Get the position of Chart Legend from Chart1.
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
const legend = chart.legend;
legend.load('position');
await context.sync();
console.log(legend.position);
});
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartLegend;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties: Interfaces.ChartLegendUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Excel.Interfaces.ChartLegendUpdateData
一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。
返回
void
set(properties)
基于现有的已加载对象，同时对对象设置多个属性。
set(properties: Excel.ChartLegend): void;参数
- properties
- Excel.ChartLegend
返回
void
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，反过来又调用toJSON传递给它的 对象的 方法。) 而原始 Excel.ChartLegend 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象 (类型为 Excel.Interfaces.ChartLegendData) ，该对象包含原始对象中加载的任何子属性的浅表副本。
toJSON(): Excel.Interfaces.ChartLegendData;