Skip to content

Commit 617f17e

Browse files
Dess user guide review part2 (#1768)
* components, map, tables after review * charts after review * fix renamed slugs * Update tables.md * applied review part 3 * Update data-sources.md
1 parent c710601 commit 617f17e

13 files changed

+186
-260
lines changed

user-guide/components/charts.md

Lines changed: 44 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -18,69 +18,20 @@ img[alt$="><"] {
1818

1919
The **Web Report Designer** offers a **Charts** section inside the **Components** tray allowing the end-user to visualize the data records from different [Data Source]({%slug web-report-designer-user-guide-components-data-sources%}) storages:
2020

21-
<div style="display: flex; align-items: flex-start; gap: 24px;">
22-
<img alt="><" title="Components tray" src="images/wrd-components-tray-charts.png" style="max-width:240px; height:auto; border:1px solid lightgrey;" />
23-
<table style="width:100%; height:100%;">
24-
<tr>
25-
<th style="width:30%">Chart Type</th><th>Description</th>
26-
</tr>
27-
<tr>
28-
<td><a href="https://testdocs.telerik.com/reporting/designing-reports/report-designer-tools/web-report-designer/user-guide/components/charts#bar-charts">Bar Chart</a></td>
29-
<td>Displays data series as sets of horizontal bars, graphically summarizes and renders data categories, and enables users to easily compare amounts or values between different categories.</td>
30-
</tr>
31-
<tr>
32-
<td><a href="https://testdocs.telerik.com/reporting/designing-reports/report-designer-tools/web-report-designer/user-guide/components/charts#line-charts">Line Chart</a></td>
33-
<td>Displays series as sets of points connected by a single line and represents large amounts of data that occur over a continuous period of time.</td>
34-
</tr>
35-
<tr>
36-
<td><a href="https://testdocs.telerik.com/reporting/designing-reports/report-designer-tools/web-report-designer/user-guide/components/charts#area-charts">Area Chart</a></td>
37-
<td>Displays a series as a set of points connected by a line with the whole area filled in under the line.</td>
38-
</tr>
39-
<tr>
40-
<td><a href="https://testdocs.telerik.com/reporting/designing-reports/report-designer-tools/web-report-designer/user-guide/components/charts#column-charts">Column Chart</a></td>
41-
<td>Displays data series as sets of vertical bars that are grouped by category.</td>
42-
</tr>
43-
<tr>
44-
<td><a href="https://testdocs.telerik.com/reporting/designing-reports/report-designer-tools/web-report-designer/user-guide/components/charts#pie-charts">Pie Chart</a></td>
45-
<td>Displays the contribution of fractional parts to a whole and is most commonly used to make comparisons between groups.</td>
46-
</tr>
47-
<tr>
48-
<td><a href="https://testdocs.telerik.com/reporting/designing-reports/report-designer-tools/web-report-designer/user-guide/components/charts#pie-charts">Doughnut Chart</a></td>
49-
<td>Similar to the Pie Chart which has an open space in the center.</td>
50-
</tr>
51-
</tr>
52-
<tr><td colspan=2 align=center><img alt="><" title="Components tray" src="images/wrd-components-tray-charts-small.png" /></td>
53-
</tr>
54-
</table>
55-
</div>
56-
21+
![Maps Group ><](images/wrd-components-tray-charts-design-mode.png)
22+
23+
The available Chart types are:
24+
* [Bar Chart]({%slug web-report-designer-user-guide-components-charts%}#adding-a-bar-chart) - Displays data series as sets of horizontal bars, graphically summarizes and renders data categories, and enables users to easily compare amounts or values between different categories.
25+
* [Line Chart]({%slug web-report-designer-user-guide-components-charts%}#adding-a-line-chart) - Displays series as sets of points connected by a single line and represents large amounts of data that occur over a continuous period of time.
26+
* [Area Chart]({%slug web-report-designer-user-guide-components-charts%}#adding-a-column-chart) - Displays a series as a set of points connected by a line with the whole area filled in under the line.
27+
* [Column Chart]({%slug web-report-designer-user-guide-components-charts%}#adding-an-area-chart) - Displays data series as sets of vertical bars that are grouped by category.</td>
28+
* [Pie Chart]({%slug web-report-designer-user-guide-components-charts%}#adding-a-pie-chart) - Displays the contribution of fractional parts to a whole and is most commonly used to make comparisons between groups.
29+
* [Doughnut Chart]({%slug web-report-designer-user-guide-components-charts%}#pie-charts) - Similar to the Pie Chart which has an open space in the center.
5730
Before adding a Chart report item, first, you need to select the **Details** section of the report. Then, you can select the desired chart type from the **Components** tray and configure it with the desired data source.
5831

59-
## Bar Charts
60-
61-
By clicking the `Bar` item from the **Components** tray (step 1.), a new tab will appear on the right-hand side of the **Web Report Designer** (step 2.):
62-
63-
>caption Configuration Settings
64-
65-
![Configure Bar Chart ><](images/wrd-components-tray-charts-configure-bar-chart.png)
32+
## Adding DataSource
6633

67-
>note The *Configuration pane* is identical for all chart types, allowing the end-user to specify the Data Source and configure the Categories, Series and Values groups.
68-
69-
Build the desired chart and use an already defined [Data Sources]({%slug web-report-designer-user-guide-components-data-sources%}). According to the data that should be displayed, it is possible to configure **Categories**, **Series** and **Values** groups. The following short video shows how to feed the chart with data from the already existing SQL Data Source that displays the total **Freight** for each **Country**:
70-
71-
>caption Populating Bar Chart with Orders' Freight by ShipCountry
72-
73-
<iframe width="560" height="315" src="https://www.youtube.com/embed/PD8RnyexfvQ?si=-sUhyCqDy0FC54O0" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
74-
75-
### Combine Mode
76-
77-
In case of having multiple series per category in the chart, it is possible to fine-tune the *combine mode* for the bar series for better illustration of the data. Telerik Reporting supports the following Bar chart types:
78-
79-
![Bar Chart Type ><](images/wrd-components-tray-charts-configure-bar-chart-type.png)
80-
81-
Let's have the following sample CSV data that will be used for the example:
82-
83-
>caption CSV Data Source
34+
Let's have the following sample **CSV** data and create a CSVDataSource that will be used in this article:
8435

8536
```
8637
Category, Year, Value
@@ -101,13 +52,41 @@ Components, 2004, 310
10152

10253
<iframe width="560" height="315" src="https://www.youtube.com/embed/ypQHSpXnJkw?si=_pjCxfXAIfKoWBa_" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
10354

104-
Create a Bar Chart that uses the **Year** column for the *Categories*, the **Category** column for the *Series* and the **Value** column for the *Values*. According to the selected Bar Chart Type, the following charts will be displayed:
55+
## Adding Charts
56+
57+
The Web Report Designer support two main chart groups:
58+
59+
* **Cartesian Charts** (Bar, Line, Column, Area) - use the Cartesian coordinate system to plot the data points in its chart series. The X and Y axes define how each point's coordinates in the plot area are calculated. Cartesian charts provides a mechanism for combining data points that reside in different series but have the same category. The combine mode can be:
60+
61+
* **Cluster**: The data points will be in the same category huddled close together.
62+
* **Stack**: Plots the points on top of each other.
63+
* **Stack100**: Presents the values of one series as a percentage of the other series.
64+
65+
* **Pie Charts** (Pie, Doughnut) - use the Radial coordinate system to plot each point as an arc segment where the arc's length is actually the percentage this point's value is from the total sum.
66+
67+
The next few sections demonstrate how to add the different chart types and illustrate how the CSV data is presented in the respective chart.
68+
69+
>note The *Configuration pane* on the right-hand side is identical for all chart types, allowing the end-user to specify the Data Source and configure the Categories, Series and Values groups.
70+
71+
### Adding a Bar Chart
72+
73+
This section shows how to create a Bar Chart that uses the **Year** column for the *Categories*, the **Category** column for the *Series* and the **Value** column for the *Values*.
74+
75+
1. Click the `Bar` item from the **Components** tray (step 1.), and configure the chart with the Configuration pane on the right-hand side of the **Web Report Designer** (step 2.):
76+
77+
2. Build the desired chart and use an already defined [Data Source]({%slug web-report-designer-user-guide-components-data-sources%}). According to the data that should be displayed, it is possible to configure **Categories**, **Series** and **Values** groups. The following short video shows how to feed the chart with data from the already existing SQL Data Source that displays the total **Freight** for each **Country**:
78+
79+
>caption Populating Bar Chart with Orders' Freight by ShipCountry
80+
81+
<iframe width="560" height="315" src="https://www.youtube.com/embed/PD8RnyexfvQ?si=-sUhyCqDy0FC54O0" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
82+
83+
According to the selected Bar Chart Type, the following charts will be displayed:
10584

10685
|**Clustered Bar**|**Stacked Bar**|**100% Stacked Bar**|
10786
|----|----|----|
10887
|![Clustered Bar Chart Type ](images/wrd-components-tray-charts-configure-bar-chart-clustered-type.png)|![Stacked Bar Chart Type ](images/wrd-components-tray-charts-configure-bar-chart-stacked-type.png)|![100% Stacked Bar Chart Type ](images/wrd-components-tray-charts-configure-bar-chart-100-stacked-type.png) |
10988

110-
## Column Charts
89+
### Adding a Column Chart
11190

11291
By clicking the `Column` item from the **Components** tray, a similar tab (like the one shown in the *Configuration Settings* above) will appear on the right-hand side of the **Web Report Designer**. The **Column** chart type is very similar to the **Bar** chart (which displays series as sets of horizontal bars) and to the **Range** Column chart (which displays series as sets of vertical bars with varying beginning and end points).
11392

@@ -123,7 +102,7 @@ According to the selected Column Chart Type, the following charts will be displa
123102
|----|----|----|
124103
|![Clustered Column Chart Type ](images/wrd-components-tray-charts-configure-column-chart-clustered-type.png)|![Stacked Column Type ](images/wrd-components-tray-charts-configure-column-chart-stacked-type.png)| ![100% Stacked Column Chart Type ](images/wrd-components-tray-charts-configure-column-chart-100-stacked-type.png) |
125104

126-
## Area Charts
105+
### Adding an Area Chart
127106

128107
By clicking the `Area` item from the **Components** tray, the *Configuration Settings* pane will appear on the right-hand side of the **Web Report Designer**. We will use the same *CSV Data Source* and configure the **Year** column for the *Categories*, the **Category** column for the *Series* and the **Value** column for the *Values*:
129108

@@ -139,7 +118,7 @@ According to the selected **Area Chart Type**, the following charts will be disp
139118
|----|----|----|
140119
|![Area Chart Type ](images/wrd-components-tray-charts-configure-area-chart-type.png)|![Stacked Area Type ](images/wrd-components-tray-charts-configure-stacked-area-type.png)|![100% Stacked Area Type ](images/wrd-components-tray-charts-configure-area-100-stacked-type.png) |
141120

142-
## Line Charts
121+
### Adding a Line Chart
143122

144123
By clicking the `Line` item from the **Components** tray, the *Configuration Settings* pane will appear on the right-hand side of the **Web Report Designer**. We will use the same *CSV Data Source* and configure the **Year** column for the *Categories*, the **Category** column for the *Series* and the **Value** column for the *Values*:
145124

@@ -161,7 +140,7 @@ The table illustrates how each of the chart types is expected to look:
161140
|----|----|----|
162141
|![Line with Markers Chart Type ](images/wrd-components-tray-charts-configure-line-with-markers-chart-type.png)|![Stacked Line with Markers Chart Type ](images/wrd-components-tray-charts-configure-stacked-line-with-markers-type.png)|![100% Stacked Line with Markers Chart Type ](images/wrd-components-tray-charts-configure-line-with-markers-100-stacked-type.png)|
163142

164-
## Pie Charts
143+
### Adding a Pie Chart
165144

166145
By clicking the `Pie` item from the **Components** tray, the *Configuration Settings* pane will appear on the right-hand side of the **Web Report Designer**. We will use the same *CSV Data Source* and configure the **Year** column for the *Categories*, the **Category** column for the *Series* and the **Value** column for the *Values*:
167146

user-guide/components/components.md

Lines changed: 19 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -12,49 +12,31 @@ position: 0
1212
img[alt$="><"] {
1313
border: 1px solid lightgrey;
1414
}
15+
table th:first-of-type {
16+
width: 50%;
17+
}
18+
table th:nth-of-type(2) {
19+
width:50%;
20+
}
21+
}
1522
</style>
1623

1724
# Components - Overview
1825

1926
Each report is constructed by [report items]({%slug user-guide/components/report-items%}) organized in different groups in the **Components** tab based on their purpose.
27+
The Components Tray lists the available report components that can be added to the web design report. The items are organized in groups based on their type. The area supports two kinds of layout - grid and list. The list is the default view.
28+
29+
![Components tray in List Mode ><](images/wrd-components-tray-design-mode.png)
2030

21-
<div style="display: flex; align-items: flex-start; gap: 24px;">
22-
23-
<img alt="><" title="Components tray" src="images/wrd-components-tray.png" style="max-width:240px; height:auto; border:1px solid lightgrey;" />
24-
<table style="width:100%; height:100%;">
25-
<tr>
26-
<th style="width:40%">Group</th><th>Report Items</th>
27-
</tr>
28-
<tr>
29-
<td><a href="https://testdocs.telerik.com/reporting/user-guide/components/report-items">Report Items</a> - The main building parts used in the report depending on the data that will be displayed, e.g. a TextBox item for static or data-bound text, a PictureBox for displaying images, a Barcode for showing barcode in a label report, etc.</td>
30-
<td><ul><li>TextBox</li><li>HtmlTextBox</li><li>PictureBox</li><li>CheckBox</li><li>Barcode</li><li>Shape</li><li>Panel</li><li>Radial Gauge Wizard</li><li>Linear Gauge Wizard</li></ul></td>
31-
</tr>
32-
<tr>
33-
<td><a href="https://testdocs.telerik.com/reporting/user-guide/components/tables">Tables</a> - The Table report item is a generalized layout report item that displays report data in cells that are organized into rows and columns.</td>
34-
<td><ul><li>List</li><li>Table</li><li>Crosstab</li><li>Table Wizard</li><li>Crosstab Wizard</li></ul></td>
35-
</tr>
36-
<tr>
37-
<td><a href="https://testdocs.telerik.com/reporting/user-guide/components/subreport">Report</a> - The SubReport item enables you to display reports within reports and serves as a container, similar to the report sections, growing in size depending on its children.</td>
38-
<td><ul><li>SubReport</li></ul></td>
39-
</tr>
40-
<tr>
41-
<td><a href="https://testdocs.telerik.com/reporting/user-guide/components/maps">Maps</a> - The Map report item is a native Telerik Reporting item which enables you to visualize an aggregated business data in a geographical manner.</td>
42-
<td><ul><li>Map types: Point, Pie, Column</li><li>Choropleth</li></ul></td>
43-
</tr>
44-
<tr>
45-
<td><a href="https://testdocs.telerik.com/reporting/user-guide/components/charts">Charts</a> - The Graph report item is a native Telerik Reporting item that allows you to generate different Chart types (objects) and visually present large volumes of aggregated information.</td>
46-
<td><ul><li>Bar Chart</li><li>Line Chart</li><li>Area Chart</li><li>Column Chart</li><li>Pie Chart</li><li>Doughnut Chart</li></ul></td>
47-
</tr>
48-
<tr>
49-
<td><a href="https://testdocs.telerik.com/reporting/user-guide/components/report-sections">Report Sections</a> - A Telerik report consists of different sections that may contain report items. Each report section represents a specific area on the report page and defines the rendering of its report items.</td>
50-
<td><ul><li>Page Header</li><li>Page Footer</li><li>Report Header</li><li>Report Footer</li><li>Table of Contents</li></ul></td>
51-
</tr>
52-
<tr>
53-
<td><a href="https://testdocs.telerik.com/reporting/user-guide/components/data-sources">DataSources</a> - Data Source components are used to connect data items to different types of data without writing any code.</td>
54-
<td><ul><li>SQL Data Source</li><li>CSV Data Source</li><li>Web Service Data Source</li><li>GraphQL Data Source</li><li>JSON Data Source</li><li>Object Data Source</li></ul></td>
55-
</tr>
56-
</table>
57-
</div>
31+
|Group|Report Items|
32+
|----|----|
33+
|[Report Items]({%slug user-guide/components/report-items%}) - The main building parts used in the report depending on the data that will be displayed, e.g. a TextBox item for static or data-bound text, a PictureBox for displaying images, a Barcode for showing barcode in a label report, etc.|<ul><li>TextBox</li><li>HtmlTextBox</li><li>PictureBox</li><li>CheckBox</li><li>Barcode</li><li>Shape</li><li>Panel</li><li>Radial Gauge Wizard</li><li>Linear Gauge Wizard</li></ul>|
34+
|[Tables]({%slug web-report-designer-user-guide-components-tables%}) - The Table report item is a generalized layout report item that displays report data in cells that are organized into rows and columns.|<ul><li>List</li><li>Table</li><li>Crosstab</li><li>Table Wizard</li><li>Crosstab Wizard</li></ul>|
35+
|Report - The SubReport item enables you to display reports within reports and serves as a container, similar to the report sections, growing in size depending on its children.|<ul><li>SubReport</li></ul>|
36+
|[Maps]({%slug web-report-designer-user-guide-components-maps%}) - The Map report item is a native Telerik Reporting item which enables you to visualize an aggregated business data in a geographical manner.|<ul><li>Map types: Point, Pie, Column</li><li>Choropleth</li></ul>|
37+
|[Charts]({%slug web-report-designer-user-guide-components-charts%}) - The Graph report item is a native Telerik Reporting item that allows you to generate different Chart types (objects) and visually present large volumes of aggregated information.|<ul><li>Bar Chart</li><li>Line Chart</li><li>Area Chart</li><li>Column Chart</li><li>Pie Chart</li><li>Doughnut Chart</li></ul>|
38+
|[Report Sections]({%slug user-guide/components/report-sections%}) - A Telerik report consists of different sections that may contain report items. Each report section represents a specific area on the report page and defines the rendering of its report items.|<ul><li>Page Header</li><li>Page Footer</li><li>Report Header</li><li>Report Footer</li><li>Table of Contents</li></ul>|
39+
|[DataSources]({%slug web-report-designer-user-guide-components-data-sources%}) - Data Source components are used to connect data items to different types of data without writing any code.|<ul><li>SQL Data Source</li><li>CSV Data Source</li><li>Web Service Data Source</li><li>GraphQL Data Source</li><li>JSON Data Source</li><li>Object Data Source</li></ul>|
5840

5941
## Next Steps
6042

0 commit comments

Comments
 (0)