Excel.IterativeCalculation class

Представляет параметры итеративного вычисления.

Extends

Комментарии

Набор API: ExcelApi 1.9

Используется

Свойства

context

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

enabled

Значение true, если в Excel используется итерация для разрешения циклических ссылок.

maxChange

Указывает максимальное количество изменений между каждой итерацией, так как Excel разрешает циклические ссылки.

maxIteration

Определяет максимальное количество итераций, которое Excel может использовать для разрешения циклической ссылки.

Методы

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.IterativeCalculation объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.IterativeCalculationData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

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

context

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

context: RequestContext;

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

enabled

Значение true, если в Excel используется итерация для разрешения циклических ссылок.

enabled: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.9

maxChange

Указывает максимальное количество изменений между каждой итерацией, так как Excel разрешает циклические ссылки.

maxChange: number;

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

number

Комментарии

Набор API: ExcelApi 1.9

maxIteration

Определяет максимальное количество итераций, которое Excel может использовать для разрешения циклической ссылки.

maxIteration: number;

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

number

Комментарии

Набор API: ExcelApi 1.9

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

load(options)

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

load(options?: Excel.Interfaces.IterativeCalculationLoadOptions): Excel.IterativeCalculation;

Параметры

options
Excel.Interfaces.IterativeCalculationLoadOptions

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

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

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

set(properties, options)

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

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

Параметры

properties
Excel.Interfaces.IterativeCalculationUpdateData

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

options
OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.IterativeCalculation): void;

Параметры

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

void

toJSON()

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

toJSON(): Excel.Interfaces.IterativeCalculationData;

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