ApiPivotDataField

Represents the ApiPivotDataField class.

Properties

Name	Type	Description
Caption	string	Returns or sets a value that represents the label text for the data field.
Function	DataConsolidateFunctionType	Returns or sets a function for the data field.
Index	number	Returns an index of the data field.
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	PivotFieldOrientationType	Returns a data field orientation value that represents the data field location in the specified pivot table report.
PivotField	ApiPivotField	Returns the pivot field from which the data field was created.
Position	number	Returns or sets a value that represents the data field position within a category.
Value	string	Returns or sets a value representing the name of the specified data field in the pivot table report.

Methods

Method	Returns	Description
AutoSort	None	Establishes automatic field-sorting rules for the pivot table reports.
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 data 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.
GetFunction	DataConsolidateFunctionType	Returns a function performed in the data field.
GetIndex	number	Returns an index of the data 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.
GetNumberFormat	string | null	Returns a value that represents the format code for the object.
GetOrientation	PivotFieldOrientationType	Returns a data field orientation value that represents the data field location in the specified pivot table report.
GetParent	ApiPivotTable	Returns the parent object for the current field.
GetPivotField	ApiPivotField	Returns the pivot field from which the data field was created.
GetPivotFilters	ApiPivotFilters	Returns the collection of pivot filters applied to the specified pivot 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 data field position within a category.
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 data field in the pivot table report.
Move	None	Moves the current data field inside the category.
Remove	None	Removes the current data field from the category.
SetCaption	None	Sets a value that represents the label text for the data 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.
SetFunction	None	Sets a function to the current data field.
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.
SetNumberFormat	None	Sets a value that represents the format code for the object.
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 data field position within a category.
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 data field in the pivot table report.