Excel.ChartAxes class
表示图表坐标轴。
- 扩展
注解
属性
| category |
表示图表中的类别轴。 |
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| series |
表示三维图表的系列轴。 |
| value |
表示坐标轴中的数值轴。 |
方法
| get |
返回通过类型和组标识的特定轴。 |
| get |
返回通过类型和组标识的特定轴。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。 |
| set(properties) | 基于现有的已加载对象，同时对对象设置多个属性。 |
| toJSON() | 重写 JavaScript |
属性详细信息
categoryAxis
context
seriesAxis
valueAxis
表示坐标轴中的数值轴。
readonly valueAxis: Excel.ChartAxis;属性值
注解
示例
// Set the maximum, minimum, majorUnit, minorUnit of valueAxis.
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.axes.valueAxis.maximum = 5;
chart.axes.valueAxis.minimum = 0;
chart.axes.valueAxis.majorUnit = 1;
chart.axes.valueAxis.minorUnit = 0.2;
await context.sync();
console.log("Axis Settings Changed");
});
方法详细信息
getItem(type, group)
返回通过类型和组标识的特定轴。
getItem(type: Excel.ChartAxisType, group?: Excel.ChartAxisGroup): Excel.ChartAxis;参数
- type
- Excel.ChartAxisType
指定坐标轴类型。 有关详细信息，请参阅 Excel.ChartAxisType。
- group
- Excel.ChartAxisGroup
可选。 指定坐标轴组。 有关详细信息，请参阅 Excel.ChartAxisGroup。
返回
注解
getItem(typeString, groupString)
返回通过类型和组标识的特定轴。
getItem(typeString: "Invalid" | "Category" | "Value" | "Series", groupString?: "Primary" | "Secondary"): Excel.ChartAxis;参数
- typeString
-
"Invalid" | "Category" | "Value" | "Series"
指定坐标轴类型。 有关详细信息，请参阅 Excel.ChartAxisType。
- groupString
-
"Primary" | "Secondary"
可选。 指定坐标轴组。 有关详细信息，请参阅 Excel.ChartAxisGroup。
返回
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.ChartAxesLoadOptions): Excel.ChartAxes;参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.ChartAxes;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartAxes;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties: Interfaces.ChartAxesUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Excel.Interfaces.ChartAxesUpdateData
一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。
返回
void
set(properties)
基于现有的已加载对象，同时对对象设置多个属性。
set(properties: Excel.ChartAxes): void;参数
- properties
- Excel.ChartAxes
返回
void
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，依次调用toJSON传递给它的 对象的 方法。) 而原始 Excel.ChartAxes 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.ChartAxesData) ，该对象包含从原始对象加载的任何子属性的浅表副本。
toJSON(): Excel.Interfaces.ChartAxesData;