Package io.jmix.reports.yarg.structure

Interface ReportBand

All Superinterfaces:
Serializable
All Known Implementing Classes:
BandDefinition
@NullMarked public interface ReportBand extends Serializable
This interface describes Band abstraction. Band is description of some data. Bands have tree structure - parent has several children, they also can have children, etc.

  • Method Details

    • getName

      String getName()

    • getParent

      ReportBand getParent()

    • getPosition

      Integer getPosition()

    • getChildren

      List<ReportBand> getChildren()

    • getReportQueries

      List<ReportQuery> getReportQueries()

    • getBandOrientation

      BandOrientation getBandOrientation()
      Returns:
      band orientation. Relevant only for Xls and Xlsx templates.

    • getStreaming

      default Boolean getStreaming()
      Returns:
      true if this band is the large "hot" band rendered by the streaming XLSX engine. A report containing at least one streaming band is generated by the streaming formatter.