Package com.grapecity.documents.excel

Interface IPivotFilter

public interface IPivotFilter
Represents a pivot filter in the PivotFilters collection.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    delete()
    Deletes the filter and removes it from the filter collections of the PivotField.
    IPivotField
    getDataField()
    Gets the data field that the pivot filter depends on.
    String
    getDescription()
    Gets the description of the pivot filter.
    PivotFilterType
    getFilterType()
    Gets the type of the pivot filter.
    String
    getName()
    Gets the name of the pivot filter.
    IPivotField
    getPivotField()
    Gets the label field that the pivot filter depends on.
    Object
    getValue1()
    Gets the first filter value.
    Object
    getValue2()
    Gets the second filter value.
    boolean
    getWholeDayFilter()
    Gets a value indicating whether the date filter should use whole days in its filtering criteria.
    void
    setWholeDayFilter(boolean wholeDayFilter)
    Sets a value indicating whether the date filter should use whole days in its filtering criteria.

  • Method Details

    • getDataField

      IPivotField getDataField()
      Gets the data field that the pivot filter depends on.
      Returns:
      the data field that the pivot filter depends on

    • getDescription

      String getDescription()
      Gets the description of the pivot filter. The maximum length of the description string is 255 characters.
      Returns:
      the description of the pivot filter

    • getFilterType

      PivotFilterType getFilterType()
      Gets the type of the pivot filter.
      Returns:
      the type of the pivot filter

    • getName

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

    • getPivotField

      IPivotField getPivotField()
      Gets the label field that the pivot filter depends on.
      Returns:
      the label field that the pivot filter depends on

    • getValue1

      Object getValue1()
      Gets the first filter value.
      Returns:
      the first filter value

    • getValue2

      Object getValue2()
      Gets the second filter value.
      Returns:
      the second filter value

    • delete

      void delete()
      Deletes the filter and removes it from the filter collections of the PivotField.

    • getWholeDayFilter

      boolean getWholeDayFilter()
      Gets a value indicating whether the date filter should use whole days in its filtering criteria.
      Returns:
      whether the date filter should use whole days in its filtering criteria

    • setWholeDayFilter

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