@mescius/activereportsnet-designer 18.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,43 @@
1
+ # ActiveReports Web Designer
2
+
3
+ The ActiveReports.NET Web Designer is a comprehensive report designer
4
+ that empowers developers and business users to design, edit, and preview
5
+ reports directly in their own web applications. With its intuitive
6
+ interface and feature-rich functionality, the Web Designer simplifies
7
+ the report creation process, saving you time and effort.
8
+
9
+ ## Features
10
+
11
+ - **Interactive Report Design:** The Web Designer provides a drag-and-drop interface, allowing you to effortlessly design your reports by arranging data fields, images, charts, and other visual elements. With the real-time preview, you can instantly see how your report will appear to end users.
12
+ - **Powerful Data Binding:** Connect your reports to various data sources, including databases, Excel files, and JSON data. The Web Designer offers robust data binding capabilities, enabling you to dynamically populate your reports with accurate information.
13
+ - **Rich Report Elements:** Customize your reports with various elements, such as tables, charts, images, text boxes, and subreports. Use advanced formatting options, including conditional formatting, to create visually appealing reports that convey information effectively.
14
+
15
+ - **Report Templates:** Create dynamic templates that can be inherited and locked based on the user. This is a quick way for end-users to start creating or modifying reports with the easy-to-use web report designer.
16
+ - **Extensibility and Integration:** Seamlessly integrate the Web Designer into your web application using our powerful API and event model. Extend its functionality by creating custom report elements or integrating with other third-party tools, ensuring a tailored reporting experience for your users.
17
+ - **Responsive Design:** Design reports that adapt to different screen sizes and devices. The Web Designer supports responsive layout options, ensuring optimal viewing experiences across desktops, tablets, and mobile devices.
18
+
19
+ ## Implementation
20
+
21
+ The following documentation page describe the inegration of the web-designer component into applications
22
+
23
+ * [Server-side configuration](https://developer.mescius.com/activereportsnet/docs/latest/online/web-designer-aspnet-middleware.html?utm_source=NPM&utm_medium=AR&utm_campaign=ARNET-WebDesigner)
24
+ * Integration
25
+ * [ASP.NET MVC Core](https://developer.mescius.com/activereportsnet/docs/latest/online/web-designer-mvccore-integration.html?utm_source=NPM&utm_medium=AR&utm_campaign=ARNET-WebDesigner)
26
+ * [Angular](https://developer.mescius.com/activereportsnet/docs/latest/online/web-designer-integration-to-angular.html?utm_source=NPM&utm_medium=AR&utm_campaign=ARNET-WebDesigner)
27
+ * [React](https://developer.mescius.com/activereportsnet/docs/latest/online/web-designer-integration-to-react.html?utm_source=NPM&utm_medium=AR&utm_campaign=ARNET-WebDesigner)
28
+ * [Vue](https://developer.mescius.com/activereportsnet/docs/latest/online/web-designer-integration-to-vuejs.html?utm_source=NPM&utm_medium=AR&utm_campaign=ARNET-WebDesigner)
29
+ * [Web Designer API](https://developer.mescius.com/activereportsnet/docs/latest/online/web-designer-api.html?utm_source=NPM&utm_medium=AR&utm_campaign=ARNET-WebDesigner)
30
+
31
+ ## Resources
32
+
33
+ - [Documentation](https://developer.mescius.com/activereportsnet/docs/latest/online/web-designer-application.html?utm_source=NPM&utm_medium=AR&utm_campaign=ARNET-WebDesigner): Access the official documentation for the ActiveReports.NET Web Report, which provides comprehensive information about installation, usage, customization, and more.
34
+ - [Demos](https://developer.mescius.com/activereportsnet/demos/?utm_source=NPM&utm_medium=AR&utm_campaign=ARNET-WebDesigner): Try our interactive demos to experience ActiveReports in action to see and use our features and controls firsthand.
35
+
36
+ ## Stay Connected
37
+
38
+ Stay up-to-date with the latest news, updates, and announcements
39
+ regarding ActiveReports by following us on social media:
40
+
41
+ - [Twitter](https://twitter.com/MESCIUS_inc/)
42
+ - [LinkedIn](https://www.linkedin.com/company/mesciusinc)
43
+ - [Facebook](https://www.facebook.com/MESCIUSinc)
@@ -0,0 +1,198 @@
1
+ # ActiveReports Web Designer Reference
2
+
3
+ This document provides information on how to set up AR Web Designer.
4
+
5
+ - [ActiveReports Web Designer Reference](#activereports-web-designer-reference)
6
+ - [Code Snippets](#code-snippets)
7
+ - [General](#general)
8
+ - [Custom Localization](#custom-localization)
9
+ - [Basic Sample Custom Localization JSON](#basic-sample-custom-localization-json)
10
+ - [Common](#common)
11
+ - [Name Templates](#name-templates)
12
+ - [Parameters](#parameters)
13
+
14
+ ## Code Snippets
15
+
16
+ ### General
17
+
18
+ ```html
19
+ <!DOCTYPE html>
20
+ <html lang="en">
21
+
22
+ <head>
23
+ <!--
24
+ Note: Page title is updated automatically.
25
+ You can alter this behavior by disabling it or providing a custom update function:
26
+
27
+ create('ar-web-designer', {
28
+ disabled: true,
29
+ title: { onUpdate: (info) => { ... your code here ... } },
30
+ });
31
+
32
+ See detailed API info in ar-web-designer-api.d.ts
33
+ -->
34
+ <title>ActiveReports Web Designer</title>
35
+ <meta charset="utf-8">
36
+ <meta name="viewport" content="width=device-width, initial-scale=1">
37
+ <meta http-equiv="x-ua-compatible" content="ie=edge">
38
+
39
+ <link rel="stylesheet" href="vendor/css/bootstrap.css" />
40
+ <link rel="stylesheet" href="vendor/css/fonts-googleapis.css" type="text/css">
41
+
42
+ <!-- Optional. Resets browser's default style which allows the Designer to occupy the whole page -->
43
+ <style>
44
+ html, body { width: 100%; height: 100%; margin: 0; padding: 0 }
45
+ </style>
46
+
47
+ <!-- Required for the AR Web Viewer -->
48
+ <link rel="stylesheet" href="jsViewer.min.css" />
49
+ <link rel="stylesheet" href="web-designer.css" />
50
+ </head>
51
+
52
+ <body>
53
+ <!-- Required for the AR Web Viewer -->
54
+ <script src="jsViewer.min.js"></script>
55
+ <script src="web-designer.js"></script>
56
+
57
+ <!-- Important! Designer requires a defined size or a container to fill -->
58
+ <div id="ar-web-designer" style="width: 100%; height: 100%;"></div>
59
+
60
+ <script>
61
+ /* Required for the AR Web Viewer */
62
+ var viewer = null;
63
+
64
+ GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
65
+ appBar: {
66
+ /* Optional */
67
+ saveButton: { visible: false },
68
+
69
+ /* Optional */
70
+ saveAsButton: { visible: false },
71
+ },
72
+
73
+ data: {
74
+ /* Optional */
75
+ dataSets: { canModify: true },
76
+
77
+ /* Optional */
78
+ dataSources: { canModify: true },
79
+ },
80
+
81
+ server: {
82
+ /* Optional */
83
+ url: 'api'
84
+ },
85
+
86
+ preview: {
87
+ /* Required for the AR Web Viewer */
88
+ openViewer: ({ element, documentInfo: { id: documentId } }) => {
89
+ if (viewer) {
90
+ viewer.openReport(documentId);
91
+ return;
92
+ }
93
+
94
+ viewer = GrapeCity.ActiveReports.JSViewer.create({
95
+ element: '#' + element,
96
+ reportID: documentId,
97
+ renderFormat: options.preferredFormat || 'html',
98
+ reportService: {
99
+ url: 'api/reporting',
100
+ },
101
+ settings: {
102
+ zoomType: 'FitPage',
103
+ },
104
+ });
105
+ }
106
+ },
107
+ });
108
+ </script>
109
+ </body>
110
+
111
+ </html>
112
+ ```
113
+
114
+ ## Custom Localization
115
+
116
+ ### Basic Sample Custom Localization JSON
117
+
118
+ Here a **common** namespace is used as an example for the **Custom Localization** feature.
119
+
120
+ * **"ns"** property is a **namespace**. It shouldn't be translated and is required for proper work of the **Custom Localization** feature. Required.
121
+ * **"lng"** property is a **language**. For example, "es" for Spanish. Required
122
+ * **"resources"** A map of localization resources used in the corresponding namespace. Contents of this property require translation. Required.
123
+
124
+ ```json
125
+ [
126
+ {
127
+ "ns": "common",
128
+ "lng": "ja",
129
+ "resources": {
130
+ "units": {
131
+ "cm": {
132
+ "textShortName": "cm",
133
+ "textFullName": "センチメートル"
134
+ },
135
+ "in": {
136
+ "textShortName": "in",
137
+ "textFullName": "インチ"
138
+ }
139
+ },
140
+ "btnAdd": "追加",
141
+ "btnOk": "OK",
142
+ "btnCancel": "キャンセル",
143
+ "btnSave": "保存",
144
+ "textOpen": "開く..."
145
+ }
146
+ }
147
+ ]
148
+ ```
149
+
150
+ ### Common
151
+
152
+ If you would like to utilize the **Custom Localization** feature:
153
+ 1. You need to translate the **resources** from the **custom-resources.json** file.
154
+ 2. Add translated resources fo the AR Web Designer **before** the instance is created.
155
+
156
+ **Example:**
157
+
158
+ ```javascript
159
+ GrapeCity.ActiveReports.Designer.addLanguage('fr', [
160
+ {
161
+ "ns": "common",
162
+ "lng": "ja",
163
+ "resources": {
164
+ "btnAdd": "追加",
165
+ "btnCancel": "キャンセル",
166
+ "btnSave": "保存",
167
+ "textOpen": "開く..."
168
+ /* ... */
169
+ }
170
+ },
171
+ /* ... Other Namespaces ... */
172
+ ]);
173
+
174
+ GrapeCity.ActiveReports.Designer.create('#ar-web-designer');
175
+ ```
176
+
177
+ ### Name Templates
178
+
179
+ In *custom-resources.json* there is a **"nameTemplates"** namespace. Values in these sections are expected to be **alphanumeric identifiers**. I.e., they can contain only **letters** and **digits** but cannot start with a digit. The same is applicable to **"textDataSourceNameTemplate"** property from the *dataSourceEditor* namespace.
180
+
181
+ ### Parameters
182
+
183
+ Please note that some resource strings have parameters. They are enclosed in double curly braces:
184
+
185
+ ```javascript
186
+ "textFieldsCount": "{{count}} fields",
187
+ "textFieldsCount_plural": "{{count}} fields",
188
+ ```
189
+
190
+ **DO NOT** translate them. Translate only surrounding text:
191
+
192
+ ```javascript
193
+ "textFieldsCount_0": "{{count}} pól",
194
+ "textFieldsCount_1": "{{count}} pole",
195
+ "textFieldsCount_2": "{{count}} pola",
196
+ ```
197
+
198
+ You can move them to a different part of the sentence according to the language you're translating to