Excel.ChartLineFormat class
Warning
This API is now deprecated.
Encapsulates the formatting options for line elements.
- Extends
Remarks
Properties
color | HTML color code representing the color of lines in the chart. |
context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
Methods
clear() | Clears the line format of a chart element. |
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 |
Property Details
color
Warning
This API is now deprecated.
HTML color code representing the color of lines in the chart.
color: string;
Property Value
string
Remarks
context
Warning
This API is now deprecated.
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
Method Details
clear()
Warning
This API is now deprecated.
Clears the line format of a chart element.
clear(): void;
Returns
void
Remarks
Examples
// Clear the format of the major gridlines on Chart1.
await Excel.run(async (context) => {
const gridlines = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").axes.valueAxis.majorGridlines;
gridlines.format.line.clear();
await context.sync();
console.log("Chart Major Gridlines Format Cleared");
});
load(options)
Warning
This API is now deprecated.
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.ChartLineFormatLoadOptions): Excel.ChartLineFormat;
Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Warning
This API is now deprecated.
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.ChartLineFormat;
Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
Examples
// Set chart major gridlines on value axis to be red.
await Excel.run(async (context) => {
const gridlines = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").axes.valueAxis.majorGridlines;
gridlines.format.line.color = "#FF0000";
await context.sync()
console.log("Chart Gridlines Color Updated");
});
load(propertyNamesAndPaths)
Warning
This API is now deprecated.
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.ChartLineFormat;
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
set(properties, options)
Warning
This API is now deprecated.
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.ChartLineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parameters
- properties
- Excel.Interfaces.ChartLineFormatUpdateData
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)
Warning
This API is now deprecated.
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: Excel.ChartLineFormat): void;
Parameters
- properties
- Excel.ChartLineFormat
Returns
void
toJSON()
Warning
This API is now deprecated.
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.ChartLineFormat
object is an API object, the toJSON
method returns a plain JavaScript object (typed as Excel.Interfaces.ChartLineFormatData
) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Excel.Interfaces.ChartLineFormatData;
Returns
Office Add-ins