Package io.jmix.reports.annotation

Annotation Interface BandDef

@Target(TYPE) @Retention(RUNTIME) @Repeatable(RepeatableBandDef.class) public @interface BandDef
Defines a band - element of the report data structure. This annotation can be used several times on the report class to define all report bands.
Model object is BandDefinition.
See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    DataSetDef[]
    dataSets
    Datasets of the band.
    String
    name
    Unique band name within the report.
    Orientation
    orientation
     
    String
    parent
    Name of the parent band - which is other band defined in this report.
    boolean
    root
    Each report must have exactly one root band definition.
    boolean
    streaming
    Renders the band in streaming mode — rows are read one by one from a database cursor, so memory stays bounded regardless of the row count.

  • Element Details

    • name

      String name
      Unique band name within the report.
      Default:
      ""

    • root

      boolean root
      Each report must have exactly one root band definition.
      Returns:
      true if this is a root band
      Default:
      false

    • parent

      String parent
      Name of the parent band - which is other band defined in this report.
      Default:
      ""

    • orientation

      Orientation orientation
      Returns:
      band orientation, applicable to spreadsheet-like output types.
      Default:
      HORIZONTAL

    • streaming

      boolean streaming
      Renders the band in streaming mode — rows are read one by one from a database cursor, so memory stays bounded regardless of the row count. Applies only to a first-level horizontal band with a single SQL or JPQL dataset and an XLSX/CSV output; the restrictions are enforced by the streaming engine at run time.
      Returns:
      true to enable streaming for this band
      Default:
      false

    • dataSets

      DataSetDef[] dataSets
      Datasets of the band. May be empty if the band has no data.
      Default:
      {}