ExcelScript.PivotLayout interface

Пакет:

ExcelScript

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

Методы

getAutoFormat()	Указывает, будет ли форматирование автоматически отформатировано при обновлении или при перемещении полей.
getBodyAndTotalRange()	Возвращает диапазон, где находятся значения данных сводной таблицы.
getColumnLabelRange()	Возвращает диапазон, где находятся названия столбцов сводной таблицы.
getDataHierarchy(cell)	Получает объект DataHierarchy, использующийся для вычисления значения в указанном диапазоне сводной таблицы.
getEnableFieldList()	Указывает, можно ли отображать список полей в пользовательском интерфейсе.
getFilterAxisRange()	Возвращает диапазон области фильтра сводной таблицы.
getLayoutType()	Это свойство указывает PivotLayoutType всех полей в сводной таблице. Если поля имеют различные состояния, оно будет иметь значение NULL.
getPreserveFormatting()	Указывает, сохраняется ли форматирование при обновлении или пересчете отчета с помощью таких операций, как сводка, сортировка или изменение элементов полей страницы.
getRange()	Возвращает диапазон, в котором существует сводная таблица, за исключением области фильтра.
getRowLabelRange()	Возвращает диапазон, где находятся названия строк сводной таблицы.
getShowColumnGrandTotals()	Указывает, отображается ли в отчете сводной таблицы общие итоги для столбцов.
getShowRowGrandTotals()	Указывает, отображается ли в отчете сводной таблицы общие итоги для строк.
getSubtotalLocation()	Это свойство указывает на SubtotalLocationType все поля в сводной таблице. Если поля имеют разные состояния, это будет null.
setAutoFormat(autoFormat)	Указывает, будет ли форматирование автоматически отформатировано при обновлении или при перемещении полей.
setAutoSortOnCell(cell, sortBy)	Задает для сводной таблицы автоматическую сортировку, используя указанную ячейку, чтобы автоматически выбрать все необходимые условия и контекст. Это работает аналогично применению автоматической сортировки из пользовательского интерфейса.
setEnableFieldList(enableFieldList)	Указывает, можно ли отображать список полей в пользовательском интерфейсе.
setLayoutType(layoutType)	Это свойство указывает PivotLayoutType всех полей в сводной таблице. Если поля имеют различные состояния, оно будет иметь значение NULL.
setPreserveFormatting(preserveFormatting)	Указывает, сохраняется ли форматирование при обновлении или пересчете отчета с помощью таких операций, как сводка, сортировка или изменение элементов полей страницы.
setShowColumnGrandTotals(showColumnGrandTotals)	Указывает, отображается ли в отчете сводной таблицы общие итоги для столбцов.
setShowRowGrandTotals(showRowGrandTotals)	Указывает, отображается ли в отчете сводной таблицы общие итоги для строк.
setSubtotalLocation(subtotalLocation)	Это свойство указывает на SubtotalLocationType все поля в сводной таблице. Если поля имеют разные состояния, это будет null.

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

getAutoFormat()

Указывает, будет ли форматирование автоматически отформатировано при обновлении или при перемещении полей.

getAutoFormat(): boolean;

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

boolean

getBodyAndTotalRange()

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

getBodyAndTotalRange(): Range;

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

ExcelScript.Range

Примеры

/**
 * This sample finds the first PivotTable in the workbook and logs the values in the "Grand Total" cells.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first PivotTable in the workbook.
  let pivotTable = workbook.getPivotTables()[0];

  // Get the names of each data column in the PivotTable.
  let pivotColumnLabelRange = pivotTable.getLayout().getColumnLabelRange();

  // Get the range displaying the pivoted data.
  let pivotDataRange = pivotTable.getLayout().getBodyAndTotalRange();

  // Get the range with the "grand totals" for the PivotTable columns.
  let grandTotalRange = pivotDataRange.getLastRow();

  // Print each of the "Grand Totals" to the console.
  grandTotalRange.getValues()[0].forEach((column, columnIndex) => {
    console.log(`Grand total of ${pivotColumnLabelRange.getValues()[0][columnIndex]}: ${grandTotalRange.getValues()[0][columnIndex]}`);
    // Example log: "Grand total of Sum of Crates Sold Wholesale: 11000"
  });
}

getColumnLabelRange()

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

getColumnLabelRange(): Range;

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

ExcelScript.Range

getDataHierarchy(cell)

Получает объект DataHierarchy, использующийся для вычисления значения в указанном диапазоне сводной таблицы.

getDataHierarchy(cell: Range | string): DataPivotHierarchy;

Параметры

cell

ExcelScript.Range | string

Одна ячейка в теле данных сводной таблицы.

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

ExcelScript.DataPivotHierarchy

getEnableFieldList()

Указывает, можно ли отображать список полей в пользовательском интерфейсе.

getEnableFieldList(): boolean;

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

boolean

getFilterAxisRange()

Возвращает диапазон области фильтра сводной таблицы.

getFilterAxisRange(): Range;

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

ExcelScript.Range

getLayoutType()

Это свойство указывает PivotLayoutType всех полей в сводной таблице. Если поля имеют различные состояния, оно будет иметь значение NULL.

getLayoutType(): PivotLayoutType;

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

ExcelScript.PivotLayoutType

getPreserveFormatting()

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

getPreserveFormatting(): boolean;

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

boolean

getRange()

Возвращает диапазон, в котором существует сводная таблица, за исключением области фильтра.

getRange(): Range;

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

ExcelScript.Range

getRowLabelRange()

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

getRowLabelRange(): Range;

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

ExcelScript.Range

getShowColumnGrandTotals()

Указывает, отображается ли в отчете сводной таблицы общие итоги для столбцов.

getShowColumnGrandTotals(): boolean;

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

boolean

getShowRowGrandTotals()

Указывает, отображается ли в отчете сводной таблицы общие итоги для строк.

getShowRowGrandTotals(): boolean;

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

boolean

getSubtotalLocation()

Это свойство указывает на SubtotalLocationType все поля в сводной таблице. Если поля имеют разные состояния, это будет null.

getSubtotalLocation(): SubtotalLocationType;

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

ExcelScript.SubtotalLocationType

setAutoFormat(autoFormat)

Указывает, будет ли форматирование автоматически отформатировано при обновлении или при перемещении полей.

setAutoFormat(autoFormat: boolean): void;

Параметры

autoFormat

boolean

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

void

setAutoSortOnCell(cell, sortBy)

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

setAutoSortOnCell(cell: Range | string, sortBy: SortBy): void;

Параметры

cell

ExcelScript.Range | string

Одна ячейка для использования получает условия для применения автосорта.

sortBy

ExcelScript.SortBy

Направление сортировки.

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

void

setEnableFieldList(enableFieldList)

Указывает, можно ли отображать список полей в пользовательском интерфейсе.

setEnableFieldList(enableFieldList: boolean): void;

Параметры

enableFieldList

boolean

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

void

setLayoutType(layoutType)

Это свойство указывает PivotLayoutType всех полей в сводной таблице. Если поля имеют различные состояния, оно будет иметь значение NULL.

setLayoutType(layoutType: PivotLayoutType): void;

Параметры

layoutType

ExcelScript.PivotLayoutType

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

void

Примеры

/**
 * 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);
}

setPreserveFormatting(preserveFormatting)

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

setPreserveFormatting(preserveFormatting: boolean): void;

Параметры

preserveFormatting

boolean

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

void

setShowColumnGrandTotals(showColumnGrandTotals)

Указывает, отображается ли в отчете сводной таблицы общие итоги для столбцов.

setShowColumnGrandTotals(showColumnGrandTotals: boolean): void;

Параметры

showColumnGrandTotals

boolean

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

void

setShowRowGrandTotals(showRowGrandTotals)

Указывает, отображается ли в отчете сводной таблицы общие итоги для строк.

setShowRowGrandTotals(showRowGrandTotals: boolean): void;

Параметры

showRowGrandTotals

boolean

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

void

setSubtotalLocation(subtotalLocation)

Это свойство указывает на SubtotalLocationType все поля в сводной таблице. Если поля имеют разные состояния, это будет null.

setSubtotalLocation(subtotalLocation: SubtotalLocationType): void;

Параметры

subtotalLocation

ExcelScript.SubtotalLocationType

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

void

Примеры

/**
 * This script displays group subtotals of the "Farms Sales" PivotTable.
 */
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();

  // Show all the subtotals at the bottom of each group.
  layout.setSubtotalLocation(ExcelScript.SubtotalLocationType.atBottom);
}