Package com.grapecity.documents.excel

Interface IPivotTable

public interface IPivotTable
代表工作表上的一个数据透视表报告。PivotTable对象是PivotTables集合的一个成员。PivotTables集合包含单个工作表上的所有数据透视表对象。

  • Method Summary

    Modifier and Type
    Method
    Description
    IPivotField
    addDataField(IPivotField field, String caption, ConsolidationFunction function)
    添加一个数据字段到透视表报告。返回一个表示新数据字段的PivotField对象。
    void
    clearAllFilters()
    删除当前应用于数据透视表的所有筛选器。这包括删除数据透视表对象中PivotFilters集合中的所有筛选器，移除任何手动应用的筛选，并将报告筛选区域中的所有数据透视字段设置为默认项。
    void
    clearTable()
    清除一个数据透视表。清除数据透视表包括移除所有字段，并删除对数据透视表应用的所有筛选和排序。此方法将数据透视表重置为创建后立即的状态，即任何字段被添加之前的状态。
    boolean
    getAllowMultipleFilters()
    获取是否可以对PivotField同时应用多个筛选器。
    ICalculatedFields
    getCalculatedFields()
    返回一个代表指定数据透视表报告中所有计算字段的CalculatedFields集合。
    IPivotFields
    getColumnFields()
    返回一个表示当前作为列字段显示的所有字段的集合的对象。只读。
    boolean
    getColumnGrand()
    获取数据透视表报告是否为列显示总计。
    IRange
    getColumnRange()
    返回一个表示包含数据透视表报告中列区域的范围的 Range 对象。
    int
    getCompactRowIndent()
    返回在开启紧凑行布局表单时，PivotItems的缩进增量。
    IRange
    getDataBodyRange()
    返回一个表示列表中从标题行到插入行之间数据区域的范围的 Range 对象。
    IPivotFields
    getDataFields()
    返回一个表示当前作为数据字段显示的所有字段的集合的对象。只读。
    boolean
    getDeferLayoutUpdate()
    返回是否推迟透视表布局更新。
    boolean
    getDisplayContextTooltips()
    获取是否为数据透视表单元格显示工具提示。
    boolean
    getDisplayErrorString()
    获取数据透视表报告是否在包含错误的单元格中显示自定义错误字符串。默认值为False。
    boolean
    getDisplayMemberPropertyTooltips()
    获取是否在工具提示中显示成员属性。
    boolean
    getDisplayNullString()
    获取数据透视表报告是否在包含空值的单元格中显示自定义字符串。默认值为 True。
    String
    getErrorString()
    返回当 PivotTable.getDisplayErrorString() 为 True 时包含错误的单元格中显示的字符串。默认值为空字符串("")。
    String
    getGrandTotalName()
    获取在指定数据透视表报告中的总计列或行标题中显示的文本字符串标签。默认值为字符串"总计"。
    boolean
    getHasAutoFormat()
    获取一个值，指示在刷新时PivotTable报告是否自动调整列宽。默认值为true。
    LayoutRowType
    getLayoutRowDefault()
    获取首次将PivotFields添加到数据透视表时的默认布局设置。
    boolean
    getMergeLabels()
    获取指定数据透视表报告中外部行项目、列项目、小计和总计标签是否使用合并单元格。
    String
    getName()
    获取对象的名称。
    String
    getNullString()
    返回当PivotTable.DisplayNullString属性为True时，包含空值单元格中显示的字符串。默认值是一个空字符串（""）。
    Order
    getPageFieldOrder()
    返回页面字段添加到数据透视表报告布局的顺序。可以是以下顺序常量之一：DownThenOver（先下后跨）或 OverThenDown（先跨后下）。默认常量是 DownThenOver。
    IPivotFields
    getPageFields()
    返回一个表示当前显示为页面字段的字段集合的对象。只读。
    int
    getPageFieldWrapCount()
    返回数据透视表报表中每一列或行中的页面字段数量。
    IRange
    getPageRange()
    返回一个表示在数据透视表报告中包含页面区域的范围的 Range 对象。
    IPivotCache
    getPivotCache()
    返回一个表示指定数据透视表报告的缓存区的PivotCache对象。
    IPivotAxis
    getPivotColumnAxis()
    返回一个表示整个列轴的PivotAxis对象。
    IPivotFields
    getPivotFields()
    返回一个代表PivotTable报告中的单个数据透视字段（PivotField对象）或同时包含可见字段和隐藏字段集合（PivotFields对象）的对象。
    IPivotFormulas
    getPivotFormulas()
    获取一个表示指定数据透视表报告公式集合的PivotFormulas对象。
    IPivotAxis
    getPivotRowAxis()
    返回一个表示整个行轴的PivotAxis对象。
    IPivotFields
    getRowFields()
    返回一个表示当前作为行字段显示的所有字段的集合的对象。只读。
    boolean
    getRowGrand()
    获取数据透视表报告是否显示行的总计。
    IRange
    getRowRange()
    返回一个表示包含数据透视表报告上 行区域 的Range对象。
    boolean
    getShowTableStyleColumnHeaders()
    获取一个布尔值，以确定是否在数据透视表中显示列标题。
    boolean
    getShowTableStyleColumnStripes()
    获取布尔值，显示带状列，其中偶数列与奇数列的格式不同。这使PivotTable更易于阅读。
    boolean
    getShowTableStyleLastColumn()
    获取是否显示总计列样式的布尔值。
    boolean
    getShowTableStyleRowHeaders()
    获取是否应在数据透视表中显示行标题的布尔值。
    boolean
    getShowTableStyleRowStripes()
    获取布尔值，以显示带状行，其中偶数行与奇数行的格式不同。这使得数据透视表更容易阅读。
    ITableStyle
    getStyle()
    获取当前应用于指定数据透视表的样式。
    IRange
    getTableRange1()
    返回一个表示包含整个数据透视表报告的范围的Range对象，但不包括页面字段。
    IRange
    getTableRange2()
    返回一个表示包含整个数据透视表报告（包括页面字段）的范围的Range对象。
    String
    getTableStyle()
    获取在数据透视表报告正文中所使用的样式。默认值为空字符串（默认情况下不应用任何样式）。
    String
    getTag()
    获取与数据透视表报告一起保存的字符串。
    IPivotValueCell
    pivotValueCell(int rowline, int columnline)
    获取给定数据区域中特定行和列索引的PivotValueCell对象。
    boolean
    refresh()
    刷新从源数据中的数据透视表报告。如果成功，返回 True。
    void
    repeatAllLabels(PivotFieldRepeatLabels repeat)
    设置是否为指定数据透视表中的所有数据透视字段重复项目标签。
    void
    setAllowMultipleFilters(boolean allowMultipleFilters)
    设置是否可以对PivotField同时应用多个筛选器。
    void
    setColumnGrand(boolean value)
    设置数据透视表报告是否显示列的汇总总计。
    void
    setCompactRowIndent(int value)
    设置当紧凑行布局表单开启时，PivotItems的缩进增量。
    void
    setDeferLayoutUpdate(boolean value)
    设置是否推迟透视表布局更新。
    void
    setDisplayContextTooltips(boolean value)
    设置是否为数据透视表单元格显示工具提示。
    void
    setDisplayErrorString(boolean value)
    设置当数据透视表报告中的单元格包含错误时，是否显示自定义错误字符串。
    void
    setDisplayMemberPropertyTooltips(boolean value)
    设置是否在工具提示中显示成员属性。
    void
    setDisplayNullString(boolean value)
    设置当数据透视表报告中包含空值的单元格是否显示自定义字符串。
    void
    setErrorString(String value)
    设置当PivotTable.getDisplayErrorString()为True时，包含错误单元格中显示的字符串。
    void
    setGrandTotalName(String value)
    设置在指定数据透视表报告中显示在总计列或行标题中的文本字符串标签。默认值为字符串"Grand Total"。
    void
    setHasAutoFormat(boolean value)
    设置一个值，指示在刷新时PivotTable报告是否自动调整列宽。
    void
    setLayoutRowDefault(LayoutRowType value)
    设置在首次将PivotFields添加到数据透视表时的默认布局设置。
    void
    setMergeLabels(boolean value)
    设置指定的数据透视表报告是否对其外行项目、列项目、小计和总计标签使用合并单元格。
    void
    setName(String value)
    设置对象的名称。
    void
    setNullString(String value)
    设置当PivotTable.DisplayNullString属性为True时，包含null值的单元格中显示的字符串。
    void
    setPageFieldOrder(Order value)
    设置页面字段添加到数据透视表报告布局的顺序。可以是以下顺序常量之一：DownThenOver 或 OverThenDown。默认常量是 DownThenOver。
    void
    setPageFieldWrapCount(int value)
    设置数据透视表报表中每列或每行中的页字段数量。
    void
    setRowAxisLayout(LayoutRowType rowLayout)
    这个方法用于同时为所有现有的PivotFields设置布局选项。
    void
    setRowGrand(boolean value)
    设置数据透视表报告是否显示行的总计。
    void
    setShowTableStyleColumnHeaders(boolean value)
    设置是否在数据透视表中显示列标题。
    void
    setShowTableStyleColumnStripes(boolean value)
    设置布尔值以显示带状列，其中偶数列的格式与奇数列不同。这使得数据透视表更易于阅读。
    void
    setShowTableStyleLastColumn(boolean value)
    设置是否显示总合计列样式的布尔值。
    void
    setShowTableStyleRowHeaders(boolean value)
    设置布尔值，以确定是否在数据透视表中显示行标题。
    void
    setShowTableStyleRowStripes(boolean value)
    设置布尔值以显示带状行，其中偶数行与奇数行的格式不同。这使得数据透视表更容易阅读。
    void
    setStyle(ITableStyle style)
    设置当前应用于指定数据透视表的样式。
    void
    setTableStyle(String value)
    设置在数据透视表报告正文中使用的样式。默认值为空字符串（默认情况下不应用任何样式）。
    void
    setTag(String value)
    设置与数据透视表报告一起保存的字符串。
    void
    subtotalLocation(SubtotalLocationType location)
    更改所有现有数据透视字段的小计位置。更改小计位置只会立即影响概要形式中的字段视觉效果，但同样也会设置表格形式中的字段。
    void
    update()
    更新链接或数据透视表报告。

  • Method Details

    • getColumnGrand

      boolean getColumnGrand()
      获取数据透视表报告是否为列显示总计。

    • setColumnGrand

      void setColumnGrand(boolean value)
      设置数据透视表报告是否显示列的汇总总计。

    • getColumnFields

      IPivotFields getColumnFields()
      返回一个表示当前作为列字段显示的所有字段的集合的对象。只读。

    • getColumnRange

      IRange getColumnRange()
      返回一个表示包含数据透视表报告中列区域的范围的 Range 对象。

    • getCompactRowIndent

      int getCompactRowIndent()
      返回在开启紧凑行布局表单时，PivotItems的缩进增量。

    • setCompactRowIndent

      void setCompactRowIndent(int value)
      设置当紧凑行布局表单开启时，PivotItems的缩进增量。

    • getDataBodyRange

      IRange getDataBodyRange()
      返回一个表示列表中从标题行到插入行之间数据区域的范围的 Range 对象。

    • getDataFields

      IPivotFields getDataFields()
      返回一个表示当前作为数据字段显示的所有字段的集合的对象。只读。

    • getDeferLayoutUpdate

      boolean getDeferLayoutUpdate()
      返回是否推迟透视表布局更新。

    • setDeferLayoutUpdate

      void setDeferLayoutUpdate(boolean value)
      设置是否推迟透视表布局更新。

    • getDisplayContextTooltips

      boolean getDisplayContextTooltips()
      获取是否为数据透视表单元格显示工具提示。

    • setDisplayContextTooltips

      void setDisplayContextTooltips(boolean value)
      设置是否为数据透视表单元格显示工具提示。

    • getDisplayErrorString

      boolean getDisplayErrorString()
      获取数据透视表报告是否在包含错误的单元格中显示自定义错误字符串。默认值为False。

    • setDisplayErrorString

      void setDisplayErrorString(boolean value)
      设置当数据透视表报告中的单元格包含错误时，是否显示自定义错误字符串。

    • getDisplayMemberPropertyTooltips

      boolean getDisplayMemberPropertyTooltips()
      获取是否在工具提示中显示成员属性。

    • setDisplayMemberPropertyTooltips

      void setDisplayMemberPropertyTooltips(boolean value)
      设置是否在工具提示中显示成员属性。

    • getDisplayNullString

      boolean getDisplayNullString()
      获取数据透视表报告是否在包含空值的单元格中显示自定义字符串。默认值为 True。

    • setDisplayNullString

      void setDisplayNullString(boolean value)
      设置当数据透视表报告中包含空值的单元格是否显示自定义字符串。

    • getErrorString

      String getErrorString()
      返回当 PivotTable.getDisplayErrorString() 为 True 时包含错误的单元格中显示的字符串。默认值为空字符串("")。

    • setErrorString

      void setErrorString(String value)
      设置当PivotTable.getDisplayErrorString()为True时，包含错误单元格中显示的字符串。

    • getGrandTotalName

      String getGrandTotalName()
      获取在指定数据透视表报告中的总计列或行标题中显示的文本字符串标签。默认值为字符串"总计"。

    • setGrandTotalName

      void setGrandTotalName(String value)
      设置在指定数据透视表报告中显示在总计列或行标题中的文本字符串标签。默认值为字符串"Grand Total"。

    • getLayoutRowDefault

      LayoutRowType getLayoutRowDefault()
      获取首次将PivotFields添加到数据透视表时的默认布局设置。

    • setLayoutRowDefault

      void setLayoutRowDefault(LayoutRowType value)
      设置在首次将PivotFields添加到数据透视表时的默认布局设置。

    • getMergeLabels

      boolean getMergeLabels()
      获取指定数据透视表报告中外部行项目、列项目、小计和总计标签是否使用合并单元格。

    • setMergeLabels

      void setMergeLabels(boolean value)
      设置指定的数据透视表报告是否对其外行项目、列项目、小计和总计标签使用合并单元格。

    • getName

      String getName()
      获取对象的名称。

    • setName

      void setName(String value)
      设置对象的名称。

    • getNullString

      String getNullString()
      返回当PivotTable.DisplayNullString属性为True时，包含空值单元格中显示的字符串。默认值是一个空字符串（""）。

    • setNullString

      void setNullString(String value)
      设置当PivotTable.DisplayNullString属性为True时，包含null值的单元格中显示的字符串。

    • getPageFieldOrder

      Order getPageFieldOrder()
      返回页面字段添加到数据透视表报告布局的顺序。可以是以下顺序常量之一：DownThenOver（先下后跨）或 OverThenDown（先跨后下）。默认常量是 DownThenOver。

    • setPageFieldOrder

      void setPageFieldOrder(Order value)
      设置页面字段添加到数据透视表报告布局的顺序。可以是以下顺序常量之一：DownThenOver 或 OverThenDown。默认常量是 DownThenOver。

    • getPageFields

      IPivotFields getPageFields()
      返回一个表示当前显示为页面字段的字段集合的对象。只读。

    • getPageFieldWrapCount

      int getPageFieldWrapCount()
      返回数据透视表报表中每一列或行中的页面字段数量。

    • setPageFieldWrapCount

      void setPageFieldWrapCount(int value)
      设置数据透视表报表中每列或每行中的页字段数量。

    • getPageRange

      IRange getPageRange()
      返回一个表示在数据透视表报告中包含页面区域的范围的 Range 对象。

    • getPivotColumnAxis

      IPivotAxis getPivotColumnAxis()
      返回一个表示整个列轴的PivotAxis对象。

    • getPivotRowAxis

      IPivotAxis getPivotRowAxis()
      返回一个表示整个行轴的PivotAxis对象。

    • getRowFields

      IPivotFields getRowFields()
      返回一个表示当前作为行字段显示的所有字段的集合的对象。只读。

    • getRowGrand

      boolean getRowGrand()
      获取数据透视表报告是否显示行的总计。

    • setRowGrand

      void setRowGrand(boolean value)
      设置数据透视表报告是否显示行的总计。

    • getRowRange

      IRange getRowRange()
      返回一个表示包含数据透视表报告上 行区域 的Range对象。

    • getShowTableStyleColumnHeaders

      boolean getShowTableStyleColumnHeaders()
      获取一个布尔值，以确定是否在数据透视表中显示列标题。

    • setShowTableStyleColumnHeaders

      void setShowTableStyleColumnHeaders(boolean value)
      设置是否在数据透视表中显示列标题。

    • getShowTableStyleColumnStripes

      boolean getShowTableStyleColumnStripes()
      获取布尔值，显示带状列，其中偶数列与奇数列的格式不同。这使PivotTable更易于阅读。

    • setShowTableStyleColumnStripes

      void setShowTableStyleColumnStripes(boolean value)
      设置布尔值以显示带状列，其中偶数列的格式与奇数列不同。这使得数据透视表更易于阅读。

    • getShowTableStyleLastColumn

      boolean getShowTableStyleLastColumn()
      获取是否显示总计列样式的布尔值。

    • setShowTableStyleLastColumn

      void setShowTableStyleLastColumn(boolean value)
      设置是否显示总合计列样式的布尔值。

    • getShowTableStyleRowHeaders

      boolean getShowTableStyleRowHeaders()
      获取是否应在数据透视表中显示行标题的布尔值。

    • setShowTableStyleRowHeaders

      void setShowTableStyleRowHeaders(boolean value)
      设置布尔值，以确定是否在数据透视表中显示行标题。

    • getShowTableStyleRowStripes

      boolean getShowTableStyleRowStripes()
      获取布尔值，以显示带状行，其中偶数行与奇数行的格式不同。这使得数据透视表更容易阅读。

    • setShowTableStyleRowStripes

      void setShowTableStyleRowStripes(boolean value)
      设置布尔值以显示带状行，其中偶数行与奇数行的格式不同。这使得数据透视表更容易阅读。

    • getTableRange1

      IRange getTableRange1()
      返回一个表示包含整个数据透视表报告的范围的Range对象，但不包括页面字段。

    • getTableRange2

      IRange getTableRange2()
      返回一个表示包含整个数据透视表报告（包括页面字段）的范围的Range对象。

    • getTableStyle

      String getTableStyle()
      获取在数据透视表报告正文中所使用的样式。默认值为空字符串（默认情况下不应用任何样式）。

    • setTableStyle

      void setTableStyle(String value)
      设置在数据透视表报告正文中使用的样式。默认值为空字符串（默认情况下不应用任何样式）。

    • getTag

      String getTag()
      获取与数据透视表报告一起保存的字符串。

    • setTag

      void setTag(String value)
      设置与数据透视表报告一起保存的字符串。

    • addDataField

      IPivotField addDataField(IPivotField field, String caption, ConsolidationFunction function)
      添加一个数据字段到透视表报告。返回一个表示新数据字段的PivotField对象。
      Parameters:
      field - 服务器上的唯一字段。如果源数据是联机分析处理（OLAP），则唯一字段是立方体字段。如果源数据是非OLAP（非OLAP源数据），则唯一字段是透视表字段。
      caption - 在透视表报告中用于标识此数据字段的标签。
      function - 在添加的数据字段中执行的功能。

    • getCalculatedFields

      ICalculatedFields getCalculatedFields()
      返回一个代表指定数据透视表报告中所有计算字段的CalculatedFields集合。

    • clearAllFilters

      void clearAllFilters()
      删除当前应用于数据透视表的所有筛选器。这包括删除数据透视表对象中PivotFilters集合中的所有筛选器，移除任何手动应用的筛选，并将报告筛选区域中的所有数据透视字段设置为默认项。

    • clearTable

      void clearTable()
      清除一个数据透视表。清除数据透视表包括移除所有字段，并删除对数据透视表应用的所有筛选和排序。此方法将数据透视表重置为创建后立即的状态，即任何字段被添加之前的状态。

    • getPivotCache

      IPivotCache getPivotCache()
      返回一个表示指定数据透视表报告的缓存区的PivotCache对象。

    • getPivotFields

      IPivotFields getPivotFields()
      返回一个代表PivotTable报告中的单个数据透视字段（PivotField对象）或同时包含可见字段和隐藏字段集合（PivotFields对象）的对象。

    • pivotValueCell

      IPivotValueCell pivotValueCell(int rowline, int columnline)
      获取给定数据区域中特定行和列索引的PivotValueCell对象。
      Parameters:
      rowline - 数据区域中的行位置。
      columnline - 数据区域中的列位置。

    • refresh

      boolean refresh()
      刷新从源数据中的数据透视表报告。如果成功，返回 True。
      Throws:
      IllegalStateException - 如果数据透视表的源工作表不存在。

    • repeatAllLabels

      void repeatAllLabels(PivotFieldRepeatLabels repeat)
      设置是否为指定数据透视表中的所有数据透视字段重复项目标签。
      Parameters:
      repeat - 指定是否为指定数据透视表中的所有数据透视字段重复项目标签。

    • setRowAxisLayout

      void setRowAxisLayout(LayoutRowType rowLayout)
      这个方法用于同时为所有现有的PivotFields设置布局选项。
      Parameters:
      rowLayout - 指定布局行的类型。

    • subtotalLocation

      void subtotalLocation(SubtotalLocationType location)
      更改所有现有数据透视字段的小计位置。更改小计位置只会立即影响概要形式中的字段视觉效果，但同样也会设置表格形式中的字段。

    • update

      void update()
      更新链接或数据透视表报告。

    • getStyle

      ITableStyle getStyle()
      获取当前应用于指定数据透视表的样式。

    • setStyle

      void setStyle(ITableStyle style)
      设置当前应用于指定数据透视表的样式。

    • getPivotFormulas

      IPivotFormulas getPivotFormulas()
      获取一个表示指定数据透视表报告公式集合的PivotFormulas对象。

    • getAllowMultipleFilters

      boolean getAllowMultipleFilters()
      获取是否可以对PivotField同时应用多个筛选器。

    • setAllowMultipleFilters

      void setAllowMultipleFilters(boolean allowMultipleFilters)
      设置是否可以对PivotField同时应用多个筛选器。

    • getHasAutoFormat

      boolean getHasAutoFormat()
      获取一个值，指示在刷新时PivotTable报告是否自动调整列宽。默认值为true。

    • setHasAutoFormat

      void setHasAutoFormat(boolean value)
      设置一个值，指示在刷新时PivotTable报告是否自动调整列宽。