Excel.ChartDataLabel class

表示图表点的数据标签。

扩展

注解

[ API 集:ExcelApi 1.7 ]

属性

autoText

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

context

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

format

表示图表数据标签的格式。

formula

该字符串值表示采用 A1 表示法的图表数据标签的公式。

height

返回图表数据标签的高度,以磅为单位。 null如果图表数据标签不可见,则值为 。

horizontalAlignment

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

left

表示图表数据标签左边缘到图表区域左边缘的距离,以磅为单位。 null如果图表数据标签不可见,则值为 。

linkNumberFormat

指定数字格式是否链接到单元格 (以便数字格式在单元格) 更改时标签中更改。

numberFormat

该字符串值表示数据标签的格式代码。

position

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

separator

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

showBubbleSize

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

showCategoryName

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

showLegendKey

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

showPercentage

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

showSeriesName

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

showValue

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

text

该字符串表示图表上的数据标签文本。

textOrientation

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

top

表示图表数据标签上边缘到图表区域顶部的距离,以磅为单位。 null如果图表数据标签不可见,则值为 。

verticalAlignment

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

width

返回图表数据标签的宽度,以磅为单位。 null如果图表数据标签不可见,则值为 。

方法

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

属性详细信息

autoText

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

autoText: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.8 ]

context

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

context: RequestContext;

属性值

format

表示图表数据标签的格式。

readonly format: Excel.ChartDataLabelFormat;

属性值

注解

[ API 集:ExcelApi 1.8 ]

formula

该字符串值表示采用 A1 表示法的图表数据标签的公式。

formula: string;

属性值

string

注解

[ API 集:ExcelApi 1.8 ]

height

返回图表数据标签的高度,以磅为单位。 null如果图表数据标签不可见,则值为 。

readonly height: number;

属性值

number

注解

[ API 集:ExcelApi 1.8 ]

horizontalAlignment

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

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

属性值

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

注解

[ API 集:ExcelApi 1.8 ]

left

表示图表数据标签左边缘到图表区域左边缘的距离,以磅为单位。 null如果图表数据标签不可见,则值为 。

left: number;

属性值

number

注解

[ API 集:ExcelApi 1.8 ]

linkNumberFormat

指定数字格式是否链接到单元格 (以便数字格式在单元格) 更改时标签中更改。

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.7 ]

separator

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

separator: string;

属性值

string

注解

[ API 集:ExcelApi 1.7 ]

showBubbleSize

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

showBubbleSize: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.7 ]

showCategoryName

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

showCategoryName: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.7 ]

showLegendKey

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

showLegendKey: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.7 ]

showPercentage

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

showPercentage: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.7 ]

showSeriesName

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

showSeriesName: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.7 ]

showValue

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

showValue: boolean;

属性值

boolean

注解

[ API 集:ExcelApi 1.7 ]

text

该字符串表示图表上的数据标签文本。

text: string;

属性值

string

注解

[ API 集:ExcelApi 1.8 ]

textOrientation

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

textOrientation: number;

属性值

number

注解

[ API 集:ExcelApi 1.8 ]

top

表示图表数据标签上边缘到图表区域顶部的距离,以磅为单位。 null如果图表数据标签不可见,则值为 。

top: number;

属性值

number

注解

[ API 集:ExcelApi 1.8 ]

verticalAlignment

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

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

属性值

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

注解

[ API 集:ExcelApi 1.8 ]

width

返回图表数据标签的宽度,以磅为单位。 null如果图表数据标签不可见,则值为 。

readonly width: number;

属性值

number

注解

[ API 集:ExcelApi 1.8 ]

方法详细信息

load(options)

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

load(options?: Excel.Interfaces.ChartDataLabelLoadOptions): Excel.ChartDataLabel;

参数

options
Excel.Interfaces.ChartDataLabelLoadOptions

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

返回

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

set(properties, options)

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

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

参数

properties
Excel.Interfaces.ChartDataLabelUpdateData

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

options
OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Excel.ChartDataLabel): void;

参数

返回

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartDataLabelData;

返回