Excel.DataPivotHierarchy class

Представляет иерархию DataPivotHierarchy Excel.

Свойства

context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
field	Возвращает сводные поля, связанные с DataPivotHierarchy.
id	Идентификатор иерархии DataPivotHierarchy.
name	Имя DataPivotHierarchy.
numberFormat	Числовой формат DataPivotHierarchy.
position	Положение DataPivotHierarchy.
showAs	Указывает, должны ли данные отображаться как конкретное суммарное вычисление.
summarizeBy	Указывает, все ли элементы DataPivotHierarchy отображаются.

Методы

load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties)	Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
setToDefault()	Сбрасывает DataPivotHierarchy до значений по умолчанию.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`, в свою очередь, вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Excel.DataPivotHierarchy` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `Excel.Interfaces.DataPivotHierarchyData`), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

context

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

context: RequestContext;

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

Excel.RequestContext

field

Возвращает сводные поля, связанные с DataPivotHierarchy.

readonly field: Excel.PivotField;

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

Excel.PivotField

id

Идентификатор иерархии DataPivotHierarchy.

readonly id: string;

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

string

name

Имя DataPivotHierarchy.

name: string;

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

string

Примеры

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

await Excel.run(async (context) => {
    const dataHierarchies = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales").dataHierarchies
    dataHierarchies.load("no-properties-needed");
    await context.sync();

    dataHierarchies.items[0].name = "Farm Sales";
    dataHierarchies.items[1].name = "Wholesale";
    await context.sync();
});

numberFormat

Числовой формат DataPivotHierarchy.

numberFormat: string;

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

string

position

Положение DataPivotHierarchy.

position: number;

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

number

showAs

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

showAs: Excel.ShowAsRule;

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

Excel.ShowAsRule

Примеры

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

await Excel.run(async (context) => {
    const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
    const farmDataHierarchy: Excel.DataPivotHierarchy = pivotTable.dataHierarchies.getItem("Sum of Crates Sold at Farm");        
    const wholesaleDataHierarchy: Excel.DataPivotHierarchy = pivotTable.dataHierarchies.getItem("Sum of Crates Sold Wholesale");

    farmDataHierarchy.load("showAs");
    wholesaleDataHierarchy.load("showAs");
    await context.sync();

    // Show the crates of each fruit type sold at the farm as a percentage of the column's total.
    let farmShowAs = farmDataHierarchy.showAs;
    farmShowAs.calculation = Excel.ShowAsCalculation.percentOfColumnTotal;
    farmShowAs.baseField = pivotTable.rowHierarchies.getItem("Type").fields.getItem("Type");
    farmDataHierarchy.showAs = farmShowAs;

    let wholesaleShowAs = wholesaleDataHierarchy.showAs;
    wholesaleShowAs.calculation = Excel.ShowAsCalculation.percentOfColumnTotal;
    wholesaleShowAs.baseField = pivotTable.rowHierarchies.getItem("Type").fields.getItem("Type");
    wholesaleDataHierarchy.showAs = wholesaleShowAs;
    await context.sync();
});

summarizeBy

Указывает, все ли элементы DataPivotHierarchy отображаются.

summarizeBy: Excel.AggregationFunction | "Unknown" | "Automatic" | "Sum" | "Count" | "Average" | "Max" | "Min" | "Product" | "CountNumbers" | "StandardDeviation" | "StandardDeviationP" | "Variance" | "VarianceP";

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

Примеры

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

async function genericFunctionSwitch(functionType: Excel.AggregationFunction) {
    await Excel.run(async (context) => {
        const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
        pivotTable.dataHierarchies.load("no-properties-needed");
        await context.sync();

        pivotTable.dataHierarchies.items[0].summarizeBy = functionType;
        pivotTable.dataHierarchies.items[1].summarizeBy = functionType;
        await context.sync();
    });
}

load(options)

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

load(options?: Excel.Interfaces.DataPivotHierarchyLoadOptions): Excel.DataPivotHierarchy;

Параметры

options: Excel.Interfaces.DataPivotHierarchyLoadOptions

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

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

Excel.DataPivotHierarchy

load(propertyNames)

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

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

Параметры

propertyNames: string | string[]

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

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

Excel.DataPivotHierarchy

load(propertyNamesAndPaths)

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

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

Параметры

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

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

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

Excel.DataPivotHierarchy

set(properties, options)

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

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

Параметры

properties: Excel.Interfaces.DataPivotHierarchyUpdateData

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

options: OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.DataPivotHierarchy): void;

Параметры

properties: Excel.DataPivotHierarchy

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

void

setToDefault()

Сбрасывает DataPivotHierarchy до значений по умолчанию.

setToDefault(): void;

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

void

toJSON()

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

toJSON(): Excel.Interfaces.DataPivotHierarchyData;

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

Excel.Interfaces.DataPivotHierarchyData

Комментарии

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

Свойства

Методы

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

context

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

field

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

Комментарии

id

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

Комментарии

name

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

Комментарии

Примеры

numberFormat

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

Комментарии

position

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

Комментарии

showAs

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

Комментарии

Примеры

summarizeBy

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

Комментарии

Примеры

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

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

setToDefault()

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

Комментарии

toJSON()

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

Обратная связь