Excel.DataPivotHierarchy interface

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

Свойства

field

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

id

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

name

Имя DataPivotHierarchy.

numberFormat

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

position

Положение DataPivotHierarchy.

showAs

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

summarizeBy

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

Методы

load(propertyNames)

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

setToDefault()

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

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

field

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

readonly field: PivotField;

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

id

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

readonly id: string;

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

string

name

Имя DataPivotHierarchy.

name: string;

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

string

Примеры

async function main(context: Excel.RequestContext) {
    let 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: ShowAsRule;

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

Примеры

async function main(context: Excel.RequestContext) {
    let pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
    let farmDataHierarchy: Excel.DataPivotHierarchy = pivotTable.dataHierarchies.getItem("Sum of Crates Sold at Farm");        
    let 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:
            | AggregationFunction
            | "Unknown"
            | "Automatic"
            | "Sum"
            | "Count"
            | "Average"
            | "Max"
            | "Min"
            | "Product"
            | "CountNumbers"
            | "StandardDeviation"
            | "StandardDeviationP"
            | "Variance"
            | "VarianceP";

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

| AggregationFunction | "Unknown" | "Automatic" | "Sum" | "Count" | "Average" | "Max" | "Min" | "Product" | "CountNumbers" | "StandardDeviation" | "StandardDeviationP" | "Variance" | "VarianceP"

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

load(propertyNames)

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

load(propertyNames?: string | string[]): void;

Параметры

propertyNames
string | string[]

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

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

void

setToDefault()

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

setToDefault(): void;

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

void