ExcelScript.PivotTable interface

Пакет:

ExcelScript

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

Комментарии

Примеры

/**
 * This script creates a PivotTable from an existing table and adds it to a new worksheet.
 * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a PivotTable based on a table in the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let table = sheet.getTables()[0];

  // Add the PivotTable to a new worksheet.
  let newSheet = workbook.addWorksheet("Pivot");
  let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");

  // Add fields to the PivotTable to show "Sales" per "Type".
  pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
  pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
}

Методы

addColumnHierarchy(pivotHierarchy)	Добавляет PivotHierarchy к текущей оси. Если иерархия присутствует в другом месте строки, столбца или оси фильтра, она будет удалена из этого расположения.
addDataHierarchy(pivotHierarchy)	Добавляет PivotHierarchy к текущей оси.
addFilterHierarchy(pivotHierarchy)	Добавляет PivotHierarchy к текущей оси. Если иерархия присутствует в другом месте строки, столбца или оси фильтра, она будет удалена из этого расположения.
addRowHierarchy(pivotHierarchy)	Добавляет PivotHierarchy к текущей оси. Если иерархия присутствует в другом месте строки, столбца или оси фильтра, она будет удалена из этого расположения.
delete()	Удаляет сводную таблицу.
getAllowMultipleFiltersPerField()	Указывает, допускает ли сводная таблица применение нескольких PivotFilter для заданного сводного поля в таблице.
getColumnHierarchies()	Иерархии сводных столбцов сводной таблицы.
getColumnHierarchy(name)	Получает RowColumnPivotHierarchy по имени. Если rowColumnPivotHierarchy не существует, этот метод возвращает undefined.
getDataHierarchies()	Иерархии сводных данных сводной таблицы.
getDataHierarchy(name)	Получает DataPivotHierarchy по имени. Если DataPivotHierarchy не существует, этот метод возвращает undefined.
getEnableDataValueEditing()	Указывает, позволяет ли сводная таблица изменять значения в тексте данных пользователем.
getFilterHierarchies()	Иерархии сводных фильтров сводной таблицы.
getFilterHierarchy(name)	Получает FilterPivotHierarchy по имени. Если filterPivotHierarchy не существует, этот метод возвращает undefined.
getHierarchies()	Иерархии сводного документа сводной таблицы.
getHierarchy(name)	Получает PivotHierarchy по имени. Если сводная иерархия не существует, этот метод возвращает undefined.
getId()	Идентификатор сводной таблицы.
getLayout()	PivotLayout, описывающий макет и визуальную структуру сводной таблицы.
getName()	Имя сводной таблицы.
getRowHierarchies()	Иерархии сводных строк сводной таблицы.
getRowHierarchy(name)	Получает RowColumnPivotHierarchy по имени. Если rowColumnPivotHierarchy не существует, этот метод возвращает undefined.
getUseCustomSortLists()	Указывает, использует ли сводная таблица настраиваемые списки при сортировке.
getWorksheet()	Лист, содержащий текущую сводную таблицу.
refresh()	Обновляет сводную таблицу.
removeColumnHierarchy(rowColumnPivotHierarchy)	Удаляет PivotHierarchy из текущей оси.
removeDataHierarchy(DataPivotHierarchy)	Удаляет PivotHierarchy из текущей оси.
removeFilterHierarchy(filterPivotHierarchy)	Удаляет PivotHierarchy из текущей оси.
removeRowHierarchy(rowColumnPivotHierarchy)	Удаляет PivotHierarchy из текущей оси.
setAllowMultipleFiltersPerField(allowMultipleFiltersPerField)	Указывает, допускает ли сводная таблица применение нескольких PivotFilter для заданного сводного поля в таблице.
setEnableDataValueEditing(enableDataValueEditing)	Указывает, позволяет ли сводная таблица изменять значения в тексте данных пользователем.
setName(name)	Имя сводной таблицы.
setUseCustomSortLists(useCustomSortLists)	Указывает, использует ли сводная таблица настраиваемые списки при сортировке.

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

addColumnHierarchy(pivotHierarchy)

Добавляет PivotHierarchy к текущей оси. Если иерархия присутствует в другом месте строки, столбца или оси фильтра, она будет удалена из этого расположения.

addColumnHierarchy(
            pivotHierarchy: PivotHierarchy
        ): RowColumnPivotHierarchy;

Параметры

pivotHierarchy

ExcelScript.PivotHierarchy

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

ExcelScript.RowColumnPivotHierarchy

Примеры

/**
 * This script adds a row hierarchy to the PivotTable on the current worksheet.
 * This assumes the source data has columns named 
 * "Type", "Classification", and "Sales".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable on the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let pivotTable = sheet.getPivotTables()[0];

  // Add the field "Type" to the PivotTable as a row hierarchy.
  pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));

  // Add the field "Classification" to the PivotTable as a column hierarchy.
  pivotTable.addColumnHierarchy(pivotTable.getHierarchy("Classification"));

  // Add the field "Sales" to the PivotTable as a data hierarchy.
  // By default, this displays the sums of the values in "Sales" based on the "Type".
  pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
}

addDataHierarchy(pivotHierarchy)

Добавляет PivotHierarchy к текущей оси.

addDataHierarchy(pivotHierarchy: PivotHierarchy): DataPivotHierarchy;

Параметры

pivotHierarchy

ExcelScript.PivotHierarchy

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

ExcelScript.DataPivotHierarchy

Примеры

/**
 * This script creates a PivotTable from an existing table and adds it to a new worksheet.
 * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a PivotTable based on a table in the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let table = sheet.getTables()[0];

  // Add the PivotTable to a new worksheet.
  let newSheet = workbook.addWorksheet("Pivot");
  let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");

  // Add fields to the PivotTable to show "Sales" per "Type".
  pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
  pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
}

addFilterHierarchy(pivotHierarchy)

Добавляет PivotHierarchy к текущей оси. Если иерархия присутствует в другом месте строки, столбца или оси фильтра, она будет удалена из этого расположения.

addFilterHierarchy(
            pivotHierarchy: PivotHierarchy
        ): FilterPivotHierarchy;

Параметры

pivotHierarchy

ExcelScript.PivotHierarchy

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

ExcelScript.FilterPivotHierarchy

Примеры

/**
 * This script adds a manual filter to a PivotTable. 
 */
function main(workbook: ExcelScript.Workbook)
{
  // Get the first PivotTable in the workbook.
  const pivot = workbook.getPivotTables()[0];

  // Get the hierarchy to use as the filter.
  const location = pivot.getHierarchy("Location");

  // Use "Location" as the FilterHierarchy.
  pivot.addFilterHierarchy(location);

  // Select items for the filter.
  // Note that hierarchies and fields have a 1:1 relationship in Excel,
  // so `getFields()[0]` always gets the correct field.
  location.getFields()[0].applyFilter({
    manualFilter: {
      selectedItems: ["Seattle", "Chicago"]
    }
  });
}

addRowHierarchy(pivotHierarchy)

Добавляет PivotHierarchy к текущей оси. Если иерархия присутствует в другом месте строки, столбца или оси фильтра, она будет удалена из этого расположения.

addRowHierarchy(
            pivotHierarchy: PivotHierarchy
        ): RowColumnPivotHierarchy;

Параметры

pivotHierarchy

ExcelScript.PivotHierarchy

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

ExcelScript.RowColumnPivotHierarchy

Примеры

/**
 * This script creates a PivotTable from an existing table and adds it to a new worksheet.
 * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a PivotTable based on a table in the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let table = sheet.getTables()[0];

  // Add the PivotTable to a new worksheet.
  let newSheet = workbook.addWorksheet("Pivot");
  let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");

  // Add fields to the PivotTable to show "Sales" per "Type".
  pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
  pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
}

delete()

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

delete(): void;

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

void

getAllowMultipleFiltersPerField()

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

getAllowMultipleFiltersPerField(): boolean;

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

boolean

getColumnHierarchies()

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

getColumnHierarchies(): RowColumnPivotHierarchy[];

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

ExcelScript.RowColumnPivotHierarchy[]

getColumnHierarchy(name)

Получает RowColumnPivotHierarchy по имени. Если rowColumnPivotHierarchy не существует, этот метод возвращает undefined.

getColumnHierarchy(name: string): RowColumnPivotHierarchy | undefined;

Параметры

name

string

Имя извлекаемой иерархии RowColumnPivotHierarchy.

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

ExcelScript.RowColumnPivotHierarchy | undefined

getDataHierarchies()

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

getDataHierarchies(): DataPivotHierarchy[];

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

ExcelScript.DataPivotHierarchy[]

getDataHierarchy(name)

Получает DataPivotHierarchy по имени. Если DataPivotHierarchy не существует, этот метод возвращает undefined.

getDataHierarchy(name: string): DataPivotHierarchy | undefined;

Параметры

name

string

Имя извлекаемой dataPivotHierarchy.

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

ExcelScript.DataPivotHierarchy | undefined

getEnableDataValueEditing()

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

getEnableDataValueEditing(): boolean;

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

boolean

getFilterHierarchies()

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

getFilterHierarchies(): FilterPivotHierarchy[];

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

ExcelScript.FilterPivotHierarchy[]

getFilterHierarchy(name)

Получает FilterPivotHierarchy по имени. Если filterPivotHierarchy не существует, этот метод возвращает undefined.

getFilterHierarchy(name: string): FilterPivotHierarchy | undefined;

Параметры

name

string

Имя извлекаемого объекта FilterPivotHierarchy.

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

ExcelScript.FilterPivotHierarchy | undefined

getHierarchies()

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

getHierarchies(): PivotHierarchy[];

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

ExcelScript.PivotHierarchy[]

getHierarchy(name)

Получает PivotHierarchy по имени. Если сводная иерархия не существует, этот метод возвращает undefined.

getHierarchy(name: string): PivotHierarchy | undefined;

Параметры

name

string

Имя извлекаемой сводной иерархии.

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

ExcelScript.PivotHierarchy | undefined

getId()

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

getId(): string;

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

string

getLayout()

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

getLayout(): PivotLayout;

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

ExcelScript.PivotLayout

Примеры

/**
 * This script sets the layout of the "Farms Sales" PivotTable to the "tabular"
 * setting. This places the fields from the Rows area in separate columns.
 */ 
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Sales".
  const pivot = workbook.getPivotTable("Farm Sales");

  // Get the PivotLayout object.
  const layout = pivot.getLayout();

  // Set the layout type to "tabular".
  layout.setLayoutType(ExcelScript.PivotLayoutType.tabular);
}

getName()

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

getName(): string;

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

string

getRowHierarchies()

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

getRowHierarchies(): RowColumnPivotHierarchy[];

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

ExcelScript.RowColumnPivotHierarchy[]

getRowHierarchy(name)

Получает RowColumnPivotHierarchy по имени. Если rowColumnPivotHierarchy не существует, этот метод возвращает undefined.

getRowHierarchy(name: string): RowColumnPivotHierarchy | undefined;

Параметры

name

string

Имя извлекаемой иерархии RowColumnPivotHierarchy.

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

ExcelScript.RowColumnPivotHierarchy | undefined

Примеры

/**
 * This sample sorts the rows of a PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get an existing PivotTable.
  const pivotTable = workbook.getPivotTable("Farm Sales");

  // Get the data hierarchy to use as the basis of the sort.
  const valueFieldToSortOn = pivotTable.getDataHierarchy("Sum of Crates Sold Wholesale");

  // Get the row to sort.
  const rowToSort = pivotTable.getRowHierarchy("Farm");

  // Sort the "Farm" row's only field by the values in "Sum of Crates Sold Wholesale".
  rowToSort.getFields()[0].sortByValues(ExcelScript.SortBy.descending, valueFieldToSortOn);
}

getUseCustomSortLists()

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

getUseCustomSortLists(): boolean;

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

boolean

getWorksheet()

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

getWorksheet(): Worksheet;

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

ExcelScript.Worksheet

refresh()

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

refresh(): void;

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

void

removeColumnHierarchy(rowColumnPivotHierarchy)

Удаляет PivotHierarchy из текущей оси.

removeColumnHierarchy(
            rowColumnPivotHierarchy: RowColumnPivotHierarchy
        ): void;

Параметры

rowColumnPivotHierarchy

ExcelScript.RowColumnPivotHierarchy

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

void

removeDataHierarchy(DataPivotHierarchy)

Удаляет PivotHierarchy из текущей оси.

removeDataHierarchy(DataPivotHierarchy: DataPivotHierarchy): void;

Параметры

DataPivotHierarchy

ExcelScript.DataPivotHierarchy

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

void

removeFilterHierarchy(filterPivotHierarchy)

Удаляет PivotHierarchy из текущей оси.

removeFilterHierarchy(filterPivotHierarchy: FilterPivotHierarchy): void;

Параметры

filterPivotHierarchy

ExcelScript.FilterPivotHierarchy

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

void

removeRowHierarchy(rowColumnPivotHierarchy)

Удаляет PivotHierarchy из текущей оси.

removeRowHierarchy(
            rowColumnPivotHierarchy: RowColumnPivotHierarchy
        ): void;

Параметры

rowColumnPivotHierarchy

ExcelScript.RowColumnPivotHierarchy

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

void

setAllowMultipleFiltersPerField(allowMultipleFiltersPerField)

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

setAllowMultipleFiltersPerField(
            allowMultipleFiltersPerField: boolean
        ): void;

Параметры

allowMultipleFiltersPerField

boolean

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

void

setEnableDataValueEditing(enableDataValueEditing)

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

setEnableDataValueEditing(enableDataValueEditing: boolean): void;

Параметры

enableDataValueEditing

boolean

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

void

setName(name)

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

setName(name: string): void;

Параметры

name

string

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

void

setUseCustomSortLists(useCustomSortLists)

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

setUseCustomSortLists(useCustomSortLists: boolean): void;

Параметры

useCustomSortLists

boolean

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

void