Excel.ChartAxis class

包:

excel

代表图表中的单个坐标轴。

Extends

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.1 ]

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
format	表示 chart 对象的格式，包括线条和字体格式。
majorGridlines	返回一个 对象，该对象代表指定轴的主要网格线。
majorUnit	表示两个主要刻度标记之间的间隔。 可以设置为数字值或空字符串。 返回的值始终为数字。
maximum	表示数值轴上的最大值。 可以设置为数字值或空字符串（对于自动坐标轴值）。 返回的值始终为数字。
minimum	表示数值轴上的最小值。 可以设置为数字值或空字符串（对于自动坐标轴值）。 返回的值始终为数字。
minorGridlines	返回一个 对象，该对象代表指定轴的次要网格线。
minorUnit	表示两个次要刻度标记之间的间隔。 可以设置为数字值或空字符串（对于自动坐标轴值）。 返回的值始终为数字。
title	表示坐标轴标题。

方法

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.ChartAxis 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.ChartAxisData) ，其中包含原始对象中加载的任何子属性的浅表副本。

属性详细信息

context

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

context: RequestContext;

属性值

Excel.RequestContext

format

表示 chart 对象的格式，包括线条和字体格式。

readonly format: Excel.ChartAxisFormat;

属性值

Excel.ChartAxisFormat

注解

[ API 集：ExcelApi 1.1 ]

majorGridlines

返回一个 对象，该对象代表指定轴的主要网格线。

readonly majorGridlines: Excel.ChartGridlines;

属性值

Excel.ChartGridlines

注解

[ API 集：ExcelApi 1.1 ]

majorUnit

表示两个主要刻度标记之间的间隔。 可以设置为数字值或空字符串。 返回的值始终为数字。

majorUnit: any;

属性值

any

注解

[ API 集：ExcelApi 1.1 ]

maximum

表示数值轴上的最大值。 可以设置为数字值或空字符串（对于自动坐标轴值）。 返回的值始终为数字。

maximum: any;

属性值

any

注解

[ API 集：ExcelApi 1.1 ]

minimum

表示数值轴上的最小值。 可以设置为数字值或空字符串（对于自动坐标轴值）。 返回的值始终为数字。

minimum: any;

属性值

any

注解

[ API 集：ExcelApi 1.1 ]

minorGridlines

返回一个 对象，该对象代表指定轴的次要网格线。

readonly minorGridlines: Excel.ChartGridlines;

属性值

Excel.ChartGridlines

注解

[ API 集：ExcelApi 1.1 ]

minorUnit

表示两个次要刻度标记之间的间隔。 可以设置为数字值或空字符串（对于自动坐标轴值）。 返回的值始终为数字。

minorUnit: any;

属性值

any

注解

[ API 集：ExcelApi 1.1 ]

title

表示坐标轴标题。

readonly title: Excel.ChartAxisTitle;

属性值

Excel.ChartAxisTitle

注解

[ API 集：ExcelApi 1.1 ]

方法详细信息

load(options)

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

load(options?: Excel.Interfaces.ChartAxisLoadOptions): Excel.ChartAxis;

参数

options

Excel.Interfaces.ChartAxisLoadOptions

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

返回

Excel.ChartAxis

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.ChartAxis

示例

// Get the maximum of Chart Axis from Chart1.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    const axis = chart.axes.valueAxis;
    axis.load('maximum');
    await context.sync();

    console.log(axis.maximum);
});

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

Excel.ChartAxis

set(properties, options)

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

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

参数

properties

Excel.Interfaces.ChartAxisUpdateData

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

options

OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Excel.ChartAxis): void;

参数

properties

Excel.ChartAxis

返回

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartAxisData;

返回

Excel.Interfaces.ChartAxisData