public interface IPivotTable
| Modifier and Type | Method and Description |
|---|---|
IPivotField |
addDataField(IPivotField field,
java.lang.String caption,
ConsolidationFunction function)
Adds a data field to a PivotTable report.
|
void |
clearAllFilters()
Deletes all filters currently applied to the PivotTable.
|
void |
clearTable()
Clears a PivotTable.
|
ICalculatedFields |
getCalculatedFields()
Returns a CalculatedFields collection that represents all the calculated fields in the specified PivotTable report.
|
IPivotFields |
getColumnFields()
Returns an object that represents a collection of all the fields that are
currently shown as column fields.
|
boolean |
getColumnGrand()
Gets whether the PivotTable report shows grand totals for columns.
|
IRange |
getColumnRange()
Returns a Range object that represents the range that contains the column
area in the PivotTable report.
|
int |
getCompactRowIndent()
Returns the indent increment for PivotItems when compact row layout form is turned on.
|
IRange |
getDataBodyRange()
Returns a Range object that represents the range that contains the data area
in the list between the header row and the insert row.
|
IPivotFields |
getDataFields()
Returns an object that represents a collection of all the fields that are
currently shown as data fields.
|
boolean |
getDeferLayoutUpdate()
Returns whether the pivotTable defer layout update.
|
boolean |
getDisplayContextTooltips()
Gets whether tooltips are displayed for PivotTable cells.
|
boolean |
getDisplayErrorString()
Gets if the PivotTable report displays a custom error string in cells that
contain errors.
|
boolean |
getDisplayMemberPropertyTooltips()
Gets whether to display member properties in tooltips.
|
boolean |
getDisplayNullString()
Gets if the PivotTable report displays a custom string in cells that
contain null values.
|
java.lang.String |
getErrorString()
Returns the string displayed in cells that contain errors when the
PivotTable.getDisplayErrorString() is
True.
|
java.lang.String |
getGrandTotalName()
Gets the text string label that is displayed in the grand total column or row
heading in the specified PivotTable report.
|
LayoutRowType |
getLayoutRowDefault()
This property specifies the layout settings for PivotFields when they are
added to the PivotTable for the first time.
|
boolean |
getMergeLabels()
Gets if the specified PivotTable report’s outer-row item, column item,
subtotal, and grand total labels use merged cells.
|
java.lang.String |
getName()
Gets the name of the object.
|
java.lang.String |
getNullString()
Returns the string displayed in cells that contain null values
when the PivotTable.DisplayNullString property
is True.
|
Order |
getPageFieldOrder()
Returns the order in which page fields are added to the PivotTable report’s layout.
|
IPivotFields |
getPageFields()
Returns an object that represents a collection of all the fields that are
currently showing as page fields.
|
int |
getPageFieldWrapCount()
Returns the number of page fields in each column or row in the PivotTable report.
|
IRange |
getPageRange()
Returns a Range object that represents the range that contains the page
area in the PivotTable report.
|
IPivotCache |
getPivotCache()
Returns a PivotCache object that represents the cache for the specified
PivotTable report.
|
IPivotAxis |
getPivotColumnAxis()
Returns a PivotAxis object representing the entire column axis.
|
IPivotFields |
getPivotFields()
Returns 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.
|
IPivotFormulas |
getPivotFormulas()
Gets a PivotFormulas object that represents the collection of formulas for the specified PivotTable report.
|
IPivotAxis |
getPivotRowAxis()
Returns a PivotAxis object representing the entire row axis.
|
IPivotFields |
getRowFields()
Returns an object that represents either a collection of all the fields that
are currently showing as row fields.
|
boolean |
getRowGrand()
Gets whether the PivotTable report shows grand totals for rows.
|
IRange |
getRowRange()
Returns a Range object that represents the range including the row area on
the PivotTable report.
|
boolean |
getShowTableStyleColumnHeaders()
Gets the boolean value if the column headers should be displayed in the
PivotTable.
|
boolean |
getShowTableStyleColumnStripes()
Gets the boolean value displays banded columns in which even columns are
formatted differently from odd columns.
|
boolean |
getShowTableStyleLastColumn()
Gets the boolean value if displays grand total columns style.
|
boolean |
getShowTableStyleRowHeaders()
Gets the boolean value if the row headers should be displayed in the
PivotTable.
|
boolean |
getShowTableStyleRowStripes()
Gets the boolean value displays banded rows in which even rows are formatted
differently from odd rows.
|
ITableStyle |
getStyle()
Gets the style currently applied to the specified pivot table.
|
IRange |
getTableRange1()
Returns a Range object that represents the range containing the entire
PivotTable report, but doesn’t include page fields.
|
IRange |
getTableRange2()
Returns a Range object that represents the range containing the entire
PivotTable report, including page fields.
|
java.lang.String |
getTableStyle()
Gets the style used in the body of the PivotTable report.
|
java.lang.String |
getTag()
Gets a string saved with the PivotTable report.
|
IPivotValueCell |
pivotValueCell(int rowline,
int columnline)
Retrieve the PivotValueCell object for a given PivotTable provided certain row and column indices.
|
boolean |
refresh()
Refreshes the PivotTable report from the source data.
|
void |
repeatAllLabels(PivotFieldRepeatLabels repeat)
Sets whether to repeat item labels for all PivotFields in the specified PivotTable.
|
void |
setColumnGrand(boolean value)
Sets whether the PivotTable report shows grand totals for columns.
|
void |
setCompactRowIndent(int value)
Sets the indent increment for PivotItems when compact row layout form is turned on.
|
void |
setDeferLayoutUpdate(boolean value)
Sets whether the pivotTable defer layout update.
|
void |
setDisplayContextTooltips(boolean value)
Sets whether tooltips are displayed for PivotTable cells.
|
void |
setDisplayErrorString(boolean value)
Sets if the PivotTable report displays a custom error string in cells that
contain errors.
|
void |
setDisplayMemberPropertyTooltips(boolean value)
Sets whether to display member properties in tooltips.
|
void |
setDisplayNullString(boolean value)
Sets if the PivotTable report displays a custom string in cells that
contain null values.
|
void |
setErrorString(java.lang.String value)
Sets the string displayed in cells that contain errors when the
PivotTable.getDisplayErrorString() is True.
|
void |
setGrandTotalName(java.lang.String value)
Sets the text string label that is displayed in the grand total column or row
heading in the specified PivotTable report.
|
void |
setLayoutRowDefault(LayoutRowType value)
This property specifies the layout settings for PivotFields when they are
added to the PivotTable for the first time.
|
void |
setMergeLabels(boolean value)
Sets if the specified PivotTable report’s outer-row item, column item,
subtotal, and grand total labels use merged cells.
|
void |
setName(java.lang.String value)
Sets the name of the object.
|
void |
setNullString(java.lang.String value)
Sets the string displayed in cells that contain null values
when the PivotTable.DisplayNullString property
is True.
|
void |
setPageFieldOrder(Order value)
Sets the order in which page fields are added to the PivotTable report’s layout.
|
void |
setPageFieldWrapCount(int value)
Sets the number of page fields in each column or row in the PivotTable report.
|
void |
setRowAxisLayout(LayoutRowType rowLayout)
This method is used for simultaneously setting layout options for all
existing PivotFields.
|
void |
setRowGrand(boolean value)
Sets whether the PivotTable report shows grand totals for rows.
|
void |
setShowTableStyleColumnHeaders(boolean value)
Sets if the column headers should be displayed in the PivotTable.
|
void |
setShowTableStyleColumnStripes(boolean value)
Sets the boolean value displays banded columns in which even columns are
formatted differently from odd columns.
|
void |
setShowTableStyleLastColumn(boolean value)
Sets the boolean value if displays grand total columns style.
|
void |
setShowTableStyleRowHeaders(boolean value)
Sets the boolean value if the row headers should be displayed in the
PivotTable.
|
void |
setShowTableStyleRowStripes(boolean value)
Sets the boolean value displays banded rows in which even rows are formatted
differently from odd rows.
|
void |
setStyle(ITableStyle style)
Sets the style currently applied to the specified pivot table.
|
void |
setTableStyle(java.lang.String value)
Sets the style used in the body of the PivotTable report.
|
void |
setTag(java.lang.String value)
Sets a string saved with the PivotTable report.
|
void |
subtotalLocation(SubtotalLocationType location)
Changes the subtotal location for all existing PivotFields.
|
void |
update()
Updates the link or PivotTable report.
|
boolean getColumnGrand()
void setColumnGrand(boolean value)
IPivotFields getColumnFields()
IRange getColumnRange()
int getCompactRowIndent()
void setCompactRowIndent(int value)
IRange getDataBodyRange()
IPivotFields getDataFields()
boolean getDeferLayoutUpdate()
void setDeferLayoutUpdate(boolean value)
boolean getDisplayContextTooltips()
void setDisplayContextTooltips(boolean value)
boolean getDisplayErrorString()
void setDisplayErrorString(boolean value)
boolean getDisplayMemberPropertyTooltips()
void setDisplayMemberPropertyTooltips(boolean value)
boolean getDisplayNullString()
void setDisplayNullString(boolean value)
java.lang.String getErrorString()
void setErrorString(java.lang.String value)
java.lang.String getGrandTotalName()
void setGrandTotalName(java.lang.String value)
LayoutRowType getLayoutRowDefault()
void setLayoutRowDefault(LayoutRowType value)
boolean getMergeLabels()
void setMergeLabels(boolean value)
java.lang.String getName()
void setName(java.lang.String value)
java.lang.String getNullString()
void setNullString(java.lang.String value)
Order getPageFieldOrder()
void setPageFieldOrder(Order value)
IPivotFields getPageFields()
int getPageFieldWrapCount()
void setPageFieldWrapCount(int value)
IRange getPageRange()
IPivotAxis getPivotColumnAxis()
IPivotAxis getPivotRowAxis()
IPivotFields getRowFields()
boolean getRowGrand()
void setRowGrand(boolean value)
IRange getRowRange()
boolean getShowTableStyleColumnHeaders()
void setShowTableStyleColumnHeaders(boolean value)
boolean getShowTableStyleColumnStripes()
void setShowTableStyleColumnStripes(boolean value)
boolean getShowTableStyleLastColumn()
void setShowTableStyleLastColumn(boolean value)
boolean getShowTableStyleRowHeaders()
void setShowTableStyleRowHeaders(boolean value)
boolean getShowTableStyleRowStripes()
void setShowTableStyleRowStripes(boolean value)
IRange getTableRange1()
IRange getTableRange2()
java.lang.String getTableStyle()
void setTableStyle(java.lang.String value)
java.lang.String getTag()
void setTag(java.lang.String value)
IPivotField addDataField(IPivotField field, java.lang.String caption, ConsolidationFunction function)
field - The unique field on the server. If the source data is Online Analytical
Processing (OLAP), the unique field is a cube field. If the source
data is non-OLAP (non-OLAP source data), the unique field is a PivotTable field.caption - The label used in the PivotTable report to identify this data field.function - The function performed in the added data field.ICalculatedFields getCalculatedFields()
void clearAllFilters()
void clearTable()
IPivotCache getPivotCache()
IPivotFields getPivotFields()
IPivotValueCell pivotValueCell(int rowline, int columnline)
rowline - The row position in the data area.columnline - The column position in the data area.boolean refresh()
void repeatAllLabels(PivotFieldRepeatLabels repeat)
repeat - Specifies whether to repeat item labels for all PivotFields in the specified PivotTable.void setRowAxisLayout(LayoutRowType rowLayout)
rowLayout - Specifies the type of layout row.void subtotalLocation(SubtotalLocationType location)
void update()
ITableStyle getStyle()
void setStyle(ITableStyle style)
IPivotFormulas getPivotFormulas()