Package io.revealbi.core

Class DocumentExportOptions

java.lang.Object
io.revealbi.core.ExportOptions
io.revealbi.core.DocumentExportOptions
All Implemented Interfaces:
IDocumentExportOptions, IExportOptions, IInitScriptProviderExportOptions
Direct Known Subclasses:
PdfExportOptions, PowerPointExportOptions
public class DocumentExportOptions extends ExportOptions implements IDocumentExportOptions
Contains document configuration for exporting a dashboard.

  • Constructor Details

    • DocumentExportOptions

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

    • DocumentExportOptions

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

  • Method Details

    • getAuthor

      public String getAuthor()
      Document author. It will be displayed in the upper left corner
      Specified by:
      getAuthor in interface IDocumentExportOptions
      Returns:
      Document author. It will be displayed in the upper left corner

    • setAuthor

      public void setAuthor(String author)
      Document author. It will be displayed in the upper left corner
      Specified by:
      setAuthor in interface IDocumentExportOptions
      Parameters:
      author - Document author. It will be displayed in the upper left corner

    • getCompany

      public String getCompany()
      Company name displayed in the lower left corner
      Specified by:
      getCompany in interface IDocumentExportOptions
      Returns:
      Company name displayed in the lower left corner

    • setCompany

      public void setCompany(String company)
      Company name displayed in the lower left corner
      Specified by:
      setCompany in interface IDocumentExportOptions
      Parameters:
      company - Company name displayed in the lower left corner

    • getIsLandscape

      public boolean getIsLandscape()
      Indicates page orientation when exporting
      Specified by:
      getIsLandscape in interface IDocumentExportOptions
      Returns:
      Indicates page orientation when exporting

    • setIsLandscape

      public void setIsLandscape(boolean isLandscape)
      Indicates page orientation when exporting
      Specified by:
      setIsLandscape in interface IDocumentExportOptions
      Parameters:
      isLandscape - Indicates page orientation when exporting

    • getLogo

      public byte[] getLogo()
      Company logo displayed in the lower left corner. Only in the first page
      Specified by:
      getLogo in interface IDocumentExportOptions
      Returns:
      Company logo displayed in the lower left corner. Only in the first page

    • setLogo

      public void setLogo(byte[] logo)
      Company logo displayed in the lower left corner. Only in the first page
      Specified by:
      setLogo in interface IDocumentExportOptions
      Parameters:
      logo - Company logo displayed in the lower left corner. Only in the first page

    • getColor

      public int getColor()
      Color used for titles underlines
      Specified by:
      getColor in interface IDocumentExportOptions
      Returns:
      Color used for titles underlines

    • setColor

      public void setColor(int color)
      Color used for titles underlines
      Specified by:
      setColor in interface IDocumentExportOptions
      Parameters:
      color - Color used for titles underlines

    • getInitScript

      public String getInitScript()
      Indicates a script used to initialize revealView when exporting. The script must contain a function called initReveal(revealView)
      Specified by:
      getInitScript in interface IInitScriptProviderExportOptions
      Returns:
      Indicates a script used to initialize revealView when exporting.

    • setInitScript

      public void setInitScript(String script)
      Indicates a script used to initialize revealView when exporting. The script must contain a function called initReveal(revealView)
      Specified by:
      setInitScript in interface IInitScriptProviderExportOptions
      Parameters:
      script - Indicates a script used to initialize revealView when exporting.

    • setCreatedBy

      @Deprecated public void setCreatedBy(String author)
      Deprecated.
      Use setAuthor(String) instead.

    • getCreatedBy

      @Deprecated public String getCreatedBy()
      Deprecated.
      Use getAuthor() instead.

    • setPoweredBy

      @Deprecated public void setPoweredBy(String company)
      Deprecated.
      Use setCompany(String) instead.

    • getPoweredBy

      @Deprecated public String getPoweredBy()
      Deprecated.
      Use getCompany() instead.