Excel.ChartBinOptions class

Package:

excel

Encapsulates the bin options for histogram charts and pareto charts.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.9 ]

Properties

allowOverflow	Specifies if bin overflow is enabled in a histogram chart or pareto chart.
allowUnderflow	Specifies if bin underflow is enabled in a histogram chart or pareto chart.
context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
count	Specifies the bin count of a histogram chart or pareto chart.
overflowValue	Specifies the bin overflow value of a histogram chart or pareto chart.
type	Specifies the bin's type for a histogram chart or pareto chart.
underflowValue	Specifies the bin underflow value of a histogram chart or pareto chart.
width	Specifies the bin width value of a histogram chart or pareto chart.

Methods

load(options)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
set(properties, options)	Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties)	Sets multiple properties on the object at the same time, based on an existing loaded object.
toJSON()	Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ChartBinOptions object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartBinOptionsData) that contains shallow copies of any loaded child properties from the original object.

Property Details

allowOverflow

Specifies if bin overflow is enabled in a histogram chart or pareto chart.

allowOverflow: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

allowUnderflow

Specifies if bin underflow is enabled in a histogram chart or pareto chart.

allowUnderflow: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Excel.RequestContext

count

Specifies the bin count of a histogram chart or pareto chart.

count: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

overflowValue

Specifies the bin overflow value of a histogram chart or pareto chart.

overflowValue: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

type

Specifies the bin's type for a histogram chart or pareto chart.

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

Property Value

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

Remarks

[ API set: ExcelApi 1.9 ]

underflowValue

Specifies the bin underflow value of a histogram chart or pareto chart.

underflowValue: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

width

Specifies the bin width value of a histogram chart or pareto chart.

width: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

Method Details

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

options

Excel.Interfaces.ChartBinOptionsLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.ChartBinOptions

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Excel.ChartBinOptions

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

propertyNamesAndPaths

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

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

Excel.ChartBinOptions

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

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

Parameters

properties

Excel.Interfaces.ChartBinOptionsUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options

OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.ChartBinOptions): void;

Parameters

properties

Excel.ChartBinOptions

Returns

void

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ChartBinOptions object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartBinOptionsData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ChartBinOptionsData;

Returns

Excel.Interfaces.ChartBinOptionsData