Excel.PivotLayout class

Пакет:

excel

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

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.8 ]

Свойства

altTextDescription	Замещающее текстовое описание сводной таблицы. Замещающий текст предоставляет альтернативные текстовые представления сведений, содержащихся в сводной таблице. Эта информация полезна для людей с нарушениями зрения или когнитивными нарушениями, которые могут не видеть или понимать таблицу. Заголовок может быть прочитан лицу с ограниченными возможностями и используется для определения того, хотят ли они услышать описание содержимого.
altTextTitle	Замещающий заголовок сводной таблицы. Замещающий текст предоставляет альтернативные текстовые представления сведений, содержащихся в сводной таблице. Эта информация полезна для людей с нарушениями зрения или когнитивными нарушениями, которые могут не видеть или понимать таблицу. Заголовок может быть прочитан лицу с ограниченными возможностями и используется для определения того, хотят ли они услышать описание содержимого.
autoFormat	Указывает, будет ли форматирование автоматически отформатировано при обновлении или при перемещении полей.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
emptyCellText	Текст, который автоматически заполняется в любую пустую ячейку в сводной таблице, если .fillEmptyCells == true Обратите внимание на то, что это значение сохраняется, если fillEmptyCells задано значение false, и при установке этого значения для этого свойства не задано значение true. По умолчанию это пустая строка.
enableFieldList	Указывает, можно ли отображать список полей в пользовательском интерфейсе.
fillEmptyCells	Указывает, должны ли пустые ячейки в сводной таблице заполняться emptyCellText. По умолчанию используется значение false. Обратите внимание, что значение emptyCellText сохраняется, если для этого свойства задано значение false.
layoutType	Это свойство указывает PivotLayoutType всех полей в сводной таблице. Если поля имеют различные состояния, оно будет иметь значение NULL.
pivotStyle	Стиль, применяемый к сводной таблице.
preserveFormatting	Указывает, сохраняется ли форматирование при обновлении или пересчете отчета с помощью таких операций, как сводка, сортировка или изменение элементов полей страницы.
showColumnGrandTotals	Указывает, отображается ли в отчете сводной таблицы общие итоги для столбцов.
showFieldHeaders	Указывает, отображает ли сводная таблица заголовки полей (заголовки полей и раскрывающиеся списки фильтров).
showRowGrandTotals	Указывает, отображается ли в отчете сводной таблицы общие итоги для строк.
subtotalLocation	Это свойство указывает на SubtotalLocationType все поля в сводной таблице. Если поля имеют разные состояния, это будет null.

Методы

displayBlankLineAfterEachItem(display)	Задает, следует ли отображать пустую строку после каждого элемента. Он задается на глобальном уровне для сводной таблицы и применяется к отдельным сводных полям. Эта функция перезаписывает параметр для всех полей в сводной таблице на значение display параметра .
getCell(dataHierarchy, rowItems, columnItems)	Получает уникальную ячейку в сводной таблице на основе иерархии данных и элементов строк и столбцов соответствующих иерархий. Возвращаемая ячейка находится на пересечении указанной строки и столбца, содержащего данные из заданной иерархии. Этот метод является обратным вызовом getPivotItems и getDataHierarchy для определенной ячейки.
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().
repeatAllItemLabels(repeatLabels)	Задает параметр "повторять все метки элементов" во всех полях сводной таблицы.
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
setAutoSortOnCell(cell, sortBy)	Задает для сводной таблицы автоматическую сортировку, используя указанную ячейку, чтобы автоматически выбрать все необходимые условия и контекст. Это работает аналогично применению автоматической сортировки из пользовательского интерфейса.
setAutoSortOnCell(cell, sortByString)	Задает для сводной таблицы автоматическую сортировку, используя указанную ячейку, чтобы автоматически выбрать все необходимые условия и контекст. Это работает аналогично применению автоматической сортировки из пользовательского интерфейса.
setStyle(style)	Задает стиль, применяемый к сводной таблице.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.PivotLayout является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.PivotLayoutData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

altTextDescription

Замещающее текстовое описание сводной таблицы.

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

altTextDescription: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.13 ]

Примеры

// 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 the alt text for the displayed PivotTable.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.altTextTitle = "Farm Sales PivotTable";
  pivotLayout.altTextDescription = "A summary of fruit sales. It is pivoted on farm name, and fruit type. The aggregated data is both the sums of crates sold at the farms and the sums of crates sold wholesale.";
  console.log("Adding alt text. Check the PivotTable settings to see the changes.");

  await context.sync();
});

altTextTitle

Замещающий заголовок сводной таблицы.

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

altTextTitle: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.13 ]

autoFormat

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

autoFormat: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

context

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

context: RequestContext;

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

Excel.RequestContext

emptyCellText

Текст, который автоматически заполняется в любую пустую ячейку в сводной таблице, если .fillEmptyCells == true Обратите внимание на то, что это значение сохраняется, если fillEmptyCells задано значение false, и при установке этого значения для этого свойства не задано значение true. По умолчанию это пустая строка.

emptyCellText: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.13 ]

Примеры

// 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 a default value for an empty cell in the PivotTable. This doesn't include cells left blank by the layout.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.emptyCellText = "--";

  // Set the text alignment to match the rest of the PivotTable.
  pivotLayout.getDataBodyRange().format.horizontalAlignment = Excel.HorizontalAlignment.right;
  await context.sync();
});

enableFieldList

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

enableFieldList: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.10 ]

fillEmptyCells

Указывает, должны ли пустые ячейки в сводной таблице заполняться emptyCellText. По умолчанию используется значение false. Обратите внимание, что значение emptyCellText сохраняется, если для этого свойства задано значение false.

fillEmptyCells: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.13 ]

Примеры

// 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) => {
  // Toggle whether empty cells are filled with a default value.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

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

  let fillToSet = !pivotLayout.fillEmptyCells;
  console.log(`Filling empty cells? - ${fillToSet}`);

  pivotLayout.fillEmptyCells = fillToSet;
  await context.sync();
});

layoutType

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

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

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

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

Комментарии

[ Набор API: ExcelApi 1.8 ]

Примеры

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

pivotStyle

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

readonly pivotStyle: Excel.PivotTableStyle;

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

Excel.PivotTableStyle

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

preserveFormatting

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

preserveFormatting: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

Примеры

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

Комментарии

[ Набор API: ExcelApi 1.8 ]

Примеры

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

showFieldHeaders

Указывает, отображает ли сводная таблица заголовки полей (заголовки полей и раскрывающиеся списки фильтров).

showFieldHeaders: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.13 ]

Примеры

// 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 field headers on and off for the row and column hierarchies.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;
  pivotLayout.load("showFieldHeaders");
  await context.sync();

  let showHeaders = !pivotLayout.showFieldHeaders;
  console.log(`Show field headers? - ${showHeaders}`);
  pivotLayout.showFieldHeaders = showHeaders;
  await context.sync();
});

showRowGrandTotals

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

showRowGrandTotals: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.8 ]

Примеры

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

Комментарии

[ Набор API: ExcelApi 1.8 ]

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

displayBlankLineAfterEachItem(display)

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

displayBlankLineAfterEachItem(display: boolean): void;

Параметры

display

boolean

Значение True включает параметр отображения пустой строки. Значение False отключает его.

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

void

Комментарии

[ Набор API: ExcelApi 1.13 ]

Примеры

// 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) => {
  // Add a blank row after each PivotItem in the row hierarchy.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.displayBlankLineAfterEachItem(true);
  console.log("Setting `PivotLayout.displayBlankLineAfterEachItem` to true.");

  await context.sync();
});

getCell(dataHierarchy, rowItems, columnItems)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Получает уникальную ячейку в сводной таблице на основе иерархии данных и элементов строк и столбцов соответствующих иерархий. Возвращаемая ячейка находится на пересечении указанной строки и столбца, содержащего данные из заданной иерархии. Этот метод является обратным вызовом getPivotItems и getDataHierarchy для определенной ячейки.

getCell(dataHierarchy: DataPivotHierarchy | string, rowItems: Array<PivotItem | string>, columnItems: Array<PivotItem | string>): Excel.Range;

Параметры

dataHierarchy

Excel.DataPivotHierarchy | string

Объект dataHierarchy , предоставляющий элемент данных для поиска.

rowItems

Array<Excel.PivotItem | string>

PivotItems из оси строк, составляющих искомое значение.

columnItems

Array<Excel.PivotItem | string>

PivotItems из оси столбца, которая состоит из искомого значения.

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

Excel.Range

Диапазон, указывающий одну ячейку, содержащую указанное значение.

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

getColumnLabelRange()

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

getColumnLabelRange(): Excel.Range;

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

Excel.Range

Комментарии

[ Набор API: ExcelApi 1.8 ]

getDataBodyRange()

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

getDataBodyRange(): Excel.Range;

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

Excel.Range

Комментарии

[ Набор API: ExcelApi 1.8 ]

Примеры

// 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, используемый для вычисления значения в указанной ячейке.

Комментарии

[ Набор API: ExcelApi 1.9 ]

getFilterAxisRange()

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

getFilterAxisRange(): Excel.Range;

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

Excel.Range

Комментарии

[ Набор API: ExcelApi 1.8 ]

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, который используется для вычисления значений в указанной строке.

Комментарии

[ Набор API: ExcelApi 1.9 ]

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, который используется для вычисления значений в указанной строке.

Комментарии

[ Набор API: ExcelApi 1.9 ]

getRange()

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

getRange(): Excel.Range;

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

Excel.Range

Комментарии

[ Набор API: ExcelApi 1.8 ]

getRowLabelRange()

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

getRowLabelRange(): Excel.Range;

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

Excel.Range

Комментарии

[ Набор API: ExcelApi 1.8 ]

load(options)

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

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

Параметры

options

Excel.Interfaces.PivotLayoutLoadOptions

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

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

Excel.PivotLayout

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.PivotLayout

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.PivotLayout

repeatAllItemLabels(repeatLabels)

Задает параметр "повторять все метки элементов" во всех полях сводной таблицы.

repeatAllItemLabels(repeatLabels: boolean): void;

Параметры

repeatLabels

boolean

Значение True включает параметр отображения повторения меток. Значение False отключает его.

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

void

Комментарии

[ Набор API: ExcelApi 1.13 ]

Примеры

// 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) => {
  // Repeat the PivotItem labels for each row used by another level of the row hierarchy.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.repeatAllItemLabels(true);
  console.log("Setting `PivotLayout.repeatAllItemLabels` to true.");

  await context.sync();
});

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

Комментарии

[ Набор API: ExcelApi 1.9 ]

setAutoSortOnCell(cell, sortByString)

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

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

Параметры

cell

Excel.Range | string

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

sortByString

"Ascending" | "Descending"

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

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

void

Комментарии

[ Набор API: ExcelApi 1.9 ]

setStyle(style)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

setStyle(style: string | PivotTableStyle | BuiltInPivotTableStyle): void;

Параметры

style

string | Excel.PivotTableStyle | Excel.BuiltInPivotTableStyle

Стиль, применяемый к сводной таблице. Если InvalidArgumentException указана строка, не соответствующая имени какого-либо стиля, возникает исключение .

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

void

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

toJSON()

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

toJSON(): Excel.Interfaces.PivotLayoutData;

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

Excel.Interfaces.PivotLayoutData