Documents for Excel, Java Edition Documentation
com.grapecity.documents.excel Package / IPivotTable Interface
Methods

In This Topic
    IPivotTable Interface Members
    In This Topic

    The following tables list the members exposed by IPivotTable.

    Public Methods
     NameDescription
     MethodAdds a data field to a PivotTable report. Returns a PivotField object that represents the new data field.  
     MethodDeletes all filters currently applied to the PivotTable. This includes deleting all filters in the PivotFilters collection of the PivotTable object, removing any manual filtering applied, and setting all PivotFields in the Report Filter area to the default item.  
     MethodClears a PivotTable. Clearing PivotTables includes removing all the fields and deleting all filtering and sorting applied to the PivotTables. This method resets the PivotTable to the state it had right after it was created, before any fields were added to it.  
     MethodReturns an object that represents a collection of all the fields that are currently shown as column fields. Read-only.  
     MethodGets whether the PivotTable report shows grand totals for columns.  
     MethodReturns a Range object that represents the range that contains the column area in the PivotTable report.  
     MethodReturns the indent increment for PivotItems when compact row layout form is turned on.  
     MethodReturns a Range object that represents the range that contains the data area in the list between the header row and the insert row.  
     MethodReturns an object that represents a collection of all the fields that are currently shown as data fields. Read-only.  
     Method  
     MethodGets whether tooltips are displayed for PivotTable cells.  
     MethodGets if the PivotTable report displays a custom error string in cells that contain errors. The default value is False.  
     MethodGets whether to display member properties in tooltips.  
     MethodGets if the PivotTable report displays a custom string in cells that contain null values. The default value is True.  
     MethodReturns the string displayed in cells that contain errors when the PivotTable.getDisplayErrorString() is True. The default value is an empty string ("").  
     MethodGets the text string label that is displayed in the grand total column or row heading in the specified PivotTable report. The default value is the string "Grand Total".  
     MethodThis property specifies the layout settings for PivotFields when they are added to the PivotTable for the first time.  
     MethodGets if the specified PivotTable reportĄ¯s outer-row item, column item, subtotal, and grand total labels use merged cells.  
     MethodGets the name of the object.  
     MethodReturns the string displayed in cells that contain null values when the PivotTable.DisplayNullString property is True. The default value is an empty string ("").  
     MethodReturns the order in which page fields are added to the PivotTable reportĄ¯s layout. Can be one of the following Order constants: DownThenOver or OverThenDown. The default constant is DownThenOver.  
     MethodReturns an object that represents a collection of all the fields that are currently showing as page fields. Read-only.  
     MethodReturns the number of page fields in each column or row in the PivotTable report.  
     MethodReturns a Range object that represents the range that contains the page area in the PivotTable report.  
     MethodReturns a PivotCache object that represents the cache for the specified PivotTable report.  
     MethodReturns a PivotAxis object representing the entire column axis.  
     MethodReturns an object that represents either a single PivotTable field (a PivotField object) or a collection of both the visible and hidden fields (a PivotFields object) in the PivotTable report.  
     MethodReturns a PivotAxis object representing the entire row axis.  
     MethodReturns an object that represents either a collection of all the fields that are currently showing as row fields. Read-only.  
     MethodGets whether the PivotTable report shows grand totals for rows.  
     MethodReturns a Range object that represents the range including the row area on the PivotTable report.  
     MethodGets the boolean value if the column headers should be displayed in the PivotTable.  
     MethodGets the boolean value displays banded columns in which even columns are formatted differently from odd columns. This makes PivotTableseasier to read.  
     MethodGets the boolean value if displays grand total columns style.  
     MethodGets the boolean value if the row headers should be displayed in the PivotTable.  
     MethodGets the boolean value displays banded rows in which even rows are formatted differently from odd rows. This makes PivotTables easier to read.  
     MethodGets the style currently applied to the specified pivot table.  
     MethodReturns a Range object that represents the range containing the entire PivotTable report, but doesnĄ¯t include page fields.  
     MethodReturns a Range object that represents the range containing the entire PivotTable report, including page fields.  
     MethodGets the style used in the body of the PivotTable report. The default value is a null string (no style is applied by default).  
     MethodGets a string saved with the PivotTable report.  
     MethodRetrieve the PivotValueCell object for a given PivotTable provided certain row and column indices.  
     MethodRefreshes the PivotTable report from the source data. Returns True if itĄ¯s successful.  
     MethodSets whether to repeat item labels for all PivotFields in the specified PivotTable.  
     MethodSets whether the PivotTable report shows grand totals for columns.  
     MethodSets the indent increment for PivotItems when compact row layout form is turned on.  
     Method  
     MethodSets whether tooltips are displayed for PivotTable cells.  
     MethodSets if the PivotTable report displays a custom error string in cells that contain errors.  
     MethodSets whether to display member properties in tooltips.  
     MethodSets if the PivotTable report displays a custom string in cells that contain null values.  
     MethodSets the string displayed in cells that contain errors when the PivotTable.getDisplayErrorString() is True.  
     MethodSets the text string label that is displayed in the grand total column or row heading in the specified PivotTable report. The default value is the string "Grand Total".  
     MethodThis property specifies the layout settings for PivotFields when they are added to the PivotTable for the first time.  
     MethodSets if the specified PivotTable reportĄ¯s outer-row item, column item, subtotal, and grand total labels use merged cells.  
     MethodSets the name of the object.  
     MethodSets the string displayed in cells that contain null values when the PivotTable.DisplayNullString property is True.  
     MethodSets the order in which page fields are added to the PivotTable reportĄ¯s layout. Can be one of the following Order constants: DownThenOver or OverThenDown. The default constant is DownThenOver.  
     MethodSets the number of page fields in each column or row in the PivotTable report.  
     MethodThis method is used for simultaneously setting layout options for all existing PivotFields.  
     MethodSets whether the PivotTable report shows grand totals for rows.  
     MethodSets if the column headers should be displayed in the PivotTable.  
     MethodSets the boolean value displays banded columns in which even columns are formatted differently from odd columns. This makes PivotTableseasier to read.  
     MethodSets the boolean value if displays grand total columns style.  
     MethodSets the boolean value if the row headers should be displayed in the PivotTable.  
     MethodSets the boolean value displays banded rows in which even rows are formatted differently from odd rows. This makes PivotTables easier to read.  
     MethodSets the style currently applied to the specified pivot table.  
     MethodSets the style used in the body of the PivotTable report. The default value is a null string (no style is applied by default).  
     MethodSets a string saved with the PivotTable report.  
     MethodChanges the subtotal location for all existing PivotFields. Changing the subtotal location has an immediate visual effect only for fields in outline form, but it will be set for fields in tabular form as well.  
     MethodUpdates the link or PivotTable report.  
    Top
    See Also