Package io.jmix.pivottableflowui.export
Interface PivotTableExporter
- All Known Implementing Classes:
PivotTableExporterImpl
public interface PivotTableExporter
-
Method Summary
Modifier and TypeMethodDescriptionvoidExports PivotTable to Xls file.voidexportTableToXls(Downloader downloader) Exports PivotTable to Xls file.booleanisRendererSupported(Renderer renderer) Checks whether renderer is supported by the exporter.voidsetExportFormat(PivotTableExcelExporter.ExportFormat exportFormat) Sets export formatXLSorXLSX.voidsetFileName(String fileName) Sets the file name.
-
Method Details
-
exportTableToXls
void exportTableToXls()Exports PivotTable to Xls file. -
exportTableToXls
Exports PivotTable to Xls file.- Parameters:
downloader- downloader to save file
-
setFileName
Sets the file name.- Parameters:
fileName- file name
-
getFileName
String getFileName()- Returns:
- file name
-
getPivotData
PivotData getPivotData()- Returns:
- serialized object from JSON which represents PivotTable with aggregated data
-
isRendererSupported
Checks whether renderer is supported by the exporter.- Parameters:
renderer- renderer to check- Returns:
trueif renderer is supported by the exporter
-
getExportFormat
PivotTableExcelExporter.ExportFormat getExportFormat()- Returns:
- export format
XLSorXLSX
-
setExportFormat
Sets export formatXLSorXLSX. The default value isXLSX.- Parameters:
exportFormat- format that should have exported file
-