Group is used to cluster multiple nodes and connectors into a single element. It acts like a container for its children (nodes, groups, and connectors). Every change made to the group also affects the children. Child elements can be edited individually.
A group can be added to the diagram model through nodes
collection. To define an object as group, add the child objects to the children
collection of the group. The following code illustrates how to create a group node.
padding
property of a group node defines the spacing between the group node’s edges and its children.diagram.group
method.diagram.unGroup
method is used to define whether the group can be ungrouped or not.<template>
<div id="app">
<ejs-diagram id="diagram" :width='width' :height='height' :nodes='nodes' :getNodeDefaults='getNodeDefaults' ></ejs-diagram>
</div>
</template>
<script>
import Vue from 'vue';
import { DiagramPlugin } from '@syncfusion/ej2-vue-diagrams';
Vue.use(DiagramPlugin);
let nodes = [{
id: "rectangle1",
offsetX: 100,
offsetY: 100,
width: 100,
height: 100,
annotations: [{
content: 'rectangle1'
}]
},
{
id: "rectangle2",
offsetX: 200,
offsetY: 200,
width: 100,
height: 100,
annotations: [{
content: 'rectangle2'
}]
},
{
id: "rectangle3",
offsetX: 400,
offsetY: 300,
width: 100,
height: 100,
style: {
fill: 'darkCyan',
strokeWidth: 2
},
annotations: [{
content: 'rectangle2'
}]
}
// Grouping node 1 and node 2 into a single group
{
id: 'group',
children: ['rectangle1', 'rectangle2'],
padding:{left:10,right:10,top:10,bottom:10}
}
]
export default {
name: 'app'
data() {
return {
width: "100%",
height: "350px",
nodes: nodes,
getNodeDefaults: (node) => {
node.height = 100;
node.width = 100;
node.style.fill = '#6BA5D7';
node.style.strokeColor = 'white';
return node;
},
}
}
mounted: function() {
let diagramInstance: Diagram;
let diagramObj: any = document.getElementById("diagram");
diagramInstance = diagramObj.ej2_instances[0];
diagramInstance.selectAll();
// Adding the third node into the existing group
diagramInstance.group();
}
}
</script>
<style>
@import "../../node_modules/@syncfusion/ej2-vue-diagrams/styles/material.css";
</style>
The following code illustrates how a ungroup at runtime.
<template>
<div id="app">
<ejs-diagram id="diagram" :width='width' :height='height' :nodes='nodes' :getNodeDefaults='getNodeDefaults' ></ejs-diagram>
</div>
</template>
<script>
import Vue from 'vue';
import { DiagramPlugin } from '@syncfusion/ej2-vue-diagrams';
Vue.use(DiagramPlugin);
let nodes = [{
id: "rectangle1",
offsetX: 100,
offsetY: 100,
width: 100,
height: 100,
annotations: [{
content: 'rectangle1'
}]
}, {
id: "rectangle2",
offsetX: 200,
offsetY: 200,
width: 100,
height: 100,
annotations: [{
content: 'rectangle2'
}]
},
{
id: 'group',
children: ['rectangle1', 'rectangle2']
},
]
export default {
name: 'app'
data() {
return {
width: "100%",
height: "350px",
nodes: nodes,
getNodeDefaults: (node) => {
node.height = 100;
node.width = 100;
node.style.fill = '#6BA5D7';
node.style.strokeColor = 'white';
return node;
},
}
}
mounted: function() {
let diagramInstance: Diagram;
let diagramObj: any = document.getElementById("diagram");
diagramInstance = diagramObj.ej2_instances[0];
diagramInstance.selectAll();
// Ungroup the selected group into nodes
diagramInstance.unGroup();
}
}
</script>
<style>
@import "../../node_modules/@syncfusion/ej2-vue-diagrams/styles/material.css";
</style>
A group node can be added at runtime by using the client-side method diagram.add
.
The following code illustrates how a group node is added at runtime.
<template>
<div id="app">
<ejs-diagram id="diagram" :width='width' :height='height' :nodes='nodes' :getNodeDefaults='getNodeDefaults'></ejs-diagram>
</div>
</template>
<script>
import Vue from 'vue';
import { DiagramPlugin,NodeModel } from '@syncfusion/ej2-vue-diagrams';
Vue.use(DiagramPlugin);
let nodes = [{
id: "rectangle1",
offsetX: 100,
offsetY: 100,
width: 100,
height: 100,
annotations: [{
content: 'rectangle1'
}]
},
{
id: "rectangle2",
offsetX: 200,
offsetY: 200,
width: 100,
height: 100,
annotations: [{
content: 'rectangle2'
}]
}];
let group: NodeModel = {
id: 'group2',
children: ['rectangle1', 'rectangle2']
};
export default {
name: 'app'
data() {
return {
width: "100%",
height: "350px",
nodes: nodes,
getNodeDefaults: (node) => {
node.height = 100;
node.width = 100;
node.style.fill = '#6BA5D7';
node.style.strokeColor = 'white';
return node;
},
}
}
mounted: function() {
let diagramInstance: Diagram;
let diagramObj: any = document.getElementById("diagram");
diagramInstance = diagramObj.ej2_instances[0];
diagramInstance.selectAll();
// Add the group into the diagram
diagramInstance.add(group);
}
}
</script>
<style>
@import "../../node_modules/@syncfusion/ej2-vue-diagrams/styles/material.css";
</style>
Containers are used to automatically measure and arrange the size and position of the child elements in a predefined manner. There are two types of containers available.
Canvas
canvas.children
property.basicElements
.Stack
orientation
is vertical.The following code illustrates how to add a stack panel.
<template>
<div id="app">
<ejs-diagram id="diagram" :width='width' :height='height' :nodes='nodes' :setNodeTemplate='setNodeTemplate' :getNodeDefaults="getNodeDefaults"></ejs-diagram>
</div>
</template>
<script>
import Vue from 'vue';
import { DiagramPlugin, NodeModel,StackPanel,TextElement } from '@syncfusion/ej2-vue-diagrams';
Vue.use(DiagramPlugin);
let count = 11;
function getTextElement(text: string){
let textElement: TextElement = new TextElement();
textElement.id = "text" + count;
textElement.width = 50;
textElement.height = 20;
textElement.content = text;
count++;
return textElement;
}
function addRows(column: StackPanel){
column.children.push(getTextElement('Row1'));
column.children.push(getTextElement('Row2'));
column.children.push(getTextElement('Row3'));
column.children.push(getTextElement('Row4'));
}
let nodes = [
{
id: 'node5',
width: 100,
height: 100,
offsetX: 100,
offsetY: 100,
style: {
strokeColor: '#6BA5D7',
fill: '#6BA5D7'
},
annotations: [{
content: 'Custom Template',
offset: {
y: 1
},
verticalAlignment: 'Top'
}]
}
]
export default {
name: 'app'
data () {
return {
width: "100%",
height: "350px",
nodes: nodes,
getNodeDefaults: (node: NodeModel) => {
node.height = 100;
node.width = 100;
node.style.fill = '#6BA5D7';
node.style.strokeColor = 'white';
return node;
},
setNodeTemplate: (obj: NodeModel, diagram: Diagram): StackPanel => {
if (obj.id.indexOf('node5') !== -1) {
// It will be replaced with grid panel
let table: StackPanel = new StackPanel();
table.orientation = 'Horizontal';
table.padding.left
let column1: StackPanel = new StackPanel();
column1.children = [];
column1.children.push(getTextElement('Column1'));
addRows(column1);
let column2: StackPanel = new StackPanel();
column2.children = [];
column2.children.push(getTextElement('Column2'));
addRows(column2);
table.children = [column1, column2];
return table;
}
return null;
},
}
}
}
</script>
<style>
@import "../../node_modules/@syncfusion/ej2-vue-diagrams/styles/material.css";
</style>
Group | Container |
---|---|
It arranges the child elements based on the child elements position and size properties. | Each container has a predefined behavior to measure and arrange its child elements. Canvas and stack containers are supported in the diagram. |
The Padding, Min, and Max Size properties are not applicable for basic group. | It is applicable for container. |
The Children’s margin and alignment properties are not applicable for basic group. | It is applicable for container. |
You can edit the group and its children at runtime. For more information about how to interact with a group, refer to Edit Groups
.