DevExtreme v24.1 is now available.

Explore our newest features/capabilities and share your thoughts with us.

Your search did not match any results.

Editing Restrictions

Our Diagram component allows you to restrict edit operations as needed. To prohibit a specific operation, set its corresponding property within the editing property to false.

In this demo, the onRequestEditOperation function implements complex logic to determine whether an operation is allowed. The reason event parameter indicates whether the event is raised by a user action or via a UI update. If a user tries to perform a prohibited action, an error message is displayed.

Backend API
import React, { useCallback, useRef } from 'react'; import Diagram, { CustomShape, Nodes, AutoLayout, ContextToolbox, Toolbox, PropertiesPanel, Group, DiagramTypes, } from 'devextreme-react/diagram'; import notify from 'devextreme/ui/notify'; import ArrayStore from 'devextreme/data/array_store'; import service from './data.ts'; const shapes = ['team', 'employee']; const orgItemsDataSource = new ArrayStore({ key: 'ID', data: service.getOrgItems(), }); function showToast(text: string) { notify({ position: { at: 'top', my: 'top', of: '#diagram', offset: '0 4', }, message: text, type: 'warning', delayTime: 2000, }); } function onRequestLayoutUpdate(e: DiagramTypes.RequestLayoutUpdateEvent) { for (let i = 0; i < e.changes.length; i += 1) { if (e.changes[i].type === 'remove') { e.allowed = true; } else if (e.changes[i].data.ParentID !== undefined && e.changes[i].data.ParentID !== null) { e.allowed = true; } } } function itemStyleExpr(obj: { Type: string; }) { if (obj.Type === 'root') { return { fill: '#ffcfc3' }; } if (obj.Type === 'team') { return { fill: '#b7e3fe' }; } return { fill: '#bbefcb' }; } export default function App() { const diagramRef = useRef(null); const onRequestEditOperation = useCallback((e) => { const diagram = diagramRef.current.instance(); if (e.operation === 'addShape') { if (e.args.shape.type !== 'employee' && e.args.shape.type !== 'team') { if (e.reason !== 'checkUIElementAvailability') { showToast('You can add only a \'Team\' or \'Employee\' shape.'); } e.allowed = false; } } else if (e.operation === 'deleteShape') { if (e.args.shape.type === 'root') { if (e.reason !== 'checkUIElementAvailability') { showToast('You cannot delete the \'Development\' shape.'); } e.allowed = false; } if (e.args.shape.type === 'team') { for (let i = 0; i < e.args.shape.attachedConnectorIds.length; i += 1) { if (diagram.getItemById(e.args.shape.attachedConnectorIds[i]).toId !== e.args.shape.id) { if (e.reason !== 'checkUIElementAvailability') { showToast('You cannot delete a \'Team\' shape that has a child shape.'); } e.allowed = false; break; } } } } else if (e.operation === 'resizeShape') { if (e.args.newSize.width < 1 || e.args.newSize.height < 0.75) { if (e.reason !== 'checkUIElementAvailability') { showToast('The shape size is too small.'); } e.allowed = false; } } else if (e.operation === 'changeConnection') { const shapeType = e.args.newShape && e.args.newShape.type; if (shapeType === 'root' && e.args.connectorPosition === 'end') { if (e.reason !== 'checkUIElementAvailability') { showToast('The \'Development\' shape cannot have an incoming connection.'); } e.allowed = false; } if (shapeType === 'employee' && e.args.connectorPosition === 'start') { e.allowed = false; } } else if (e.operation === 'changeConnectorPoints') { if (e.args.newPoints.length > 2) { if (e.reason !== 'checkUIElementAvailability') { showToast('You cannot add points to a connector.'); } e.allowed = false; } } else if (e.operation === 'beforeChangeShapeText') { if (e.args.shape.type === 'root') { if (e.reason !== 'checkUIElementAvailability') { showToast('You cannot change the \'Development\' shape\'s text.'); } e.allowed = false; } } else if (e.operation === 'changeShapeText') { if (e.args.text === '') { if (e.reason !== 'checkUIElementAvailability') { showToast('A shape text cannot be empty.'); } e.allowed = false; } } else if (e.operation === 'beforeChangeConnectorText') { e.allowed = false; } }, []); return ( <Diagram id="diagram" ref={diagramRef} onRequestEditOperation={onRequestEditOperation} onRequestLayoutUpdate={onRequestLayoutUpdate} > <CustomShape category="items" type="root" baseType="octagon" defaultText="Development" /> <CustomShape category="items" type="team" baseType="ellipse" title="Team" defaultText="Team Name" /> <CustomShape category="items" type="employee" baseType="rectangle" title="Employee" defaultText="Employee Name" /> <Nodes dataSource={orgItemsDataSource} keyExpr="ID" textExpr="Name" typeExpr="Type" parentKeyExpr="ParentID" styleExpr={itemStyleExpr} > <AutoLayout type="tree" /> </Nodes> <ContextToolbox shapeIconsPerRow={2} width={100} shapes={shapes as any}> </ContextToolbox> <Toolbox shapeIconsPerRow={2}> <Group title="Items" shapes={shapes as any} /> </Toolbox> <PropertiesPanel visibility="disabled"> </PropertiesPanel> </Diagram> ); }
import React, { useCallback, useRef } from 'react'; import Diagram, { CustomShape, Nodes, AutoLayout, ContextToolbox, Toolbox, PropertiesPanel, Group, } from 'devextreme-react/diagram'; import notify from 'devextreme/ui/notify'; import ArrayStore from 'devextreme/data/array_store'; import service from './data.js'; const shapes = ['team', 'employee']; const orgItemsDataSource = new ArrayStore({ key: 'ID', data: service.getOrgItems(), }); function showToast(text) { notify({ position: { at: 'top', my: 'top', of: '#diagram', offset: '0 4', }, message: text, type: 'warning', delayTime: 2000, }); } function onRequestLayoutUpdate(e) { for (let i = 0; i < e.changes.length; i += 1) { if (e.changes[i].type === 'remove') { e.allowed = true; } else if (e.changes[i].data.ParentID !== undefined && e.changes[i].data.ParentID !== null) { e.allowed = true; } } } function itemStyleExpr(obj) { if (obj.Type === 'root') { return { fill: '#ffcfc3' }; } if (obj.Type === 'team') { return { fill: '#b7e3fe' }; } return { fill: '#bbefcb' }; } export default function App() { const diagramRef = useRef(null); const onRequestEditOperation = useCallback((e) => { const diagram = diagramRef.current.instance(); if (e.operation === 'addShape') { if (e.args.shape.type !== 'employee' && e.args.shape.type !== 'team') { if (e.reason !== 'checkUIElementAvailability') { showToast("You can add only a 'Team' or 'Employee' shape."); } e.allowed = false; } } else if (e.operation === 'deleteShape') { if (e.args.shape.type === 'root') { if (e.reason !== 'checkUIElementAvailability') { showToast("You cannot delete the 'Development' shape."); } e.allowed = false; } if (e.args.shape.type === 'team') { for (let i = 0; i < e.args.shape.attachedConnectorIds.length; i += 1) { if (diagram.getItemById(e.args.shape.attachedConnectorIds[i]).toId !== e.args.shape.id) { if (e.reason !== 'checkUIElementAvailability') { showToast("You cannot delete a 'Team' shape that has a child shape."); } e.allowed = false; break; } } } } else if (e.operation === 'resizeShape') { if (e.args.newSize.width < 1 || e.args.newSize.height < 0.75) { if (e.reason !== 'checkUIElementAvailability') { showToast('The shape size is too small.'); } e.allowed = false; } } else if (e.operation === 'changeConnection') { const shapeType = e.args.newShape && e.args.newShape.type; if (shapeType === 'root' && e.args.connectorPosition === 'end') { if (e.reason !== 'checkUIElementAvailability') { showToast("The 'Development' shape cannot have an incoming connection."); } e.allowed = false; } if (shapeType === 'employee' && e.args.connectorPosition === 'start') { e.allowed = false; } } else if (e.operation === 'changeConnectorPoints') { if (e.args.newPoints.length > 2) { if (e.reason !== 'checkUIElementAvailability') { showToast('You cannot add points to a connector.'); } e.allowed = false; } } else if (e.operation === 'beforeChangeShapeText') { if (e.args.shape.type === 'root') { if (e.reason !== 'checkUIElementAvailability') { showToast("You cannot change the 'Development' shape's text."); } e.allowed = false; } } else if (e.operation === 'changeShapeText') { if (e.args.text === '') { if (e.reason !== 'checkUIElementAvailability') { showToast('A shape text cannot be empty.'); } e.allowed = false; } } else if (e.operation === 'beforeChangeConnectorText') { e.allowed = false; } }, []); return ( <Diagram id="diagram" ref={diagramRef} onRequestEditOperation={onRequestEditOperation} onRequestLayoutUpdate={onRequestLayoutUpdate} > <CustomShape category="items" type="root" baseType="octagon" defaultText="Development" /> <CustomShape category="items" type="team" baseType="ellipse" title="Team" defaultText="Team Name" /> <CustomShape category="items" type="employee" baseType="rectangle" title="Employee" defaultText="Employee Name" /> <Nodes dataSource={orgItemsDataSource} keyExpr="ID" textExpr="Name" typeExpr="Type" parentKeyExpr="ParentID" styleExpr={itemStyleExpr} > <AutoLayout type="tree" /> </Nodes> <ContextToolbox shapeIconsPerRow={2} width={100} shapes={shapes} ></ContextToolbox> <Toolbox shapeIconsPerRow={2}> <Group title="Items" shapes={shapes} /> </Toolbox> <PropertiesPanel visibility="disabled"></PropertiesPanel> </Diagram> ); }
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.tsx'; ReactDOM.render( <App />, document.getElementById('app'), );
const orgItems = [{ ID: '106', Name: 'Development', Type: 'root', }, { ID: '107', Name: 'WinForms Team', Type: 'team', ParentID: '106', }, { ID: '109', Name: 'Javascript Team', Type: 'team', ParentID: '106', }, { ID: '110', Name: 'ASP.NET Team', Type: 'team', ParentID: '106', }, { ID: '112', Name: 'Ana Trujillo', Type: 'employee', ParentID: '107', }, { ID: '113', Name: 'Antonio Moreno', Type: 'employee', ParentID: '107', }, { ID: '115', Name: 'Christina Berglund', Type: 'employee', ParentID: '109', }, { ID: '116', Name: 'Hanna Moos', Type: 'employee', ParentID: '109', }, { ID: '119', Name: 'Laurence Lebihan', Type: 'employee', ParentID: '110', }, { ID: '122', Name: 'Patricio Simpson', Type: 'employee', ParentID: '110', }, { ID: '123', Name: 'Francisco Chang', Type: 'employee', ParentID: '110', }]; export default { getOrgItems() { return orgItems; }, };
window.exports = window.exports || {}; window.config = { transpiler: 'ts', typescriptOptions: { module: 'system', emitDecoratorMetadata: true, experimentalDecorators: true, jsx: 'react', }, meta: { 'react': { 'esModule': true, }, 'typescript': { 'exports': 'ts', }, 'devextreme/time_zone_utils.js': { 'esModule': true, }, 'devextreme/localization.js': { 'esModule': true, }, 'devextreme/viz/palette.js': { 'esModule': true, }, }, paths: { 'npm:': 'https://unpkg.com/', }, defaultExtension: 'js', map: { 'ts': 'npm:plugin-typescript@4.2.4/lib/plugin.js', 'typescript': 'npm:typescript@4.2.4/lib/typescript.js', 'react': 'npm:react@17.0.2/umd/react.development.js', 'react-dom': 'npm:react-dom@17.0.2/umd/react-dom.development.js', 'prop-types': 'npm:prop-types@15.8.1/prop-types.js', 'rrule': 'npm:rrule@2.6.4/dist/es5/rrule.js', 'luxon': 'npm:luxon@1.28.1/build/global/luxon.min.js', 'es6-object-assign': 'npm:es6-object-assign@1.1.0', 'devextreme': 'npm:devextreme@24.1.3/cjs', 'devextreme-react': 'npm:devextreme-react@24.1.3/cjs', 'jszip': 'npm:jszip@3.10.1/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@1.7.1/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.2.8/dist/dx-diagram.js', 'devexpress-gantt': 'npm:devexpress-gantt@4.1.56/dist/dx-gantt.js', '@devextreme/runtime': 'npm:@devextreme/runtime@3.0.13', 'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js', 'inferno-compat': 'npm:inferno-compat/dist/inferno-compat.min.js', 'inferno-create-element': 'npm:inferno-create-element@7.4.11/dist/inferno-create-element.min.js', 'inferno-dom': 'npm:inferno-dom/dist/inferno-dom.min.js', 'inferno-hydrate': 'npm:inferno-hydrate@7.4.11/dist/inferno-hydrate.min.js', 'inferno-clone-vnode': 'npm:inferno-clone-vnode/dist/inferno-clone-vnode.min.js', 'inferno-create-class': 'npm:inferno-create-class/dist/inferno-create-class.min.js', 'inferno-extras': 'npm:inferno-extras/dist/inferno-extras.min.js', 'devextreme-cldr-data': 'npm:devextreme-cldr-data@1.0.3', // SystemJS plugins 'plugin-babel': 'npm:systemjs-plugin-babel@0.0.25/plugin-babel.js', 'systemjs-babel-build': 'npm:systemjs-plugin-babel@0.0.25/systemjs-babel-browser.js', // Prettier 'prettier/standalone': 'npm:prettier@2.8.8/standalone.js', 'prettier/parser-html': 'npm:prettier@2.8.8/parser-html.js', }, packages: { 'devextreme': { defaultExtension: 'js', }, 'devextreme-react': { main: 'index.js', }, 'devextreme/events/utils': { main: 'index', }, 'devextreme/localization/messages': { format: 'json', defaultExtension: 'json', }, 'devextreme/events': { main: 'index', }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js', }, }, packageConfigPaths: [ 'npm:@devextreme/*/package.json', 'npm:@devextreme/runtime@3.0.13/inferno/package.json', ], babelOptions: { sourceMaps: false, stage0: true, react: true, }, }; System.config(window.config);
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render(<App />, document.getElementById('app'));
const orgItems = [ { ID: '106', Name: 'Development', Type: 'root', }, { ID: '107', Name: 'WinForms Team', Type: 'team', ParentID: '106', }, { ID: '109', Name: 'Javascript Team', Type: 'team', ParentID: '106', }, { ID: '110', Name: 'ASP.NET Team', Type: 'team', ParentID: '106', }, { ID: '112', Name: 'Ana Trujillo', Type: 'employee', ParentID: '107', }, { ID: '113', Name: 'Antonio Moreno', Type: 'employee', ParentID: '107', }, { ID: '115', Name: 'Christina Berglund', Type: 'employee', ParentID: '109', }, { ID: '116', Name: 'Hanna Moos', Type: 'employee', ParentID: '109', }, { ID: '119', Name: 'Laurence Lebihan', Type: 'employee', ParentID: '110', }, { ID: '122', Name: 'Patricio Simpson', Type: 'employee', ParentID: '110', }, { ID: '123', Name: 'Francisco Chang', Type: 'employee', ParentID: '110', }, ]; export default { getOrgItems() { return orgItems; }, };
<!DOCTYPE html> <html lang="en"> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=5.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/24.1.3/css/dx-diagram.min.css" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/24.1.3/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" /> <link rel="stylesheet" type="text/css" href="styles.css" /> <script src="https://unpkg.com/core-js@2.6.12/client/shim.min.js"></script> <script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script> <script type="text/javascript" src="config.js"></script> <script type="text/javascript"> System.import("./index.tsx"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> </body> </html>
#diagram { height: 600px; }