Excel.PivotTable class

Пакет:

excel

Представляет сводную таблицу Excel. Дополнительные сведения об объектной модели сводной таблицы см. в статье Работа со сводными таблицами с помощью API JavaScript для Excel.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.3 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
id	Идентификатор сводной таблицы.
name	Имя сводной таблицы.
worksheet	Лист, содержащий текущую сводную таблицу.

Методы

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

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

context

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

context: RequestContext;

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

Excel.RequestContext

id

Идентификатор сводной таблицы.

readonly id: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.5 ]

name

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

name: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.3 ]

worksheet

Лист, содержащий текущую сводную таблицу.

readonly worksheet: Excel.Worksheet;

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

Excel.Worksheet

Комментарии

[ Набор API: ExcelApi 1.3 ]

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

load(options)

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

load(options?: Excel.Interfaces.PivotTableLoadOptions): Excel.PivotTable;

Параметры

options

Excel.Interfaces.PivotTableLoadOptions

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

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

Excel.PivotTable

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.PivotTable

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.PivotTable

refresh()

Обновляет сводную таблицу.

refresh(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.3 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-refresh.yaml

// This function refreshes the "Farm Sales" PivotTable,
// which updates the PivotTable with changes made to the source table.
await Excel.run(async (context) => {
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  pivotTable.refresh();
  await context.sync();
});

set(properties, options)

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

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

Параметры

properties

Excel.Interfaces.PivotTableUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.PivotTable): void;

Параметры

properties

Excel.PivotTable

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

void

toJSON()

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

toJSON(): Excel.Interfaces.PivotTableData;

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

Excel.Interfaces.PivotTableData