Package io.jmix.pivottable.component

Interface PivotTableExtension

All Known Implementing Classes:
PivotTableExtensionImpl
public interface PivotTableExtension

  • Method Details

    • 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(String fileName)
      Sets the file name.
      Parameters:
      fileName - file name

    • getFileName

      String getFileName()
      Returns:
      file name

    • getPivotDataJSON

      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 String getDateTimeParseFormat()
      Returns:
      dateTime format or null

    • setDateTimeParseFormat

      void setDateTimeParseFormat(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 String getDateParseFormat()
      Returns:
      date format or null

    • setDateParseFormat

      void setDateParseFormat(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 String getTimeParseFormat()
      Returns:
      time format or null

    • setTimeParseFormat

      void setTimeParseFormat(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