Excel.TimelineStyleCollection class

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents a collection of TimelineStyles.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Extends
OfficeExtension.ClientObject

Properties

context

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

items

Gets the loaded child items in this collection.

Methods

add(name, makeUniqueName)

Creates a blank TimelineStyle with the specified name.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

getCount()

Gets the number of timeline styles in the collection.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

getDefault()

Gets the default TimelineStyle for the parent object's scope.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

getItem(name)

Gets a TimelineStyle by name.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

getItemOrNullObject(name)

Gets a TimelineStyle by name. If the TimelineStyle does not exist, will return a null object.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

setDefault(newDefaultStyle)

Sets the default TimelineStyle for use in the parent object's scope.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.TimelineStyleCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.TimelineStyleCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

Property Details

context

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

items

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the loaded child items in this collection.

readonly items: Excel.TimelineStyle[];

Property Value

Method Details

add(name, makeUniqueName)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Creates a blank TimelineStyle with the specified name.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

add(name: string, makeUniqueName?: boolean): Excel.TimelineStyle;

Parameters

name
string

The unique name for the new TimelineStyle. Will throw an invalid argument exception if the name is already in use.

makeUniqueName
boolean

Optional, defaults to false. If true, will append numbers to the name in order to make it unique, if needed.

Returns

The newly created TimelineStyle.

getCount()

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the number of timeline styles in the collection.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

getCount(): OfficeExtension.ClientResult<number>;

Returns

OfficeExtension.ClientResult<number>

getDefault()

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the default TimelineStyle for the parent object's scope.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

getDefault(): Excel.TimelineStyle;

Returns

The TimelineStyle object that is the current default TimelineStyle.

getItem(name)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets a TimelineStyle by name.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

getItem(name: string): Excel.TimelineStyle;

Parameters

name
string

Name of the TimelineStyle to be retrieved.

Returns

The TimelineStyle object whose name matches the input.

getItemOrNullObject(name)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets a TimelineStyle by name. If the TimelineStyle does not exist, will return a null object.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

getItemOrNullObject(name: string): Excel.TimelineStyle;

Parameters

name
string

Name of the TimelineStyle to be retrieved.

Returns

The TimelineStyle object whose name matches the input.

load(options)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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.TimelineStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TimelineStyleCollection;

Parameters

options
Excel.Interfaces.TimelineStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Provides options for which properties of the object to load.

Returns

load(propertyNames)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

Parameters

propertyNames
string | string[]

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

Returns

load(propertyNamesAndPaths)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TimelineStyleCollection;

Parameters

propertyNamesAndPaths
OfficeExtension.LoadOption

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

setDefault(newDefaultStyle)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Sets the default TimelineStyle for use in the parent object's scope.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

setDefault(newDefaultStyle: TimelineStyle | string): void;

Parameters

newDefaultStyle
TimelineStyle | string

The TimelineStyle object or name of the TimelineStyle object that should be the new default.

Returns

void

toJSON()

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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.TimelineStyleCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.TimelineStyleCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Excel.Interfaces.TimelineStyleCollectionData;

Returns