Package io.revealbi.core

Interface IDashboardExporter

All Known Implementing Classes:

DefaultDashboardExporter

public interface IDashboardExporter

Interface exposing methods to export dashboards to different formats.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<InputStream>	export(ExportFormat format, String dashboardId)	Exports a dashboard to a specific format
CompletableFuture<InputStream>	export(ExportFormat format, String dashboardId, IRVUserContext userContext, IExportOptions options)	Exports a dashboard to a specific format
CompletableFuture<String>	export(ExportFormat format, String dashboardId, String filePath)	Exports a dashboard to a specific format
CompletableFuture<String>	export(ExportFormat format, String dashboardId, String filePath, IRVUserContext userContext, IExportOptions options)	Exports a dashboard to a specific format
CompletableFuture<InputStream>	exportToCsv(String dashboardId)	Exports a dashboard to CSV.
CompletableFuture<InputStream>	exportToCsv(String dashboardId, IRVUserContext userContext, CsvExportOptions options)	Exports a dashboard to CSV.
CompletableFuture<String>	exportToCsv(String dashboardId, String filePath)	Exports a dashboard to CSV.
CompletableFuture<String>	exportToCsv(String dashboardId, String filePath, IRVUserContext userContext, CsvExportOptions options)	Exports a dashboard to CSV.
CompletableFuture<InputStream>	exportToExcel(String dashboardId)	Exports a dashboard to Excel.
CompletableFuture<InputStream>	exportToExcel(String dashboardId, IRVUserContext userContext, ExcelExportOptions options)	Exports a dashboard to Excel.
CompletableFuture<String>	exportToExcel(String dashboardId, String filePath)	Exports a dashboard to Excel.
CompletableFuture<String>	exportToExcel(String dashboardId, String filePath, IRVUserContext userContext, ExcelExportOptions options)	Exports a dashboard to Excel.
CompletableFuture<InputStream>	exportToImage(String dashboardId)	Exports a dashboard to Image (png).
CompletableFuture<InputStream>	exportToImage(String dashboardId, IRVUserContext userContext, ImageExportOptions options)	Exports a dashboard to Image (png).
CompletableFuture<String>	exportToImage(String dashboardId, String filePath)	Exports a dashboard to Image (png).
CompletableFuture<String>	exportToImage(String dashboardId, String filePath, IRVUserContext userContext, ImageExportOptions options)	Exports a dashboard to Image (png).
CompletableFuture<InputStream>	exportToPdf(String dashboardId)	Exports a dashboard to Pdf.
CompletableFuture<InputStream>	exportToPdf(String dashboardId, IRVUserContext userContext, PdfExportOptions options)	Exports a dashboard to Pdf.
CompletableFuture<String>	exportToPdf(String dashboardId, String filePath)	Exports a dashboard to Pdf.
CompletableFuture<String>	exportToPdf(String dashboardId, String filePath, IRVUserContext userContext, PdfExportOptions options)	Exports a dashboard to Pdf.
CompletableFuture<InputStream>	exportToPowerPoint(String dashboardId)	Exports a dashboard to PowerPoint.
CompletableFuture<InputStream>	exportToPowerPoint(String dashboardId, IRVUserContext userContext, PowerPointExportOptions options)	Exports a dashboard to PowerPoint.
CompletableFuture<String>	exportToPowerPoint(String dashboardId, String filePath)	Exports a dashboard to PowerPoint.
CompletableFuture<String>	exportToPowerPoint(String dashboardId, String filePath, IRVUserContext userContext, PowerPointExportOptions options)	Exports a dashboard to PowerPoint.

Method Details

export

CompletableFuture<InputStream> export(ExportFormat format,
 String dashboardId)

Exports a dashboard to a specific format

Parameters:

format - ExportFormat indicating the output format

dashboardId - Dashboard identifier

Returns:

Stream containing the output file

export

CompletableFuture<String> export(ExportFormat format,
 String dashboardId,
 String filePath)

Exports a dashboard to a specific format

Parameters:

format - ExportFormat indicating the output format

dashboardId - Dashboard identifier

filePath - Destination file for the exported dashboard

export

CompletableFuture<InputStream> export(ExportFormat format,
 String dashboardId,
 IRVUserContext userContext,
 IExportOptions options)

Exports a dashboard to a specific format

Parameters:

format - ExportFormat indicating the output format

dashboardId - Dashboard identifier

userContext - User context

options - IExportOptions

Returns:

Stream containing the output file

export

CompletableFuture<String> export(ExportFormat format,
 String dashboardId,
 String filePath,
 IRVUserContext userContext,
 IExportOptions options)

Exports a dashboard to a specific format

Parameters:

format - ExportFormat indicating the output format

dashboardId - Dashboard identifier

filePath - Path where the resulting file will be copied.

userContext - User context

options - IExportOptions

exportToPdf

CompletableFuture<InputStream> exportToPdf(String dashboardId)

Exports a dashboard to Pdf.

Parameters:

dashboardId - Dashboard identifier.

exportToPdf

CompletableFuture<InputStream> exportToPdf(String dashboardId,
 IRVUserContext userContext,
 PdfExportOptions options)

Exports a dashboard to Pdf.

Parameters:

dashboardId - Dashboard identifier.

userContext - The user context.

options - Pdf export options PdfExportOptions.

exportToPdf

CompletableFuture<String> exportToPdf(String dashboardId,
 String filePath)

Exports a dashboard to Pdf.

Parameters:

dashboardId - Dashboard identifier.

filePath - Destination file for the exported dashboard.

exportToPdf

CompletableFuture<String> exportToPdf(String dashboardId,
 String filePath,
 IRVUserContext userContext,
 PdfExportOptions options)

Exports a dashboard to Pdf.

Parameters:

dashboardId - Dashboard identifier.

filePath - Destination file for the exported dashboard.

userContext - The user context.

options - Pdf export options PdfExportOptions.

exportToExcel

CompletableFuture<InputStream> exportToExcel(String dashboardId)

Exports a dashboard to Excel.

Parameters:

dashboardId - Dashboard identifier.

exportToExcel

CompletableFuture<InputStream> exportToExcel(String dashboardId,
 IRVUserContext userContext,
 ExcelExportOptions options)

Exports a dashboard to Excel.

Parameters:

dashboardId - Dashboard identifier.

userContext - The user context.

options - Excel export options ExcelExportOptions.

exportToExcel

CompletableFuture<String> exportToExcel(String dashboardId,
 String filePath)

Exports a dashboard to Excel.

Parameters:

dashboardId - Dashboard identifier.

filePath - Destination file for the exported dashboard.

exportToExcel

CompletableFuture<String> exportToExcel(String dashboardId,
 String filePath,
 IRVUserContext userContext,
 ExcelExportOptions options)

Exports a dashboard to Excel.

Parameters:

dashboardId - Dashboard identifier.

filePath - Destination file for the exported dashboard.

userContext - The user context.

options - Excel export options ExcelExportOptions.

exportToPowerPoint

CompletableFuture<InputStream> exportToPowerPoint(String dashboardId)

Exports a dashboard to PowerPoint.

Parameters:

dashboardId - Dashboard identifier.

exportToPowerPoint

CompletableFuture<InputStream> exportToPowerPoint(String dashboardId,
 IRVUserContext userContext,
 PowerPointExportOptions options)

Exports a dashboard to PowerPoint.

Parameters:

dashboardId - Dashboard identifier.

userContext - The user context.

options - PowerPoint export options PowerPointExportOptions.

exportToPowerPoint

CompletableFuture<String> exportToPowerPoint(String dashboardId,
 String filePath)

Exports a dashboard to PowerPoint.

Parameters:

dashboardId - Dashboard identifier.

filePath - Destination file for the exported dashboard.

exportToPowerPoint

CompletableFuture<String> exportToPowerPoint(String dashboardId,
 String filePath,
 IRVUserContext userContext,
 PowerPointExportOptions options)

Exports a dashboard to PowerPoint.

Parameters:

dashboardId - Dashboard identifier.

filePath - Destination file for the exported dashboard.

userContext - The user context.

options - PowerPoint export options PowerPointExportOptions.

exportToImage

CompletableFuture<InputStream> exportToImage(String dashboardId)

Exports a dashboard to Image (png).

Parameters:

dashboardId - Dashboard identifier.

exportToImage

CompletableFuture<InputStream> exportToImage(String dashboardId,
 IRVUserContext userContext,
 ImageExportOptions options)

Exports a dashboard to Image (png).

Parameters:

dashboardId - Dashboard identifier.

userContext - The user context.

options - Image export options ImageExportOptions.

exportToImage

CompletableFuture<String> exportToImage(String dashboardId,
 String filePath)

Exports a dashboard to Image (png).

Parameters:

dashboardId - Dashboard identifier.

filePath - Destination file for the exported dashboard.

exportToImage

CompletableFuture<String> exportToImage(String dashboardId,
 String filePath,
 IRVUserContext userContext,
 ImageExportOptions options)

Exports a dashboard to Image (png).

Parameters:

dashboardId - Dashboard identifier.

filePath - Destination file for the exported dashboard.

userContext - The user context.

options - Image export options ImageExportOptions.

exportToCsv

CompletableFuture<InputStream> exportToCsv(String dashboardId)

Exports a dashboard to CSV.

Parameters:

dashboardId - Dashboard identifier.

exportToCsv

CompletableFuture<InputStream> exportToCsv(String dashboardId,
 IRVUserContext userContext,
 CsvExportOptions options)

Exports a dashboard to CSV.

Parameters:

dashboardId - Dashboard identifier.

userContext - The user context.

options - CSV export options CsvExportOptions.

exportToCsv

CompletableFuture<String> exportToCsv(String dashboardId,
 String filePath)

Exports a dashboard to CSV.

Parameters:

dashboardId - Dashboard identifier.

filePath - Destination file for the exported dashboard.

exportToCsv

CompletableFuture<String> exportToCsv(String dashboardId,
 String filePath,
 IRVUserContext userContext,
 CsvExportOptions options)

Exports a dashboard to CSV.

Parameters:

dashboardId - Dashboard identifier.

filePath - Destination file for the exported dashboard.

userContext - The user context.

options - CSV export options CsvExportOptions.