Excel.ChartPoint class

  • 参考
包:
excel

表示图表中某个系列的点。

Extends
OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.1 ]

属性

context

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

返回图表点的数据标签。
format

封装图表点的格式属性。
hasDataLabel

表示数据点是否具有数据标签。 不适用于曲面图。
markerBackgroundColor

数据点标记背景色的 HTML 颜色代码表示形式 (例如，#FF0000 表示红色) 。
markerForegroundColor

数据点标记前景色的 HTML 颜色代码表示形式 (例如，#FF0000 表示红色) 。
markerSize

表示数据点的标记大小。 支持的大小范围为 2 到 72。 如果设置为超出支持范围的大小，此方法将返回 InvalidArgument 错误。
markerStyle

表示图表数据点的标记样式。 有关详细信息，请参阅 Excel.ChartMarkerStyle。
value

返回图表点的值。

方法

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

属性详细信息

context

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

context: RequestContext;

属性值

Excel.RequestContext

dataLabel

返回图表点的数据标签。

readonly dataLabel: Excel.ChartDataLabel;

属性值

Excel.ChartDataLabel

注解

[ API 集：ExcelApi 1.7 ]

format

封装图表点的格式属性。

readonly format: Excel.ChartPointFormat;

属性值

Excel.ChartPointFormat

注解

[ API 集：ExcelApi 1.1 ]

hasDataLabel

表示数据点是否具有数据标签。 不适用于曲面图。

hasDataLabel: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.7 ]

markerBackgroundColor

数据点标记背景色的 HTML 颜色代码表示形式 (例如，#FF0000 表示红色) 。

markerBackgroundColor: string;

属性值

string

注解

[ API 集：ExcelApi 1.7 ]

markerForegroundColor

数据点标记前景色的 HTML 颜色代码表示形式 (例如，#FF0000 表示红色) 。

markerForegroundColor: string;

属性值

string

注解

[ API 集：ExcelApi 1.7 ]

markerSize

表示数据点的标记大小。 支持的大小范围为 2 到 72。 如果设置为超出支持范围的大小，此方法将返回 InvalidArgument 错误。

markerSize: number;

属性值

number

注解

[ API 集：ExcelApi 1.7 ]

markerStyle

表示图表数据点的标记样式。 有关详细信息，请参阅 Excel.ChartMarkerStyle。

markerStyle: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture";

属性值

Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture"

注解

[ API 集：ExcelApi 1.7 ]

value

返回图表点的值。

readonly value: any;

属性值

any

注解

[ API 集：ExcelApi 1.1 ]

方法详细信息

load(options)

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

load(options?: Excel.Interfaces.ChartPointLoadOptions): Excel.ChartPoint;

参数

options
Excel.Interfaces.ChartPointLoadOptions

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

返回

Excel.ChartPoint

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.ChartPoint

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

Excel.ChartPoint

set(properties, options)

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

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

参数

properties
Excel.Interfaces.ChartPointUpdateData

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

options
OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Excel.ChartPoint): void;

参数

properties
Excel.ChartPoint

返回

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartPointData;

返回

Excel.Interfaces.ChartPointData