Excel.PivotLayout class

Пакет:

excel

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

Extends

OfficeExtension.ClientObject

Комментарии

Набор API: ExcelApi 1.8

Используется

• Excel.Сводная таблица: макет

Свойства

altTextDescription	Замещающий текст сводной таблицы. Замещающий текст предоставляет альтернативные текстовые представления информации, содержащейся в сводной таблице. Эта информация полезна для людей со зрением или когнитивными нарушениями, которым может быть сложно увидеть или понять таблицу. Заголовок может быть прочитан человеку с ограниченными возможностями и используется для определения того, хочет ли он услышать описание содержимого.
altTextTitle	Заголовок сводной таблицы с замещающим текстом. Замещающий текст предоставляет альтернативные текстовые представления информации, содержащейся в сводной таблице. Эта информация полезна для людей со зрением или когнитивными нарушениями, которым может быть сложно увидеть или понять таблицу. Заголовок может быть прочитан человеку с ограниченными возможностями и используется для определения того, хочет ли он услышать описание содержимого.
autoFormat	Указывает, будет ли форматирование автоматически применяться при обновлении или при перемещении полей.
context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
emptyCellText	Текст, автоматически заполняемый любой пустой ячейкой в сводной таблице, если fillEmptyCells == true. Обратите внимание, что это значение сохраняется, если fillEmptyCells установлено значение false, и что присвоение этого значения не задает этому свойству значение true. По умолчанию это пустая строка.
enableFieldList	Указывает, можно ли отображать список полей в пользовательском интерфейсе.
fillEmptyCells	Указывает, должны ли пустые ячейки в сводной таблице заполняться значением emptyCellText. Значение по умолчанию — false. Обратите внимание, что значение "s" сохраняется, если это свойство 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(axis, 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, sortBy)	Задает для сводной таблицы автоматическую сортировку, используя указанную ячейку, чтобы автоматически выбрать все необходимые условия и контекст. Это работает аналогично применению автоматической сортировки из пользовательского интерфейса.
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. Обратите внимание, что значение "s" сохраняется, если это свойство 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>

Элементы сводных таблиц на оси строки, составляющие искомое значение.

columnItems

Array<Excel.PivotItem | string>

Элементы сводных таблиц на оси столбца, составляющие искомое значение.

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

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

Ось, от которой нужно получить элементы сводки. Должно быть либо строкой, либо столбцом.

cell

Excel.Range | string

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

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

Excel.PivotItemCollection

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

Комментарии

Набор API: ExcelApi 1.9

getPivotItems(axis, cell)

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

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

Параметры

axis

"Unknown" | "Row" | "Column" | "Data" | "Filter"

Ось, от которой нужно получить элементы сводки. Должно быть либо строкой, либо столбцом.

cell

Excel.Range | string

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

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

Excel.PivotItemCollection

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

Комментарии

Набор 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

Истина включает параметр отображения повтора меток. Значение 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

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

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

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, sortBy)

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

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

Параметры

cell

Excel.Range | string

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

sortBy

"Ascending" | "Descending"

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

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

void

Комментарии

Набор API: ExcelApi 1.9

setStyle(style)

Примечание

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

Стиль сводной таблицы.

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

Параметры

style

string | Excel.PivotTableStyle | Excel.BuiltInPivotTableStyle

Стиль для приложения к сводной таблице. An 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