report_flutter library
Report Flutter - complete toolkit to design, view and print reports and labels.
Classes
- AppTheme
- Custom theme of the Report Designer
- DataExtractor
- Extracts fields from any object for the report designer
- DataImporter
- Imports data from several sources (CSV, JSON)
- DataSchema
- Abstract schema that defines the data structure
- FieldDefinition
- Definition of a data field of the schema
- FieldInfo
- Information about a field extracted from a class
- ImportResult
- Result of a data import
- InMemoryPrintStore
- Keeps the library in memory: useful for demos and for apps that do not persist templates. Everything is lost when the app closes.
- PaperFormat
- Physical layout of the media a template prints on.
- PaperFormatDefaults
-
Ready-made paper formats of the library: common adhesive A4 sheets,
thermal rolls, sign and report pages. With
PrintLibraryOptions.loadDefaultPaperFormatsthey are stored once, the first time the print library is set up; after that they are ordinary formats that can be changed or deleted. - PaperFormatsPage
- Paper formats of the shop, grouped by template type. Shop managers can add, change and delete them, defaults included.
- PdfExporter
- Service that exports reports to PDF
- PdfExportOptions
- PDF export options
- PdfImageCache
- Rasterised PDF pages, cached by request so going back and forth between steps does not render the same template twice.
- PdfPageImage
- PdfPagesView
- Shows every page of a request. While the user types, the previous pages stay on screen and the new render starts after a short pause.
- PrintCategory
- A group of templates, e.g. "Labels" or "Sales". Categories only order the list: the shop creates, renames, reorders and deletes them freely.
- PrintCenter
- The print center: the Print tab prints labels, signs and reports; the Template tab manages templates, categories and paper formats.
- PrintColumn
- A column of a table element.
- PrintController
- State of the Print tab: the chosen template, the print settings and, when rows with real data were given, the rows to print.
- PrintDataProvider
- What the app tells the print library about its data. The library knows how to manage, design and print templates; the app knows what the fields mean and where the data comes from.
- PrintDesign
- Small builder for designer layouts. Every measure is in millimetres.
- PrintFonts
- Fonts embedded in every generated PDF.
- PrintJob
- Lines to print with real data.
- PrintLibrary
- Manages a print library: templates, their categories and the paper formats, kept by a PrintStore.
- PrintLibraryOptions
- Defaults stored the first time a print library is set up.
- PrintPdfRenderer
- Turns a PrintTemplate into a PDF document.
- PrintRequest
- What to print and how many times.
- PrintRow
- One line to print: a product, a variant, a person, whatever the app prints. The library does not know what it is: it shows title and subtitle, prints quantity copies and asks dataFor the fields of the chosen template.
- PrintScope
- Gives the print screens below it the library they manage and the data provider of the app. The print center puts it at its root.
- PrintStore
- Where the print library lives: a server, a file, a database. The app provides the implementation; the library only calls these methods and changes its own lists after they succeed.
- PrintStoreItem
- One stored item. data is a JSON-compatible map owned by the library model it comes from (template, paper format, category).
- PrintStoreSnapshot
- What a PrintStore holds at a given moment.
- PrintTemplate
- A label, sign or report template, kept by the PrintStore.
- PrintTemplateThumbnail
- ReportBuilder
- Main widget of the drag-and-drop report/label designer
- ReportElement
- Single element of the report template
- ReportEngine
- Main engine that renders and processes reports
- ReportFilter
- Filter options for the report data
- ReportLocalizations
-
Callers can lookup localized strings with an instance of ReportLocalizations
returned by
ReportLocalizations.of(context). - ReportRenderer
- Renderer for a single report
- ReportSort
- Sort options for the report tables
- ReportTemplate
- Report template - accepts any data class
- ReportViewer
- Main widget to view reports on their own
- ReportViewerOptions
- Options of the report viewer
- SchemaRegistry
- Registry of the available schemas
- SingleReportViewer
- Simplified widget for a single report (no pagination)
- TemplateInfo
- Basic information about a template
- TemplateLoader
- Loader for .rpt template files
- TemplateWithSchema
- Result of loading a template with its schema
- ValidationResult
- Validation result
Enums
- PageFormat
- Predefined page format
- PaperFeed
- How the printer receives the media.
- PaperFormatError
- Reasons a paper format cannot be saved.
- PrintCollection
- Collections of the print library.
- PrintMessageKind
- Kind of a short message shown by the print screens.
- ReportElementType
- Type of element that can be added to the report
- ReportType
- Report type
- ReportViewMode
- Report display mode
Extensions
- PrintThemeContext on BuildContext
-
Theme access for the print screens. The names start with
printso they never clash with the extensions of the app using the library. - ReportBuilderExtensions on _ReportBuilderState
- ReportBuilderMethods on _ReportBuilderState
- ReportL10nContext on BuildContext
-
Access to the library texts:
context.reportL10n.printTitle.
Functions
-
lookupReportLocalizations(
Locale locale) → ReportLocalizations -
openPrintTemplateDesigner(
BuildContext context, PrintTemplate template) → Future< PrintTemplate?> -
Opens the drag-and-drop designer on
templateand returns the template with the edited layout, paper format and app settings, or null when the user leaves without applying them.