Package com.grapecity.documents.excel

Class PivotFilterOptions

java.lang.Object
com.grapecity.documents.excel.PivotFilterOptions
public class PivotFilterOptions extends Object
Pivot filter optional settings, contains some special settings for Value filter, date filter, and top 10 filter.

  • Constructor Details

    • PivotFilterOptions

      public PivotFilterOptions()

  • Method Details

    • getName

      public String getName()
      Gets the name of the filter.
      Returns:
      the name of the filter

    • setName

      public void setName(String name)
      Sets the name of the filter.
      Parameters:
      name - the name of the filter

    • getDescription

      public String getDescription()
      Gets a brief description of the filter.
      Returns:
      the description of the filter

    • setDescription

      public void setDescription(String description)
      Sets a brief description of the filter.
      Parameters:
      description - the description of the filter

    • getAppliedDataField

      public int getAppliedDataField()
      Gets the value filter setting. Specifies which DataField the current field is filtered by. The value represents the index of the referenced DataField in the DataFields collection.
      Returns:
      the applied data field index

    • setAppliedDataField

      public void setAppliedDataField(int appliedDataField)
      Sets the value filter setting. Specifies which DataField the current field is filtered by. The value represents the index of the referenced DataField in the DataFields collection.
      Parameters:
      appliedDataField - the applied data field index

    • getWholeDayFilter

      public boolean getWholeDayFilter()
      Gets a value indicating whether the date filter should use whole days in its filtering criteria.
      Returns:
      true if the date filter should use whole days, false otherwise

    • setWholeDayFilter

      public void setWholeDayFilter(boolean wholeDayFilter)
      Sets a value indicating whether the date filter should use whole days in its filtering criteria.
      Parameters:
      wholeDayFilter - true if the date filter should use whole days, false otherwise

    • getIsTop10Type

      public boolean getIsTop10Type()
      Gets a value indicating the selection direction of the 'top 10 filter'. 'True' means selecting the top n items, and 'false' means selecting the bottom n items. The default value is 'true'.
      Returns:
      true if selecting the top n items, false if selecting the bottom n items

    • setIsTop10Type

      public void setIsTop10Type(boolean isTop10Type)
      Sets a value indicating the selection direction of the 'top 10 filter'. 'True' means selecting the top n items, and 'false' means selecting the bottom n items. The default value is 'true'.
      Parameters:
      isTop10Type - true if selecting the top n items, false if selecting the bottom n items