Excel.PivotTable class

Ссылка

Пакет:: excel

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

Extends: OfficeExtension.ClientObject

Свойства

allowMultipleFiltersPerField	Указывает, допускает ли сводная таблица применение нескольких PivotFilter для заданного сводного поля в таблице.
columnHierarchies	Иерархии сводных столбцов сводной таблицы.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
dataHierarchies	Иерархии сводных данных сводной таблицы.
enableDataValueEditing	Указывает, позволяет ли сводная таблица изменять значения в тексте данных пользователем.
filterHierarchies	Иерархии сводных фильтров сводной таблицы.
hierarchies	Иерархии сводного документа сводной таблицы.
id	Идентификатор сводной таблицы.
layout	PivotLayout, описывающий макет и визуальную структуру сводной таблицы.
name	Имя сводной таблицы.
refreshOnOpen	Указывает, обновляется ли сводная таблица при открытии книги. Соответствует параметру "Обновить при загрузке" в пользовательском интерфейсе.
rowHierarchies	Иерархии сводных строк сводной таблицы.
useCustomSortLists	Указывает, использует ли сводная таблица настраиваемые списки при сортировке.
worksheet	Лист, содержащий текущую сводную таблицу.

Методы

delete()	Удаляет сводную таблицу.
getDataSourceString()	Возвращает строковое представление источника данных для сводной таблицы. В настоящее время этот метод поддерживает строковые представления для объектов таблицы и диапазона. В противном случае возвращается пустая строка.
getDataSourceType()	Возвращает тип источника данных для сводной таблицы.
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`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

allowMultipleFiltersPerField

Указывает, допускает ли сводная таблица применение нескольких PivotFilter для заданного сводного поля в таблице.

allowMultipleFiltersPerField: boolean;

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

boolean

columnHierarchies

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

readonly columnHierarchies: Excel.RowColumnPivotHierarchyCollection;

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

Excel.RowColumnPivotHierarchyCollection

Примеры

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

await Excel.run(async (context) => {
    const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");       

    // Check if the PivotTable already has a column.
    const column = pivotTable.columnHierarchies.getItemOrNullObject("Farm");
    column.load("id");
    await context.sync();

    if (column.isNullObject) {
        // Adding the farm column to the column hierarchy automatically removes it from the row hierarchy.
        pivotTable.columnHierarchies.add(pivotTable.hierarchies.getItem("Farm"));
    } else {
        pivotTable.columnHierarchies.remove(column);
    }

    await context.sync();
});

context

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

context: RequestContext;

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

Excel.RequestContext

dataHierarchies

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

readonly dataHierarchies: Excel.DataPivotHierarchyCollection;

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

Excel.DataPivotHierarchyCollection

Примеры

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

await Excel.run(async (context) => {
    const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
    pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold at Farm"));
    pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold Wholesale"));

    await context.sync();
});

enableDataValueEditing

Указывает, позволяет ли сводная таблица изменять значения в тексте данных пользователем.

enableDataValueEditing: boolean;

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

boolean

filterHierarchies

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

readonly filterHierarchies: Excel.FilterPivotHierarchyCollection;

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

Excel.FilterPivotHierarchyCollection

Примеры

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

async function filter(functionType: Excel.AggregationFunction) {
    await Excel.run(async (context) => {
        const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
        const filters = pivotTable.filterHierarchies;
        const filter = filters.getItemOrNullObject("Classification");
        filter.load();
        await context.sync();

        // Add the Classification hierarchy to the filter, if it's not already there.
        if (filter.isNullObject) {
            filters.add(pivotTable.hierarchies.getItem("Classification"));
            await context.sync();
        }
    });
}

hierarchies

Иерархии сводного документа сводной таблицы.

readonly hierarchies: Excel.PivotHierarchyCollection;

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

Excel.PivotHierarchyCollection

id

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

readonly id: string;

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

string

layout

PivotLayout, описывающий макет и визуальную структуру сводной таблицы.

readonly layout: Excel.PivotLayout;

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

Excel.PivotLayout

Примеры

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

await Excel.run(async (context) => {
    const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
    pivotTable.layout.load("layoutType");
    await context.sync();

    // Cycle between the three layout types.
    if (pivotTable.layout.layoutType === "Compact") {
        pivotTable.layout.layoutType = "Outline";
    } else if (pivotTable.layout.layoutType === "Outline") {
        pivotTable.layout.layoutType = "Tabular";
    } else {
        pivotTable.layout.layoutType = "Compact";
    }
    await context.sync();
    console.log("Pivot layout is now " + pivotTable.layout.layoutType);
});

name

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

name: string;

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

string

refreshOnOpen

Указывает, обновляется ли сводная таблица при открытии книги. Соответствует параметру "Обновить при загрузке" в пользовательском интерфейсе.

refreshOnOpen: boolean;

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

boolean

rowHierarchies

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

readonly rowHierarchies: Excel.RowColumnPivotHierarchyCollection;

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

Excel.RowColumnPivotHierarchyCollection

useCustomSortLists

Указывает, использует ли сводная таблица настраиваемые списки при сортировке.

useCustomSortLists: boolean;

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

boolean

worksheet

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

readonly worksheet: Excel.Worksheet;

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

Excel.Worksheet

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

delete()

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

delete(): void;

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

void

Примеры

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

await Excel.run(async (context) => {
    context.workbook.worksheets.getItem("Pivot").pivotTables.getItem("Farm Sales").delete();

    await context.sync();
});

getDataSourceString()

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

getDataSourceString(): OfficeExtension.ClientResult<string>;

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

OfficeExtension.ClientResult<string>

Примеры

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

// This function logs information about the data source of a PivotTable.
await Excel.run(async (context) => {
  const worksheet = context.workbook.worksheets.getItem("TotalPivot");
  const pivotTable = worksheet.pivotTables.getItem("All Farm Sales");

  // Retrieve the type and string representation of the data source of the PivotTable.
  const pivotTableDataSourceType = pivotTable.getDataSourceType();
  const pivotTableDataSourceString = pivotTable.getDataSourceString();
  await context.sync();

  // Log the data source information.
  console.log("Data source: " + pivotTableDataSourceString.value);
  console.log("Source type: " + pivotTableDataSourceType.value);
});

getDataSourceType()

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

getDataSourceType(): OfficeExtension.ClientResult<Excel.DataSourceType>;

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

OfficeExtension.ClientResult<Excel.DataSourceType>

Примеры

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

// This function logs information about the data source of a PivotTable.
await Excel.run(async (context) => {
  const worksheet = context.workbook.worksheets.getItem("TotalPivot");
  const pivotTable = worksheet.pivotTables.getItem("All Farm Sales");

  // Retrieve the type and string representation of the data source of the PivotTable.
  const pivotTableDataSourceType = pivotTable.getDataSourceType();
  const pivotTableDataSourceString = pivotTable.getDataSourceString();
  await context.sync();

  // Log the data source information.
  console.log("Data source: " + pivotTableDataSourceString.value);
  console.log("Source type: " + pivotTableDataSourceType.value);
});

load(options)

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

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

Параметры

options: Excel.Interfaces.PivotTableLoadOptions

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

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

Excel.PivotTable

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Excel.PivotTable

load(propertyNamesAndPaths)

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

Параметры

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

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

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

Excel.PivotTable

refresh()

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

refresh(): void;

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

void

Примеры

// 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

Поделиться через

Excel.PivotTable class

Комментарии

Свойства

Методы

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

allowMultipleFiltersPerField

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

Комментарии

columnHierarchies

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

Комментарии

Примеры

context

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

dataHierarchies

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

Комментарии

Примеры

enableDataValueEditing

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

Комментарии

filterHierarchies

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

Комментарии

Примеры

hierarchies

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

Комментарии

id

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

Комментарии

layout

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

Комментарии

Примеры

name

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

Комментарии

refreshOnOpen

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

Комментарии

rowHierarchies

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

Комментарии

useCustomSortLists

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

Комментарии

worksheet

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

Комментарии

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

delete()

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

Комментарии

Примеры

getDataSourceString()

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

Комментарии

Примеры

getDataSourceType()

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

Комментарии

Примеры

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

refresh()

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

Комментарии

Примеры

set(properties, options)

Параметры

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