ApiPivotField

Represents the ApiPivotField class.

Properties

Name	Type	Description
Caption	string	Returns or sets a value that represents the label text for the pivot field.
CurrentPage	string | number	Returns the current page which is displayed for the page field (valid only for page fields).
DragToColumn	boolean	Returns or sets the setting which specifies whether the specified field can be dragged to the column position.
DragToData	boolean	Returns or sets the setting which specifies whether the specified field can be dragged to the data position.
DragToPage	boolean	Returns or sets the setting which specifies whether the specified field can be dragged to the page position.
DragToRow	boolean	Returns or sets the setting which specifies whether the specified field can be dragged to the row position.
Formula	number	Returns or sets a value that represents the object's formula.
Index	number	Returns an index for the pivot table field.
LayoutBlankLine	boolean	Returns and sets the setting which specifies whether to insert blank rows after each item.
LayoutCompactRow	boolean	Returns or sets the setting which specifies whether a pivot table field is compacted.
LayoutForm	number	Returns or sets the way the specified pivot table items appear — in table format or in outline format.
LayoutPageBreak	boolean	Returns or sets the setting which specifies whether to insert a page break after each field.
LayoutSubtotalLocation	number	Returns or sets the layout subtotal location.
LayoutSubtotals	boolean	Returns or sets the setting which specifies whether to show subtotals.
Name	string	Returns or sets a value representing the object name.
NumberFormat	string | null	Returns or sets a value that represents the format code for the object.
Orientation	number	Returns or sets a pivot field orientation value that represents the location of the field in the specified pivot table report.
Parent	ApiPivotTable	Returns the parent object for the current field.
PivotItems	ApiPivotItem | ApiPivotItem[]	Returns an object that represents either a single pivot table item (the ApiPivotItem object)\ or a collection of all the visible and hidden items (an array of the ApiPivotItem objects) in the specified field.
Position	number	Returns or sets a value that represents the position of the field (first, second, third, and so on) among all the fields in its orientation (Rows, Columns, Pages, Data).
RepeatLabels	boolean	Returns or sets the setting which specifies whether to repeat items labels at each row.
ShowAllItems	boolean	Returns or sets the setting which specifies whether to show items with no data.
ShowingInAxis	boolean	Returns the setting which specifies whether the pivot table field is currently visible in the pivot table.
SourceName	string	Returns a source name for the pivot table field.
SubtotalName	string	Returns or sets the text label displayed in the subtotal column or row heading in the specified pivot table report.
Subtotals	object	Returns or sets the subtotals.
Table	ApiPivotTable	Returns the ApiPivotTable object which represents the pivot table for the current field.
Value	string	Returns or sets a value representing the name of the specified field in the pivot table report.

Methods

Method	Returns	Description
ClearAllFilters	None	Deletes all filters currently applied to the pivot field.
ClearLabelFilters	None	Deletes all label filters or all date filters from the pivot filters collection.
ClearManualFilters	None	Deletes all manual filters from the pivot filters collection.
ClearValueFilters	None	Deletes all value filters from the pivot filters collection.
GetCaption	string	Returns a value that represents the label text for the pivot field.
GetCurrentPage	string | number	Returns the current page which is displayed for the page field (valid only for page fields).
GetDragToColumn	boolean	Returns the setting which specifies whether the specified field can be dragged to the column position.
GetDragToData	boolean	Returns the setting which specifies whether the specified field can be dragged to the data position.
GetDragToPage	boolean	Returns the setting which specifies whether the specified field can be dragged to the page position.
GetDragToRow	boolean	Returns the setting which specifies whether the specified field can be dragged to the row position.
GetIndex	number	Returns an index for the pivot table field.
GetLayoutBlankLine	boolean	Returns the setting which specifies whether to insert blank rows after each item.
GetLayoutCompactRow	boolean	Returns the setting which specifies whether a pivot table field is compacted.
GetLayoutForm	PivotLayoutType	Returns the way the specified pivot table items appear — in table format or in outline format.
GetLayoutPageBreak	boolean	Returns the setting which specifies whether to insert a page break after each field.
GetLayoutSubtotalLocation	LayoutSubtotalLocationType	Returns the layout subtotal location.
GetLayoutSubtotals	boolean	Returns the setting which specifies whether to show subtotals.
GetName	string	Returns a value representing the object name.
GetOrientation	PivotFieldOrientationType	Returns a pivot field orientation value that represents the location\ of the field in the specified pivot table report.
GetParent	ApiPivotTable	Returns the parent object for the current field.
GetPivotItems	ApiPivotItem[] | ApiPivotItem | null	Returns an object that represents either a single pivot table item (the ApiPivotItem object)\ or a collection of all the visible and hidden items (an array of the ApiPivotItem objects) in the specified field.
GetPosition	number	Returns a value that represents the position of the field (first, second, third, and so on)\ among all the fields in its orientation (Rows, Columns, Pages, Data).
GetRepeatLabels	boolean	Returns the setting which specifies whether to repeat items labels at each row.
GetShowAllItems	boolean	Returns the setting which specifies whether to show items with no data.
GetShowingInAxis	boolean	Returns the setting which specifies whether the pivot table field is currently visible in the pivot table.
GetSourceName	string	Returns a source name for the pivot table field.
GetSubtotalName	string	Returns the text label displayed in the subtotal column or row heading in the specified pivot table report.
GetSubtotals	PivotFieldSubtotals	Returns an object that represents all subtotals.
GetTable	ApiPivotTable	Returns the ApiPivotTable object which represents the pivot table for the current field.
GetValue	string	Returns a value representing the name of the specified field in the pivot table report.
Move	None	Moves the current pivot field inside the category.
Remove	None	Removes the current pivot field from the pivot table.
SetCaption	None	Sets a value that represents the label text for the pivot field.
SetDragToColumn	None	Sets the setting which specifies whether the specified field can be dragged to the column position.
SetDragToData	None	Sets the setting which specifies whether the specified field can be dragged to the data position.
SetDragToPage	None	Sets the setting which specifies whether the specified field can be dragged to the page position.
SetDragToRow	None	Sets the setting which specifies whether the specified field can be dragged to the row position.
SetLayoutBlankLine	None	Sets the setting which specifies whether to insert blank rows after each item.
SetLayoutCompactRow	None	Sets the setting which specifies whether a pivot table field is compacted.
SetLayoutForm	None	Sets the way the specified pivot table items appear — in table format or in outline format.
SetLayoutPageBreak	None	Sets the setting which specifies whether to insert a page break after each field.
SetLayoutSubtotalLocation	None	Sets the layout subtotal location.
SetLayoutSubtotals	None	Sets the setting which specifies whether to show subtotals.
SetName	None	Sets a value representing the object name.
SetOrientation	None	Sets a pivot field orientation value that represents the location\ of the field in the specified pivot table report.
SetPosition	None	Sets a value that represents the position of the field (first, second, third, and so on)\ among all the fields in its orientation (Rows, Columns, Pages, Data).
SetRepeatLabels	None	Sets the setting which specifies whether to repeat items labels at each row.
SetShowAllItems	None	Sets the setting which specifies whether to show items with no data.
SetSubtotalName	None	Sets the text label displayed in the subtotal column or row heading in the specified pivot table report.
SetSubtotals	None	Sets an object that represents all subtotals.
SetValue	None	Sets a value representing the name of the specified field in the pivot table report.