Package io.revealbi.core

Interface IExportOptions

All Known Implementing Classes:
CsvExportOptions, DocumentExportOptions, ExcelExportOptions, ExportOptions, ImageExportOptions, PdfExportOptions, PowerPointExportOptions
public interface IExportOptions
Indicates configuration for exporting a dashboard

  • Method Details

    • setUseNewCharts

      void setUseNewCharts(boolean useNewCharts)

    • getUseNewCharts

      boolean getUseNewCharts()

    • setTheme

      void setTheme(IDashboardTheme theme)
      Theme object to indicate export used colors
      Parameters:
      theme - Theme object to indicate export used colors

    • getTheme

      IDashboardTheme getTheme()
      Theme object to indicate export used colors
      Returns:
      Theme object to indicate export used colors

    • setTimeout

      void setTimeout(int timeoutSeconds)
      Timeout in seconds for exporting a dashboard
      Parameters:
      timeoutSeconds - Timeout in seconds for exporting a dashboard

    • getTimeout

      int getTimeout()
      Timeout in seconds for exporting a dashboard
      Returns:
      Timeout in seconds for exporting a dashboard

    • setTimeZone

      void setTimeZone(String tz)
      Timezone in IANA format
      Parameters:
      tz - Timezone in IANA format

    • getTimeZone

      String getTimeZone()
      Timezone in IANA format
      Returns:
      Timezone in IANA format

    • setMaxCacheAge

      void setMaxCacheAge(Duration maxCacheAge)
      Maximum age of cached data used during the export.
      Parameters:
      maxCacheAge - Maximum age of cached data used during the export.

    • getMaxCacheAge

      Duration getMaxCacheAge()
      Maximum age of cached data used during the export.
      Returns:
      Maximum age of cached data used during the export.

    • setMaxCells

      void setMaxCells(int maxCells)
      Max cells returned when getting dashboard data
      Parameters:
      maxCells - Max cells returned when getting dashboard data

    • getMaxCells

      int getMaxCells()
      Max cells returned when getting dashboard data
      Returns:
      Max cells returned when getting dashboard data

    • setUserLanguage

      void setUserLanguage(String ul)
      User language
      Parameters:
      ul - User language

    • getUserLanguage

      String getUserLanguage()
      User language
      Returns:
      User language

    • setVisualizations

      void setVisualizations(ArrayList<VisualizationExport> visualizations)
      List of visualizations that will be exported. If this collection is empty all visualizations are exported
      Parameters:
      visualizations - List of visualizations that will be exported. If this collection is empty all visualizations are exported

    • getVisualizations

      ArrayList<VisualizationExport> getVisualizations()
      List of visualizations that will be exported. If this collection is empty all visualizations are exported
      Returns:
      List of visualizations that will be exported. If this collection is empty all visualizations are exported

    • getFilters

      ArrayList<IRVDashboardFilter> getFilters()
      Dashboard filters applied during the export.
      Returns:
      Dashboard filters applied during the export.

    • setFilters

      void setFilters(ArrayList<IRVDashboardFilter> filters)
      Dashboard filters applied during the export.
      Parameters:
      filters - Dashboard filters applied during the export.

    • getIncludeFiltersSummaryPage

      boolean getIncludeFiltersSummaryPage()
      Indicates whether a summary page listing the active filters is appended to the export.
      Returns:
      Indicates whether a summary page listing the active filters is appended to the export.

    • setIncludeFiltersSummaryPage

      void setIncludeFiltersSummaryPage(boolean includeFiltersSummary)
      Indicates whether a summary page listing the active filters is appended to the export.
      Parameters:
      includeFiltersSummary - Indicates whether a summary page listing the active filters is appended to the export.