程序包 com.grapecity.documents.excel

接口 IPivotField

public interface IPivotField
表示在数据透视表报告中的一个字段。PivotField 对象是 PivotFields 集合的一个成员。PivotFields 集合包含了数据透视表报告中的所有字段，包括隐藏的字段。

  • 方法详细资料

    • getAllItemsVisible

      boolean getAllItemsVisible()
      获取一个值，该值表示是否对PivotField应用了任何手动筛选。

    • getAutoSortField

      String getAutoSortField()
      返回用于自动排序指定数据透视表字段的数据字段名称。

    • getAutoSortOrder

      SortOrder getAutoSortOrder()
      返回用于自动对指定数据透视表字段进行排序的顺序。

    • getBaseField

      String getBaseField()
      获取自定义计算的基础字段。此属性仅对数据字段有效。

    • setBaseField

      void setBaseField(String value)
      设置自定义计算的基础字段。此属性仅对数据字段有效。

    • getBaseItem

      String getBaseItem()
      获取基础字段中用于自定义计算的项。仅对数据字段有效。

    • setBaseItem

      void setBaseItem(String value)
      设置自定义计算的基础字段中的项目。仅对数据字段有效。

    • getCalculation

      PivotFieldCalculation getCalculation()
      获取一个 PivotFieldCalculation 值，该值表示指定字段执行的计算类型。此属性仅对数据字段有效。

    • setCalculation

      void setCalculation(PivotFieldCalculation value)
      设置一个 PivotFieldCalculation 值，该值表示指定字段执行的计算类型。此属性仅对数据字段有效。

    • getCurrentPage

      int getCurrentPage()
      获取当前页面字段显示的索引（仅对页面字段有效）。有效值基于零。" -1 "表示 "全部" 或 "多个项目"。

    • setCurrentPage

      void setCurrentPage(int value)
      设置当前页面字段显示的索引（仅对页面字段有效）。有效值基于零。" -1 "表示 "全部" 或 "多项内容"。

    • getDragToColumn

      boolean getDragToColumn()
      获取指定字段是否可以拖动到列位置。默认值为True。

    • setDragToColumn

      void setDragToColumn(boolean value)
      设置指定字段是否可以拖动到列位置。默认值为 True。

    • getDragToData

      boolean getDragToData()
      获取指定字段是否可以拖动到数据位置。默认值为 True。

    • setDragToData

      void setDragToData(boolean value)
      设置指定字段是否可以拖动到数据位置。默认值为 True。

    • getDragToHide

      boolean getDragToHide()
      获取字段是否可以通过拖动使其离开数据透视表报告而被隐藏。默认值为 True。

    • setDragToHide

      void setDragToHide(boolean value)
      设置该字段是否可以通过拖动从数据透视表报告中隐藏。默认值为 True。

    • getDragToPage

      boolean getDragToPage()
      获取字段是否可以被拖动到页面位置。默认值为 True。

    • setDragToPage

      void setDragToPage(boolean value)
      设置该字段是否可以拖动到页面位置。默认值为True。

    • getDragToRow

      boolean getDragToRow()
      获取字段是否可以拖动到行位置。默认值为True。

    • setDragToRow

      void setDragToRow(boolean value)
      设置字段是否可以拖动到行位置。默认值为True。

    • getEnableMultiplePageItems

      boolean getEnableMultiplePageItems()
      获取字段是否可以在页面字段中选择多个项目。默认值为false。

    • setEnableMultiplePageItems

      void setEnableMultiplePageItems(boolean value)
      设置字段是否可以在页面字段中选择多个项目。默认值为 false。

    • getFormula

      String getFormula()
      获取一个字符串值，该值以A1样式表示对象的公式，并使用宏的语言。

    • setFormula

      void setFormula(String value)
      设置一个代表对象公式的字符串值，使用A1样式表示法，并且用宏的语言表达。

    • getFunction

      ConsolidationFunction getFunction()
      获取用于汇总透视表字段（仅限数据字段）的函数。

    • setFunction

      void setFunction(ConsolidationFunction value)
      设置用于汇总透视表字段的功能（仅限数据字段）。

    • getLayoutBlankLine

      boolean getLayoutBlankLine()
      获取在PivotTable报表中指定行字段后是否插入空行的设置。默认值为False。

    • setLayoutBlankLine

      void setLayoutBlankLine(boolean value)
      设置在透视表报告中的指定行字段后是否插入空行。默认值为 False。

    • getLayoutCompactRow

      boolean getLayoutCompactRow()
      获取当选择行时，是否对 PivotField 进行了压缩（多个 PivotField 的项目在单列中显示）。

    • setLayoutCompactRow

      void setLayoutCompactRow(boolean value)
      设置当选择行时，是否将PivotField合并（多个PivotField的项目在单列中显示）。

    • getLayoutForm

      LayoutFormType getLayoutForm()
      返回指定数据透视表项的显示方式——以表格格式还是大纲格式。

    • setLayoutForm

      void setLayoutForm(LayoutFormType value)
      设置指定数据透视表项目的外观方式——以表格格式或大纲格式显示。

    • getLayoutSubtotalLocation

      SubtotalLocationType getLayoutSubtotalLocation()
      获取枢轴表字段小计与指定字段（上方或下方）的相对位置。

    • setLayoutSubtotalLocation

      void setLayoutSubtotalLocation(SubtotalLocationType value)
      设置数据透视表字段小计相对于指定字段的位置（在字段上方或下方）。

    • getName

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

    • setName

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

    • getNumberFormat

      String getNumberFormat()
      获取对象的格式代码。

    • setNumberFormat

      void setNumberFormat(String value)
      设置对象的格式代码。

    • getOrientation

      PivotFieldOrientation getOrientation()
      获取指定数据透视表报告中字段的位置。

    • setOrientation

      void setOrientation(PivotFieldOrientation value)
      设置字段在指定数据透视表报告中的位置。

    • getPosition

      int getPosition()
      获取字段在其方向上（行、列、页、数据）所有字段中的位置（第一、第二、第三等）。

    • setPosition

      void setPosition(int value)
      设置字段在其方向（行、列、页、数据）中所有字段中的位置（第一、第二、第三等）。

    • getRepeatLabels

      boolean getRepeatLabels()
      获取是否为指定的PivotField在数据透视表中重复项目标签。
      返回:
      如果标签重复，则为True；否则为False。

    • setRepeatLabels

      void setRepeatLabels(boolean value)
      设置是否在数据透视表中为指定的数据透视字段重复项目标签。

    • getShowAllItems

      boolean getShowAllItems()
      获取是否在数据透视表报告中显示所有项，即使它们不包含汇总数据。默认值为 False。

    • setShowAllItems

      void setShowAllItems(boolean value)
      设置是否显示数据透视表报告中的所有项，即使它们不包含汇总数据。默认值为 False。

    • getSourceName

      String getSourceName()
      返回指定对象在指定数据透视表报告的原始源数据中的名称。如果用户在创建数据透视表报告后重命名了该对象，这个名称可能与当前项目名称不同。

    • getSubtotals

      EnumSet<SubtotalType> getSubtotals()
      获取指定数据透视字段中所有显示的小计类型的组合。仅对非数据字段有效。

    • setSubtotals

      void setSubtotals(EnumSet<SubtotalType> value)
      设置指定数据透视字段中所有显示的小计类型的组合。仅对非数据字段有效。

    • autoSort

      void autoSort(SortOrder Order, String Field)
      建立PivotTable报告的自动字段排序规则。
      参数:
      Order - 必需的 SortOrder。排序顺序。
      Field - 排序关键字段的名称。您必须指定唯一的名称（如 IPivotField.getSourceName() 返回的名称），而不是显示的名称。

    • autoSort

      void autoSort(SortOrder Order)
      建立数据透视表报告的自动字段排序规则。
      参数:
      Order - 必需的 SortOrder。排序顺序。

    • clearAllFilters

      void clearAllFilters()
      删除当前应用于PivotField的所有筛选器。这包括删除PivotField的PivotFilters集合中的所有筛选器，以及移除对PivotField应用的任何手动筛选。如果PivotField位于报告筛选区域，所选项目将被设置为默认项。

    • clearManualFilter

      void clearManualFilter()
      提供了一个简单的方法，用于将透视表中的PivotField的所有项目的Visible属性设置为True，并在OLAP透视表中清空HiddenItemsList和VisibleItemsList集合。

    • getPivotItems

      IPivotItems getPivotItems()
      返回指定字段中所有可见和隐藏项目的集合。

    • getCalculatedItems

      ICalculatedItems getCalculatedItems()
      返回一个表示指定数据透视表报告中所有计算项目的 ICalculatedItems 集合。
      返回:
      计算项目集合

    • getPivotFilters

      IPivotFilters getPivotFilters()
      获取当前IPivotField的筛选器集合。

    • clearLabelFilter

      void clearLabelFilter()
      该方法删除PivotField中的PivotFilters集合中的所有标签过滤器或所有日期过滤器。

    • clearValueFilter

      void clearValueFilter()
      此方法删除PivotField中PivotFilters集合内的所有值过滤器。