sgcReports Feature Matrix
Everything sgcReports does, grouped by task, with a link to the help topic of each feature. The core has no VCL or FMX and no external DLL, so it runs in Windows services and Linux64 daemons.
Everything sgcReports does, grouped by task, with a link to the help topic of each feature. The core has no VCL or FMX and no external DLL, so it runs in Windows services and Linux64 daemons.
9 features
3 features
5 features
3 features
8 features
8 features
8 NuGet packages
Online help and PDF manuals
Registered marks the features that are in the Registered and Trial editions and not in the free Community edition. ~ marks a feature that Community has in part, with the difference below it.
Every row links to its help topic. Rows marked Registered need the Registered edition. The Web Bridge rows also need sgcWebSockets Professional or higher and sgcHTML.
| Feature | Details | Community | Help |
|---|---|---|---|
| Fluent builder | TsgcReportBuilder builds a report in code with a fluent chain. | Help | |
| Report model | Fill the TsgcReport model directly. | Help | |
| JSON definitions | Load a report definition from JSON at run time without recompiling. | Help | |
| Bands and groups | Group headers and footers, master data, page footer, subtotals and page numbers. | Help | |
| Master detail | Master and detail bands, for example an invoice with its lines. | Help | |
| Expressions | Expressions such as Sum(Sales.Amount). | Help | |
| Scripting | TsgcReport.Script holds procedures in a small Pascal like language (variables, if, case, for, while, repeat and every expression function), stored in the report definition and the JSON. The report runs StartScript and FinishScript, each band runs BeforePrintScript, AfterPrintScript and AfterDataScript, and each item BeforePrintScript and AfterPrintScript. A script can hide a band, change the text, the font colour or the height of an item for the current print, read data fields and set report variables. ScriptMaxSteps stops a script that does not end, and ScriptErrorAction and OnScriptError decide what an error does. In Delphi, C++Builder and .NET. | Help | |
| Barcodes | Barcodes in reports through the sgcPDF barcode engine. | Help | |
| Right to left (Arabic and Hebrew) | TsgcReport.RightToLeft and BiDiMode on bands and items mirror the layout, with shaped, bidi ordered and justified text. The PDF export sets a right to left reading direction, XLSX writes a right to left sheet, and the HTML viewer and designer get dir="rtl". | Help |
| Feature | Details | Community | Help |
|---|---|---|---|
| Accessible PDF | Tagged PDF/UA-1 by default (PDFUA is True). | Help | |
| PDF/A-3 | Archival PDF/A-3 on request (rpaA3b, rpaA3a). In Delphi and .NET, also PDF/A-4 (rpaA4) and PDF/UA-2 (PDFUAPart set to rpuPart2). | Help | |
| XLSX, CSV and PNG | One prepared report, many outputs: TsgcReportXLSXExport, TsgcReportCSVExport and TsgcReportImageExport. | Help | |
| Preview | TsgcReportPreviewVCL and TsgcReportPreviewFMX with page navigation. The FireMonkey preview runs on Windows, macOS, iOS and Android, with touch pan and pinch zoom. On iOS and Android, Print and Save PDF open the share sheet of the system, which offers AirPrint or Android printing (SharePDF, Delphi 10.3 and later), and RenderPage draws any page into a bitmap on every platform. | Help | |
| Linux daemon | Run the engine headless in a Linux64 daemon. | Help |
| Feature | Details | Community | Help |
|---|---|---|---|
| Serve reports over HTTP | TsgcReportHTTPEndpoint serves reports as PDF, XLSX, CSV and PNG. Needs sgcWebSockets Professional or higher and sgcHTML. | ~Delphi and C++ Builder: needs sgcWebSockets Professional or higher and sgcHTML. .NET: the esegece.sgcReports.HTML and AspNetCore packages host the same routes. | Help |
| Browser viewer | TsgcReportHTMLViewer shows reports in the browser. | Help | |
| Web report designer | TsgcReportHTMLDesigner edits report definitions in the browser. | ~Leave DesignerEnabled off on production endpoints and put it behind your own authentication. | Help |
| Feature | Details | Community | Help |
|---|---|---|---|
| Designer for VCL | TsgcVCLReportDesigner is a panel where your users edit reports inside your application. Drop it on a form, assign Engine and add the data sources. | Registered | Help |
| Designer for FireMonkey | TsgcFMXReportDesigner is the FireMonkey twin over the same designer units. The modal designer works on Windows and macOS. | Registered | Help |
| Toolbox, outline, data tree and inspector | Drag item kinds from the Toolbox and fields from the Data tree onto a band, browse pages, bands and items in the Outline, and edit properties in the inspector. Every drop is one undo step. | Registered | Help |
| Rulers, alignment and undo | A design surface with rulers and zoom, align and distribute commands, and undo and redo. | Registered | Help |
| Preview and JSON files | The Preview tab prepares the report with the data of the engine. New, Open and Save use JSON report definitions that a server can run headless. A modal designer with OK and Cancel is one call away. | Registered | Help |
| Localized designer | The texts of the designer are translated by sgcUISetLanguage into the 12 built-in languages of sgcUI. | Registered | Help |
| .NET designer classes | Designer controls for WinForms, WPF and Avalonia are included: TsgcWinFormsReportDesigner, TsgcWpfReportDesigner and TsgcAvaloniaReportDesigner, with toolbox, outline, data tree, property inspector, rulers and live preview, plus modal designer windows. They are built on the platform neutral designer model, which you can also use to build your own host. | Registered | Help |
| Script editor | The designers of VCL, FireMonkey, WinForms, WPF and Avalonia edit the report script in a code editor with a Check button that shows the line and column of an error. The inspector lists the script events of the report, the bands and the items, with the procedures of the script to choose from and a "(new procedure)" entry that adds an empty procedure. Script changes are part of undo and redo. | Registered | Help |
| Feature | Details | Community | Help |
|---|---|---|---|
| Rich text | Bold, italic, colors, fonts, lists and links in one item, written as markup similar to HTML with [expressions]. Links are kept in the PDF, HTML and DOCX exports. | Help | |
| Watermarks | A text or image watermark on every report page, with opacity, rotation, centered, tiled or custom position, behind or in front of the content, page ranges and a visibility expression. | Help | |
| Crosstab tables | Row and column fields, several measures (sum, count, average, minimum and maximum), totals, and an accessible table in PDF/UA and HTML. Columns that do not fit continue on the following pages. | Help | |
| Custom item types | Register your own TsgcReportCustomRenderer by name. It prints in the PDF, PNG, HTML and DOCX exports and appears in the designer Toolbox. The ready-made Chart and PivotTable bridges are Registered. | Help | |
| Charts in reports | The sgcReportsCharts bridge adds a Chart item drawn by sgcCharts: bar, stacked bar, line and area, as vector content in PDF and inline SVG in HTML. Requires sgcCharts. | Registered | Help |
| Pivot tables in reports | The sgcReportsPivotGrid bridge adds a PivotTable item calculated by sgcPivotGrid, with more aggregates than the built-in crosstab. Requires sgcPivotGrid. | Registered | Help |
| HTML export | TsgcReportHTMLExport writes one self contained HTML file, paged or continuous. The semantic mode writes headings, paragraphs and ARIA tables and hides decorative items from assistive technology. | Help | |
| DOCX export | TsgcReportDOCXExport writes a Word document, either with the layout fixed in exact frames or as a flowing, editable table. No external zip library is needed. | Registered | Help |
The .NET reports are a C# port with the same class names: the builder, JSON source, engine and exports, a WinForms preview, and HTML, ASP.NET Core and sgcSign packages.
| Package | Edition | Contents |
|---|---|---|
esegece.sgcReports.Community | Community (free) | Core library |
esegece.sgcReports.WinForms.Community | Community (free) | Windows Forms controls |
esegece.sgcReports.HTML.Community | Community (free) | HTML viewer and web integration |
esegece.sgcReports.AspNetCore.Community | Community (free) | ASP.NET Core integration |
esegece.sgcReports.Wpf.Community | Community (free) | WPF controls |
esegece.sgcReports.Avalonia.Community | Community (free) | Avalonia controls |
esegece.sgcReports.sgcSign.Community | Community (free) | sgcSign bridge, signs the PDF exports (PAdES) |
esegece.sgcReports | Registered | Core library |
esegece.sgcReports.WinForms | Registered | Windows Forms controls |
esegece.sgcReports.HTML | Registered | HTML viewer and web integration |
esegece.sgcReports.AspNetCore | Registered | ASP.NET Core integration |
esegece.sgcReports.Wpf | Registered | WPF controls |
esegece.sgcReports.Avalonia | Registered | Avalonia controls |
esegece.sgcReports.sgcCharts | Registered only | sgcCharts bridge, the Chart item |
esegece.sgcReports.sgcPivotGrid | Registered only | sgcPivotGrid bridge, the PivotTable item |
esegece.sgcReports.sgcSign | Registered | sgcSign bridge, signs the PDF exports (PAdES) |
Every feature of sgcReports is documented in the sgcUI help, with one build for each development environment.
Start with the sgcReports introduction, then follow the quick start and the feature topics.
Delphi →The complete sgcUI help as a PDF file, to read offline or print.
Delphi (PDF) →