Excel.ChartDataLabels class

表示图表点上的所有数据标签的集合。

扩展

注解

[ API 集:ExcelApi 1.1 ]

属性

autoText

指定数据标签是否根据上下文自动生成适当的文本。

context

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

format

指定图表数据标签的格式,其中包括填充和字体格式。

horizontalAlignment

指定图表数据标签的水平对齐方式。 有关详细信息,请参阅 Excel.ChartTextHorizontalAlignment。 仅当数据标签的 为 0 时, TextOrientation 此属性才有效。

linkNumberFormat

指定数字格式是否链接到单元格。 如果 true为 ,则当单元格中更改时,标签中的数字格式将更改。

numberFormat

指定数据标签的格式代码。

position

表示数据标签位置的值。 有关详细信息,请参阅 Excel.ChartDataLabelPosition

separator

表示用于图表中数据标签的分隔符的字符串。

showBubbleSize

指定数据标签气泡大小是否可见。

showCategoryName

指定数据标签类别名称是否可见。

showLegendKey

指定数据标签图例键是否可见。

showPercentage

指定数据标签百分比是否可见。

showSeriesName

指定数据标签系列名称是否可见。

showValue

指定数据标签值是否可见。

textOrientation

表示文本针对数据标签的方向。 对于垂直方向文本,该值应为 -90 到 90 的整数或整数 180。

verticalAlignment

表示图表数据标签垂直对齐。 有关详细信息,请参阅 Excel.ChartTextVerticalAlignment。 仅当数据标签为 -90、90 或 180 时 TextOrientation ,此属性才有效。

方法

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

属性详细信息

autoText

指定数据标签是否根据上下文自动生成适当的文本。

autoText: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.8 ]

context

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

context: RequestContext;

属性值

format

指定图表数据标签的格式,其中包括填充和字体格式。

readonly format: Excel.ChartDataLabelFormat;

属性值

注解

[ API 集:ExcelApi 1.1 ]

horizontalAlignment

指定图表数据标签的水平对齐方式。 有关详细信息,请参阅 Excel.ChartTextHorizontalAlignment。 仅当数据标签的 为 0 时, TextOrientation 此属性才有效。

horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";

属性值

Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"

注解

[ API 集:ExcelApi 1.8 ]

linkNumberFormat

指定数字格式是否链接到单元格。 如果 true为 ,则当单元格中更改时,标签中的数字格式将更改。

linkNumberFormat: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.9 ]

numberFormat

指定数据标签的格式代码。

numberFormat: string;

属性值

string

注解

[ API 集:ExcelApi 1.8 ]

position

表示数据标签位置的值。 有关详细信息,请参阅 Excel.ChartDataLabelPosition

position: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout";

属性值

Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout"

注解

[ API 集:ExcelApi 1.1 ]

separator

表示用于图表中数据标签的分隔符的字符串。

separator: string;

属性值

string

注解

[ API 集:ExcelApi 1.1 ]

showBubbleSize

指定数据标签气泡大小是否可见。

showBubbleSize: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.1 ]

showCategoryName

指定数据标签类别名称是否可见。

showCategoryName: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.1 ]

showLegendKey

指定数据标签图例键是否可见。

showLegendKey: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.1 ]

showPercentage

指定数据标签百分比是否可见。

showPercentage: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.1 ]

showSeriesName

指定数据标签系列名称是否可见。

showSeriesName: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.1 ]

showValue

指定数据标签值是否可见。

showValue: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.1 ]

textOrientation

表示文本针对数据标签的方向。 对于垂直方向文本,该值应为 -90 到 90 的整数或整数 180。

textOrientation: number;

属性值

number

注解

[ API 集:ExcelApi 1.8 ]

verticalAlignment

表示图表数据标签垂直对齐。 有关详细信息,请参阅 Excel.ChartTextVerticalAlignment。 仅当数据标签为 -90、90 或 180 时 TextOrientation ,此属性才有效。

verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";

属性值

Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"

注解

[ API 集:ExcelApi 1.8 ]

方法详细信息

load(options)

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

load(options?: Excel.Interfaces.ChartDataLabelsLoadOptions): Excel.ChartDataLabels;

参数

options
Excel.Interfaces.ChartDataLabelsLoadOptions

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

返回

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

示例

// Show the series name in data labels and set the position of the data labels to "top".
await Excel.run(async (context) => {
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
    chart.dataLabels.showValue = true;
    chart.dataLabels.position = Excel.ChartDataLabelPosition.top;
    chart.dataLabels.showSeriesName = true;
    await context.sync();

    console.log("Data labels shown");
});

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

set(properties, options)

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

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

参数

properties
Excel.Interfaces.ChartDataLabelsUpdateData

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

options
OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Excel.ChartDataLabels): void;

参数

返回

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartDataLabelsData;

返回