Excel.ChartBinOptions class

包:

excel

封装直方图和排列图的容器选项。

扩展

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.9 ]

属性

allowOverflow	指定是在直方图还是直方图中启用箱溢出。
allowUnderflow	指定是在直方图还是直方图中启用 bin 下溢。
context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
count	指定直方图或直方图的箱数。
overflowValue	指定直方图或直方图的箱溢出值。
type	指定直方图或直方图的箱类型。
underflowValue	指定直方图或直方图的箱下溢值。
width	指定直方图或直方图的箱宽度值。

方法

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

属性详细信息

allowOverflow

指定是在直方图还是直方图中启用箱溢出。

allowOverflow: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.9 ]

allowUnderflow

指定是在直方图还是直方图中启用 bin 下溢。

allowUnderflow: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.9 ]

context

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

context: RequestContext;

属性值

Excel.RequestContext

count

指定直方图或直方图的箱数。

count: number;

属性值

number

注解

[ API 集：ExcelApi 1.9 ]

overflowValue

指定直方图或直方图的箱溢出值。

overflowValue: number;

属性值

number

注解

[ API 集：ExcelApi 1.9 ]

type

指定直方图或直方图的箱类型。

type: Excel.ChartBinType | "Category" | "Auto" | "BinWidth" | "BinCount";

属性值

Excel.ChartBinType | "Category" | "Auto" | "BinWidth" | "BinCount"

注解

[ API 集：ExcelApi 1.9 ]

underflowValue

指定直方图或直方图的箱下溢值。

underflowValue: number;

属性值

number

注解

[ API 集：ExcelApi 1.9 ]

width

指定直方图或直方图的箱宽度值。

width: number;

属性值

number

注解

[ API 集：ExcelApi 1.9 ]

方法详细信息

load(options)

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

load(options?: Excel.Interfaces.ChartBinOptionsLoadOptions): Excel.ChartBinOptions;

参数

options

Excel.Interfaces.ChartBinOptionsLoadOptions

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

返回

Excel.ChartBinOptions

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.ChartBinOptions

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

Excel.ChartBinOptions

set(properties, options)

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

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

参数

properties

Excel.Interfaces.ChartBinOptionsUpdateData

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

options

OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Excel.ChartBinOptions): void;

参数

properties

Excel.ChartBinOptions

返回

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartBinOptionsData;

返回

Excel.Interfaces.ChartBinOptionsData