Package io.revealbi.core

Class ExcelExportOptions

java.lang.Object

io.revealbi.core.ExportOptions

io.revealbi.core.ExcelExportOptions

All Implemented Interfaces:

IExcelExportOptions, IExportOptions

public class ExcelExportOptions
extends ExportOptions
implements IExcelExportOptions

Contains Excel configuration for exporting a dashboard.

Field Summary

Fields

Modifier and Type	Field	Description
ExportExcelVisualization	excelVisualization	Deprecated. Deprecated: Please use VisualizationMode instead.
ExcelVisualizationMode	visualizationMode	Controls how visualizations are included in the Excel export.

Constructor Summary

Constructors

Constructor	Description
ExcelExportOptions()	Creates a new ExcelExportOptions instance with ExcelVisualizationMode.INCLUDE as the default mode.

Method Summary

Modifier and Type	Method	Description
String	getCreatedBy()	Deprecated. Deprecated: This property is no longer used in excel exports and will be removed in future versions.
ExportExcelVisualization	getExcelVisualization()	Deprecated. Deprecated: Please use VisualizationMode instead.
String	getPoweredBy()	Deprecated. Deprecated: This property is no longer used in excel exports and will be removed in future versions.
ExcelVisualizationMode	getVisualizationMode()	Indicates additional configuration for Excel, see ExcelVisualizationMode
void	setCreatedBy(String author)	Deprecated. Deprecated: This property is no longer used in excel exports and will be removed in future versions.
void	setExcelVisualization(ExportExcelVisualization ev)	Deprecated. Deprecated: Please use VisualizationMode instead.
void	setLogo(byte[] logo)	Deprecated. Deprecated: This property is no longer used in excel exports and will be removed in future versions.
void	setPoweredBy(String company)	Deprecated. Deprecated: This property is no longer used in excel exports and will be removed in future versions.
void	setVisualizationMode(ExcelVisualizationMode mode)	Indicates additional configuration for Excel, see ExcelVisualizationMode

Methods inherited from class io.revealbi.core.ExportOptions

getFilters, getIncludeFiltersSummaryPage, getMaxCacheAge, getMaxCells, getTheme, getTimeout, getTimeZone, getUseNewCharts, getUserLanguage, getVisualizations, setFilters, setIncludeFiltersSummaryPage, setMaxCacheAge, setMaxCells, setTheme, setTimeout, setTimeZone, setUseNewCharts, setUserLanguage, setVisualizations

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

excelVisualization

@Deprecated
public ExportExcelVisualization excelVisualization

Deprecated.

Deprecated: Please use VisualizationMode instead.

visualizationMode

public ExcelVisualizationMode visualizationMode

Controls how visualizations are included in the Excel export.

Constructor Details

ExcelExportOptions

public ExcelExportOptions()

Creates a new ExcelExportOptions instance with ExcelVisualizationMode.INCLUDE as the default mode.

Method Details

getExcelVisualization

@Deprecated
public ExportExcelVisualization getExcelVisualization()

Deprecated.

Deprecated: Please use VisualizationMode instead.

setExcelVisualization

@Deprecated
public void setExcelVisualization(ExportExcelVisualization ev)

Deprecated.

Deprecated: Please use VisualizationMode instead.

setVisualizationMode

public void setVisualizationMode(ExcelVisualizationMode mode)

Description copied from interface: IExcelExportOptions

Indicates additional configuration for Excel, see ExcelVisualizationMode

Specified by:

setVisualizationMode in interface IExcelExportOptions

Parameters:

mode - Indicates additional configuration for Excel, see ExcelVisualizationMode

getVisualizationMode

public ExcelVisualizationMode getVisualizationMode()

Description copied from interface: IExcelExportOptions

Indicates additional configuration for Excel, see ExcelVisualizationMode

Specified by:

getVisualizationMode in interface IExcelExportOptions

Returns:

Indicates additional configuration for Excel, see ExcelVisualizationMode

setCreatedBy

@Deprecated
public void setCreatedBy(String author)

Deprecated.

Deprecated: This property is no longer used in excel exports and will be removed in future versions.

getCreatedBy

@Deprecated
public String getCreatedBy()

Deprecated.

Deprecated: This property is no longer used in excel exports and will be removed in future versions.

setPoweredBy

@Deprecated
public void setPoweredBy(String company)

Deprecated.

Deprecated: This property is no longer used in excel exports and will be removed in future versions.

getPoweredBy

@Deprecated
public String getPoweredBy()

Deprecated.

Deprecated: This property is no longer used in excel exports and will be removed in future versions.

setLogo

@Deprecated
public void setLogo(byte[] logo)

Deprecated.

Deprecated: This property is no longer used in excel exports and will be removed in future versions.