Skip to content

Commit b510808

Browse files
dimodidimodi
committed
kb(Diagram): Add new KB for Diagram shape text below the image
1 parent d58bb4b commit b510808

File tree

2 files changed

+135
-1
lines changed

2 files changed

+135
-1
lines changed

‎components/diagram/shapes.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,7 @@ When using a visual function, the Diagram ignores all Shape parameters in the Ra
414414

415415
> This section links to the documentation of Kendo UI for jQuery. The Telerik Diagram for Blazor is not a wrapper of the Kendo UI Diagram. However, both components use the same client-side rendering engine. When the Kendo UI documentation mentions the `kendo.dataviz.diagram` JavaScript namespace, you must use `TelerikBlazor.DiagramCommon` instead.
416416
417-
In addition to the following example, also check this [Blazor Diagram demo](https://demos.telerik.com/blazor-ui/diagram/overview), which uses a visual function.
417+
In addition to the following example, also check the [Blazor Diagram Overview demo](https://demos.telerik.com/blazor-ui/diagram/overview) and the [Show Diagram Shape Text Below Image](slug:diagram-kb-show-shape-text-below-image) knowledge base article. Both use a visual function.
418418

419419
>caption Using Diagram Shape visual function
420420

‎knowledge-base/diagram-show-shape-text-below-image.md‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
---
2+
title: Show Diagram Shape Text Below Image
3+
description: Learn how to display shape text below the shape image in a Telerik Blazor Diagram component.
4+
type: how-to
5+
page_title: How to Show Shape Text Below the Image in Telerik Diagram for Blazor
6+
slug: diagram-kb-show-shape-text-below-image
7+
tags: telerik, blazor, diagram
8+
ticketid: 1698784
9+
res_type: kb
10+
---
11+
12+
## Environment
13+
14+
<table>
15+
<tbody>
16+
<tr>
17+
<td>Product</td>
18+
<td>Diagram for Blazor</td>
19+
</tr>
20+
</tbody>
21+
</table>
22+
23+
## Description
24+
25+
This KB answers the following questions:
26+
27+
* How to show the text label of a Diagram Shape below the image? By default, the text overlays the image, making it hard to read.
28+
* Can the Shape text be positioned under the image without using visual functions with JavaScript?
29+
* How to display and position the text in a Diagram Shape below the image?
30+
31+
## Solution
32+
33+
To rearrange the text labels and images in the Blazor Diagram Shapes, use the [`Visual` parameter of the `<DiagramShapeDefaults>` or `<DiagramShape>` tag](slug:diagram-shapes#visual-function). This will either affect all Shapes or a specific Shape. The associated JavaScript function may position the image and text with [`x` and `y` properties](https://www.telerik.com/kendo-jquery-ui/documentation/api/javascript/dataviz/diagram/text_block), but usually, the better option is to use a [`Layout` primitive](https://www.telerik.com/kendo-jquery-ui/documentation/api/javascript/dataviz/diagram/layout) as in the example below.
34+
35+
>caption Arrange Diagram Shape image and text one below the other
36+
37+
````RAZOR
38+
<TelerikDiagram>
39+
<DiagramConnectionDefaults Type="@DiagramConnectionType.Cascading" />
40+
<DiagramLayout Type="@DiagramLayoutType.Tree" />
41+
<DiagramShapeDefaults Visual="imageShapeVisual">
42+
<DiagramShapeDefaultsContent Color="black" FontSize="16" />
43+
</DiagramShapeDefaults>
44+
45+
<DiagramShapes>
46+
@foreach (DiagramShapeModel diagramShape in DiagramData)
47+
{
48+
<DiagramShape @key="@diagramShape" Id="@diagramShape.Id" DataItem="@diagramShape" />
49+
}
50+
</DiagramShapes>
51+
52+
<DiagramConnections>
53+
@foreach (DiagramShapeModel diagramShape in DiagramData)
54+
{
55+
if (!string.IsNullOrEmpty(diagramShape.ParentId))
56+
{
57+
<DiagramConnection @key="@diagramShape" FromId="@diagramShape.ParentId" ToId="@diagramShape.Id" />
58+
}
59+
}
60+
</DiagramConnections>
61+
</TelerikDiagram>
62+
63+
@* Move JavaScript code to a separate JS file *@
64+
<script suppress-error="BL9992">
65+
function imageShapeVisual(context) {
66+
let diagramNS = TelerikBlazor.DiagramCommon;
67+
68+
let shapeGroup = new diagramNS.Group();
69+
70+
let shapeRectangle = new diagramNS.Rectangle({
71+
width: context.width,
72+
height: context.height,
73+
stroke: {
74+
color: "transparent"
75+
}
76+
});
77+
shapeGroup.append(shapeRectangle);
78+
79+
let layoutSpacing = 6;
80+
// Make sure the layout content can fit, otherwise you will get unexpected results.
81+
let imageDimension = context.height - context.content.fontSize * 1.5;
82+
let imageTextRect = new diagramNS.Rect(0, 0, context.width, context.height);
83+
84+
let imageTextLayout = new diagramNS.Layout(imageTextRect, {
85+
alignContent: "center",
86+
alignItems: "center",
87+
justifyContent: "center",
88+
orientation: "vertical",
89+
spacing: layoutSpacing
90+
});
91+
shapeGroup.append(imageTextLayout);
92+
93+
let image = new diagramNS.Image({
94+
source: context.dataItem.Source,
95+
width: imageDimension,
96+
height: imageDimension
97+
});
98+
let title = new diagramNS.TextBlock({
99+
text: context.dataItem.Title,
100+
color: context.color
101+
});
102+
103+
imageTextLayout.append(image);
104+
imageTextLayout.append(title);
105+
imageTextLayout.reflow();
106+
107+
return shapeGroup;
108+
}
109+
</script>
110+
111+
@code {
112+
private List<DiagramShapeModel> DiagramData { get; set; } = new()
113+
{
114+
new DiagramShapeModel() { Id = "shape-1", Title = "Shape 1 Title" },
115+
new DiagramShapeModel() { Id = "shape-2", ParentId = "shape-1", Title = "Shape 2 Title" },
116+
new DiagramShapeModel() { Id = "shape-3", ParentId = "shape-1", Title = "Shape 3 Title" },
117+
};
118+
119+
public class DiagramShapeModel
120+
{
121+
public string Id { get; set; } = string.Empty;
122+
public string ParentId { get; set; } = string.Empty;
123+
public string Title { get; set; } = "Default Shape Title";
124+
public string Source { get; set; } = Base64SvgImage;
125+
}
126+
127+
private const string Base64SvgImage = "data:image/svg;base64,iVBORw0KGgoAAAANSUhEUgAAAKQAAACkCAMAAAAua3VzAAACylBMVEVMaXFc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBc5QBeULtoAAAA7XRSTlMAgAIEmOsx8uAhAQUG+vX0/AP7/jMdovfO5weHChPmt+/2LkdrrfkWC5/cYDZ5F8vuOA743v0QgXqTHKzjFMjNUG6h8909EejtIBoeiC/J0w+0XL1bPOHMQAySGyXPUvHwVbwmOt9thmwZJ0vl7Fpe0NHKq9mbhWYJMhhBIg10K9Wc5L+Lvo+UoxJkRerplq81SbgwnigsRCrUtXe6WDkfYkNIkHa5V+KkQq5McISoRomy2zuxtk4kIwhUmYM/f2OmaFM0FWeqmsNhqYots9dWwsdlb9bBX2lKjU94u1l9xYywcntRanPEKZ11N5XgtWiRAAAG0klEQVR42u3d5VcbSxQA8NuEGiEJIRDc3d2KuzsUKnhxitTd3d3d3d2eu7u7y/4P7zxe2xcoyWw2d5LhHO73WX4nszs7c+fuAIAaoTtCZLKQHaHAbljlu3J94ZpvxShRsi6LexpOrWEMEsXulVy/qHQXM0YUhcZxz0RcqIgl4+EWOTdIyFsmM0M08yjiNIRfioQJomnNVU5LXK0xNb7RcqkFpzUslloamRgVvYwjRvysScY0lgcrOT7R22U04pQyc45nmJdNMQpxkoo3sY+pMnyfL3zkxOkYdS0+BiU6lNtwAsKm3MFwg3dGCScwSjLMDGNcvEnOCQ75psUGIHp72HJ6ha2HN+3nJTmJ0zuSkhfSnNZaxnEoEWdJbd4RFGvNIYX1xHFUiJkpfhxixC+Kwh92ahI55ChMRu5zyfccfrjGXcf9IR+ullFgdsbOQ15qbaag5Hpbcbtc8fMSCkrz93fjMtdeyKLAHD0deU2Zs4LGrbnhSiburXn9pJQCc8Y3uMOR+ODHNJifHMVNd0QFbqTxoD+PPInL83WhoMyOQU4YVn3nRYFZdCoBVWk3m8aoyW2rws3KOH47lYLSK9YNt893pbpSYNq2vozL3L2SRp8nvoe7pvT2p3FrSp0DcH/MnQ9oDEchsW24zIDpNPq888e7uFmXmkIKyvDqe8jD0QvjKTDrftiC/KZcbUGB2YS9oNzlTGFCjL80v2xjZKRd43mP8412hLnmhXQjIk3dTPoambgRHrhJEzcaC2kV8yQlKSfO+c6WpBkD6ejfo9aux9+R0OelwYZHzh/41DrPJ7QIGzHDsEi3idaDJO5Icz6rNdaGQ2aeGDz5bHuCsFKWHHU2FLK7MlJD68jKbkLbCd0zDIG09NT2prPwJO2+Bi3Kpo30NiHthMhNSPsIBb5eNJE+gRE8rhERSNiJ87l8UkkLqSi14TensbBJJryCHD/cSwc59xz/3Nloz7mEPs+94oWOFAWt0m3R4rIqiJBrcnsTGWmXovsce3wKaQl6LAkRKXEXdrXECtIk7rMmJKRp+yXBd8+ldsIT1LY6GwM5LrpWjwexNpq0E1cw3UJfpEPrGD1fD+NnE/oc6lea64MUdyxHmA8s7yBU+pn9GiEcuV2FkweXqrYTfsztq0IEIv/AyzSm2xNuTdH6zUpByBbM1VNiOaHPb2cJ6+7fNyFue0Tuy9C+Y5Uu8MERPdyGmbgzua0FOXaM4CFIUY9ZGdD51V0aSIDij+oQmb0vUkEC7HzNGpG53JIKEqDia8QMniw1hwoSzEqrEX/Mkb840kACRM2KR2T2dITRQALsWTMST6lMTaCCBHB/Ha9CYGoAJSRInkNLh44cRQsJ0Hbcln0kwJ5Xw9lHgqJjJftIgOJX4tlHAjTau7KPBHjJU8k+Eoo/L2QfCZC7fxn7SIAF98PZRwIcujkEkACn3h0CSJgTeJp9JICVbwj7SIBD+6TsIwE+/WAIICHKvol9JMBc3zT2kaBYX8Y+EsBnth/7SICEWXL2kQBnhgLSZBg5jBxGDiOHkWpxp5F5pGirywrWkaN8ZdwItpGZ+f/mrZhGKt747xNVlpEZNx8vvdhFLvDd8KQFq0iHGLVyBEaRt/oVjjOJDCjpX3vCIDJn5sAdW+aQjs3P7uIwhpywdbCvGJhCigJuDNqCJWR7voa8GTvIBH+Nl2AFKT7WoHnThhHkZJW28lsmkEEXtRcMMICUrCOlyYyP3PobcTfJ2Mj2+zwKbo2AnKbW7EEnnxZGQN5Ta9acxiZSpX56mChnhyt7SNfYtQMWWxkNrCHLBqnHM/MvYglZ5D/4pwph0U6sIJ2iNR9Oe/iMlAWkfOZYrTPyqgZzbKSutWrmDVWk1ZfpkWlKXGTWZF2QymlH+HwfP89+GSoySZf6ST97vqdahaYiImXJOiBTC/hn0ST1B7CQSntT3sgD9bodbTSn+RoKMjtQzLem91rzHJ0T4uNWhOuPXLPFlGfhscvFPCFpe9GWc3oig28p+JZwbx4ldHdB7F6tB/L0umK+xfDVeh0rbubhJBBpbq/xEKWBSCcPfQ+1WfDFaCHIG29rvmR/ZNpb3vqfAyaq8JTpiIwM/lLbFdWRMs8KnKPKFF3BUl2QTSna/+7/SGlwlwKwwuenDbyRWcdzCVd7iozYPwEww0pVywuZ9s584rUeI2tVeYAdU9IDycjCUh5jSR8yfBuVc7mD2khIpxhe3Td2DBfZ0w0Giv7Iupl3+DXbGSn/03D/ukId6eV8lm+z3Ed/ARgDufegHbAZT5Eui3IB2EZKlxYAMI50Xu8AjCMjutYCsI20zs8DxuPv3l0G+Tv/AJiXQD+0DbN3AAAAAElFTkSuQmCC";
128+
}
129+
````
130+
131+
## See Also
132+
133+
* [Diagram Shapes](slug:diagram-shapes)
134+
* [Diagram Demo with Shape Visual](https://demos.telerik.com/blazor-ui/diagram/overview)

0 commit comments

Comments
 (0)