Path: geraldo.Report
This is the report main class. Every report must inherit or be an instance of this class. It supports some bands and report definitions.
You can also override some methods to customize some things.
Data source
Report properties
Report page dimensions
Report bands
A report band must be a class inherited from ReportBand or an instance of ReportBand or a class inherited from ReportBand
Report composition
Look & feel
Methods
Path: geraldo.SubReport
Class to be used for subreport objects. It doesn’t need to be inherited.
Attributes
queryset_string - must be a string to create a Python-compatible queryset.
Examples:
- ‘%(object)s.user_permissions.all()’
- ‘%(object)s.groups.all()’
- ‘Message.objects.filter(user=%(object)s)’
- ‘Message.objects.filter(user__id=%(object)s.id)’
visible - Default: True
Set to False if you want to make it not visible.
Report bands
A report band must be a class inherited from ReportBand or an instance of ReportBand or a class inherited from ReportBand
Methods
Path: geraldo.ReportBand
A band is a horizontal area in the report. It can be used to print things on the top, on summary, on page header, on page footer or one time per object from queryset.
Attributes
name - Default: None
height - Default: 1*cm
width - Default: None
visible - Default: True
Set to False if you want to make it not visible.
borders - Default: {‘top’: None, ‘right’: None, ‘bottom’: None, ‘left’: None, ‘all’: None}
elements - Default: []
child_bands - Default: []
force_new_page - Default: False
default_style - Default: None
margin_top - Default: 0
margin_bottom - Default: 0
auto_expanded_height - Default: False
Use ‘auto_expanded_height’ to make flexible bands to fit their heights to their elements.
Path: geraldo.DetailBand
An extension of ReportBand. The only difference is that this class supports more attributes, specific to detail bands.
Attributes
name - Default: None
margin_left - Default: 0
margin_right - Default: 0
display_inline - Default: False
When you use display_inline with True value and width with a valid value, the generator will try to align the detail band instances in the same way that HTML does with inline displaying of left floating elements: it will keep each detail band to the right of the last one if there is width available.
This is useful for label reports.
Path: geraldo.ReportGroup
This a report grouper class. A report can be grouped to multiple levels by attribute values.
Attributes
Report bands
A report band must be a class inherited from ReportBand or an instance of ReportBand or a class inherited from ReportBand