Excel.ChartErrorBars class

Package:

excel

This object represents the attributes for a chart's error bars.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.9 ]

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
endStyleCap	Specifies if error bars have an end style cap.
format	Specifies the formatting type of the error bars.
include	Specifies which parts of the error bars to include.
type	The type of range marked by the error bars.
visible	Specifies whether the error bars are displayed.

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's passed to it.) Whereas the original Excel.ChartErrorBars object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartErrorBarsData) that contains shallow copies of any loaded child properties from the original object.

Property Details

context

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

TypeScript

context: RequestContext;

Property Value

Excel.RequestContext

endStyleCap

Specifies if error bars have an end style cap.

TypeScript

endStyleCap: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

format

Specifies the formatting type of the error bars.

TypeScript

readonly format: Excel.ChartErrorBarsFormat;

Property Value

Excel.ChartErrorBarsFormat

Remarks

[ API set: ExcelApi 1.9 ]

include

Specifies which parts of the error bars to include.

TypeScript

include: Excel.ChartErrorBarsInclude | "Both" | "MinusValues" | "PlusValues";

Property Value

Excel.ChartErrorBarsInclude | "Both" | "MinusValues" | "PlusValues"

Remarks

[ API set: ExcelApi 1.9 ]

type

The type of range marked by the error bars.

TypeScript

type: Excel.ChartErrorBarsType | "FixedValue" | "Percent" | "StDev" | "StError" | "Custom";

Property Value

Excel.ChartErrorBarsType | "FixedValue" | "Percent" | "StDev" | "StError" | "Custom"

Remarks

[ API set: ExcelApi 1.9 ]

visible

Specifies whether the error bars are displayed.

TypeScript

visible: boolean;

Property Value

boolean

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.

TypeScript

load(options?: Excel.Interfaces.ChartErrorBarsLoadOptions): Excel.ChartErrorBars;

Parameters

options

Excel.Interfaces.ChartErrorBarsLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.ChartErrorBars

load(propertyNames)

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

TypeScript

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

Parameters

propertyNames

string | string[]

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

Returns

Excel.ChartErrorBars

load(propertyNamesAndPaths)

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

TypeScript

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

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

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.

TypeScript

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

Parameters

properties

Excel.Interfaces.ChartErrorBarsUpdateData

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.

TypeScript

set(properties: Excel.ChartErrorBars): void;

Parameters

properties

Excel.ChartErrorBars

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's passed to it.) Whereas the original Excel.ChartErrorBars object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartErrorBarsData) that contains shallow copies of any loaded child properties from the original object.

TypeScript

toJSON(): Excel.Interfaces.ChartErrorBarsData;

Returns

Excel.Interfaces.ChartErrorBarsData