io.jmix.pivottable.component

Interface PivotTableExtension

All Known Implementing Classes:

PivotTableExtensionImpl

public interface PivotTableExtension

Method Summary

Modifier and Type	Method and Description
void	exportTableToXls() Exports PivotTable to Xls file.
void	exportTableToXls(Downloader downloader) Exports PivotTable to Xls file.
java.lang.String	getDateParseFormat()
java.lang.String	getDateTimeParseFormat()
PivotExcelExporter.ExportFormat	getExportFormat()
java.lang.String	getFileName()
PivotData	getPivotData()
java.lang.String	getPivotDataJSON()
java.lang.String	getTimeParseFormat()
boolean	isRendererSupported(Renderer renderer) Checks whether renderer is supported by the exporter.
void	setDateParseFormat(java.lang.String dateParseFormat) Sets date format that will be used to finding dateTime value and exporting it to excel with date type.
void	setDateTimeParseFormat(java.lang.String dateTimeParseFormat) Sets dateTime format that will be used to finding dateTime value and exporting it to excel with dateTime type.
void	setExportFormat(PivotExcelExporter.ExportFormat exportFormat) Sets export format XLS or XLSX.
void	setFileName(java.lang.String fileName) Sets the file name.
void	setTimeParseFormat(java.lang.String timeParseFormat) Sets date format that will be used to finding dateTime value and exporting it to excel with date type.

Method Detail

exportTableToXls

void exportTableToXls()

Exports PivotTable to Xls file.

exportTableToXls

void exportTableToXls(Downloader downloader)

Exports PivotTable to Xls file.

Parameters:

downloader - downloader to save file

setFileName

void setFileName(java.lang.String fileName)

Sets the file name.

Parameters:

fileName - file name

getFileName

java.lang.String getFileName()

Returns:

file name

getPivotDataJSON

java.lang.String getPivotDataJSON()

Returns:

JSON string which represents PivotTable with aggregated data

getPivotData

PivotData getPivotData()

Returns:

serialized object from JSON which represents PivotTable with aggregated data

getDateTimeParseFormat

@Nullable
java.lang.String getDateTimeParseFormat()

Returns:

dateTime format or null

setDateTimeParseFormat

void setDateTimeParseFormat(java.lang.String dateTimeParseFormat)

Sets dateTime format that will be used to finding dateTime value and exporting it to excel with dateTime type.

Parameters:

dateTimeParseFormat - dateTime format (e.g. dd/MM/yyyy HH:mm)

getDateParseFormat

@Nullable
java.lang.String getDateParseFormat()

Returns:

date format or null

setDateParseFormat

void setDateParseFormat(java.lang.String dateParseFormat)

Sets date format that will be used to finding dateTime value and exporting it to excel with date type. If there is no format set, date properties will be recognized as text value.

Parameters:

dateParseFormat - date format (e.g. dd/MM/yyyy)

getTimeParseFormat

@Nullable
java.lang.String getTimeParseFormat()

Returns:

time format or null

setTimeParseFormat

void setTimeParseFormat(java.lang.String timeParseFormat)

Sets date format that will be used to finding dateTime value and exporting it to excel with date type. If there is no format set, time properties will be recognized as text value.

Parameters:

timeParseFormat - time format (e.g. HH:mm)

isRendererSupported

boolean isRendererSupported(Renderer renderer)

Checks whether renderer is supported by the exporter.

Parameters:

renderer - renderer to check

Returns:

true if renderer is supported by the exporter

getExportFormat

PivotExcelExporter.ExportFormat getExportFormat()

Returns:

export format XLS or XLSX

setExportFormat

void setExportFormat(PivotExcelExporter.ExportFormat exportFormat)

Sets export format XLS or XLSX. The default value is XLSX.

Parameters:

exportFormat - format that should have exported file