DevExtreme v24.1 is now available.

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

Your search did not match any results.

Vue Diagram - Background Images

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
<template> <DxDiagram id="diagram" ref="diagram" > <DxCustomShape :category="'hardware'" :type="'internet'" :title="'Internet'" :background-image-url="'../../../../images/shapes/internet.svg'" :background-image-left="0.15" :background-image-top="0" :background-image-width="0.7" :background-image-height="0.7" :default-width="0.75" :default-height="0.75" :default-text="'Internet'" :allow-edit-text="true" :text-left="0" :text-top="0.7" :text-width="1" :text-height="0.3" > <DxConnectionPoint :x="0.5" :y="0" /> <DxConnectionPoint :x="0.9" :y="0.5" /> <DxConnectionPoint :x="0.5" :y="1" /> <DxConnectionPoint :x="0.1" :y="0.5" /> </DxCustomShape> <DxCustomShape :category="'hardware'" :type="'laptop'" :title="'Laptop'" :background-image-url="'../../../../images/shapes/laptop.svg'" :background-image-left="0.15" :background-image-top="0" :background-image-width="0.7" :background-image-height="0.7" :default-width="0.75" :default-height="0.75" :default-text="'Laptop'" :allow-edit-text="true" :text-left="0" :text-top="0.7" :text-width="1" :text-height="0.3" > <DxConnectionPoint :x="0.5" :y="0" /> <DxConnectionPoint :x="0.9" :y="0.5" /> <DxConnectionPoint :x="0.5" :y="1" /> <DxConnectionPoint :x="0.1" :y="0.5" /> </DxCustomShape> <DxCustomShape :category="'hardware'" :type="'mobile'" :title="'Mobile'" :background-image-url="'../../../../images/shapes/mobile.svg'" :background-image-left="0.15" :background-image-top="0" :background-image-width="0.7" :background-image-height="0.7" :default-width="0.75" :default-height="0.75" :default-text="'Mobile'" :allow-edit-text="true" :text-left="0" :text-top="0.7" :text-width="1" :text-height="0.3" > <DxConnectionPoint :x="0.5" :y="0" /> <DxConnectionPoint :x="0.9" :y="0.5" /> <DxConnectionPoint :x="0.5" :y="1" /> <DxConnectionPoint :x="0.1" :y="0.5" /> </DxCustomShape> <DxCustomShape :category="'hardware'" :type="'pc'" :title="'PC'" :background-image-url="'../../../../images/shapes/pc.svg'" :background-image-left="0.15" :background-image-top="0" :background-image-width="0.7" :background-image-height="0.7" :default-width="0.75" :default-height="0.75" :default-text="'PC'" :allow-edit-text="true" :text-left="0" :text-top="0.7" :text-width="1" :text-height="0.3" > <DxConnectionPoint :x="0.5" :y="0" /> <DxConnectionPoint :x="0.9" :y="0.5" /> <DxConnectionPoint :x="0.5" :y="1" /> <DxConnectionPoint :x="0.1" :y="0.5" /> </DxCustomShape> <DxCustomShape :category="'hardware'" :type="'phone'" :title="'Phone'" :background-image-url="'../../../../images/shapes/phone.svg'" :background-image-left="0.15" :background-image-top="0" :background-image-width="0.7" :background-image-height="0.7" :default-width="0.75" :default-height="0.75" :default-text="'Phone'" :allow-edit-text="true" :text-left="0" :text-top="0.7" :text-width="1" :text-height="0.3" > <DxConnectionPoint :x="0.5" :y="0" /> <DxConnectionPoint :x="0.9" :y="0.5" /> <DxConnectionPoint :x="0.5" :y="1" /> <DxConnectionPoint :x="0.1" :y="0.5" /> </DxCustomShape> <DxCustomShape :category="'hardware'" :type="'printer'" :title="'Printer'" :background-image-url="'../../../../images/shapes/printer.svg'" :background-image-left="0.15" :background-image-top="0" :background-image-width="0.7" :background-image-height="0.7" :default-width="0.75" :default-height="0.75" :default-text="'Printer'" :allow-edit-text="true" :text-left="0" :text-top="0.7" :text-width="1" :text-height="0.3" > <DxConnectionPoint :x="0.5" :y="0" /> <DxConnectionPoint :x="0.9" :y="0.5" /> <DxConnectionPoint :x="0.5" :y="1" /> <DxConnectionPoint :x="0.1" :y="0.5" /> </DxCustomShape> <DxCustomShape :category="'hardware'" :type="'router'" :title="'Router'" :background-image-url="'../../../../images/shapes/router.svg'" :background-image-left="0.15" :background-image-top="0" :background-image-width="0.7" :background-image-height="0.7" :default-width="0.75" :default-height="0.75" :default-text="'Router'" :allow-edit-text="true" :text-left="0" :text-top="0.7" :text-width="1" :text-height="0.3" /> <DxCustomShape :category="'hardware'" :type="'scaner'" :title="'Scaner'" :background-image-url="'../../../../images/shapes/scaner.svg'" :background-image-left="0.15" :background-image-top="0" :background-image-width="0.7" :background-image-height="0.7" :default-width="0.75" :default-height="0.75" :default-text="'Scaner'" :allow-edit-text="true" :text-left="0" :text-top="0.7" :text-width="1" :text-height="0.3" > <DxConnectionPoint :x="0.5" :y="0" /> <DxConnectionPoint :x="0.9" :y="0.5" /> <DxConnectionPoint :x="0.5" :y="1" /> <DxConnectionPoint :x="0.1" :y="0.5" /> </DxCustomShape> <DxCustomShape :category="'hardware'" :type="'server'" :title="'Server'" :background-image-url="'../../../../images/shapes/server.svg'" :background-image-left="0.15" :background-image-top="0" :background-image-width="0.7" :background-image-height="0.7" :default-width="0.75" :default-height="0.75" :default-text="'Server'" :allow-edit-text="true" :text-left="0" :text-top="0.7" :text-width="1" :text-height="0.3" > <DxConnectionPoint :x="0.5" :y="0" /> <DxConnectionPoint :x="0.9" :y="0.5" /> <DxConnectionPoint :x="0.5" :y="1" /> <DxConnectionPoint :x="0.1" :y="0.5" /> </DxCustomShape> <DxCustomShape :category="'hardware'" :type="'switch'" :title="'Switch'" :background-image-url="'../../../../images/shapes/switch.svg'" :background-image-left="0.15" :background-image-top="0" :background-image-width="0.7" :background-image-height="0.7" :default-width="0.75" :default-height="0.75" :default-text="'Switch'" :allow-edit-text="true" :text-left="0" :text-top="0.7" :text-width="1" :text-height="0.3" > <DxConnectionPoint :x="0.5" :y="0" /> <DxConnectionPoint :x="0.9" :y="0.5" /> <DxConnectionPoint :x="0.5" :y="1" /> <DxConnectionPoint :x="0.1" :y="0.5" /> </DxCustomShape> <DxCustomShape :category="'hardware'" :type="'wifi'" :title="'Wi Fi Router'" :background-image-url="'../../../../images/shapes/wifi.svg'" :background-image-left="0.15" :background-image-top="0" :background-image-width="0.7" :background-image-height="0.7" :default-width="0.75" :default-height="0.75" :default-text="'Wi Fi'" :allow-edit-text="true" :text-left="0" :text-top="0.7" :text-width="1" :text-height="0.3" > <DxConnectionPoint :x="0.5" :y="0" /> <DxConnectionPoint :x="0.9" :y="0.5" /> <DxConnectionPoint :x="0.5" :y="1" /> <DxConnectionPoint :x="0.1" :y="0.5" /> </DxCustomShape> <DxToolbox :visible="true"> <DxGroup :category="'hardware'" :title="'Hardware'" /> </DxToolbox> </DxDiagram> </template> <script setup lang="ts"> import { watch, ref } from 'vue'; import { DxDiagram, DxGroup, DxToolbox, DxCustomShape, DxConnectionPoint, } from 'devextreme-vue/diagram'; import 'whatwg-fetch'; const diagram = ref(); watch( diagram, ({ instance }) => { fetch('../../../../data/diagram-hardware.json') .then((response) => response.json()) .then((json) => { instance.import(JSON.stringify(json)); }) .catch(() => { throw new Error('Data Loading Error'); }); }, ); </script> <style scoped> #diagram { height: 900px; } </style>
window.exports = window.exports || {}; window.config = { transpiler: 'plugin-babel', meta: { '*.vue': { loader: 'vue-loader', }, '*.ts': { loader: 'demo-ts-loader', }, '*.svg': { loader: 'svg-loader', }, 'devextreme/time_zone_utils.js': { 'esModule': true, }, 'devextreme/localization.js': { 'esModule': true, }, 'devextreme/viz/palette.js': { 'esModule': true, }, }, paths: { 'root:': '../../../../', 'npm:': 'https://unpkg.com/', }, map: { 'vue': 'npm:vue@3.2.47/dist/vue.esm-browser.js', 'vue-loader': 'npm:dx-systemjs-vue-browser@1.1.1/index.js', 'demo-ts-loader': 'root:utils/demo-ts-loader.js', 'svg-loader': 'root:utils/svg-loader.js', 'whatwg-fetch': 'npm:whatwg-fetch@2.0.4/fetch.js', 'mitt': 'npm:mitt/dist/mitt.umd.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.6/cjs', 'devextreme-vue': 'npm:devextreme-vue@24.1.6/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.11/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', '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-vue': { main: 'index.js', }, 'devextreme': { defaultExtension: 'js', }, 'devextreme/events/utils': { main: 'index', }, '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, }, }; System.config(window.config);
import { createApp } from 'vue'; import App from './App.vue'; createApp(App).mount('#app');
<!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.6/css/dx-diagram.min.css" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/24.1.6/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" /> <script src="https://unpkg.com/typescript@4.9.5/lib/typescript.js"></script> <script type="module"> import * as vueCompilerSFC from "https://unpkg.com/@vue/compiler-sfc@3.4.16/dist/compiler-sfc.esm-browser.js"; window.vueCompilerSFC = vueCompilerSFC; </script> <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.ts"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"> </div> </div> </body> </html>
{ "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": 9000 }, { "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": 9000 }, { "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 } ] }