Excel.DataPivotHierarchy interface

Representa o Excel DataPivotHierarchy.

Propriedades

field

Retorna PivotFields associados a DataPivotHierarchy.

id

ID do DataPivotHierarchy.

name

Nome da DataPivotHierarchy.

numberFormat

Formato de número do DataPivotHierarchy.

position

Posição da DataPivotHierarchy.

showAs

Especifica se os dados devem ser mostrados como um cálculo de resumo específico.

summarizeBy

Especifica se todos os itens do DataPivotHierarchy são exibidos.

Métodos

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

setToDefault()

Redefina a DataPivotHierarchy para os valores padrão.

Detalhes da propriedade

field

Retorna PivotFields associados a DataPivotHierarchy.

readonly field: PivotField;

Valor da propriedade

id

ID do DataPivotHierarchy.

readonly id: string;

Valor da propriedade

string

name

Nome da DataPivotHierarchy.

name: string;

Valor da propriedade

string

Exemplos

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

Formato de número do DataPivotHierarchy.

numberFormat: string;

Valor da propriedade

string

position

Posição da DataPivotHierarchy.

position: number;

Valor da propriedade

number

showAs

Especifica se os dados devem ser mostrados como um cálculo de resumo específico.

showAs: ShowAsRule;

Valor da propriedade

Exemplos

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

Especifica se todos os itens do DataPivotHierarchy são exibidos.

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

Valor da propriedade

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

Detalhes do método

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNames
string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

void

setToDefault()

Redefina a DataPivotHierarchy para os valores padrão.

setToDefault(): void;

Retornos

void