Package io.revealbi.core.impl.exporter
Class DefaultDashboardExporter
java.lang.Object
io.revealbi.core.impl.exporter.DefaultDashboardExporter
- All Implemented Interfaces:
IDashboardExporter
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionexport(ExportFormat format, String dashboardId) Exports a dashboard to a specific formatexport(ExportFormat format, String dashboardId, IRVUserContext userContext, IExportOptions options) Exports a dashboard to a specific formatexport(ExportFormat format, String dashboardId, String filePath) Exports a dashboard to a specific formatexport(ExportFormat format, String dashboardId, String filePath, IRVUserContext userContext, IExportOptions options) Exports a dashboard to a specific formatexportToCsv(String dashboardId) Exports a dashboard to CSV.exportToCsv(String dashboardId, IRVUserContext userContext, CsvExportOptions options) Exports a dashboard to CSV.exportToCsv(String dashboardId, String filePath) Exports a dashboard to CSV.exportToCsv(String dashboardId, String filePath, IRVUserContext userContext, CsvExportOptions options) Exports a dashboard to CSV.exportToExcel(String dashboardId) Exports a dashboard to Excel.exportToExcel(String dashboardId, IRVUserContext userContext, ExcelExportOptions options) Exports a dashboard to Excel.exportToExcel(String dashboardId, String filePath) Exports a dashboard to Excel.exportToExcel(String dashboardId, String filePath, IRVUserContext userContext, ExcelExportOptions options) Exports a dashboard to Excel.exportToImage(String dashboardId) Exports a dashboard to Image (png).exportToImage(String dashboardId, IRVUserContext userContext, ImageExportOptions options) Exports a dashboard to Image (png).exportToImage(String dashboardId, String filePath) Exports a dashboard to Image (png).exportToImage(String dashboardId, String filePath, IRVUserContext userContext, ImageExportOptions options) Exports a dashboard to Image (png).exportToPdf(String dashboardId) Exports a dashboard to Pdf.exportToPdf(String dashboardId, IRVUserContext userContext, PdfExportOptions options) Exports a dashboard to Pdf.exportToPdf(String dashboardId, String filePath) Exports a dashboard to Pdf.exportToPdf(String dashboardId, String filePath, IRVUserContext userContext, PdfExportOptions options) Exports a dashboard to Pdf.exportToPowerPoint(String dashboardId) Exports a dashboard to PowerPoint.exportToPowerPoint(String dashboardId, IRVUserContext userContext, PowerPointExportOptions options) Exports a dashboard to PowerPoint.exportToPowerPoint(String dashboardId, String filePath) Exports a dashboard to PowerPoint.exportToPowerPoint(String dashboardId, String filePath, IRVUserContext userContext, PowerPointExportOptions options) Exports a dashboard to PowerPoint.
-
Constructor Details
-
DefaultDashboardExporter
-
-
Method Details
-
exportToPdf
Description copied from interface:IDashboardExporterExports a dashboard to Pdf.- Specified by:
exportToPdfin interfaceIDashboardExporter- Parameters:
dashboardId- Dashboard identifier.
-
exportToPdf
public CompletableFuture<InputStream> exportToPdf(String dashboardId, IRVUserContext userContext, PdfExportOptions options) Description copied from interface:IDashboardExporterExports a dashboard to Pdf.- Specified by:
exportToPdfin interfaceIDashboardExporter- Parameters:
dashboardId- Dashboard identifier.userContext- The user context.options- Pdf export optionsPdfExportOptions.
-
exportToPdf
Description copied from interface:IDashboardExporterExports a dashboard to Pdf.- Specified by:
exportToPdfin interfaceIDashboardExporter- Parameters:
dashboardId- Dashboard identifier.filePath- Destination file for the exported dashboard.
-
exportToPdf
public CompletableFuture<String> exportToPdf(String dashboardId, String filePath, IRVUserContext userContext, PdfExportOptions options) Description copied from interface:IDashboardExporterExports a dashboard to Pdf.- Specified by:
exportToPdfin interfaceIDashboardExporter- Parameters:
dashboardId- Dashboard identifier.filePath- Destination file for the exported dashboard.userContext- The user context.options- Pdf export optionsPdfExportOptions.
-
exportToExcel
Description copied from interface:IDashboardExporterExports a dashboard to Excel.- Specified by:
exportToExcelin interfaceIDashboardExporter- Parameters:
dashboardId- Dashboard identifier.
-
exportToExcel
public CompletableFuture<InputStream> exportToExcel(String dashboardId, IRVUserContext userContext, ExcelExportOptions options) Description copied from interface:IDashboardExporterExports a dashboard to Excel.- Specified by:
exportToExcelin interfaceIDashboardExporter- Parameters:
dashboardId- Dashboard identifier.userContext- The user context.options- Excel export optionsExcelExportOptions.
-
exportToExcel
Description copied from interface:IDashboardExporterExports a dashboard to Excel.- Specified by:
exportToExcelin interfaceIDashboardExporter- Parameters:
dashboardId- Dashboard identifier.filePath- Destination file for the exported dashboard.
-
exportToExcel
public CompletableFuture<String> exportToExcel(String dashboardId, String filePath, IRVUserContext userContext, ExcelExportOptions options) Description copied from interface:IDashboardExporterExports a dashboard to Excel.- Specified by:
exportToExcelin interfaceIDashboardExporter- Parameters:
dashboardId- Dashboard identifier.filePath- Destination file for the exported dashboard.userContext- The user context.options- Excel export optionsExcelExportOptions.
-
exportToPowerPoint
Description copied from interface:IDashboardExporterExports a dashboard to PowerPoint.- Specified by:
exportToPowerPointin interfaceIDashboardExporter- Parameters:
dashboardId- Dashboard identifier.
-
exportToPowerPoint
public CompletableFuture<InputStream> exportToPowerPoint(String dashboardId, IRVUserContext userContext, PowerPointExportOptions options) Description copied from interface:IDashboardExporterExports a dashboard to PowerPoint.- Specified by:
exportToPowerPointin interfaceIDashboardExporter- Parameters:
dashboardId- Dashboard identifier.userContext- The user context.options- PowerPoint export optionsPowerPointExportOptions.
-
exportToPowerPoint
Description copied from interface:IDashboardExporterExports a dashboard to PowerPoint.- Specified by:
exportToPowerPointin interfaceIDashboardExporter- Parameters:
dashboardId- Dashboard identifier.filePath- Destination file for the exported dashboard.
-
exportToPowerPoint
public CompletableFuture<String> exportToPowerPoint(String dashboardId, String filePath, IRVUserContext userContext, PowerPointExportOptions options) Description copied from interface:IDashboardExporterExports a dashboard to PowerPoint.- Specified by:
exportToPowerPointin interfaceIDashboardExporter- Parameters:
dashboardId- Dashboard identifier.filePath- Destination file for the exported dashboard.userContext- The user context.options- PowerPoint export optionsPowerPointExportOptions.
-
exportToImage
Description copied from interface:IDashboardExporterExports a dashboard to Image (png).- Specified by:
exportToImagein interfaceIDashboardExporter- Parameters:
dashboardId- Dashboard identifier.
-
exportToImage
public CompletableFuture<InputStream> exportToImage(String dashboardId, IRVUserContext userContext, ImageExportOptions options) Description copied from interface:IDashboardExporterExports a dashboard to Image (png).- Specified by:
exportToImagein interfaceIDashboardExporter- Parameters:
dashboardId- Dashboard identifier.userContext- The user context.options- Image export optionsImageExportOptions.
-
exportToImage
Description copied from interface:IDashboardExporterExports a dashboard to Image (png).- Specified by:
exportToImagein interfaceIDashboardExporter- Parameters:
dashboardId- Dashboard identifier.filePath- Destination file for the exported dashboard.
-
exportToImage
public CompletableFuture<String> exportToImage(String dashboardId, String filePath, IRVUserContext userContext, ImageExportOptions options) Description copied from interface:IDashboardExporterExports a dashboard to Image (png).- Specified by:
exportToImagein interfaceIDashboardExporter- Parameters:
dashboardId- Dashboard identifier.filePath- Destination file for the exported dashboard.userContext- The user context.options- Image export optionsImageExportOptions.
-
exportToCsv
Description copied from interface:IDashboardExporterExports a dashboard to CSV.- Specified by:
exportToCsvin interfaceIDashboardExporter- Parameters:
dashboardId- Dashboard identifier.
-
exportToCsv
public CompletableFuture<InputStream> exportToCsv(String dashboardId, IRVUserContext userContext, CsvExportOptions options) Description copied from interface:IDashboardExporterExports a dashboard to CSV.- Specified by:
exportToCsvin interfaceIDashboardExporter- Parameters:
dashboardId- Dashboard identifier.userContext- The user context.options- CSV export optionsCsvExportOptions.
-
exportToCsv
Description copied from interface:IDashboardExporterExports a dashboard to CSV.- Specified by:
exportToCsvin interfaceIDashboardExporter- Parameters:
dashboardId- Dashboard identifier.filePath- Destination file for the exported dashboard.
-
exportToCsv
public CompletableFuture<String> exportToCsv(String dashboardId, String filePath, IRVUserContext userContext, CsvExportOptions options) Description copied from interface:IDashboardExporterExports a dashboard to CSV.- Specified by:
exportToCsvin interfaceIDashboardExporter- Parameters:
dashboardId- Dashboard identifier.filePath- Destination file for the exported dashboard.userContext- The user context.options- CSV export optionsCsvExportOptions.
-
export
Description copied from interface:IDashboardExporterExports a dashboard to a specific format- Specified by:
exportin interfaceIDashboardExporter- Parameters:
format-ExportFormatindicating the output formatdashboardId- Dashboard identifier- Returns:
- Stream containing the output file
-
export
Description copied from interface:IDashboardExporterExports a dashboard to a specific format- Specified by:
exportin interfaceIDashboardExporter- Parameters:
format-ExportFormatindicating the output formatdashboardId- Dashboard identifierfilePath- Destination file for the exported dashboard
-
export
public CompletableFuture<InputStream> export(ExportFormat format, String dashboardId, IRVUserContext userContext, IExportOptions options) Description copied from interface:IDashboardExporterExports a dashboard to a specific format- Specified by:
exportin interfaceIDashboardExporter- Parameters:
format-ExportFormatindicating the output formatdashboardId- Dashboard identifieruserContext- User contextoptions-IExportOptions- Returns:
- Stream containing the output file
-
export
public CompletableFuture<String> export(ExportFormat format, String dashboardId, String filePath, IRVUserContext userContext, IExportOptions options) Description copied from interface:IDashboardExporterExports a dashboard to a specific format- Specified by:
exportin interfaceIDashboardExporter- Parameters:
format-ExportFormatindicating the output formatdashboardId- Dashboard identifierfilePath- Path where the resulting file will be copied.userContext- User contextoptions-IExportOptions
-