This browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Note
Access to this page requires authorization. You can trysigning in orchanging directories.
Access to this page requires authorization. You can trychanging directories.
Represents the substring in chart related objects that contain text, like aChartTitle
object orChartAxisTitle
object.
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. |
load(options) | Queues up a command to load the specified properties of the object. You must call |
load(property | Queues up a command to load the specified properties of the object. You must call |
load(property | Queues up a command to load the specified properties of the object. You must call |
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 |
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;
Represents the font attributes, such as font name, font size, and color of a chart characters object.
readonly font: Excel.ChartFont;
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;
Provides options for which properties of the object to load.
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;
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
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;
{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.
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;
A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
Provides an option to suppress errors if the properties object tries to set any read-only properties.
void
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: Excel.ChartFormatString): void;
void
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;
Was this page helpful?
Was this page helpful?