Excel.ShowAsRule interface

Properties

baseField

The base PivotField to base the ShowAs calculation, if applicable based on the ShowAsCalculation type, else null.

[ API set: ExcelApi 1.8 ]

baseItem

The base Item to base the ShowAs calculation on, if applicable based on the ShowAsCalculation type, else null.

[ API set: ExcelApi 1.8 ]

calculation

The ShowAs Calculation to use for the Data PivotField. See Excel.ShowAsCalculation for Details.

[ API set: ExcelApi 1.8 ]

Property Details

baseField

The base PivotField to base the ShowAs calculation, if applicable based on the ShowAsCalculation type, else null.

[ API set: ExcelApi 1.8 ]

baseField?: Excel.PivotField;

Property Value

baseItem

The base Item to base the ShowAs calculation on, if applicable based on the ShowAsCalculation type, else null.

[ API set: ExcelApi 1.8 ]

baseItem?: Excel.PivotItem;

Property Value

Examples

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 difference between crate sales of the "A Farms" and the other farms
    // this difference is both aggregated and shown for individual fruit types (where applicable)
    let farmShowAs = farmDataHierarchy.showAs;
    farmShowAs.calculation = Excel.ShowAsCalculation.differenceFrom;
    farmShowAs.baseField = pivotTable.rowHierarchies.getItem("Farm").fields.getItem("Farm");
    farmShowAs.baseItem = pivotTable.rowHierarchies.getItem("Farm").fields.getItem("Farm").items.getItem("A Farms");
    farmDataHierarchy.showAs = farmShowAs;

    let wholesaleShowAs = wholesaleDataHierarchy.showAs;
    wholesaleShowAs.calculation = Excel.ShowAsCalculation.differenceFrom;
    wholesaleShowAs.baseField = pivotTable.rowHierarchies.getItem("Farm").fields.getItem("Farm");
    wholesaleShowAs.baseItem = pivotTable.rowHierarchies.getItem("Farm").fields.getItem("Farm").items.getItem("A Farms");
    wholesaleDataHierarchy.showAs = wholesaleShowAs;
    await context.sync();
});

calculation

The ShowAs Calculation to use for the Data PivotField. See Excel.ShowAsCalculation for Details.

[ API set: ExcelApi 1.8 ]

calculation: Excel.ShowAsCalculation | "Unknown" | "None" | "PercentOfGrandTotal" | "PercentOfRowTotal" | "PercentOfColumnTotal" | "PercentOfParentRowTotal" | "PercentOfParentColumnTotal" | "PercentOfParentTotal" | "PercentOf" | "RunningTotal" | "PercentRunningTotal" | "DifferenceFrom" | "PercentDifferenceFrom" | "RankAscending" | "RankDecending" | "Index";

Property Value

Excel.ShowAsCalculation | "Unknown" | "None" | "PercentOfGrandTotal" | "PercentOfRowTotal" | "PercentOfColumnTotal" | "PercentOfParentRowTotal" | "PercentOfParentColumnTotal" | "PercentOfParentTotal" | "PercentOf" | "RunningTotal" | "PercentRunningTotal" | "DifferenceFrom" | "PercentDifferenceFrom" | "RankAscending" | "RankDecending" | "Index"