Excel.PivotLayout class

Ссылка

Пакет:: excel

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

Extends: OfficeExtension.ClientObject

Свойства

autoFormat	Указывает, будет ли форматирование автоматически отформатировано при обновлении или при перемещении полей.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
enableFieldList	Указывает, можно ли отображать список полей в пользовательском интерфейсе.
layoutType	Это свойство указывает PivotLayoutType всех полей в сводной таблице. Если поля имеют различные состояния, оно будет иметь значение NULL.
preserveFormatting	Указывает, сохраняется ли форматирование при обновлении или пересчете отчета с помощью таких операций, как сводка, сортировка или изменение элементов полей страницы.
showColumnGrandTotals	Указывает, отображается ли в отчете сводной таблицы общие итоги для столбцов.
showRowGrandTotals	Указывает, отображается ли в отчете сводной таблицы общие итоги для строк.
subtotalLocation	Это свойство указывает на `SubtotalLocationType` все поля в сводной таблице. Если поля имеют разные состояния, это будет `null`.

Методы

getColumnLabelRange()	Возвращает диапазон, где находятся названия столбцов сводной таблицы.
getDataBodyRange()	Возвращает диапазон, где находятся значения данных сводной таблицы.
getDataHierarchy(cell)	Получает объект DataHierarchy, использующийся для вычисления значения в указанном диапазоне сводной таблицы.
getFilterAxisRange()	Возвращает диапазон области фильтра сводной таблицы.
getPivotItems(axis, cell)	Получает объекты PivotItem с оси, образующие значение в указанном диапазоне сводной таблицы.
getPivotItems(axisString, cell)	Получает объекты PivotItem с оси, образующие значение в указанном диапазоне сводной таблицы.
getRange()	Возвращает диапазон, в котором существует сводная таблица, за исключением области фильтра.
getRowLabelRange()	Возвращает диапазон, где находятся названия строк сводной таблицы.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
setAutoSortOnCell(cell, sortBy)	Задает для сводной таблицы автоматическую сортировку, используя указанную ячейку, чтобы автоматически выбрать все необходимые условия и контекст. Это работает аналогично применению автоматической сортировки из пользовательского интерфейса.
setAutoSortOnCell(cell, sortByString)	Задает для сводной таблицы автоматическую сортировку, используя указанную ячейку, чтобы автоматически выбрать все необходимые условия и контекст. Это работает аналогично применению автоматической сортировки из пользовательского интерфейса.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный объект Excel.PivotLayout является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Excel.Interfaces.PivotLayoutData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

autoFormat

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

autoFormat: boolean;

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

boolean

context

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

context: RequestContext;

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

Excel.RequestContext

enableFieldList

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

enableFieldList: boolean;

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

boolean

layoutType

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

layoutType: Excel.PivotLayoutType | "Compact" | "Tabular" | "Outline";

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

Excel.PivotLayoutType | "Compact" | "Tabular" | "Outline"

Примеры

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

await Excel.run(async (context) => {
  // Change the PivotLayout.type to a new type.
  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);
});

preserveFormatting

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

preserveFormatting: boolean;

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

boolean

Примеры

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

await Excel.run(async (context) => {
  // Set whether the PivotTable keeps the established format after it is refreshed and recalculated.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.load("preserveFormatting");
  await context.sync();

  let preserveFormattingToSet = !pivotLayout.preserveFormatting;
  console.log(`Preserve the formatting PivotTable after a refresh? - ${preserveFormattingToSet}`);

  pivotLayout.preserveFormatting = preserveFormattingToSet;
  await context.sync();
});

showColumnGrandTotals

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

showColumnGrandTotals: boolean;

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

boolean

Примеры

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

await Excel.run(async (context) => {
  // Turn the grand totals on and off for the rows and columns.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.load(["showRowGrandTotals", "showColumnGrandTotals"]);
  await context.sync();

  let showColumnTotals = !pivotLayout.showColumnGrandTotals;
  let showRowTotals = !pivotLayout.showRowGrandTotals;
  console.log(`Show column grand totals? - ${showColumnTotals}`);
  console.log(`Show row grand totals? - ${showRowTotals}`);

  pivotLayout.showColumnGrandTotals = showColumnTotals;
  pivotLayout.showRowGrandTotals = showRowTotals;

  await context.sync();
});

showRowGrandTotals

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

showRowGrandTotals: boolean;

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

boolean

Примеры

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

await Excel.run(async (context) => {
  // Turn the grand totals on and off for the rows and columns.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.load(["showRowGrandTotals", "showColumnGrandTotals"]);
  await context.sync();

  let showColumnTotals = !pivotLayout.showColumnGrandTotals;
  let showRowTotals = !pivotLayout.showRowGrandTotals;
  console.log(`Show column grand totals? - ${showColumnTotals}`);
  console.log(`Show row grand totals? - ${showRowTotals}`);

  pivotLayout.showColumnGrandTotals = showColumnTotals;
  pivotLayout.showRowGrandTotals = showRowTotals;

  await context.sync();
});

subtotalLocation

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

subtotalLocation: Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off";

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

Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off"

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

getColumnLabelRange()

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

getColumnLabelRange(): Excel.Range;

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

Excel.Range

getDataBodyRange()

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

getDataBodyRange(): Excel.Range;

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

Excel.Range

Примеры

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

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

    // The layout controls the ranges used by the PivotTable.
    const range = pivotTable.layout.getDataBodyRange();

    // Get all the data hierarchy totals.
    const grandTotalRange = range.getLastRow();
    grandTotalRange.load("address");
    await context.sync();
    
    // Use the wholesale and farm sale totals to make a final sum.
    const masterTotalRange = context.workbook.worksheets.getActiveWorksheet().getRange("B27:C27");
    masterTotalRange.formulas = [["All Crates", "=SUM(" + grandTotalRange.address + ")"]];
    await context.sync();
});

getDataHierarchy(cell)

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

getDataHierarchy(cell: Range | string): Excel.DataPivotHierarchy;

Параметры

cell: Excel.Range | string

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

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

Excel.DataPivotHierarchy

Объект DataPivotHierarchy, используемый для вычисления значения в указанной ячейке.

getFilterAxisRange()

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

getFilterAxisRange(): Excel.Range;

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

Excel.Range

getPivotItems(axis, cell)

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

getPivotItems(axis: Excel.PivotAxis, cell: Range | string): Excel.PivotItemCollection;

Параметры

axis: Excel.PivotAxis

Ось, из которой нужно получить PivotItems. Должен иметь значение "строка" или "столбец".

cell: Excel.Range | string

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

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

Excel.PivotItemCollection

PivotItemCollection элемента PivotItems, который используется для вычисления значений в указанной строке.

getPivotItems(axisString, cell)

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

getPivotItems(axisString: "Unknown" | "Row" | "Column" | "Data" | "Filter", cell: Range | string): Excel.PivotItemCollection;

Параметры

axisString: "Unknown" | "Row" | "Column" | "Data" | "Filter"

Ось, из которой нужно получить PivotItems. Должен иметь значение "строка" или "столбец".

cell: Excel.Range | string

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

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

Excel.PivotItemCollection

PivotItemCollection элемента PivotItems, который используется для вычисления значений в указанной строке.

getRange()

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

getRange(): Excel.Range;

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

Excel.Range

getRowLabelRange()

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

getRowLabelRange(): Excel.Range;

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

Excel.Range

load(options)

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

load(options?: Excel.Interfaces.PivotLayoutLoadOptions): Excel.PivotLayout;

Параметры

options: Excel.Interfaces.PivotLayoutLoadOptions

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

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

Excel.PivotLayout

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Excel.PivotLayout

load(propertyNamesAndPaths)

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

Параметры

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

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

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

Excel.PivotLayout

set(properties, options)

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

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

Параметры

properties: Excel.Interfaces.PivotLayoutUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.PivotLayout): void;

Параметры

properties: Excel.PivotLayout

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

void

setAutoSortOnCell(cell, sortBy)

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

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

Параметры

cell: Excel.Range | string

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

sortBy: Excel.SortBy

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

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

void

setAutoSortOnCell(cell, sortByString)

setAutoSortOnCell(cell: Range | string, sortByString: "Ascending" | "Descending"): void;

Параметры

cell: Excel.Range | string

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

sortByString: "Ascending" | "Descending"

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

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

void

toJSON()

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

toJSON(): Excel.Interfaces.PivotLayoutData;

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

Excel.Interfaces.PivotLayoutData

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

Excel.PivotLayout class

Комментарии

Свойства

Методы

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

autoFormat

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

Комментарии

context

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

enableFieldList

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

Комментарии

layoutType

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

Комментарии

Примеры

preserveFormatting

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

Комментарии

Примеры

showColumnGrandTotals

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

Комментарии

Примеры

showRowGrandTotals

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

Комментарии

Примеры

subtotalLocation

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

Комментарии

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

getColumnLabelRange()

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

Комментарии

getDataBodyRange()

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

Комментарии

Примеры

getDataHierarchy(cell)

Параметры

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

Комментарии

getFilterAxisRange()

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

Комментарии

getPivotItems(axis, cell)

Параметры

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

Комментарии

getPivotItems(axisString, cell)

Параметры

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

Комментарии

getRange()

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

Комментарии

getRowLabelRange()

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

setAutoSortOnCell(cell, sortBy)

Параметры

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