User handle in Vue Diagram component
16 Mar 202324 minutes to read
- User handles are used to add some frequently used commands around the selector. To create user handles, define and add them to the
userHandlescollection of theselectedItemsproperty. - 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.
Alignment
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.
Offset for user handle
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.
Side
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 for user handle
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.
Appearance
The appearance of the user handle can be customized by using the size, borderColor, backgroundColor, visible, pathData, and pathColor properties of the userHandles.
<template>
<div id="app">
<ejs-diagram id="diagram" :width='width' :height='height' :nodes='nodes' :getCustomTool='getCustomTool' :selectedItems='selectedItems'></ejs-diagram>
</div>
</template>
<script>
import Vue from 'vue';
import { DiagramPlugin,NodeModel ,MoveTool,BasicShapeModel,UserHandleModel,randomId,
SelectorConstraints,cloneObject} from '@syncfusion/ej2-vue-diagrams';
Vue.use(DiagramPlugin);
let diagramInstance: Diagram;
let shape: BasicShapeModel = {
type: 'Basic',
shape: 'Rectangle'
};
function getTool(action: string): ToolBase {
let tool: ToolBase | any;
if (action === "clone") {
tool = new CloneTool(diagramInstance.commandHandler);
}
return tool;
}
class CloneTool extends MoveTool {
public mouseDown(args: MouseEventArgs): void {
let newObject: any;
if (diagramInstance.selectedItems.nodes.length > 0) {
newObject = cloneObject(diagramInstance.selectedItems.nodes[0]) as NodeModel;
} else {
newObject = cloneObject(diagramInstance.selectedItems.connectors[0]) as ConnectorModel;
}
newObject.id += randomId();
diagramInstance.paste([newObject]);
args.source = diagramInstance.nodes[diagramInstance.nodes.length - 1] as IElement;
args.sourceWrapper = args.source.wrapper;
super.mouseDown(args);
this.inAction = true;
}
}
let nodes = [{
id: 'node',
offsetX: 100,
offsetY: 100,
shape: shape
}]
let handles: UserHandleModel[] = [{
name: 'clone',
pathData: 'M60.3,18H27.5c-3,0-5.5,2.4-5.5,5.5v38.2h5.5V23.5h32.7V18z M68.5,28.9h-30c-3, 0-5.5,2.4-5.5,5.5v38.2c0,3,2.4,5.5,5.5,5.5h30c3,0,5.5-2.4,5.5-5.5V34.4C73.9,31.4,71.5,28.9,68.5,28.9z M68.5,72.5h-30V34.4h30V72.5z',
visible: true,
offset: 0,
side: 'Bottom',
margin: {
top: 0,
bottom: 0,
left: 0,
right: 0
}
}];
export default {
name: 'app'
data() {
return {
width: "100%",
height: "350px",
nodes: nodes,
selectedItems: {
constraints: SelectorConstraints.UserHandle,
userHandles: handles
},
getCustomTool: getTool
}
}
mounted: function() {
let obj: any = document.getElementById("diagram");
diagramInstance = obj.ej2_instances[0];
}
}
</script>
<style>
@import "../../node_modules/@syncfusion/ej2-vue-diagrams/styles/material.css";
</style>Fixed user handles
The fixed user handles are used to add some frequently used commands around the node and connector even without selecting it.
Initialization an fixed user handles
To create the fixed user handles, define and add them to the collection of nodes and connectors property. The following code example used to create an fixed user handles for the nodes and connectors.
<template>
<div id="app">
<ejs-diagram id="diagram" :width='width' :height='height' :nodes='nodes' ></ejs-diagram>
</div>
</template>
<script>
import Vue from 'vue';
import { DiagramPlugin } from '@syncfusion/ej2-vue-diagrams';
Vue.use(DiagramPlugin);
let nodes = [{
offsetX: 250,
offsetY: 250,
width: 100,
height: 100,
style: {
fill: '#6BA5D7',
strokeColor: 'white'
},
// A fixed user handle is created and stored in fixed user handle collection of Node.
fixedUserHandles: [{margin: { right: 20 },pathData: 'M60.3,18H27.5c-3,0-5.5,2.4-5.5,5.5v38.2h5.5V23.5h32.7V18z M68.5,28.9h-30c-3,0-5.5,2.4-5.5,5.5v38.2c0,3,2.4,5.5,5.5,5.5h30c3,0,5.5-2.4,5.5-5.5V34.4C73.9,31.4,71.5,28.9,68.5,28.9z M68.5,72.5h-30V34.4h30V72.5z' }]
}]
export default {
name: 'app'
data() {
return {
width: "100%",
height: "350px",
nodes: nodes,
}
}
}
</script>
<style>
@import "../../node_modules/@syncfusion/ej2-vue-diagrams/styles/material.css";
</style>Customization
-
The id property of fixed user handle is used to define the unique identification of the fixed user handle and it is further used to add custom events to the fixed user handle.
-
The fixed user handle can be positioned relative to the node and connector boundaries. It has offset, padding and cornerRadius settings. It is used to position and customize the fixed user handle.
-
The
Paddingis used to leave the space that is inside the fixed user handle between the icon and the border. -
The corner radius allows to create fixed user handles with rounded corners. The radius of the rounded corner is set with the
cornerRadiusproperty.
Note: The PathData needs to be provided to render fixed user handle.
Size
Diagram allows you set size for the fixed user handles by using the width and height property. The default value of the width and height property is 10.
Style
-
You can change the style of the fixed user handles with the specific properties of borderColor, borderWidth, and background color using the handleStrokeColor, handleStrokeWidth, and fill properties, and the icon borderColor, and borderWidth using the iconStrokeColor and iconStrokeWidth.
-
The fixed user handle’s
iconStrokeColorandiconStrokeWidthproperty used to change the stroke color and stroke width of the givenpathData. -
The fixed user handle
handleStrokeColorand,fillproperties are used to define the background color and border color of the userhandle and thehandleStrokeWidthproperty is used to define the border width of the fixed user handle. -
The
visibleproperty of the fixed user handle enables or disables the visibility of fixed user handle.
The following code explains how to customize the appearance of the fixed user handles.
<template>
<div id="app">
<ejs-diagram id="diagram" :width='width' :height='height' :nodes='nodes' :connectors='connectors' ></ejs-diagram>
</div>
</template>
<script>
import Vue from 'vue';
import { DiagramPlugin } from '@syncfusion/ej2-vue-diagrams';
Vue.use(DiagramPlugin);
let nodes = [{
offsetX: 150,
offsetY: 150,
width: 100,
height: 100,
style: {
fill: '#6BA5D7',
strokeColor: 'white'
},
// A fixed user handle is created and stored in fixed user handle collection of Node.
fixedUserHandles: [{offset: { x: 0, y: 0 },margin: { right: 20 }, width: 20, height: 20,
padding:{left:3,right:3,top:3,bottom:3},iconStrokeColor:'white',fill:'black', id: 'user1', pathData: 'M60.3,18H27.5c-3,0-5.5,2.4-5.5,5.5v38.2h5.5V23.5h32.7V18z M68.5,28.9h-30c-3,0-5.5,2.4-5.5,5.5v38.2c0,3,2.4,5.5,5.5,5.5h30c3,0,5.5-2.4,5.5-5.5V34.4C73.9,31.4,71.5,28.9,68.5,28.9z M68.5,72.5h-30V34.4h30V72.5z' }]
}];
let connectors = [{
sourcePoint: {
x: 300,
y: 100
},
targetPoint: {
x: 400,
y: 200
},
type: 'Orthogonal',
style: {
strokeColor: '#6BA5D7'
},
// A fixed user handle is created and stored in fixed user handle collection of Connector.
fixedUserHandles: [{ offset: 0.5, width: 20, alignment: 'Before', height: 20,
padding:{left:3,right:3,top:3,bottom:3},iconStrokeColor:'white',fill:'black', id: 'usercon1', displacement:{x:10,y:10}, pathData: 'M60.3,18H27.5c-3,0-5.5,2.4-5.5,5.5v38.2h5.5V23.5h32.7V18z M68.5,28.9h-30c-3,0-5.5,2.4-5.5,5.5v38.2c0,3,2.4,5.5,5.5,5.5h30c3,0,5.5-2.4,5.5-5.5V34.4C73.9,31.4,71.5,28.9,68.5,28.9z M68.5,72.5h-30V34.4h30V72.5z' }]
}]
export default {
name: 'app'
data() {
return {
width: "100%",
height: "350px",
nodes: nodes,
connectors: connectors
}
}
}
</script>
<style>
@import "../../node_modules/@syncfusion/ej2-vue-diagrams/styles/material.css";
</style>Note: The Fixed user handle id should need to be unique.
Customizing the node fixed user handle
- The node fixed user handle can be aligned relative to the node boundaries. It has
marginandoffsetsettings. It is quite useful to position the node fixed userhandle and used together and gives you more control over the node fixed user handle positioning.
Margin for the node fixed user handle
Margin is an absolute value used to add some blank space in any one of its four sides. The fixed user handle can be displaced with the margin property.
Offset for the node fixed user handle
The offset property of fixed user handle is used to align the user handle based on the x and y points. (0,0) represents the top or left corner and (1,1) represents the bottom or right corner.
The following table shows all the possible alignments visually shows the fixed user handle positions.
| Offset | Margin | Output |
|---|---|---|
| (0,0) | Right = 20 |  |
| (0.5,0) | Bottom = 20 |  |
| (1,0) | Left = 20 |  |
| (0,0.5) | Right = 20 |  |
| (0,1) | Left = 20 |  |
| (0,1) | Right = 20 |  |
| (0.5,1) | Top = 20 |  |
| (1,1) | Left = 20 |  |
The following code explains how to customize the node fixed user handle.
<template>
<div id="app">
<ejs-diagram id="diagram" :width='width' :height='height' :nodes='nodes' ></ejs-diagram>
</div>
</template>
<script>
import Vue from 'vue';
import { DiagramPlugin } from '@syncfusion/ej2-vue-diagrams';
Vue.use(DiagramPlugin);
let nodes = [{
offsetX: 250,
offsetY: 250,
width: 100,
height: 100,
style: {
fill: '#6BA5D7',
strokeColor: 'white'
},
// A fixed user handle is created and stored in fixed user handle collection of Node.
fixedUserHandles: [{offset: { x: 0, y: 0 },margin: { right: 20 }, width: 20, height: 20,
id: 'user1', pathData: 'M60.3,18H27.5c-3,0-5.5,2.4-5.5,5.5v38.2h5.5V23.5h32.7V18z M68.5,28.9h-30c-3,0-5.5,2.4-5.5,5.5v38.2c0,3,2.4,5.5,5.5,5.5h30c3,0,5.5-2.4,5.5-5.5V34.4C73.9,31.4,71.5,28.9,68.5,28.9z M68.5,72.5h-30V34.4h30V72.5z' }]
}]
export default {
name: 'app'
data() {
return {
width: "100%",
height: "350px",
nodes: nodes,
}
}
}
</script>
<style>
@import "../../node_modules/@syncfusion/ej2-vue-diagrams/styles/material.css";
</style>Customizing the connector fixed user handle
-
The connector fixed user handle can be aligned relative to the connector boundaries. It has alignment, displacement and offset settings. It is useful to position the connector fixed userhandle and used together and gives you more control over the connector fixed user handle positioning.
-
The
offsetandalignmentproperties of fixed user handle allows you to align the connector fixed user handles to the segments.
Offset for the connector fixed user handle
The offset property of connector fixed user handle is used to align the user handle based on fractions. 0 represents the connector source point, 1 represents the connector target point, and 0.5 represents the center point of the connector segment.
Alignment
The connector’s fixed user handle can be aligned over its segment path using the alignment property of fixed user handle.
The following table shows all the possible alignments visually shows the fixed user handle positions.
| Offset | Alignment | Output |
|---|---|---|
| 0 | Before |  |
| 0.5 | Center |  |
| 1 | After |  |
Displacement
- The
displacementproperty allows you to specify the space to be left from the connector segment based on the x and y value provided.
The following table shows all the possible alignments visually shows the fixed user handle positions.
| Displacment | Alignment | Output |
|---|---|---|
| x=10 | Before |  |
| x=10 | After |  |
| y=10 | Before |  |
| y=10 | After |  |
Note: Displacement will not be done if the alignment is set to be center.
The following code explains how to customize the connector fixed user handle.
<template>
<div id="app">
<ejs-diagram id="diagram" :width='width' :height='height' :connectors='connectors' ></ejs-diagram>
</div>
</template>
<script>
import Vue from 'vue';
import { DiagramPlugin } from '@syncfusion/ej2-vue-diagrams';
Vue.use(DiagramPlugin);
let connectors = [{
id: "connector1",
style: {
strokeColor: '#6BA5D7',
fill: '#6BA5D7',
strokeWidth: 2
},
targetDecorator: {
style: {
fill: '#6BA5D7',
strokeColor: '#6BA5D7'
}
},
sourcePoint: {
x: 100,
y: 100
},
targetPoint: {
x: 200,
y: 200
},type: 'Orthogonal',// A fixed user handle is created and stored in fixed user handle collection of Connector.
fixedUserHandles: [{ offset: 0.5, width: 20, alignment: 'Before', height: 20, id: 'usercon1', displacement:{x:10,y:10}, pathData: 'M60.3,18H27.5c-3,0-5.5,2.4-5.5,5.5v38.2h5.5V23.5h32.7V18z M68.5,28.9h-30c-3,0-5.5,2.4-5.5,5.5v38.2c0,3,2.4,5.5,5.5,5.5h30c3,0,5.5-2.4,5.5-5.5V34.4C73.9,31.4,71.5,28.9,68.5,28.9z M68.5,72.5h-30V34.4h30V72.5z' }]
}]
export default {
name: 'app'
data() {
return {
width: "100%",
height: "350px",
connectors: connectors
}
}
}
</script>
<style>
@import "../../node_modules/@syncfusion/ej2-vue-diagrams/styles/material.css";
</style>Tooltip support for User Handle
The diagram provides support to show tooltip when the mouse hovers over any user handle.
To show tooltip on mouse over, the tooltip property of diagram model needs to be set with the tooltip content and position as shown in the following example.
<template>
<div id="app">
<ejs-diagram id="diagram" :width='width' :height='height' :nodes='nodes' :constraints='constraints' :selectedItems='selectedItems'></ejs-diagram>
</div>
</template>
<script>
import Vue from 'vue';
import { DiagramPlugin,NodeModel ,MoveTool,BasicShapeModel,UserHandleModel,randomId,NodeConstraints, DiagramConstraints,SelectorConstraints,cloneObject} from '@syncfusion/ej2-vue-diagrams';
Vue.use(DiagramPlugin);
let diagramInstance;
let nodes = [{
id: 'node',
// Position of the node
offsetX: 250,
offsetY: 250,
// Size of the node
width: 100,
height: 100,
style: { fill: '#6BA5D7', strokeColor: 'white' },
tooltip: { content: 'node1', position: 'BottomRight', relativeMode: 'Object' },
constraints: NodeConstraints.Default | NodeConstraints.Tooltip,
}]
let handles = [{
name: 'clone', pathData: 'M60.3,18H27.5c-3,0-5.5,2.4-5.5,5.5v38.2h5.5V23.5h32.7V18z M68.5,28.9h-30c-3,' +
'0-5.5,2.4-5.5,5.5v38.2c0,3,2.4,5.5,5.5,5.5h30c3,0,5.5-2.4,5.5-5.5V34.4C73.9,31.4,71.5,28.9,68.5,28.9z ' +
'M68.5,72.5h-30V34.4h30V72.5z',
visible: true, offset: 0, side: 'Bottom', margin: { top: 0, bottom: 0, left: 0, right: 0 },
tooltip: { content: 'handle1', position: 'BottomRight', relativeMode: 'Object' }
}];
export default {
name: 'app',
data() {
return {
width: "100%",
height: "350px",
nodes: nodes,
constraints: DiagramConstraints.Default | DiagramConstraints.Tooltip,
selectedItems: {
constraints: SelectorConstraints.All,userHandles: handles
}
}
},
}
</script>
<style>
@import "../../node_modules/@syncfusion/ej2-vue-diagrams/styles/material.css";
</style>