Syncfusion recommends using Blazor Diagram Component which provides better performance than this diagram control. Blazor Diagram Component will be actively developed in the future.
Interaction in Blazor Diagram Component
15 Dec 202210 minutes to read
Selector provides a visual representation of selected elements. It behaves like a container and allows to update the size, position, and rotation angle of the selected elements through interaction and by using program. Single or multiple elements can be selected at a time.
An element can be selected by clicking that element. During single click, all previously selected items are cleared. The following image shows how the selected elements are visually represented.
- While selecting the diagram elements, the following events can be used to do your customization.
- When selecting/unselecting the diagram elements, the SelectionChanged event gets triggered.
Selecting a group
When a child element of any group is clicked, its contained group is selected instead of the child element. With consecutive clicks on the selected element, selection is changed from top to bottom in the hierarchy of parent group to its children.
Multiple elements can be selected with the following ways:
During single click, any existing item in the selection list be cleared, and only the item clicked recently is there in the selection list. To avoid cleaning the old selected item, Ctrl key must be on hold when clicking.
- Selection rectangle/rubber band selection
Clicking and dragging the diagram area allows to create a rectangular region. The elements that are covered under the rectangular region are selected at the end.
Select/Unselect elements using program
The server-side methods Select and ClearSelection help to select or clear the selection of the elements at runtime.
Get the current selected items from the Nodes and Connectors collection of the SelectedItems property of the diagram model.
Select entire elements in diagram programmatically
The server-side method SelectAll used to select all the elements such as nodes/connectors in the diagram. Refer to the following link which shows how to use SelectAll method on the diagram.
- An object can be dragged by clicking and dragging it. When multiple elements are selected, dragging any one of the selected elements move every selected element.
- When you drag the elements in the diagram, the OnPositionChange event gets triggered and to do customization in this event.
- Selector is surrounded by eight thumbs. When dragging these thumbs, selected items can be resized.
- When one corner of the selector is dragged, opposite corner is in a static position.
- When a node is resized, the OnSizeChange event gets triggered.
While dragging and resizing, the objects are snapped towards the nearest objects to make better alignments. For better alignments, refer to
- A rotate handler is placed above the selector. Clicking and dragging the handler in a circular direction lead to rotate the node.
- The node is rotated with reference to the static pivot point.
- Pivot thumb (thumb at the middle of the node) appears while rotating the node to represent the static point.
- Each segment of a selected connector is editable with some specific handles/thumbs.
End point handles
Source and target points of the selected connectors are represented with two handles. Clicking and dragging those handles help you to adjust the source and target points.
- If you drag the connector end points, then the following events can be used to do your customization.
- When you connect connector with ports/node or disconnect from it, the ConnectionChange event gets triggered.
Straight segment editing
- End point of each straight segment is represented by a thumb that enables to edit the segment.
- Any number of new segments can be inserted into a straight line by clicking, when Shift and Ctrl keys are pressed (Ctrl+Shift+Click).
- Straight segments can be removed by clicking the segment end point, when Ctrl and Shift keys are pressed (Ctrl+Shift+Click).
- Orthogonal thumbs allow you to adjust the length of adjacent segments by clicking and dragging it.
- When necessary, some segments are added or removed automatically, when dragging the segment. This is to maintain proper routing of orthogonality between segments.
Drag and drop nodes over other elements
Diagram provides support to drop a node/connector over another node/connector. The OnDrop event is raised to notify that an element is dropped over another one and it is disabled, by default. It can enabled with the constraints property.
- User handles are used to add some frequently used commands around the selector. To create user handles, define and add them to the UserHandles collection of the SelectedItems property.
- The name property of user handle is used to define the name of the user handle and its further used to find the user handle at runtime and do any customization.
User handles can be aligned relative to the node boundaries. It has Margin, Offset, Side, HorizontalAlignment, and VerticalAlignment settings. It is quite tricky when all four alignments are used together but gives more control over alignment.
The Offset property of UserHandles is used to align the user handle based on fractions. 0 represents top/left corner, 1 represents bottom/right corner, and 0.5 represents half of width/height.
The Side property of UserHandles is used to align the user handle by using the Top, Bottom, Left, and Right options.
Horizontal and vertical alignments
The HorizontalAlignment property of UserHandles is used to set how the user handle is horizontally aligned at the position based on the Offset. The VerticalAlignment property is used to set how user handle is vertically aligned at the position.
Margin is an absolute value used to add some blank space in any one of its four sides. The UserHandles can be displaced with the Margin property.
Notification for the mouse button clicked
The diagram component notifies the mouse button clicked. For example, whenever the right mouse button is clicked, the clicked button is notified as right. The mouse click is notified with,
|Left||When the left mouse button is clicked, left is notified|
|Middle||When the mouse wheel is clicked, middle is notified|
|Right||When the right mouse button is clicked, right is notified|
The appearance of the user handle can be customized by using the Size, BorderColor, BackgroundColor, Visible, PathData, and PathColor properties of the UserHandles.
- When a large diagram is loaded, only certain portion of the diagram is visible. The remaining portions are clipped. Clipped portions can be explored by scrolling the scrollbars or panning the diagram.
- Diagram can be zoomed in or out by using Ctrl + mouse wheel.
Diagram provides support to interact with the elements with key gestures. By default, some in-built commands are bound with a relevant set of key combinations.
The following table illustrates those commands with the associated key values.
|Ctrl + A||
||Select all nodes/connectors in the diagram.|
|Ctrl + C||Copy||Copy the diagram selected elements.|
|Ctrl + V||Paste||Pastes the copied elements.|
|Ctrl + X||Cut||Cuts the selected elements.|
|Ctrl + Z||Undo||Reverses the last editing action performed on the diagram.|
|Ctrl + Y||Redo||Restores the last editing action when no other actions have occurred since the last undo on the diagram.|
|Delete||Delete||Deletes the selected elements.|
|Ctrl/Shift + Click on object||Multiple selection (Selector binds all selected nodes/connectors).|
|Ctrl + MouseWheel||Zoom||Zoom (Zoom in/Zoom out the diagram).|
||Starts to edit the label of selected element.|
||Sets the label mode as view and stops editing.|