Excel.PivotTableScopedCollection class

Пакет:

excel

Представляет коллекцию сводных таблиц с заданной областью. Сводные таблицы сортируются по расположению левого верхнего угла сводной таблицы. Они упорядочены сверху вниз, а затем слева направо.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.12 ]

Свойства

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

Методы

getCount()	Возвращает количество сводных таблиц в коллекции.
getFirst()	Возвращает первую сводную таблицу в коллекции. Сводные таблицы в коллекции сортируются сверху вниз и слева направо, поэтому верхняя левая таблица является первой сводной таблицей в коллекции.
getFirstOrNullObject()	Возвращает первую сводную таблицу в коллекции. Сводные таблицы в коллекции сортируются сверху вниз и слева направо, чтобы верхняя левая таблица была первой сводной таблицей в коллекции. Если коллекция пуста, то этот метод возвращает объект со свойством isNullObject .true Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getItem(key)	Получает сводную таблицу по имени.
getItemOrNullObject(name)	Получает сводную таблицу по имени. Если сводная таблица не существует, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.PivotTableScopedCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.PivotTableScopedCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.

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

context

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

context: RequestContext;

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

Excel.RequestContext

items

Получает загруженные дочерние элементы в этой коллекции.

readonly items: Excel.PivotTable[];

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

Excel.PivotTable[]

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

getCount()

Возвращает количество сводных таблиц в коллекции.

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

Комментарии

[ Набор API: ExcelApi 1.12 ]

getFirst()

Возвращает первую сводную таблицу в коллекции. Сводные таблицы в коллекции сортируются сверху вниз и слева направо, поэтому верхняя левая таблица является первой сводной таблицей в коллекции.

getFirst(): Excel.PivotTable;

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

Excel.PivotTable

Комментарии

[ Набор API: ExcelApi 1.12 ]

getFirstOrNullObject()

Возвращает первую сводную таблицу в коллекции. Сводные таблицы в коллекции сортируются сверху вниз и слева направо, чтобы верхняя левая таблица была первой сводной таблицей в коллекции. Если коллекция пуста, то этот метод возвращает объект со свойством isNullObject .true Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getFirstOrNullObject(): Excel.PivotTable;

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

Excel.PivotTable

Комментарии

[ Набор API: ExcelApi 1.15 ]

getItem(key)

Получает сводную таблицу по имени.

getItem(key: string): Excel.PivotTable;

Параметры

key

string

Имя получаемой сводной таблицы.

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

Excel.PivotTable

Комментарии

[ Набор API: ExcelApi 1.12 ]

getItemOrNullObject(name)

Получает сводную таблицу по имени. Если сводная таблица не существует, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getItemOrNullObject(name: string): Excel.PivotTable;

Параметры

name

string

Имя получаемой сводной таблицы.

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

Excel.PivotTable

Комментарии

[ Набор API: ExcelApi 1.12 ]

load(options)

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

load(options?: Excel.Interfaces.PivotTableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableScopedCollection;

Параметры

options

Excel.Interfaces.PivotTableScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

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

Excel.PivotTableScopedCollection

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.PivotTableScopedCollection

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

OfficeExtension.LoadOption

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

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

Excel.PivotTableScopedCollection

toJSON()

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

toJSON(): Excel.Interfaces.PivotTableScopedCollectionData;

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

Excel.Interfaces.PivotTableScopedCollectionData