Excel.TimelineStyle class

Пакет:

excel

TimelineStyleПредставляет объект , который определяет элементы стиля по регионам на временной шкале.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.10 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
name	Указывает имя стиля временной шкалы.
readOnly	Указывает, доступен ли этот TimelineStyle объект только для чтения.

Методы

delete()	Удаляет стиль таблицы.
duplicate()	Создает дубликат этого стиля временной шкалы с копиями всех элементов стиля.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.TimelineStyle является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.TimelineStyleData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

Сведения о свойстве

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

name

Указывает имя стиля временной шкалы.

name: string;

Значение свойства

string

Комментарии

[ Набор API: ExcelApi 1.10 ]

readOnly

Указывает, доступен ли этот TimelineStyle объект только для чтения.

readonly readOnly: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.10 ]

Сведения о методе

delete()

Удаляет стиль таблицы.

delete(): void;

Возвращаемое значение

void

Комментарии

[ Набор API: ExcelApi 1.10 ]

duplicate()

Создает дубликат этого стиля временной шкалы с копиями всех элементов стиля.

duplicate(): Excel.TimelineStyle;

Возвращаемое значение

Excel.TimelineStyle

Новый TimelineStyle объект, дублированный из этого стиля временной шкалы.

Комментарии

[ Набор API: ExcelApi 1.10 ]

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.TimelineStyleLoadOptions): Excel.TimelineStyle;

Параметры

options

Excel.Interfaces.TimelineStyleLoadOptions

Предоставляет параметры свойств загружаемого объекта.

Возвращаемое значение

Excel.TimelineStyle

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Excel.TimelineStyle

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNamesAndPaths

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

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Excel.TimelineStyle

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.TimelineStyleUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties

Excel.Interfaces.TimelineStyleUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options

OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

Возвращаемое значение

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Excel.TimelineStyle): void;

Параметры

properties

Excel.TimelineStyle

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.TimelineStyle является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.TimelineStyleData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Excel.Interfaces.TimelineStyleData;

Возвращаемое значение

Excel.Interfaces.TimelineStyleData