Movatterモバイル変換


[0]ホーム

URL:


Skip to main contentSkip to in-page navigation

This browser is no longer supported.

Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.

Download Microsoft EdgeMore info about Internet Explorer and Microsoft Edge
Table of contentsExit focus mode

Excel.ChartFormatString class

Package:
excel

Represents the substring in chart related objects that contain text, like aChartTitle object orChartAxisTitle object.

Properties

context

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

font

Represents the font attributes, such as font name, font size, and color of a chart characters object.

Methods

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must callcontext.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 JavaScripttoJSON() method in order to provide more useful output when an API object is passed toJSON.stringify(). (JSON.stringify, in turn, calls thetoJSON method of the object that's passed to it.) Whereas the originalExcel.ChartFormatString object is an API object, thetoJSON method returns a plain JavaScript object (typed asExcel.Interfaces.ChartFormatStringData) 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.

context: RequestContext;

Property Value

font

Represents the font attributes, such as font name, font size, and color of a chart characters object.

readonly font: Excel.ChartFont;

Property Value

Remarks

[API set: ExcelApi 1.7 ]

Method Details

load(options)

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

load(options?: Excel.Interfaces.ChartFormatStringLoadOptions): Excel.ChartFormatString;

Parameters

options
Excel.Interfaces.ChartFormatStringLoadOptions

Provides options for which properties of the object to load.

Returns

load(propertyNames)

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

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

Parameters

propertyNames

string | string[]

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

Returns

load(propertyNamesAndPaths)

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

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

Parameters

propertyNamesAndPaths

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

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

Returns

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.ChartFormatStringUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties
Excel.Interfaces.ChartFormatStringUpdateData

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.ChartFormatString): void;

Parameters

Returns

void

toJSON()

Overrides the JavaScripttoJSON() method in order to provide more useful output when an API object is passed toJSON.stringify(). (JSON.stringify, in turn, calls thetoJSON method of the object that's passed to it.) Whereas the originalExcel.ChartFormatString object is an API object, thetoJSON method returns a plain JavaScript object (typed asExcel.Interfaces.ChartFormatStringData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ChartFormatStringData;

Returns

Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, seeour contributor guide.

Feedback

Was this page helpful?

YesNo

In this article

Was this page helpful?

YesNo