xtrareports-405348-web-reporting-blazor-reporting-web-report-designer.md
The JavaScript-based Report Designer for Blazor allows you to design, preview, and interact with reports in your Blazor apps. The viewer allows users to specify data parameters, navigate the report, and print or export the resulting document.
Depending on your application type and requirements, use one of the following components:
| Component | Communication Mechanism | Requires an ASP.NET Core Backend |
|---|---|---|
| DxReportDesigner | SignalR | No |
| DxWasmReportDesigner | fetch | Yes |
For a more comprehensive overview of DevExpress Blazor Reporting components, refer to the following topic: Blazor Reporting Components Overview.
The following topics show how to create a Blazor application with the JavaScript-based Report Designer using DevExpress and Microsoft templates:
Visit our online demos and learn about key features and capabilities of our JavaScript-based Report Designer:
Search sample projects and learn how to use and customize the DevExpress Blazor Reporting components:
For end-user documentation for the JavaScript-based Report Designer, refer to the following topics:
The JavaScript-based Report Designer includes the following nested components:
DxReportDesignerCallbacksSpecifies client-side event handler functions for the Report Designer. See DxReportDesignerCallbacks Members for the complete list of events.DxReportDesignerClientSideModelSettingsContains settings for the Report Designer client-side model.DxReportDesignerDataSourceSettingsContains settings that configure the user interface related to the data sources in the Report Designer.DxReportDesignerWizardSettingsProvides access to the Report Designer‘s wizard settings.DxReportDesignerParameterEditingSettingsContains settings that configure user interface elements related to the editing of parameters, parameter groups, and parameter separators in the Web Report Designer.DxReportDesignerReportPreviewSettingsAllows you to specify settings for Report Designer Preview.
In the DxWasmReportDesigner component, the following settings should be placed inside the DxReportDesignerModelSettings component:
The code snippets below illustrate how to use these components:
<DxReportDesigner ReportName="TestReport" Height="calc(100vh - 130px)" Width="100%" AllowMDI="true" DataSources="DataSources">
<DxReportDesignerParameterEditingSettings AllowEditParameterCollection="false" />
<DxReportDesignerDataSourceSettings AllowAddDataSource="false" />
<DxReportDesignerWizardSettings ReportWizardTemplatesSearchBoxVisibility="SearchBoxVisibility.Always" />
<DxReportDesignerReportPreviewSettings ExportSettings="new ExportSettings { UseSameTab = false, UseAsynchronousExport = false }" />
</DxReportDesigner>
<DxWasmReportDesigner ReportName="Report" Height="100%">
<DxWasmReportDesignerRequestOptions GetDesignerModelAction="DXXRD/GetReportDesignerModel" />
<DxReportDesignerModelSettings AllowMDI="true">
<DxReportDesignerParameterEditingSettings AllowEditParameterCollection="false" />
<DxReportDesignerDataSourceSettings AllowAddDataSource="false" />
<DxReportDesignerWizardSettings ReportWizardTemplatesSearchBoxVisibility="SearchBoxVisibility.Always" />
<DxReportDesignerReportPreviewSettings ExportSettings="new ExportSettings { UseSameTab = false, UseAsynchronousExport = false }" />
</DxReportDesignerModelSettings>
</DxWasmReportDesigner>
The Use Data Sources section contains information on how to add and configure data sources in the Report Designer for Blazor applications.
The following help topics explain how to customize the Report Designer UI and its behavior:
The following help topics describe how to integrate AI-powered functionality into the Report Designer:
Run Demo: Report Designer AI Extensions
Learn how to localize the Report Designer UI:
Use the CustomizeLocalization event to change specific strings in the Report Designer UI.
When you run an application with the Report Designer in a WebAssembly (WASM) environment, keep the following limitations in mind:
Data SourcesOnly JSON and Object data sources are currently supported.Rendering Engine (Skia)The Report Viewer uses a Skia-based engine to render content in the browser. Make sure your project references DevExpress.Drawing.Skia.Font ManagementWASM applications cannot rely on system fonts. Use DXFontRepository to explicitly load and register all required fonts.
To ensure that a Blazor WebAssembly application runs properly, set the MSBuild WasmBuildNative setting to true.
The following help topic lists common issues that can occur in a Web Reporting application and describes solutions: Troubleshooting.
For information on how to identify the cause of an issue, refer to the following topic: Reporting Application Diagnostics.