PivotField Class

• Open Markdown

• ---

• Open in ChatGPT
• Open in Claude
• Open in Perplexity

PivotField class

Represents a field in a PivotTable report.

type PivotField struct  {
	ptr unsafe.Pointer
}

Constructors

Method	Description

Methods

Method	Description
IsNull	Checks whether the implementation object is nullptr.
GetPivotItems	Gets the pivot items of the pivot field
GetMaxValue	Gets the max value of this field.
GetMinValue	Gets the max value of this field.
GetGroupSettings	Gets the group settings of the pivot field.
InitPivotItems	Init the pivot items of the pivot field
Group	Automatically group the field.
Group_PivotFieldGroupOptions	Groups the pivot field with options.
GroupBy	Custom group the field.
Ungroup	Ungroup the pivot field.
GetPivotFilterByType	Gets the pivot filter of the pivot field by type
GetFilters	Gets all pivot filters applied for this pivot field.
ClearFilter	Clears filter setting on this pivot field.
FilterTop10	Filters by values of data pivot field.
FilterByValue	Filters by values of data pivot field.
FilterByLabel	Filters by captions of row or column pivot field.
FilterByDate	Filters by date values of row or column pivot field.
IsCalculatedField	Indicates whether the this pivot field is calculated field.
GetFormula	Gets the formula of the calculated field .Only works for calculated field.
IsValuesField	Indicates whether this field represents values field.
GetBaseIndex	Represents the index in the source pivot fields.
SetBaseIndex	Represents the index in the source pivot fields.
GetPosition	Represents the index of PivotField in the region.
GetRegionType	Specifies the region of the pivot table that this field is displayed.
GetName	Represents the name of PivotField.
SetName	Represents the name of PivotField.
GetDisplayName	Represents the display name of pivot field in the pivot table view.
SetDisplayName	Represents the display name of pivot field in the pivot table view.
SetSubtotals_PivotFieldSubtotalType_Bool	Sets how to subtotal the specified field.
GetSubtotals_PivotFieldSubtotalType	Indicates whether to show specified subtotal for this pivot field.
GetSubtotals	Gets or sets the subtotals of the field. Only for Row or Column pivot field.
SetSubtotals_PivotFieldSubtotalType	Gets or sets the subtotals of the field. Only for Row or Column pivot field.
IsAutoSubtotals	Indicates whether the specified field shows automatic subtotals. Default is true.
SetIsAutoSubtotals	Indicates whether the specified field shows automatic subtotals. Default is true.
GetAllowDraggingToRow	Indicates whether the specified field can be dragged to the row region.The default value is true.
SetAllowDraggingToRow	Indicates whether the specified field can be dragged to the row region.The default value is true.
GetAllowDraggingToColumn	Indicates whether the specified field can be dragged to the column region.The default value is true.
SetAllowDraggingToColumn	Indicates whether the specified field can be dragged to the column region.The default value is true.
GetAllowDraggingToPage	Indicates whether the specified field can be dragged to the page region.The default value is true.
SetAllowDraggingToPage	Indicates whether the specified field can be dragged to the page region.The default value is true.
GetAllowRemovingFromView	Indicates whether this pivot field can be removed from the PivotTable view.The default value is true.
SetAllowRemovingFromView	Indicates whether this pivot field can be removed from the PivotTable view.The default value is true.
GetAllowDraggingToData	Indicates whether the specified field can be dragged to the values region.The default value is true.
SetAllowDraggingToData	Indicates whether the specified field can be dragged to the values region.The default value is true.
IsMultipleItemSelectionAllowed	Indicates whether multiple items could be selected in the page field.The default value is false.
SetIsMultipleItemSelectionAllowed	Indicates whether multiple items could be selected in the page field.The default value is false.
IsRepeatItemLabels	Indicates whether to repeat labels of the field in the region.The default value is false.
SetIsRepeatItemLabels	Indicates whether to repeat labels of the field in the region.The default value is false.
IsIncludeNewItemsInFilter	Indicates whether to include new items to the field in manual filter.The default value is false.
SetIsIncludeNewItemsInFilter	Indicates whether to include new items to the field in manual filter.The default value is false.
IsInsertPageBreaksBetweenItems	Indicates whether to insert page breaks after each item.The default value is false.
SetIsInsertPageBreaksBetweenItems	Indicates whether to insert page breaks after each item.The default value is false.
GetShowAllItems	Indicates whether to display all items in the PivotTable view,even if they don’t contain summary data.The default value is false.
SetShowAllItems	Indicates whether to display all items in the PivotTable view,even if they don’t contain summary data.The default value is false.
SortBy_SortOrder	Sorts this pivot field.
SortBy_SortOrder_Int_String	Sorts this pivot field.
GetSortSetting	Gets all settings of auto sorting
GetTop10AutoShowSettings	Gets the Top 10 AutoShow settings for a pivot field.
Top10AutoShow	Configures Top10 AutoShow settings for this pivot field.
GetFunction	Represents the function used to summarize this PivotTable data field.
SetFunction	Represents the function used to summarize this PivotTable data field.
ShowValuesAs	Shows values of data field as different display format when the ShowDataAs calculation is in use.
GetShowValuesSetting	Gets the settings of showing values as when the ShowDataAs calculation is in use.
GetCurrentPageItem	Represents the current selected page item of the page field to filter data.Only valid for page fields.
SetCurrentPageItem	Represents the current selected page item of the page field to filter data.Only valid for page fields.
GetInsertBlankRow	Indicates whether to insert a blank line after each item.Only for row fields.
SetInsertBlankRow	Indicates whether to insert a blank line after each item.Only for row fields.
GetShowSubtotalAtTop	Indicates whether to display subtotals at the top or bottom of items when ShowInOutlineForm is true, then
SetShowSubtotalAtTop	Indicates whether to display subtotals at the top or bottom of items when ShowInOutlineForm is true, then
GetShowInOutlineForm	Indicates whether to layout this field in outline form on the Pivot Table view.
SetShowInOutlineForm	Indicates whether to layout this field in outline form on the Pivot Table view.
GetNumber	Represents the built-in display format of numbers and dates.
SetNumber	Represents the built-in display format of numbers and dates.
Get_NumberFormat	Represents the custom display format of numbers and dates.
SetNumberFormat	Represents the custom display format of numbers and dates.
HideAllDetails	Hides all details
ShowAllDetails	Show all details
GetItems	Get all labels of pivot items in this field.
GetOriginalItems	Get the original base items;
AddCalculatedItem	Add a calculated formula item to the pivot field.
GetShowCompact	Indicates whether to display labels of the next field in the same column on the Pivot Table view
SetShowCompact	Indicates whether to display labels of the next field in the same column on the Pivot Table view