Group in Angular Diagram component

31 Jan 202524 minutes to read

Create group

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.

Add group when initializing diagram

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.

  • While creating group, its child node need to be declared before the group declaration.
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser'
import { DiagramModule } from '@syncfusion/ej2-angular-diagrams'
import { Component, ViewEncapsulation, OnInit, ViewChild } from '@angular/core';
import { DiagramComponent, Diagram, NodeModel, ShapeStyleModel } from '@syncfusion/ej2-angular-diagrams';

@Component({
  imports: [
    DiagramModule
  ],

  providers: [],
  standalone: true,
  selector: "app-container",
  template: `<ejs-diagram #diagram id="diagram" width="100%" height="600px" [getNodeDefaults] ='getNodeDefaults' [nodes]='nodes' (created)='created($event)'>
    </ejs-diagram>`,
  encapsulation: ViewEncapsulation.None
})
export class AppComponent {
  @ViewChild("diagram")
  public diagram?: DiagramComponent;
  public nodes: NodeModel[] = [
    {
      id: 'rectangle1',
      offsetX: 100,
      offsetY: 100,
      width: 100,
      height: 100,
      style: {
        strokeColor: '#6BA5D7',
        fill: '#6BA5D7',
      },
      annotations: [
        {
          content: 'rectangle1',
        },
      ],
    },
    {
      id: 'rectangle2',
      offsetX: 200,
      offsetY: 200,
      width: 100,
      height: 100,
      style: {
        strokeColor: '#6BA5D7',
        fill: '#6BA5D7',
      },
      annotations: [
        {
          content: 'rectangle2',
        },
      ],
    },
    {
      id: 'group',
      children: ['rectangle1', 'rectangle2'],
    },
  ];
  public getNodeDefaults(node: NodeModel): NodeModel {
    node.height = 100;
    node.width = 100;
    ((node as NodeModel).style as ShapeStyleModel).strokeColor = "White";
    return node;
  }
  public created(args: Object): void {
    (this.diagram as DiagramComponent).select([(this.diagram as DiagramComponent).getObject('group')]);
  }
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

Connectors can be added to a group. To create a group using Nodes and Connectors in the Angular Diagram, refer to the below video link,

The following code illustrates how to add connectors into a group.

import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { DiagramModule } from '@syncfusion/ej2-angular-diagrams'

import { Component, ViewEncapsulation, ViewChild, } from '@angular/core';
import {
  DiagramComponent, NodeModel, ConnectorModel,
} from '@syncfusion/ej2-angular-diagrams';

@Component({
  imports: [
    DiagramModule
  ],

  providers: [],
  standalone: true,
  selector: 'app-container',
  template: `<ejs-diagram #diagram id="diagram" width="1000px" height="700px" [nodes]='nodes' [connectors]="connectors">
    </ejs-diagram>`,
  encapsulation: ViewEncapsulation.None
})

export class AppComponent {
  @ViewChild('diagram')
  public diagram?: DiagramComponent;
  public connectors: ConnectorModel[] = [{
    id: 'connector1', type: 'Orthogonal', sourceID: 'node1', targetID: 'node2'
  },
  ];
  public nodes: NodeModel[] = [{
    id: 'node1', height: 100, width: 100, offsetX: 100, offsetY: 100, annotations: [{ content: 'Node1' }]
  },
  {
    id: 'node2', height: 100, width: 100, offsetX: 300, offsetY: 100, annotations: [{ content: 'Node2' }]
  },
  {
    id: 'group', children: ['node1', 'node2', 'connector1',], style: { strokeWidth: 0 }
  }];
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

Group nodes at runtime

Groups can be dynamically created during runtime in the diagram by invoking the diagram.group method. To initiate this process, first, select the nodes that you intend to include within the group. Subsequently, by utilizing the diagram.group method, the selected nodes will be encapsulated within a newly formed group node.

The following code illustrates how to group at runtime.

import { NgModule } from '@angular/core'
import { BrowserModule } from '@angular/platform-browser'
import { Component, ViewEncapsulation, ViewChild } from '@angular/core';
import { DiagramModule, DiagramComponent, NodeModel } from '@syncfusion/ej2-angular-diagrams';

@Component({
    imports: [
        DiagramModule
    ],

    providers: [],
    standalone: true,
    selector: "app-container",
    template: `<button (click)="group()">group selected nodes</button>
     <ejs-diagram #diagram id="diagram" width="100%" height="900px" [nodes]='nodes' (created)='created($event)'>
    </ejs-diagram>`,
    encapsulation: ViewEncapsulation.None
})
export class AppComponent {
    @ViewChild("diagram")
    public diagram?: DiagramComponent;
    public nodes: NodeModel[] = [
        {
            id: 'node1', height: 100, width: 100, offsetX: 100, offsetY: 100, annotations: [{ content: 'Node1' }]
        },
        {
            id: 'node2', height: 100, width: 100, offsetX: 200, offsetY: 200, annotations: [{ content: 'Node2' }]
        },
        {
            id: 'node3', height: 100, width: 100, offsetX: 300, offsetY: 300, annotations: [{ content: 'Node3' }]
        },
    ];
    public created(args: Object): void {
        (this.diagram as DiagramComponent).selectAll();
    }
    public group(): void {
        // Groups the selected nodes and connectors in the diagram.
        (this.diagram as DiagramComponent).group();
    }
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

UnGroup nodes at runtime

Group node can be unGrouped dynamically, by using the diagram.unGroup method. The following code example shows how to unGroup group node at runtime.

import { Component, ViewEncapsulation, OnInit, ViewChild } from '@angular/core';
import { DiagramComponent, NodeModel, Diagram } from '@syncfusion/ej2-angular-diagrams';
import { DiagramModule } from '@syncfusion/ej2-angular-diagrams';
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';

@Component({
    imports: [
        DiagramModule
    ],

    providers: [],
    standalone: true,
    selector: "app-container",
    template: `<button (click)="unGroup()">unGroup</button>
     <ejs-diagram #diagram id="diagram" width="100%" height="600px" [nodes]='nodes' (created)='created($event)'>
    </ejs-diagram>`,
    encapsulation: ViewEncapsulation.None
})
export class AppComponent {
    @ViewChild("diagram")
    public diagram?: DiagramComponent;
    public nodes: NodeModel[] = [
        {
            id: 'rectangle1',
            offsetX: 100,
            offsetY: 100,
            width: 100,
            height: 100,
            style: {
                strokeColor: '#6BA5D7',
                fill: '#6BA5D7',
            },
            annotations: [
                {
                    content: 'rectangle1',
                },
            ],
        },
        {
            id: 'rectangle2',
            offsetX: 200,
            offsetY: 200,
            width: 100,
            height: 100,
            style: {
                strokeColor: '#6BA5D7',
                fill: '#6BA5D7',
            },
            annotations: [
                {
                    content: 'rectangle2',
                },
            ],
        },
        {
            id: 'group',
            children: ['rectangle1', 'rectangle2'],
        }
    ];
    public created(args: Object): void {
        (this.diagram as DiagramComponent).select([(this.diagram as DiagramComponent).getObject('group')]);
    }
    public unGroup(): void {
        // Ungroups the selected nodes and connectors in the diagram.
        (this.diagram as DiagramComponent).unGroup();
    }
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

Add group node at runtime

A group node can be added at runtime by using the diagram method diagram.add.

The following code illustrates how a group node is added at runtime.

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { Component, ViewEncapsulation, ViewChild } from '@angular/core';
import { DiagramModule, DiagramComponent, NodeModel } from '@syncfusion/ej2-angular-diagrams';

@Component({
    imports: [
        DiagramModule
    ],

    providers: [],
    standalone: true,
    selector: "app-container",
    template: `<ejs-diagram #diagram id="diagram" width="100%" height="580px" [nodes]="nodes" (created)='created($event)'>
            </ejs-diagram>`,
    encapsulation: ViewEncapsulation.None
})
export class AppComponent {
    @ViewChild("diagram")
    public diagram?: DiagramComponent;
    public nodes: NodeModel[] = [
        {
            id: 'rectangle1',
            offsetX: 100,
            offsetY: 100,
            width: 100,
            height: 100,
            style: {
                strokeColor: '#6BA5D7',
                fill: '#6BA5D7',
            },
            annotations: [
                {
                    content: 'rectangle1',
                },
            ],
        },
        {
            id: 'rectangle2',
            offsetX: 200,
            offsetY: 200,
            width: 100,
            height: 100,
            style: {
                strokeColor: '#6BA5D7',
                fill: '#6BA5D7',
            },
            annotations: [
                {
                    content: 'rectangle2',
                },
            ],
        }
    ];
    public group: NodeModel = {
        id: 'group2',
        children: ['rectangle1', 'rectangle2']
    }
    public created(args: Object): void {
        // Add the group into the diagram
        (this.diagram as DiagramComponent).add(this.group as NodeModel);
    }
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

Add collection of group nodes at runtime

  • The collection of group nodes can be dynamically added using addElements method.Each time an element is added to the diagram canvas, the collectionChange event will be triggered.

The following code illustrates how to add group nodes collection at runtime.

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { Component, ViewEncapsulation, OnInit, ViewChild } from '@angular/core';
import { DiagramModule, DiagramComponent, Diagram, NodeModel } from '@syncfusion/ej2-angular-diagrams';

@Component({
    imports: [
        DiagramModule
    ],

    providers: [],
    standalone: true,
    selector: "app-container",
    template: `<ejs-diagram #diagram id="diagram" width="100%" height="580px" (created)='created($event)'>
        </ejs-diagram>`,
    encapsulation: ViewEncapsulation.None
})
export class AppComponent {
    @ViewChild("diagram")
    public diagram?: DiagramComponent;
    public group: NodeModel = [
        { id: "rectangle1", offsetX: 100, offsetY: 100, width: 100, height: 100, annotations: [{ content: 'node1' }] },
        { id: "rectangle2", offsetX: 200, offsetY: 200, width: 100, height: 100, annotations: [{ content: 'node2' }] },
        { id: 'group', children: ['rectangle1', 'rectangle2'] },
        { id: "rectangle3", offsetX: 400, offsetY: 400, width: 100, height: 100, annotations: [{ content: 'node1' }] },
        { id: "rectangle4", offsetX: 500, offsetY: 500, width: 100, height: 100, annotations: [{ content: 'node2' }] },
        { id: 'group2', children: ['rectangle3', 'rectangle4'], padding: { left: 10, right: 10, top: 10, bottom: 10 } },
    ] as NodeModel;
    public created(args: Object): void {
        // Add the group collection into the diagram
        (this.diagram as DiagramComponent).addElements(this.group as any);
    }
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

Add/Remove children from group

Add children To group at runtime

A childNode can be added to the specified Group at runtime by utilizing the diagram method diagram.addChildToGroup.

This functionality is achieved by passing the group and existing children as arguments to the method.

The following code illustrates how a child node and a group node can be passed as arguments to the method and executed at runtime.

this.diagram.addChildToGroup(groupNode, childNode);

Remove children from group at runtime

A specific child from a group node can be removed at runtime by utilizing the diagram method diagram.removeChildFromGroup.

This functionality is achieved by passing the group and its children as arguments to the method.

The following code illustrates how a child node is removed from a group at runtime.

this.diagram.removeChildFromGroup (groupNode, childNode);
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { Component, ViewEncapsulation, OnInit, ViewChild } from '@angular/core';
import { DiagramComponent, DiagramModule, NodeModel } from '@syncfusion/ej2-angular-diagrams';

@Component({
    imports: [
        DiagramModule
    ],

    providers: [],
    standalone: true,
    selector: "app-container",
    template: `
    <button (click)="addChild()">addChildToGroup</button>
    <button (click)="removeChild()">removeChildFromGroup</button>
    <ejs-diagram #diagram id="diagram" width="100%" height="600" [nodes]="nodes" >
    </ejs-diagram>`,
    encapsulation: ViewEncapsulation.None
})
export class AppComponent {
    @ViewChild("diagram")
    public diagram?: DiagramComponent;
    public nodes?: NodeModel[];
    ngOnInit(): void {
        this.nodes = [
            {
                id: 'node1', width: 150, height: 100, offsetX: 100, offsetY: 100, annotations: [{ content: 'Node1' }]
            }, {
                id: 'node2', width: 80, height: 130, offsetX: 200, offsetY: 200, annotations: [{ content: 'Node2' }]
            }, {
                id: 'group1', children: ['node1', 'node2']
            }, {
                id: 'node3', width: 100, height: 100, offsetX: 300, offsetY: 300, annotations: [{ content: 'Node3' }]
            }
        ];
    }
    addChild() {
        // Adds the specified diagram object to the specified group node.
        /**
         * parameter 1 - The group node to which the diagram object will be added.
         * parameter 2 - The diagram object to be added to the group.
         */
        (this.diagram as DiagramComponent).addChildToGroup(
            (this.diagram as DiagramComponent).getObject('group1'),
            'node3'
        );
    }
    removeChild() {
        // Removes the specified diagram object from the specified group node.
        /**
         * parameter 1 - The group node from which the diagram object will be removed.
         * parameter 2 - The diagram object to be removed from the group.
         */
        (this.diagram as DiagramComponent).removeChildFromGroup(
            (this.diagram as DiagramComponent).getObject('group1'),
            'node3'
        );
    }
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

Group padding

The Padding property of a group node defines the spacing between the group node’s edges and its children.

The following code illustrates how to add Padding to the node group.

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { Component, ViewEncapsulation, OnInit, ViewChild } from '@angular/core';
import { DiagramComponent, DiagramModule, NodeModel } from '@syncfusion/ej2-angular-diagrams';

@Component({
  imports: [
    DiagramModule
  ],

  providers: [],
  standalone: true,
  selector: "app-container",
  template: `<ejs-diagram #diagram id="diagram" width="100%" height="600px" [nodes]='nodes' (created)='created($event)'>
    </ejs-diagram>`,
  encapsulation: ViewEncapsulation.None
})
export class AppComponent {
  @ViewChild("diagram")
  public diagram?: DiagramComponent;
  public nodes: NodeModel[] = [
    {
      id: 'node1',
      width: 100,
      height: 100,
      offsetX: 100,
      offsetY: 100,
      annotations: [{ content: 'Node1' }],
    },
    {
      id: 'node2',
      width: 100,
      height: 100,
      offsetX: 200,
      offsetY: 200,
      annotations: [{ content: 'Node2' }],
    },
    {
      id: 'node3',
      width: 100,
      height: 100,
      offsetX: 300,
      offsetY: 300,
      annotations: [{ content: 'Node3' }],
    },
    {
      id: 'group',
      children: ['node1', 'node2', 'node3'],
      // Defines the space between the group node edges and its children
      padding: { left: 20, right: 20, top: 20, bottom: 20 },
    }
  ];
  public created(args: Object): void {
    (this.diagram as DiagramComponent).select([(this.diagram as DiagramComponent).getObject('group')]);
  }
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

Group flip

The flip functionality for a group node works similarly to that of normal nodes. However, when flipping a group node, the flip of its child nodes is combined with the group’s flip. This combination ensures that the child nodes inherit the group’s flip while retaining their own individual flips.

Example:

  • If a child node’s flip is set to Vertical and the group node’s flip is set to Horizontal, the resulting flip for the child node will be a combination of Vertical and Horizontal (effectively a “both” flip).
  • This ensures that the child nodes’ orientations adapt dynamically based on the group’s flip while maintaining their unique flip settings.

The following example shows how to apply flip for group node.

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { Component, ViewEncapsulation, OnInit, ViewChild } from '@angular/core';
import { DiagramComponent, DiagramModule, NodeModel, FlipDirection } from '@syncfusion/ej2-angular-diagrams';

@Component({
  imports: [
    DiagramModule
  ],

  providers: [],
  standalone: true,
  selector: "app-container",
  template: `<ejs-diagram #diagram id="diagram" width="100%" height="600px" [nodes]='nodes'>
    </ejs-diagram>`,
  encapsulation: ViewEncapsulation.None
})
export class AppComponent {
  @ViewChild("diagram")
  public diagram?: DiagramComponent;
  public nodes: NodeModel[] = [
    {
      id: 'node1',
      width: 70,
      height: 70,
      offsetX: 100,
      offsetY: 100,
      //Sets the flip as Vertical
      flip: FlipDirection.Vertical,
      shape: {
        type: 'Basic',
        shape: 'RightTriangle',
      },
      style: {
        fill: '#6BA5D7',
      },
    },
    {
      id: 'node2',
      width: 70,
      height: 70,
      offsetX: 180,
      offsetY: 180,
      shape: {
        type: 'Basic',
        shape: 'RightTriangle',
      },
      style: {
        fill: '#6BA5D7',
      },
  
    },
    {
      id: 'group',
      children: ['node1', 'node2',],
      padding: { left: 20, right: 20, top: 20, bottom: 20 },
      //Sets the flip as Horizontal
      flip: FlipDirection.Horizontal,
    }
  ];
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

Group flip mode

The flipMode of a group node also behave similarly to those of normal nodes. However,When you apply a flip mode to a group node, it takes precedence over any flip mode set on its child nodes, overriding their individual settings.

For example, in the below code,
the flipMode for the child node Node1 is set to LabelText.
The flipMode for the group node is set to Label.
As a result, the effective flipMode for both the child node and the group node will be Label, as the group node’s flipMode overrides the child’s.

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { Component, ViewEncapsulation, OnInit, ViewChild } from '@angular/core';
import { DiagramComponent, DiagramModule, NodeModel, FlipDirection } from '@syncfusion/ej2-angular-diagrams';

@Component({
  imports: [
    DiagramModule
  ],

  providers: [],
  standalone: true,
  selector: "app-container",
  template: `<ejs-diagram #diagram id="diagram" width="100%" height="600px" [nodes]='nodes'>
    </ejs-diagram>`,
  encapsulation: ViewEncapsulation.None
})
export class AppComponent {
  @ViewChild("diagram")
  public diagram?: DiagramComponent;
  public nodes: NodeModel[] = [
    {
      id: 'node1',
      width: 70,
      height: 70,
      offsetX: 100,
      offsetY: 100,
      //Sets the flip mode as LabelText
      flipMode: 'LabelText',
      annotations: [{ content: 'Node1', offset: { x: 0, y: 0.8 } }],
      shape: {
        type: 'Basic',
        shape: 'RightTriangle',
      },
      style: {
        fill: '#6BA5D7',
      },
    },
    {
      id: 'node2',
      width: 70,
      height: 70,
      offsetX: 180,
      offsetY: 180,
      shape: {
        type: 'Basic',
        shape: 'RightTriangle',
      },
      style: {
        fill: '#6BA5D7',
      },

    },
    {
      id: 'group',
      children: ['node1', 'node2',],
      padding: { left: 20, right: 20, top: 20, bottom: 20 },
      annotations: [{ content: 'Group', offset: { x: 0, y: 0.8 } }],
      //Sets the flip as Horizontal
      flip: FlipDirection.Horizontal,
      //Sets the flip mode as Label
      flipMode: 'Label',
    }
  ];
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

Nested group

Nested groups are essentially groups within groups, where a group can contain other groups as its children, creating a hierarchy that helps manage complexity and relationships between different elements.

Nested Group GIF

The following code illustrates how to create nested group node.

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { Component, ViewEncapsulation, OnInit, ViewChild } from '@angular/core';
import { DiagramComponent, DiagramModule, NodeModel } from '@syncfusion/ej2-angular-diagrams';

@Component({
imports: [
         DiagramModule
    ],

providers: [ ],
standalone: true,
    selector: "app-container",
    template: `<ejs-diagram #diagram id="diagram" width="100%" height="600px" [nodes]='nodes' (created)='created($event)'>
    </ejs-diagram>`,
    encapsulation: ViewEncapsulation.None
})
export class AppComponent {
    @ViewChild("diagram")
    public diagram?: DiagramComponent;
    public nodes: NodeModel[] = [
      {
        id: 'node1',
        width: 100,
        height: 100,
        offsetX: 100,
        offsetY: 100,
        annotations: [{ content: 'Node1' }],
      },
      {
        id: 'node2',
        width: 100,
        height: 100,
        offsetX: 200,
        offsetY: 200,
        annotations: [{ content: 'Node2' }],
      },
      {
        id: 'node3',
        width: 100,
        height: 100,
        offsetX: 300,
        offsetY: 350,
        annotations: [{ content: 'Node3' }],
      },
      {
        id: 'node4',
        width: 100,
        height: 100,
        offsetX: 500,
        offsetY: 350,
        annotations: [{ content: 'Node4' }],
      },
      {
        id: 'group1',
        children: ['node1', 'node2'],
        padding: { left: 20, right: 20, top: 20, bottom: 20 },
        style: { fill: 'green' },
      },
      {
        id: 'group2',
        children: ['node3', 'node4'],
        padding: { left: 20, right: 20, top: 20, bottom: 20 },
        style: { fill: 'skyblue' },
      },
      // Nested Group
      {
        id: 'group3',
        children: ['group1', 'group2'],
        padding: { left: 20, right: 20, top: 20, bottom: 20 },
        style: { fill: 'yellow' },
      }
    ];
    public created(args: Object): void {
        (this.diagram as DiagramComponent).select([(this.diagram as DiagramComponent).getObject('group3')]);
    }
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

Add Group in palette

Group node can be added in symbol palette like the normal nodes. The following code illustrates how to render group node in palette.

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { Component, ViewEncapsulation, OnInit, ViewChild } from '@angular/core';
import { DiagramModule, SymbolPaletteModule, DiagramComponent, NodeModel, PaletteModel, SymbolPaletteComponent } from '@syncfusion/ej2-angular-diagrams';
import { ExpandMode } from '@syncfusion/ej2-navigations';


@Component({
  imports: [
    DiagramModule, SymbolPaletteModule
  ],

  providers: [],
  standalone: true,
  selector: "app-container",
  template: `<ejs-symbolpalette #symbolpalette id="symbolpalette" [expandMode]="expandMode" width="30%" [palettes]="palettes" >
      </ejs-symbolpalette>
      <ejs-diagram #diagram id="diagram" width="70%" height="645px" [nodes]='nodes' (created)='created($event)'>
      </ejs-diagram>`,
  encapsulation: ViewEncapsulation.None
})
export class AppComponent {
  @ViewChild("diagram")
  public diagram?: DiagramComponent;
  @ViewChild("symbolpalette")
  public symbolPalette?: SymbolPaletteComponent;
  public expandMode: ExpandMode = 'Multiple';
  public nodes: NodeModel[] = [
    {
      offsetX: 250,
      offsetY: 250,
      width: 100,
      height: 100,
      visible: true,
      style: { fill: '#6AA8D7', strokeWidth: 1 },
    }
  ];
  getSymbols(): NodeModel[] {
    let shapes: NodeModel[] = [
      {
        id: 'n1',
        height: 50,
        width: 50,
        offsetX: 50,
        offsetY: 50,
        style: { fill: 'green' },
      },
      {
        id: 'n2',
        height: 50,
        width: 50,
        offsetX: 100,
        offsetY: 100,
        style: { fill: 'yellow' },
      },
      {
        id: 'group1',
        children: ['n1', 'n2'],
        padding: { left: 10, right: 10, top: 10, bottom: 10 },
      },
      {
        id: 'n3',
        height: 50,
        width: 50,
        offsetX: 100,
        offsetY: 100,
        style: { fill: 'pink' },
      },
      {
        id: 'n4',
        height: 50,
        width: 50,
        offsetX: 100,
        offsetY: 170,
        style: { fill: 'orange' },
      },
      {
        id: 'group2',
        children: ['n3', 'n4'],
        padding: { left: 10, right: 10, top: 10, bottom: 10 },
      },
    ];
    return shapes;
  }
  public palettes: PaletteModel[] = [
    {
      id: 'palette1',
      title: 'Basic Shapes',
      symbols: this.getSymbols(),
      expanded: true,
    }
  ]
  public created(args: Object): void {
    (this.diagram as DiagramComponent).fitToPage({ mode: 'Width' });
  }
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

Update group node at runtime

Group can be updated dynamically similar to the normal nodes. The following code illustrates how to update group node at runtime.

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { Component, ViewEncapsulation, OnInit, ViewChild } from '@angular/core';
import { DiagramModule, DiagramComponent, NodeModel } from '@syncfusion/ej2-angular-diagrams';

@Component({
  imports: [
    DiagramModule
  ],

  providers: [],
  standalone: true,
  selector: "app-container",
  template: `<button (click)="updatePadding()">updateGroupPadding</button>
      <button (click)="updateStyle()">updateGroupStyle</button>
      <ejs-diagram #diagram id="diagram" width="100%" height="600px" [nodes]='nodes'>
      </ejs-diagram>`,
  encapsulation: ViewEncapsulation.None
})
export class AppComponent {
  @ViewChild("diagram")
  public diagram?: DiagramComponent;
  public nodes: NodeModel[] = [
    {
      id: 'rectangle1',
      offsetX: 100,
      offsetY: 100,
      width: 100,
      height: 100,
      style: {
        strokeColor: '#6BA5D7',
        fill: '#6BA5D7',
      },
      annotations: [
        {
          content: 'rectangle1',
        },
      ],
    },
    {
      id: 'rectangle2',
      offsetX: 200,
      offsetY: 200,
      width: 100,
      height: 100,
      style: {
        strokeColor: '#6BA5D7',
        fill: '#6BA5D7',
      },
      annotations: [
        {
          content: 'rectangle2',
        },
      ],
    },
    {
      id: 'group',
      children: ['rectangle1', 'rectangle2'],
      style: { strokeColor: 'green' },
    },
  ];
  updatePadding() {
    let group: NodeModel = (this.diagram as DiagramComponent).getObject('group');
    (group.padding = { left: 10, right: 10, top: 10, bottom: 10 }), group.style;
    (this.diagram as DiagramComponent).dataBind();
  }
  updateStyle() {
    let group: NodeModel = (this.diagram as DiagramComponent).getObject('group');
    group.style = { fill: 'green' };
    (this.diagram as DiagramComponent).dataBind();
  }
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

Container

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

  • The canvas panel supports absolute positioning and provides the least layout functionality to its contained diagram elements.

  • Canvas allows you to position its contained elements by using the margin and alignment properties.

  • Rendering alone possible in canvas container.

  • It allows elements to be either vertically or horizontally aligned.

  • Child can be defined with the collection canvas.children property.

  • Basic element can be defined with the collection of basicElements.

Stack

  • Stack panel is used to arrange its children in a single line or stack order, either vertically or horizontally.

  • It controls spacing by setting margin properties of child and padding properties of group. By default, a stack panel’s orientation is vertical.

The following code illustrates how to add a stack panel.

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { Component, ViewEncapsulation, OnInit, ViewChild } from '@angular/core';
import { DiagramModule, DiagramComponent, Diagram, NodeModel, TextElement, StackPanel, PointModel, VerticalAlignment, ShapeStyleModel } from '@syncfusion/ej2-angular-diagrams';

@Component({
    imports: [
        DiagramModule
    ],

    providers: [],
    standalone: true,
    selector: "app-container",
    template: `<ejs-diagram #diagram id="diagram" width="100%" height="580px" [getNodeDefaults] ='getNodeDefaults' [setNodeTemplate]="setNodeTemplate">
        <e-nodes>
            <e-node id='node1' [offsetX]=100 [offsetY]=100>
                <e-node-annotations>
                    <e-node-annotation content="Custom Template" [offset]='offset' [verticalAlignment]='verticalAlignment'>
                </e-node-annotation>
        </e-node-annotations>
            </e-node>
        </e-nodes>
    </ejs-diagram>`,
    encapsulation: ViewEncapsulation.None
})
export class AppComponent {
    @ViewChild("diagram")
    public diagram?: DiagramComponent;
    public offset?: PointModel = { y: 1 };
    public verticalAlignment?: VerticalAlignment = 'Top';

    public getNodeDefaults(node: NodeModel): NodeModel {
        node.height = 100;
        node.width = 100;
        ((node as NodeModel).style as ShapeStyleModel).fill = '#6BA5D7';
        ((node as NodeModel).style as ShapeStyleModel).strokeColor = 'white';
        return node;
    }
    public setNodeTemplate(obj: NodeModel | any, diagram: Diagram): StackPanel | undefined {
        if (obj.id.indexOf('node1') !== -1) {
            let table: StackPanel = new StackPanel();
            table.orientation = 'Horizontal';
            // stack panel - column 1
            let column1: StackPanel = new StackPanel();
            column1.children = [];
            // add coloumn 1 text element
            let textElement1: TextElement = new TextElement();
            textElement1.width = 50;
            textElement1.height = 20;
            textElement1.content = 'Column1';
            column1.children.push(textElement1);
            // row 1
            let row11: TextElement = new TextElement();
            row11.width = 50;
            row11.height = 20;
            row11.content = 'Row1';
            column1.children.push(row11);
            // row 2
            let row12: TextElement = new TextElement();
            row12.width = 50;
            row12.height = 20;
            row12.content = 'Row2';
            column1.children.push(row12);
            //row 3
            let row13: TextElement = new TextElement();
            row13.width = 50;
            row13.height = 20;
            row13.content = 'Row3';
            column1.children.push(row13);
            // row 4
            let row14: TextElement = new TextElement();
            row14.width = 50;
            row14.height = 20;
            row14.content = 'Row4';
            column1.children.push(row14);
            // stack panel - column 2
            let column2: StackPanel = new StackPanel();
            column2.children = [];
            // add coloumn 2 text element
            let textElement2: TextElement = new TextElement();
            textElement2.width = 50;
            textElement2.height = 20;
            textElement2.content = 'Column2';
            column2.children.push(textElement2);
            // row 1
            let row21: TextElement = new TextElement();
            row21.width = 50;
            row21.height = 20;
            row21.content = 'Row1';
            column2.children.push(row21);
            // row 2
            let row22: TextElement = new TextElement();
            row22.width = 50;
            row22.height = 20;
            row22.content = 'Row2';
            column2.children.push(row22);
            // row 3
            let row23: TextElement = new TextElement();
            row23.width = 50;
            row23.height = 20;
            row23.content = 'Row3';
            column2.children.push(row23);
            // row 4
            let row24: TextElement = new TextElement();
            row24.width = 50;
            row24.height = 20;
            row24.content = 'Row4';
            column2.children.push(row24);
            // add both the coloumn stack panel as children of a horizontal stack panel
            table.children = [column1, column2];
            return table;
        }
        return undefined;
    }
}
import { bootstrapApplication } from '@angular/platform-browser';
import { AppComponent } from './app.component';
import 'zone.js';
bootstrapApplication(AppComponent).catch((err) => console.error(err));

Difference between a basic group and containers

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.

Interaction

Group node interactions can be performed similarly to normal nodes. Fundamental diagram interactions like selecting, dragging, resizing, and rotating apply equally to group nodes. For more informatation refer to the nodes interactions

Selecting a Node Group

When a child element within a node group is clicked, the entire contained node group is selected instead of the individual child element. Subsequent clicks on the selected element change the selection from top to bottom within the hierarchy, moving from the parent node group to its children.

Group Interactions GIF

Events

The events triggered when interacting with group nodes are similar to those for individual nodes. For more information, refer to the nodes events

See Also