Package io.keikai.model

Interface STimeline

All Known Implementing Classes:
TimelineImpl
public interface STimeline
Represents a timeline control on a sheet, used to filter a date field in a pivot table.
Since:
7.0.0

  • Method Details

    • getName

      String getName()
      Returns the unique name of this timeline.
      Returns:
      the timeline name

    • getCaption

      String getCaption()
      Returns the display caption.
      Returns:
      the caption

    • getPivotTable

      SPivotTable getPivotTable()
      Returns the pivot table this timeline is connected to.
      Returns:
      the associated pivot table

    • getFieldIndex

      int getFieldIndex()
      Returns the index of the pivot field (date field) this timeline controls.
      Returns:
      the field index

    • getAnchor

      ViewAnchor getAnchor()
      Returns the anchor position of this timeline on the sheet.
      Returns:
      the view anchor

    • getLevel

      STimeline.TimeLevel getLevel()
      Returns the current time level (granularity).
      Returns:
      the time level

    • setLevel

      void setLevel(STimeline.TimeLevel level)
      Sets the time level (granularity).
      Parameters:
      level - the time level

    • getFilterStart

      Date getFilterStart()
      Returns the start date of the current filter, or null if no filter.
      Returns:
      the filter start date

    • getFilterEnd

      Date getFilterEnd()
      Returns the end date of the current filter, or null if no filter.
      Returns:
      the filter end date

    • setFilter

      void setFilter(Date start, Date end)
      Sets the date filter range.
      Parameters:
      start - the start date (inclusive)
      end - the end date (inclusive)

    • clearFilter

      void clearFilter()
      Clears the date filter.