Table of Contents

Interface IXLPivotValue

Namespace
SlapKit.Excel.Excel
Assembly
SlapKit.Excel.dll

A pivot value field, it is basically a specification of how to determine and format values from source to display in the pivot table.

public interface IXLPivotValue
Extension Methods

Properties

BaseFieldName

Specifies the index to the base field when the ShowDataAs calculation is in use. Instead of base item, previous or next value can be used through CalculationItem

string BaseFieldName { get; set; }

Property Value

string

The name of the column of the relevant base field.

Examples

Show values as a percent of a specific value of a different field, e.g. as a % of units sold from Q1 (quarts is a base field and Q1 is a base item).

Remarks

Used only if the value should be showed Show Values As in the value field settings.

BaseItemValue

The value of a base item to calculate a value to show in the pivot table. The base item is selected from values of a base field.

XLCellValue BaseItemValue { get; set; }

Property Value

XLCellValue

The value of the referenced base field item.

Examples

Show values as a percent of a specific value of a different field, e.g. as a % of units sold from Q1 (quarts is a base field and Q1 is a base item).

Remarks

Used only if the value should be showed Show Values As in the value field settings.

Calculation 

XLPivotCalculation Calculation { get; set; }

Property Value

XLPivotCalculation

CalculationItem 

XLPivotCalculationItem CalculationItem { get; set; }

Property Value

XLPivotCalculationItem

CustomName 

string CustomName { get; set; }

Property Value

string

NumberFormat 

IXLPivotValueFormat NumberFormat { get; }

Property Value

IXLPivotValueFormat

SourceName 

string SourceName { get; }

Property Value

string

SummaryFormula 

XLPivotSummary SummaryFormula { get; set; }

Property Value

XLPivotSummary

Methods

SetBaseFieldName(string) 

IXLPivotValue SetBaseFieldName(string value)

Parameters

value string

Returns

IXLPivotValue

SetBaseItemValue(XLCellValue) 

IXLPivotValue SetBaseItemValue(XLCellValue value)

Parameters

value XLCellValue

Returns

IXLPivotValue

SetCalculation(XLPivotCalculation) 

IXLPivotValue SetCalculation(XLPivotCalculation value)

Parameters

value XLPivotCalculation

Returns

IXLPivotValue

SetCalculationItem(XLPivotCalculationItem) 

IXLPivotValue SetCalculationItem(XLPivotCalculationItem value)

Parameters

value XLPivotCalculationItem

Returns

IXLPivotValue

SetSummaryFormula(XLPivotSummary) 

IXLPivotValue SetSummaryFormula(XLPivotSummary value)

Parameters

value XLPivotSummary

Returns

IXLPivotValue

ShowAsDifferenceFrom(string) 

IXLPivotValueCombination ShowAsDifferenceFrom(string fieldSourceName)

Parameters

fieldSourceName string

Returns

IXLPivotValueCombination

ShowAsIndex() 

IXLPivotValue ShowAsIndex()

Returns

IXLPivotValue

ShowAsNormal() 

IXLPivotValue ShowAsNormal()

Returns

IXLPivotValue

ShowAsPercentageDifferenceFrom(string) 

IXLPivotValueCombination ShowAsPercentageDifferenceFrom(string fieldSourceName)

Parameters

fieldSourceName string

Returns

IXLPivotValueCombination

ShowAsPercentageFrom(string) 

IXLPivotValueCombination ShowAsPercentageFrom(string fieldSourceName)

Parameters

fieldSourceName string

Returns

IXLPivotValueCombination

ShowAsPercentageOfColumn() 

IXLPivotValue ShowAsPercentageOfColumn()

Returns

IXLPivotValue

ShowAsPercentageOfRow() 

IXLPivotValue ShowAsPercentageOfRow()

Returns

IXLPivotValue

ShowAsPercentageOfTotal() 

IXLPivotValue ShowAsPercentageOfTotal()

Returns

IXLPivotValue

ShowAsRunningTotalIn(string) 

IXLPivotValue ShowAsRunningTotalIn(string fieldSourceName)

Parameters

fieldSourceName string

Returns

IXLPivotValue