Package io.revealbi.core

Class ExportOptions

java.lang.Object
io.revealbi.core.ExportOptions
All Implemented Interfaces:
IExportOptions
Direct Known Subclasses:
CsvExportOptions, DocumentExportOptions, ExcelExportOptions, ImageExportOptions
public class ExportOptions extends Object implements IExportOptions
Contains base configuration for exporting a dashboard.

  • Constructor Details

    • ExportOptions

      public ExportOptions()
      Initializes a new instance of the export options.

    • ExportOptions

      public ExportOptions(IExportOptions options)
      Initializes a new instance of the export options from existing export options.
      Parameters:
      options - The export options to copy values from.

  • Method Details

    • setUseNewCharts

      public void setUseNewCharts(boolean useNewCharts)
      Specified by:
      setUseNewCharts in interface IExportOptions

    • getUseNewCharts

      public boolean getUseNewCharts()
      Specified by:
      getUseNewCharts in interface IExportOptions

    • getTheme

      public IDashboardTheme getTheme()
      Theme object to indicate export used colors
      Specified by:
      getTheme in interface IExportOptions
      Returns:
      Theme object to indicate export used colors

    • setTheme

      public void setTheme(IDashboardTheme theme)
      Theme object to indicate export used colors
      Specified by:
      setTheme in interface IExportOptions
      Parameters:
      theme - Theme object to indicate export used colors

    • setTimeout

      public void setTimeout(int seconds)
      Timeout in seconds for exporting a dashboard
      Specified by:
      setTimeout in interface IExportOptions
      Parameters:
      seconds - Timeout in seconds for exporting a dashboard

    • getTimeout

      public int getTimeout()
      Timeout in seconds for exporting a dashboard
      Specified by:
      getTimeout in interface IExportOptions
      Returns:
      Timeout in seconds for exporting a dashboard

    • setTimeZone

      public void setTimeZone(String tz)
      Timezone in IANA format
      Specified by:
      setTimeZone in interface IExportOptions
      Parameters:
      tz - Timezone in IANA format

    • getTimeZone

      public String getTimeZone()
      Timezone in IANA format
      Specified by:
      getTimeZone in interface IExportOptions
      Returns:
      Timezone in IANA format

    • setMaxCacheAge

      public void setMaxCacheAge(Duration maxCacheAge)
      Maximum age of cached data used during the export.
      Specified by:
      setMaxCacheAge in interface IExportOptions
      Parameters:
      maxCacheAge - Maximum age of cached data used during the export.

    • getMaxCacheAge

      public Duration getMaxCacheAge()
      Maximum age of cached data used during the export.
      Specified by:
      getMaxCacheAge in interface IExportOptions
      Returns:
      Maximum age of cached data used during the export.

    • setMaxCells

      public void setMaxCells(int maxCells)
      Max cells returned when getting dashboard data
      Specified by:
      setMaxCells in interface IExportOptions
      Parameters:
      maxCells - Max cells returned when getting dashboard data

    • getMaxCells

      public int getMaxCells()
      Max cells returned when getting dashboard data
      Specified by:
      getMaxCells in interface IExportOptions
      Returns:
      Max cells returned when getting dashboard data

    • setUserLanguage

      public void setUserLanguage(String ul)
      User language
      Specified by:
      setUserLanguage in interface IExportOptions
      Parameters:
      ul - User language

    • getUserLanguage

      public String getUserLanguage()
      User language
      Specified by:
      getUserLanguage in interface IExportOptions
      Returns:
      User language

    • setVisualizations

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

    • getVisualizations

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

    • getFilters

      public ArrayList<IRVDashboardFilter> getFilters()
      Dashboard filters applied during the export.
      Specified by:
      getFilters in interface IExportOptions
      Returns:
      Dashboard filters applied during the export.

    • setFilters

      public void setFilters(ArrayList<IRVDashboardFilter> filters)
      Dashboard filters applied during the export.
      Specified by:
      setFilters in interface IExportOptions
      Parameters:
      filters - Dashboard filters applied during the export.

    • getIncludeFiltersSummaryPage

      public boolean getIncludeFiltersSummaryPage()
      Indicates whether a summary page listing the active filters is appended to the export.
      Specified by:
      getIncludeFiltersSummaryPage in interface IExportOptions
      Returns:
      Indicates whether a summary page listing the active filters is appended to the export.

    • setIncludeFiltersSummaryPage

      public void setIncludeFiltersSummaryPage(boolean includeFiltersSummary)
      Indicates whether a summary page listing the active filters is appended to the export.
      Specified by:
      setIncludeFiltersSummaryPage in interface IExportOptions
      Parameters:
      includeFiltersSummary - Indicates whether a summary page listing the active filters is appended to the export.