Edit

Share via

Excel.ChartTrendlineLabel class

  • Reference
Package:
excel

This object represents the attributes for a chart trendline label object.

Extends
OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.8 ]

Properties

autoText

Specifies if the trendline label automatically generates appropriate text based on context.
context

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

The format of the chart trendline label.
formula

String value that represents the formula of the chart trendline label using A1-style notation.
height

Returns the height, in points, of the chart trendline label. Value is null if the chart trendline label is not visible.
horizontalAlignment

Represents the horizontal alignment of the chart trendline label. See Excel.ChartTextHorizontalAlignment for details. This property is valid only when TextOrientation of a trendline label is -90, 90, or 180.
left

Represents the distance, in points, from the left edge of the chart trendline label to the left edge of the chart area. Value is null if the chart trendline label is not visible.
linkNumberFormat

Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).
numberFormat

String value that represents the format code for the trendline label.
text

String representing the text of the trendline label on a chart.
textOrientation

Represents the angle to which the text is oriented for the chart trendline label. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text.
top

Represents the distance, in points, from the top edge of the chart trendline label to the top of the chart area. Value is null if the chart trendline label is not visible.
verticalAlignment

Represents the vertical alignment of the chart trendline label. See Excel.ChartTextVerticalAlignment for details. This property is valid only when TextOrientation of a trendline label is 0.
width

Returns the width, in points, of the chart trendline label. Value is null if the chart trendline label is not visible.

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.ChartTrendlineLabel object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartTrendlineLabelData) that contains shallow copies of any loaded child properties from the original object.

Property Details

autoText

Specifies if the trendline label automatically generates appropriate text based on context.

autoText: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

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

format

The format of the chart trendline label.

readonly format: Excel.ChartTrendlineLabelFormat;

Property Value

Excel.ChartTrendlineLabelFormat

Remarks

[ API set: ExcelApi 1.8 ]

formula

String value that represents the formula of the chart trendline label using A1-style notation.

formula: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.8 ]

height

Returns the height, in points, of the chart trendline label. Value is null if the chart trendline label is not visible.

readonly height: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]

horizontalAlignment

Represents the horizontal alignment of the chart trendline label. See Excel.ChartTextHorizontalAlignment for details. This property is valid only when TextOrientation of a trendline label is -90, 90, or 180.

horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";

Property Value

Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"

Remarks

[ API set: ExcelApi 1.8 ]

left

Represents the distance, in points, from the left edge of the chart trendline label to the left edge of the chart area. Value is null if the chart trendline label is not visible.

left: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]

linkNumberFormat

Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).

linkNumberFormat: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

numberFormat

String value that represents the format code for the trendline label.

numberFormat: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.8 ]

text

String representing the text of the trendline label on a chart.

text: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.8 ]

textOrientation

Represents the angle to which the text is oriented for the chart trendline label. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text.

textOrientation: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]

top

Represents the distance, in points, from the top edge of the chart trendline label to the top of the chart area. Value is null if the chart trendline label is not visible.

top: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]

verticalAlignment

Represents the vertical alignment of the chart trendline label. See Excel.ChartTextVerticalAlignment for details. This property is valid only when TextOrientation of a trendline label is 0.

verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";

Property Value

Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"

Remarks

[ API set: ExcelApi 1.8 ]

width

Returns the width, in points, of the chart trendline label. Value is null if the chart trendline label is not visible.

readonly width: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]

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.ChartTrendlineLabelLoadOptions): Excel.ChartTrendlineLabel;

Parameters

options
Excel.Interfaces.ChartTrendlineLabelLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.ChartTrendlineLabel

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.ChartTrendlineLabel;

Parameters

propertyNames

string | string[]

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

Returns

Excel.ChartTrendlineLabel

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.ChartTrendlineLabel;

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

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

Parameters

properties
Excel.Interfaces.ChartTrendlineLabelUpdateData

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

Parameters

properties
Excel.ChartTrendlineLabel

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.ChartTrendlineLabel object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartTrendlineLabelData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ChartTrendlineLabelData;

Returns

Excel.Interfaces.ChartTrendlineLabelData