Package io.revealbi.core

Class ExportConfiguration

java.lang.Object
io.revealbi.core.ExportConfiguration
public class ExportConfiguration extends Object
Contains configuration settings for dashboard exports.

  • Constructor Details

    • ExportConfiguration

      public ExportConfiguration()

  • Method Details

    • getProperties

      public Map<String,Object> getProperties()

    • getChromiumExecutablePath

      public String getChromiumExecutablePath()
      Path to Chromium executable file. If not set, the application will use a temporary folder to download chromium and use it from there.
      Returns:
      Path to Chromium executable file. If not set, the application will use a temporary folder to download chromium and use it from there.

    • setChromiumExecutablePath

      public void setChromiumExecutablePath(String path)
      Path to Chromium executable file. If not set, the application will use a temporary folder to download chromium and use it from there.
      Parameters:
      path - Path to Chromium executable file. If not set, the application will use a temporary folder to download chromium and use it from there.

    • getChromiumDownloadFolder

      public String getChromiumDownloadFolder()
      Indicates the folder where Chromium will be downloaded. The intention of this property is to allow the application to download Chromium automatically if it's not installed. If you already have chromium locally, please use getChromiumExecutablePath() to indicate the path to the executable file.
      Returns:
      Indicates the folder where Chromium will be downloaded. The intention of this property is to allow the application to download Chromium automatically if it's not installed. If you already have chromium locally, please use getChromiumExecutablePath() to indicate the path to the executable file.

    • setChromiumDownloadFolder

      public void setChromiumDownloadFolder(String path)
      Indicates the folder where Chromium will be downloaded. The intention of this property is to allow the application to download Chromium automatically if it's not installed. If you already have chromium locally, please use getChromiumExecutablePath() to indicate the path to the executable file.
      Parameters:
      path - Indicates the folder where Chromium will be downloaded. The intention of this property is to allow the application to download Chromium automatically if it's not installed. If you already have chromium locally, please use getChromiumExecutablePath() to indicate the path to the executable file.

    • getSdkJsDistributionFile

      public String getSdkJsDistributionFile()
      Indicates a local zip file containing the sdk js distribution. It could be downloaded from https://dl.revealbi.io/reveal/libs/x.x.x/reveal-sdk-distribution-js.zip, where x.x.x is the corresponding version.
      Returns:
      Indicates a local zip file containing the sdk js distribution. It could be downloaded from https://dl.revealbi.io/reveal/libs/x.x.x/reveal-sdk-distribution-js.zip, where x.x.x is the corresponding version.

    • setSdkJsDistributionFile

      public void setSdkJsDistributionFile(String path)
      Indicates a local zip file containing the sdk js distribution. It could be downloaded from https://dl.revealbi.io/reveal/libs/x.x.x/reveal-sdk-distribution-js.zip, where x.x.x is the corresponding version.
      Parameters:
      path - Indicates a local zip file containing the sdk js distribution. It could be downloaded from https://dl.revealbi.io/reveal/libs/x.x.x/reveal-sdk-distribution-js.zip, where x.x.x is the corresponding version.

    • getMaxConcurrentExportingThreads

      public Integer getMaxConcurrentExportingThreads()
      Max allowed concurrent Threads for the exporting to image tool (Playwright). Default value: 2.
      Returns:
      Max allowed concurrent Threads for the exporting to image tool (Playwright). Default value: 2.

    • setMaxConcurrentExportingThreads

      public void setMaxConcurrentExportingThreads(Integer value)
      Max allowed concurrent Threads for the exporting to image tool (Playwright). Default value: 2.
      Parameters:
      value - Max allowed concurrent Threads for the exporting to image tool (Playwright). Default value: 2.

    • getCreateChromiumInstancesOnDemand

      public Boolean getCreateChromiumInstancesOnDemand()
      Indicates if Chromium instances are created when they are needed, or when application is started. Default: true
      Returns:
      Indicates if Chromium instances are created when they are needed, or when application is started. Default: true

    • setCreateChromiumInstancesOnDemand

      public void setCreateChromiumInstancesOnDemand(Boolean value)
      Indicates if Chromium instances are created when they are needed, or when application is started. Default: true
      Parameters:
      value - Indicates if Chromium instances are created when they are needed, or when application is started. Default: true

    • getExportingTimeout

      public Integer getExportingTimeout()
      Indicates the time in ms to wait when exporting dashboard is called. Default value: 30000 ms.
      Returns:
      Indicates the time in ms to wait when exporting dashboard is called. Default value: 30000 ms.

    • setExportingTimeout

      public void setExportingTimeout(Integer value)
      Indicates the time in ms to wait when exporting dashboard is called. Default value: 30000 ms.
      Parameters:
      value - Indicates the time in ms to wait when exporting dashboard is called. Default value: 30000 ms.