Your search did not match any results.
Diagram

Background Images

Documentation

The Diagram component provides a collection of built-in shapes. You can extend this collection with custom shapes.

An array of custom shape objects is accessible through the customShapes property. For each custom shape object, you can specify the type, background image, default size, text, connection points, and other settings. Note that shape images should be supplied as SVG files.

This demo shows how to populate the shape collection with custom shape types, and how to use custom shapes in the Diagram.

Backend API
Copy to CodeSandBox
Apply
Reset
import React from 'react'; import Diagram, { CustomShape, ConnectionPoint, Group, Toolbox } from 'devextreme-react/diagram'; import 'whatwg-fetch'; class App extends React.Component { constructor(props) { super(props); this.diagramRef = React.createRef(); } componentDidMount() { var diagram = this.diagramRef.current.instance; fetch('../../../../data/diagram-hardware.json') .then(function(response) { return response.json(); }) .then(function(json) { diagram.import(JSON.stringify(json)); }) .catch(function() { throw 'Data Loading Error'; }); } render() { return ( <Diagram id="diagram" ref={this.diagramRef}> <CustomShape category="hardware" type="internet" title="Internet" backgroundImageUrl="../../../../images/shapes/internet.svg" backgroundImageLeft={0.15} backgroundImageTop={0} backgroundImageWidth={0.7} backgroundImageHeight={0.7} defaultWidth={0.75} defaultHeight={0.75} defaultText="Internet" allowEditText={true} textLeft={0} textTop={0.7} textWidth={1} textHeight={0.3}> <ConnectionPoint x={0.5} y={0} /> <ConnectionPoint x={0.9} y={0.5} /> <ConnectionPoint x={0.5} y={1} /> <ConnectionPoint x={0.1} y={0.5} /> </CustomShape> <CustomShape category="hardware" type="laptop" title="Laptop" backgroundImageUrl="../../../../images/shapes/laptop.svg" backgroundImageLeft={0.15} backgroundImageTop={0} backgroundImageWidth={0.7} backgroundImageHeight={0.7} defaultWidth={0.75} defaultHeight={0.75} defaultText="Laptop" allowEditText={true} textLeft={0} textTop={0.7} textWidth={1} textHeight={0.3}> <ConnectionPoint x={0.5} y={0} /> <ConnectionPoint x={0.9} y={0.5} /> <ConnectionPoint x={0.5} y={1} /> <ConnectionPoint x={0.1} y={0.5} /> </CustomShape> <CustomShape category="hardware" type="mobile" title="Mobile" backgroundImageUrl="../../../../images/shapes/mobile.svg" backgroundImageLeft={0.15} backgroundImageTop={0} backgroundImageWidth={0.7} backgroundImageHeight={0.7} defaultWidth={0.75} defaultHeight={0.75} defaultText="Mobile" allowEditText={true} textLeft={0} textTop={0.7} textWidth={1} textHeight={0.3}> <ConnectionPoint x={0.5} y={0} /> <ConnectionPoint x={0.9} y={0.5} /> <ConnectionPoint x={0.5} y={1} /> <ConnectionPoint x={0.1} y={0.5} /> </CustomShape> <CustomShape category="hardware" type="pc" title="PC" backgroundImageUrl="../../../../images/shapes/pc.svg" backgroundImageLeft={0.15} backgroundImageTop={0} backgroundImageWidth={0.7} backgroundImageHeight={0.7} defaultWidth={0.75} defaultHeight={0.75} defaultText="PC" allowEditText={true} textLeft={0} textTop={0.7} textWidth={1} textHeight={0.3}> <ConnectionPoint x={0.5} y={0} /> <ConnectionPoint x={0.9} y={0.5} /> <ConnectionPoint x={0.5} y={1} /> <ConnectionPoint x={0.1} y={0.5} /> </CustomShape> <CustomShape category="hardware" type="phone" title="Phone" backgroundImageUrl="../../../../images/shapes/phone.svg" backgroundImageLeft={0.15} backgroundImageTop={0} backgroundImageWidth={0.7} backgroundImageHeight={0.7} defaultWidth={0.75} defaultHeight={0.75} defaultText="Phone" allowEditText={true} textLeft={0} textTop={0.7} textWidth={1} textHeight={0.3}> <ConnectionPoint x={0.5} y={0} /> <ConnectionPoint x={0.9} y={0.5} /> <ConnectionPoint x={0.5} y={1} /> <ConnectionPoint x={0.1} y={0.5} /> </CustomShape> <CustomShape category="hardware" type="printer" title="Printer" backgroundImageUrl="../../../../images/shapes/printer.svg" backgroundImageLeft={0.15} backgroundImageTop={0} backgroundImageWidth={0.7} backgroundImageHeight={0.7} defaultWidth={0.75} defaultHeight={0.75} defaultText="Printer" allowEditText={true} textLeft={0} textTop={0.7} textWidth={1} textHeight={0.3}> <ConnectionPoint x={0.5} y={0} /> <ConnectionPoint x={0.9} y={0.5} /> <ConnectionPoint x={0.5} y={1} /> <ConnectionPoint x={0.1} y={0.5} /> </CustomShape> <CustomShape category="hardware" type="router" title="Router" backgroundImageUrl="../../../../images/shapes/router.svg" backgroundImageLeft={0.15} backgroundImageTop={0} backgroundImageWidth={0.7} backgroundImageHeight={0.7} defaultWidth={0.75} defaultHeight={0.75} defaultText="Router" allowEditText={true} textLeft={0} textTop={0.7} textWidth={1} textHeight={0.3}> </CustomShape> <CustomShape category="hardware" type="scaner" title="Scaner" backgroundImageUrl="../../../../images/shapes/scaner.svg" backgroundImageLeft={0.15} backgroundImageTop={0} backgroundImageWidth={0.7} backgroundImageHeight={0.7} defaultWidth={0.75} defaultHeight={0.75} defaultText="Scaner" allowEditText={true} textLeft={0} textTop={0.7} textWidth={1} textHeight={0.3}> <ConnectionPoint x={0.5} y={0} /> <ConnectionPoint x={0.9} y={0.5} /> <ConnectionPoint x={0.5} y={1} /> <ConnectionPoint x={0.1} y={0.5} /> </CustomShape> <CustomShape category="hardware" type="server" title="Server" backgroundImageUrl="../../../../images/shapes/server.svg" backgroundImageLeft={0.15} backgroundImageTop={0} backgroundImageWidth={0.7} backgroundImageHeight={0.7} defaultWidth={0.75} defaultHeight={0.75} defaultText="Server" allowEditText={true} textLeft={0} textTop={0.7} textWidth={1} textHeight={0.3}> <ConnectionPoint x={0.5} y={0} /> <ConnectionPoint x={0.9} y={0.5} /> <ConnectionPoint x={0.5} y={1} /> <ConnectionPoint x={0.1} y={0.5} /> </CustomShape> <CustomShape category="hardware" type="switch" title="Switch" backgroundImageUrl="../../../../images/shapes/switch.svg" backgroundImageLeft={0.15} backgroundImageTop={0} backgroundImageWidth={0.7} backgroundImageHeight={0.7} defaultWidth={0.75} defaultHeight={0.75} defaultText="Switch" allowEditText={true} textLeft={0} textTop={0.7} textWidth={1} textHeight={0.3}> <ConnectionPoint x={0.5} y={0} /> <ConnectionPoint x={0.9} y={0.5} /> <ConnectionPoint x={0.5} y={1} /> <ConnectionPoint x={0.1} y={0.5} /> </CustomShape> <CustomShape category="hardware" type="wifi" title="Wi Fi Router" backgroundImageUrl="../../../../images/shapes/wifi.svg" backgroundImageLeft={0.15} backgroundImageTop={0} backgroundImageWidth={0.7} backgroundImageHeight={0.7} defaultWidth={0.75} defaultHeight={0.75} defaultText="Wi Fi" allowEditText={true} textLeft={0} textTop={0.7} textWidth={1} textHeight={0.3}> <ConnectionPoint x={0.5} y={0} /> <ConnectionPoint x={0.9} y={0.5} /> <ConnectionPoint x={0.5} y={1} /> <ConnectionPoint x={0.1} y={0.5} /> </CustomShape> <Toolbox> <Group category="hardware" title="Hardware" /> </Toolbox> </Diagram> ); } } export default App;
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render( <App />, document.getElementById('app') );
<!DOCTYPE html> <html> <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=1.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/21.1.5/css/dx.common.css" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/21.1.5/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/21.1.5/css/dx-diagram.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.4.1/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.js'); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> </body> </html>
#diagram { height: 900px; }
window.config = { transpiler: 'plugin-babel', meta: { 'devextreme/localization.js': { "esModule": true }, }, paths: { 'npm:': 'https://unpkg.com/' }, defaultExtension: 'js', map: { '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.7.2/prop-types.js', 'whatwg-fetch': 'npm:whatwg-fetch@2.0.4/fetch.js', 'rrule': 'npm:rrule@2.6.6/dist/es5/rrule.js', 'luxon': 'npm:luxon@1.28.0/build/global/luxon.min.js', 'es6-object-assign': 'npm:es6-object-assign@1.1.0', 'devextreme': 'npm:devextreme@21.1.5/cjs', 'devextreme-react': 'npm:devextreme-react@21.1.5', 'jszip': 'npm:jszip@3.7.0/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@1.3.1/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.1.25/dist/dx-diagram.js', 'devexpress-gantt': 'npm:devexpress-gantt@3.0.4/dist/dx-gantt.js', '@devextreme/vdom': 'npm:@devextreme/vdom@1.2.2', 'inferno': 'npm:inferno@7.4.8/dist/inferno.min.js', 'inferno-compat': 'npm:inferno-compat@7.4.8/dist/inferno-compat.min.js', 'inferno-create-element': 'npm:inferno-create-element@7.4.8/dist/inferno-create-element.min.js', 'inferno-dom': 'npm:inferno-dom@1.0.7/dist/inferno-dom.min.js', 'inferno-hydrate': 'npm:inferno-hydrate@7.4.8/dist/inferno-hydrate.min.js', 'inferno-clone-vnode': 'npm:inferno-clone-vnode@7.4.8/dist/inferno-clone-vnode.min.js', 'inferno-create-class': 'npm:inferno-create-class@7.4.8/dist/inferno-create-class.min.js', 'inferno-extras': 'npm:inferno-extras@7.4.8/dist/inferno-extras.min.js', // 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' }, packages: { 'devextreme': { defaultExtension: 'js' }, '@devextreme/vdom': { defaultExtension: 'js' }, 'devextreme-react': { main: 'index.js' }, 'devextreme/events/utils': { main: 'index' }, 'devextreme/events': { main: 'index' }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js' } }, packageConfigPaths: [ "npm:@devextreme/*/package.json", ], babelOptions: { sourceMaps: false, stage0: true, react: true } }; System.config(window.config);
{ "page": { "width": 8391, "height": 11906, "pageColor": "white", "pageWidth": 8391, "pageHeight": 11906, "pageLandscape": false, "gridSize": 180, "showGrid": true, "snapToGrid": true, "units": 1 }, "connectors": [ { "key": "19", "locked": false, "zIndex": 0, "points": [ { "x": 4860, "y": 1620 }, { "x": 4860, "y": 2160 } ], "properties": { "endLineEnding": 0 }, "beginItemKey": "0", "beginConnectionPointIndex": 2, "endItemKey": "1", "endConnectionPointIndex": 0 }, { "key": "20", "locked": false, "zIndex": 0, "points": [ { "x": 4860, "y": 3240 }, { "x": 4860, "y": 5040 }, { "x": 3780, "y": 5040 }, { "x": 2700, "y": 5580 } ], "properties": { "endLineEnding": 0 }, "beginItemKey": "1", "beginConnectionPointIndex": 2, "endItemKey": "2", "endConnectionPointIndex": 0 }, { "key": "21", "locked": false, "zIndex": 0, "points": [ { "x": 4860, "y": 3240 }, { "x": 4860, "y": 5040 }, { "x": 7020, "y": 5040 }, { "x": 7020, "y": 5580 } ], "properties": { "endLineEnding": 0 }, "beginItemKey": "1", "beginConnectionPointIndex": 2, "endItemKey": "3", "endConnectionPointIndex": 0 }, { "key": "22", "locked": false, "zIndex": 0, "points": [ { "x": 2700, "y": 6660 }, { "x": 1980, "y": 7560 } ], "properties": { "endLineEnding": 0 }, "beginItemKey": "2", "beginConnectionPointIndex": 2, "endItemKey": "5", "endConnectionPointIndex": 0 }, { "key": "23", "locked": false, "zIndex": 0, "points": [ { "x": 2700, "y": 6660 }, { "x": 3240, "y": 7560 } ], "properties": { "endLineEnding": 0 }, "beginItemKey": "2", "beginConnectionPointIndex": 2, "endItemKey": "6", "endConnectionPointIndex": 0 }, { "key": "24", "locked": false, "zIndex": 0, "points": [ { "x": 2700, "y": 6660 }, { "x": 720, "y": 7560 } ], "properties": { "endLineEnding": 0 }, "beginItemKey": "2", "beginConnectionPointIndex": 2, "endItemKey": "4", "endConnectionPointIndex": 0 }, { "key": "25", "locked": false, "zIndex": 0, "points": [ { "x": 2700, "y": 6660 }, { "x": 4500, "y": 7560 } ], "properties": { "endLineEnding": 0 }, "beginItemKey": "2", "beginConnectionPointIndex": 2, "endItemKey": "7", "endConnectionPointIndex": 0 }, { "key": "27", "locked": false, "zIndex": 0, "points": [ { "x": 6300, "y": 8640 }, { "x": 6300, "y": 9540 }, { "x": 6012, "y": 9540 } ], "properties": { "endLineEnding": 0 }, "beginItemKey": "9", "beginConnectionPointIndex": 2, "endItemKey": "10", "endConnectionPointIndex": 1 }, { "key": "28", "locked": false, "zIndex": 0, "points": [ { "x": 6300, "y": 8640 }, { "x": 6300, "y": 10980 }, { "x": 6012, "y": 10980 } ], "properties": { "endLineEnding": 0 }, "beginItemKey": "9", "beginConnectionPointIndex": 2, "endItemKey": "11", "endConnectionPointIndex": 1 }, { "key": "29", "locked": false, "zIndex": 0, "points": [ { "x": 7020, "y": 6660 }, { "x": 6300, "y": 7560 } ], "properties": { "endLineEnding": 0 }, "beginItemKey": "3", "beginConnectionPointIndex": 2, "endItemKey": "9", "endConnectionPointIndex": 0 }, { "key": "30", "locked": false, "zIndex": 0, "points": [ { "x": 4320, "y": 2700 }, { "x": 2592, "y": 2700 } ], "properties": { "endLineEnding": 0 }, "beginItemKey": "1", "beginConnectionPointIndex": 3, "endItemKey": "12", "endConnectionPointIndex": 1 }, { "key": "31", "locked": false, "zIndex": 0, "points": [ { "x": 5400, "y": 2700 }, { "x": 7128, "y": 2700 } ], "properties": { "endLineEnding": 0 }, "beginItemKey": "1", "beginConnectionPointIndex": 1, "endItemKey": "13", "endConnectionPointIndex": 3 }, { "key": "32", "locked": false, "zIndex": 0, "points": [ { "x": 2160, "y": 3240 }, { "x": 2160, "y": 3780 } ], "properties": { "endLineEnding": 0 }, "beginItemKey": "12", "beginConnectionPointIndex": 2, "endItemKey": "14", "endConnectionPointIndex": 0 }, { "key": "33", "locked": false, "zIndex": 0, "points": [ { "x": 2160, "y": 3240 }, { "x": 3600, "y": 3780 } ], "properties": { "endLineEnding": 0 }, "beginItemKey": "12", "beginConnectionPointIndex": 2, "endItemKey": "15", "endConnectionPointIndex": 0 }, { "key": "34", "locked": false, "zIndex": 0, "points": [ { "x": 7020, "y": 6660 }, { "x": 7740, "y": 7560 } ], "properties": { "endLineEnding": 0 }, "beginItemKey": "3", "beginConnectionPointIndex": 2, "endItemKey": "16", "endConnectionPointIndex": 0 }, { "key": "35", "locked": false, "zIndex": 0, "points": [ { "x": 7740, "y": 8640 }, { "x": 7740, "y": 9000 } ], "properties": { "lineOption": 0, "endLineEnding": 0 }, "beginItemKey": "16", "beginConnectionPointIndex": 2, "endItemKey": "17", "endConnectionPointIndex": 0 }, { "key": "36", "locked": false, "zIndex": 0, "points": [ { "x": 2160, "y": 3240 }, { "x": 720, "y": 3780 } ], "properties": { "endLineEnding": 0 }, "beginItemKey": "12", "beginConnectionPointIndex": 2, "endItemKey": "18", "endConnectionPointIndex": 0 } ], "shapes": [ { "key": "0", "locked": false, "zIndex": 0, "type": "internet", "text": "Internet", "x": 4320, "y": 540, "width": 1080, "height": 1080 }, { "key": "1", "locked": false, "zIndex": 0, "type": "router", "text": "Router", "x": 4320, "y": 2160, "width": 1080, "height": 1080 }, { "key": "2", "locked": false, "zIndex": 0, "type": "switch", "text": "Switch", "x": 2160, "y": 5580, "width": 1080, "height": 1080 }, { "key": "3", "locked": false, "zIndex": 0, "type": "switch", "text": "Switch", "x": 6480, "y": 5580, "width": 1080, "height": 1080 }, { "key": "4", "locked": false, "zIndex": 0, "type": "pc", "text": "PC", "x": 180, "y": 7560, "width": 1080, "height": 1080 }, { "key": "5", "locked": false, "zIndex": 0, "type": "pc", "text": "PC", "x": 1440, "y": 7560, "width": 1080, "height": 1080 }, { "key": "6", "locked": false, "zIndex": 0, "type": "pc", "text": "PC", "x": 2700, "y": 7560, "width": 1080, "height": 1080 }, { "key": "7", "locked": false, "zIndex": 0, "type": "pc", "text": "PC", "x": 3960, "y": 7560, "width": 1080, "height": 1080 }, { "key": "9", "locked": false, "zIndex": 0, "type": "pc", "text": "PC", "x": 5760, "y": 7560, "width": 1080, "height": 1080 }, { "key": "10", "locked": false, "zIndex": 0, "type": "printer", "text": "Printer", "x": 5040, "y": 9000, "width": 1080, "height": 1080 }, { "key": "11", "locked": false, "zIndex": 0, "type": "scaner", "text": "Scaner", "x": 5040, "y": 10440, "width": 1080, "height": 1080 }, { "key": "12", "locked": false, "zIndex": 0, "type": "wifi", "text": "Wi Fi", "x": 1620, "y": 2160, "width": 1080, "height": 1080 }, { "key": "13", "locked": false, "zIndex": 0, "type": "server", "text": "Server", "x": 7020, "y": 2160, "width": 1080, "height": 1080 }, { "key": "14", "locked": false, "zIndex": 0, "type": "laptop", "text": "Laptop", "x": 1620, "y": 3780, "width": 1080, "height": 1080 }, { "key": "15", "locked": false, "zIndex": 0, "type": "mobile", "text": "Mobile", "x": 3060, "y": 3780, "width": 1080, "height": 1080 }, { "key": "16", "locked": false, "zIndex": 0, "type": "pc", "text": "PC", "x": 7200, "y": 7560, "width": 1080, "height": 1080 }, { "key": "17", "locked": false, "zIndex": 0, "type": "phone", "text": "Phone", "x": 7200, "y": 9000, "width": 1080, "height": 1080 }, { "key": "18", "locked": false, "zIndex": 0, "type": "laptop", "text": "Laptop", "x": 180, "y": 3780, "width": 1080, "height": 1080 } ] }