ReportRequirements are sent from the custom report via report-lib to the reporting container. They specify which requirements the report has regarding the reporting environment. These are things like: requires facets, or requires a view.
Defines whether the reporting framework should allow the user to switch
into a table view that shows the data of the report.
If not specified the default value is
true, so the table view will be
allowed if not explicitly disabled.
Hint: In order to configure the table (e.g. initially visible columns) for the report use ReportConfiguration.tableConfigCallback
The export options allow to influence the PDF or image export of a report.
autoScale has been renamed to fitHorizontally and will be removed in the near future.
This callback is invoked just before the report framework extracts the HTML from the report to export it as PDF or image. It allows to make adjustments to the HTML for exporting.
CSS selector which specifies the DOM element whose contents should be extracted for export to PDF or image.
fitHorizontally scales the content for PDF exports to fit it to the page width so that no content is cut off. It should not be enabled if the content is already responsive HTML.
fitVertically scales the content for PDF exports to fit it to the page height so that the content fits on a single page.
Paper format for PDF exports.
The type of content that is extracted from the DOM to be exported. Default is HTML.
Specify SVG if your report uses SVG elements for visualization.
Paper orientation for PDF exports.
Multiple facets configurations (ReportFacetsConfig) can be provided in order to allow the user to filter different aspects of your report.
This callback is invoked whenever the user wants to see / change the reports configuration.
Define custom dropdowns that are shown to the user and allow him or her to select different options that influcene how the report behaves or presents data.
Does the report provide configuration possibilities. If true: There will be a configuration action shown to the user, that triggers [[ReportConfiguration.configureCallback]].
This callback is invoked whenever the user changes the view of the report. It is also invoked, once the report view results are loaded during initialization.
In order to define which views should be available to the user, you can specify a Fact Sheet type via ReportConfiguration.reportViewFactSheetType.
If defined the views that are applicable for this Fact Sheet type will be available for the user to be selected from a dropdown. Whenever the view is fetched from the backend the view data will be provided via ReportConfiguration.reportViewCallback.
Additional options that can be provided for the view calculation.
This callback is invoked one time after the report has been initialised to get an initial, static configuration for the table. If the configuration is dynamic or computed asynchronously, LxCustomReportLib.ready needs to be used instead.
ui defines the configuration of the UI elements to be displayed around the report.
Generated using TypeDoc