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

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

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

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