Skip to content

Commit df3b2cb

Browse files
Revamping the Ug
1 parent 5fa700f commit df3b2cb

File tree

9 files changed

+29
-28
lines changed

9 files changed

+29
-28
lines changed

blazor/diagram/commands.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -781,7 +781,7 @@ The following example demonstrates the grouping commands.
781781
A complete working sample can be downloaded from [GitHub](https://github.com/SyncfusionExamples/Blazor-Diagram-Examples/tree/master/UG-Samples/Commands/GroupingCommands)
782782
## How to Arrange Diagram Elements Using Z-Order Commands
783783

784-
ZOrder commands are used to control the stacking order (Z-Order) of the diagram elements such as nodes, connectors, and groups. Also, arrange the selected objects on the diagram page with their Z-order values by using the Bring to front, Bring forward, Send to back, and Send backward features.
784+
Z-Order commands are used to control the stacking order (Z-Order) of the diagram elements such as nodes, connectors, and groups. Also, arrange the selected objects on the diagram page with their Z-order values by using the Bring to front, Bring forward, Send to back, and Send backward features.
785785

786786
### How to Use the Bring To Front Commands
787787

@@ -1257,7 +1257,7 @@ A complete working sample can be downloaded from [GitHub](https://github.com/Syn
12571257

12581258
## How to Bring the Entire Diagram into the Current Viewport Using Fit to Page Command
12591259

1260-
The `FitToPage` command is used to bring the entire diagram (including large diagrams) into view. Customize the behavior of the FitToPage command by passing a [FitOptions](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.FitOptions.html) object as a parameter. If no parameter is provided, the entire diagram is fit into the view using default settings.
1260+
The [FitToPage](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.FitMode.html) command is used to bring the entire diagram (including large diagrams) into view. Customize the behavior of the `FitToPage` command by passing a [FitOptions](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.FitOptions.html) object as a parameter. If no parameter is provided, the entire diagram is fit into the view using default settings.
12611261

12621262
The following code illustrates how to execute the FitToPage method.
12631263

@@ -1397,7 +1397,7 @@ A complete working sample can be downloaded from [GitHub](https://github.com/Syn
13971397

13981398
#### FitToPage Parameters
13991399

1400-
The [FitOptions](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.FitOptions.html) parameter allows you to customize the behavior of the FitToPage command. By configuring various properties of the FitOptions object, Control how the diagram is adjusted within the view.
1400+
The [FitOptions](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.FitOptions.html) parameter allows you to customize the behavior of the `FitToPage` command. By configuring various properties of the `FitOptions` object, Control how the diagram is adjusted within the view.
14011401

14021402
#### FitToPage
14031403

blazor/diagram/constraints.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ To learn more about bitwise operators, refer to [Bitwise Operations](constraints
4141
|[Routing](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.DiagramConstraints.html#Syncfusion_Blazor_Diagram_DiagramConstraints_Routing)|Determines if automatic line routing is enabled or disabled for connectors. When enabled, lines are automatically routed to avoid overlapping with nodes and other obstacles.|
4242
|[Default](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.DiagramConstraints.html#Syncfusion_Blazor_Diagram_DiagramConstraints_Default)|Enables or disables all constraints in diagram.|
4343

44-
The following example shows how to disable the PageEditable constraint from the default diagram constraints.
44+
The following example shows how to disable the `PageEditable` constraint from the default diagram constraints.
4545

4646
```cshtml
4747
@using Syncfusion.Blazor.Diagram
@@ -142,7 +142,7 @@ The [Constraints](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagra
142142
|[RoutingObstacle](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.NodeConstraints.html#Syncfusion_Blazor_Diagram_NodeConstraints_RoutingObstacle)|Enables or disables the node to be treated as obstacle while in routing.|
143143
|[Default](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.NodeConstraints.html#Syncfusion_Blazor_Diagram_NodeConstraints_Default)|Enables all default constraints for the node.|
144144

145-
The following example shows how to disable the rotate constraint from the default node constraints.
145+
The following example shows how to disable the `Rotate` constraint from the default node constraints.
146146

147147
```cshtml
148148
@using Syncfusion.Blazor.Diagram
@@ -178,7 +178,7 @@ A complete working sample can be downloaded from [GitHub](https://github.com/Syn
178178

179179
![Node Constraints in Blazor Diagram](images/blazor-diagram-node-constraints.png)
180180

181-
The following example shows how to add the Shadow constraint to the default constraints of a node.
181+
The following example shows how to add the `Shadow` constraint to the default constraints of a node.
182182

183183
```csharp
184184
NodeConstraints NodeConstraints = NodeConstraints.Default | NodeConstraints.Shadow;
@@ -255,7 +255,7 @@ The [Constraints](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagra
255255
|[ReadOnly](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.ConnectorConstraints.html#Syncfusion_Blazor_Diagram_ConnectorConstraints_ReadOnly)|Enables or disables readonly for the connector.|
256256
|[Default](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.ConnectorConstraints.html#Syncfusion_Blazor_Diagram_ConnectorConstraints_Default)|Enables all constraints for the connector.|
257257

258-
The following code shows how to disable the Select constraint from the default connector constraints.
258+
The following code shows how to disable the `Select` constraint from the default connector constraints.
259259

260260
```cshtml
261261
@using Syncfusion.Blazor.Diagram
@@ -287,7 +287,7 @@ The following code shows how to disable the Select constraint from the default c
287287

288288
A complete working sample can be downloaded from [GitHub](https://github.com/SyncfusionExamples/Blazor-Diagram-Examples/tree/master/UG-Samples/Constraints/ConnectorConstraints)
289289

290-
The following example shows how to add the Bridging constraint to the default constraints of a connector.
290+
The following example shows how to add the `Bridging` constraint to the default constraints of a connector.
291291

292292
```csharp
293293
ConnectorConstraints ConnectorConstraints = ConnectorConstraints.Default | ConnectorConstraints.Bridging;
@@ -613,7 +613,7 @@ N> By default, the following constraints are enabled for the selected items,
613613

614614
## How to Enable or Disable Snap Constraints
615615

616-
The [Constraints](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.SnapSettings.html#Syncfusion_Blazor_Diagram_SnapSettings_Constraints) property of the SnapConstraints controls the visibility of gridlines and enables or disables snapping. Snap constraints allow the following behaviors.
616+
The [Constraints](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.SnapSettings.html#Syncfusion_Blazor_Diagram_SnapSettings_Constraints) property of the `SnapConstraints` controls the visibility of gridlines and enables or disables snapping. Snap constraints allow the following behaviors.
617617

618618
* Show only horizontal or vertical gridlines.
619619
* Show both horizontal and vertical gridlines.
@@ -686,7 +686,7 @@ N> By default, the following constraints are enabled for the snap functionality
686686

687687
## How to Use Boundary Constraints
688688

689-
Boundary [constraints](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.BoundaryConstraints.html) defines a boundary for the diagram inside that the interaction should be done. Boundary constraints allow the following behaviors:
689+
[BoundaryConstraints](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.BoundaryConstraints.html) defines a boundary for the diagram inside that the interaction should be done. Boundary constraints allow the following behaviors:
690690

691691
* Infinity
692692
* Diagram

blazor/diagram/context-menu.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ A complete working sample can be downloaded from [GitHub](https://github.com/Syn
155155

156156
### How to Show Custom Context Menu Alone
157157

158-
Set the [ShowCustomMenuOnly](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.ContextMenuSettings.html#Syncfusion_Blazor_Diagram_ContextMenuSettings_ShowCustomMenuOnly) property to true to display only custom context menu items.
158+
Set the [ShowCustomMenuOnly](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.ContextMenuSettings.html#Syncfusion_Blazor_Diagram_ContextMenuSettings_ShowCustomMenuOnly) property to **true** to display only custom context menu items.
159159
The following code example shows how to show custom context menu items alone.
160160

161161
```cshtml

blazor/diagram/how-to.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The diagram's core functionalities are implemented through a comprehensive set o
1313

1414
## How to Add Nodes Using the Add Method
1515

16-
Create a node in a Blazor diagram, define a Node object and add it to the diagram's nodes collection using the `Add()` method. It's crucial to call the Add() method within the OnInitialized() lifecycle method. This approach ensures that each diagram element is properly measured and rendered individually before the entire diagram is displayed. Attempting to use the Add() method outside of OnInitialized() is not recommended, as it may lead to unexpected behavior or rendering issues in the diagram. The following code example shows how to add a node to the diagram.
16+
Create a node in a Blazor diagram, define a Node object and add it to the diagram's nodes collection using the `Add` method. It's crucial to call the `Add` method within the `OnInitialized` lifecycle method. This approach ensures that each diagram element is properly measured and rendered individually before the entire diagram is displayed. Attempting to use the `Add` method outside of `OnInitialized` is not recommended, as it may lead to unexpected behavior or rendering issues in the diagram. The following code example shows how to add a node to the diagram.
1717

1818
```cshtml
1919
@using Syncfusion.Blazor.Diagram
@@ -723,7 +723,7 @@ The [GetPageBounds](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diag
723723
A complete working sample can be downloaded from [GitHub](https://github.com/SyncfusionExamples/Blazor-Diagram-Examples/tree/master/UG-Samples/Methods/GetPageBounds)
724724

725725
## How to Select All Objects in the Diagram
726-
The [SelectAll](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.SfDiagramComponent.html#Syncfusion_Blazor_Diagram_SfDiagramComponent_SelectAll) method selects all objects (nodes, connectors, and annotations) in the diagram simultaneously. This feature is particularly useful for performing bulk operations or applying changes to multiple elements at once.
726+
The [SelectAll](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.SfDiagramComponent.html#Syncfusion_Blazor_Diagram_SfDiagramComponent_SelectAll) method selects all objects (like nodes, connectors, and groups) in the diagram simultaneously. This feature is particularly useful for performing bulk operations or applying changes to multiple elements at once.
727727

728728
```cshtml
729729
@using Syncfusion.Blazor.Diagram

blazor/diagram/interaction.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -376,6 +376,7 @@ The DiagramSelectionSettings provides access to:
376376
A complete working sample can be downloaded from [GitHub](https://github.com/SyncfusionExamples/Blazor-Diagram-Examples/tree/master/UG-Samples/Interaction/CurrentSelection)
377377
378378
### How to clone the selected nodes and connector at runtime
379+
379380
Clone is a virtual method of the node used to create a copy of a diagram object. After cloning, it is necessary to set a unique ID for the cloned nodes and connectors. The following code demonstrates how to clone selected nodes during runtime.
380381
```cshtml
381382
@using Syncfusion.Blazor.Diagram

blazor/diagram/swimlane/phase.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -407,13 +407,13 @@ Below is an example demonstrating how to set the orientation for phases in an Sf
407407

408408
You can download a complete working sample from [GitHub](https://github.com/SyncfusionExamples/Blazor-Diagram-Examples/tree/master/UG-Samples/Swimlanes/Phase/PhaseOrientation).
409409

410-
![Phse](Swimlane-images/PhaseOrientation.PNG).
410+
![Phase](Swimlane-images/PhaseOrientation.PNG).
411411

412412
## How to Select and Resize Phase Header
413413

414414
* Select an individual phase header by clicking the header twice. The first click selects the phase, and the second click selects the header.
415415

416-
* Resize an individual phase header. While resizing a phase, a 20 px distance is maintained from the lane children.
416+
* Resize an individual phase header. While resizing a phase, a 20 pixels distance is maintained from the lane children.
417417

418418
* When an element is resized, the [SizeChanging](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.SfDiagramComponent.html#Syncfusion_Blazor_Diagram_SfDiagramComponent_SizeChanging) and [SizeChanged](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.SfDiagramComponent.html#Syncfusion_Blazor_Diagram_SfDiagramComponent_SizeChanged) events are triggered.
419419

blazor/diagram/swimlane/swimlane.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ To create a swimlane, you have to define the swimlane object and add it to the [
6565
```
6666
{% previewsample "https://blazorplayground.syncfusion.com/embed/LNBIiDNcgwRwLkFg?appbar=false&editor=false&result=true&errorlist=false&theme=bootstrap5" %}
6767

68-
>**Note:** Swimlane IDs should not start with numbers or special characters and should not contain special characters such as underscore(_) or spaces.
68+
>**Note:** Swimlane ID should not start with numbers or special characters and should not contain special characters such as underscore(_) or spaces.
6969
7070
The swimlane appears as follows.
7171

@@ -319,13 +319,13 @@ A complete working sample can be downloaded from [GitHub](https://github.com/Syn
319319
| Vertical | ![Vertical](Swimlane-images/Swimlane_Vertical.PNG) |
320320

321321

322-
## How to set pacing between lane or phase header and its children
322+
## How to set spacing between lane or phase header and its children
323323

324-
Define custom spacing between a lane or phase header and its child elements (nodes, connectors, or groups) using the [ChildrenSpacing](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.Swimlane.html#Syncfusion_Blazor_Diagram_Swimlane_ChildrenSpacing) property, which accepts a DiagramThickness with Top, Bottom, Left, and Right values.
324+
Define custom spacing between a lane or phase header and its child elements (nodes, connectors, or groups) using the [ChildrenSpacing](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.Swimlane.html#Syncfusion_Blazor_Diagram_Swimlane_ChildrenSpacing) property, which accepts a `DiagramThickness` with `Top`, `Bottom`, `Left`, and `Right` values.
325325

326-
By default, ChildrenSpacing is 20 px on all sides. Adjust these values to control padding between the header and its children within the swimlane layout.
326+
By default, `ChildrenSpacing` is 20 pixels on all sides. Adjust these values to control padding between the header and its children within the `Swimlane`.
327327

328-
The following example shows how to apply custom spacing using ChildrenSpacing property.
328+
The following example shows how to apply custom spacing using `ChildrenSpacing` property.
329329

330330
```cshtml
331331
@using Syncfusion.Blazor.Diagram
@@ -433,7 +433,7 @@ A complete working sample can be downloaded from [GitHub](https://github.com/Syn
433433

434434
### How to Select the Swimlane
435435

436-
Select a swimlane by clicking (tapping) the header of the swimlane. Also, it can be selected at runtime by using the [Select](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.SfDiagramComponent.html#Syncfusion_Blazor_Diagram_SfDiagramComponent_Select_System_Collections_ObjectModel_ObservableCollection_Syncfusion_Blazor_Diagram_IDiagramObject__System_Nullable_System_Boolean__) method and clear the selection in the diagram by using the [ClearSelection](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.SfDiagramComponent.html#Syncfusion_Blazor_Diagram_SfDiagramComponent_ClearSelection)
436+
Select a `Swimlane` by clicking (tapping) the header of the swimlane. Also, it can be selected at runtime by using the [Select](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.SfDiagramComponent.html#Syncfusion_Blazor_Diagram_SfDiagramComponent_Select_System_Collections_ObjectModel_ObservableCollection_Syncfusion_Blazor_Diagram_IDiagramObject__System_Nullable_System_Boolean__) method and clear the selection in the diagram by using the [ClearSelection](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Diagram.SfDiagramComponent.html#Syncfusion_Blazor_Diagram_SfDiagramComponent_ClearSelection)
437437

438438
### How to Drag the Swimlane
439439

0 commit comments

Comments
 (0)