JavaScript/jQuery Diagram Methods
This section describes members used to manipulate the UI component.
See Also
beginUpdate()
Postpones rendering that can negatively affect performance until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
defaultOptions(rule)
Specifies the device-dependent default configuration properties for this component.
The component's default device properties.
Name | Type | Description |
---|---|---|
device | | |
Device parameters. |
options |
Options to be applied. |
defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the Diagram UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxDiagram.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Diagram properties } });
Angular
import Diagram, { Properties } from "devextreme/ui/diagram"; // ... export class AppComponent { constructor () { Diagram.defaultOptions<Properties>({ device: { deviceType: "desktop" }, options: { // Here go the Diagram properties } }); } }
Vue
<template> <div> <DxDiagram id="diagram1" /> <DxDiagram id="diagram2" /> </div> </template> <script> import DxDiagram from "devextreme-vue/diagram"; import Diagram from "devextreme/ui/diagram"; Diagram.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Diagram properties } }); export default { components: { DxDiagram } } </script>
React
import dxDiagram from "devextreme/ui/diagram"; import Diagram from "devextreme-react/diagram"; dxDiagram.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Diagram properties } }); export default function App() { return ( <div> <Diagram id="diagram1" /> <Diagram id="diagram2" /> </div> ) }
You can also set rules for multiple device types:
jQuery
const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { DevExpress.ui.dxDiagram.defaultOptions({ device: deviceConfig, options: { // Here go the Diagram properties } }); });
Angular
import Diagram, { Properties } from "devextreme/ui/diagram"; // ... export class AppComponent { constructor () { const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { Diagram.defaultOptions<Properties>({ device: deviceConfig, options: { // Here go the Diagram properties } }); }); } }
Vue
<template> <div> <DxDiagram /> </div> </template> <script> import DxDiagram from "devextreme-vue/diagram"; import Diagram from "devextreme/ui/diagram"; const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { Diagram.defaultOptions({ device: deviceConfig, options: { // Here go the Diagram properties } }); }); export default { components: { DxDiagram } } </script>
React
import dxDiagram from "devextreme/ui/diagram"; import Diagram from "devextreme-react/diagram"; const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { dxDiagram.defaultOptions({ device: deviceConfig, options: { // Here go the Diagram properties } }); }); export default function App() { return ( <div> <Diagram /> </div> ) }
dispose()
Disposes of all the resources allocated to the Diagram instance.
jQuery
After calling this method, remove the DOM element associated with the UI component:
$("#myDiagram").dxDiagram("dispose"); $("#myDiagram").remove();
Angular
Use conditional rendering instead of this method:
<dx-diagram ... *ngIf="condition"> </dx-diagram>
Vue
Use conditional rendering instead of this method:
<template> <DxDiagram ... v-if="condition"> </DxDiagram> </template> <script> import DxDiagram from 'devextreme-vue/diagram'; export default { components: { DxDiagram } } </script>
React
Use conditional rendering instead of this method:
import React from 'react'; import Diagram from 'devextreme-react/diagram'; function DxDiagram(props) { if (!props.shouldRender) { return null; } return ( <Diagram ... > </Diagram> ); } class App extends React.Component { render() { return ( <DxDiagram shouldRender="condition" /> ); } } export default App;
element()
Gets the root UI component element.
An HTML element or a jQuery element when you use jQuery.
See Also
endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
export()
Exports the diagram data to a JSON object.
The diagram data in JSON format.
The export method allows you to save information about a diagram's layout, appearance, and the diagram's shape positions.
The component saves the diagram's data in its own text format. The resulting JSON object contains measurements in twips, regardless of the units or viewUnits property values. Do not modify this JSON object because modified data can load incorrectly.
Use the import method to load this data on demand.
exportTo(format, callback)
Exports the diagram to an image format.
The image format.
A function to be executed after a diagram image is prepared and allows you to save the image.
focus()
Sets focus on the UI component.
Items become active and show connectors when the Diagram component is focused.
See Also
getEdgeDataSource()
Returns the DataSource instance.
The DataSource instance.
See Also
getInstance(element)
Gets the instance of a UI component found using its DOM node.
The UI component's instance.
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the Diagram instance found in an element with the myDiagram
ID:
// Modular approach import Diagram from "devextreme/ui/diagram"; ... let element = document.getElementById("myDiagram"); let instance = Diagram.getInstance(element) as Diagram; // Non-modular approach let element = document.getElementById("myDiagram"); let instance = DevExpress.ui.dxDiagram.getInstance(element);
See Also
getItemById(id)
The item identifier.
A dxDiagramItem object descendant (dxDiagramShape or dxDiagramConnector).
When a user pastes or clones several items in a diagram, the control adds the items to the model one by one. For each added item, the requestEditOperation event fires. In the event handler, you can access the processed item. However, if you call the getItemById method to access an attached connector (see the attachedConnectorIds property) or a container's child item (see the containerChildItemIds property), you can get the undefined
result if the item is not added to the model yet.
getItemByKey(key)
The item key.
A dxDiagramItem object descendant (dxDiagramShape or dxDiagramConnector).
An item key specifies the item's identifier in a data source. If a diagram is not bound to a data source, the key value is empty. In this instance, use the GetItemById(id) method to get an item by its internal identifier. An item always has an identifier.
getItems()
Returns an array of diagram items.
An array of items (shapes and connectors).
The code sample below demonstrates how to get the full collection of diagram items and filter the items that are directly connected to the clicked item.
jQuery
$(() => { $('#diagram').dxDiagram({ nodes: { dataSource: new DevExpress.data.ArrayStore({ key: 'ID', data: employees, }), keyExpr: 'ID', textExpr: 'Full_Name', parentKeyExpr: 'Head_ID', }, onItemClick(e) { var itemKey = e.item.key; var connectors = e.component.getItems().filter(function (item) { return item.itemType === "connector" && (item.fromKey === itemKey || item.toKey === itemKey); }); var relativeShapes = []; connectors.forEach(element => { if (element.fromKey === itemKey) relativeShapes.push(e.component.getItemByKey(element.toKey)); // all child shapes if (element.toKey === itemKey) relativeShapes.push(e.component.getItemByKey(element.fromKey)); // all parent shapes }); }, }).dxDiagram('instance'); });
Angular
<dx-diagram #diagram id="diagram" (onItemClick)="itemClickHandler($event)"> <dxo-nodes [dataSource]="dataSource" keyExpr="ID" textExpr="Full_Name" parentKeyExpr="Head_ID" /> </dx-diagram>
// ... itemClickHandler(e) { var itemKey = e.item.key; var connectors = e.component.getItems().filter(function (item) { return item.itemType === "connector" && (item.fromKey === itemKey || item.toKey === itemKey); }); var relativeShapes = []; connectors.forEach(element => { if (element.fromKey === itemKey) relativeShapes.push(e.component.getItemByKey(element.toKey)); // all subsequent shapes if (element.toKey === itemKey) relativeShapes.push(e.component.getItemByKey(element.fromKey)); // all previous shapes }); } // ...
Vue
<template> <DxDiagram id="diagram" ref="diagram" @item-click="onItemClick" > <DxNodes :data-source="dataSource" :key-expr="'ID'" :text-expr="'Full_Name'" :parent-key-expr="'Head_ID'" > <DxAutoLayout :type="'tree'" /> </DxNodes> </DxDiagram> </template> <script> // ... onItemClick(e) { var itemKey = e.item.key; var connectors = e.component.getItems().filter(function (item) { return item.itemType === "connector" && (item.fromKey === itemKey || item.toKey === itemKey); }); var relativeShapes = []; connectors.forEach(element => { if (element.fromKey === itemKey) relativeShapes.push(e.component.getItemByKey(element.toKey)); // all subsequent shapes if (element.toKey === itemKey) relativeShapes.push(e.component.getItemByKey(element.fromKey)); // all previous shapes }); console.log(relativeShapes); }, // ... </script>
React
class App extends React.Component { constructor(props) { // ... onItemClick(e) { var itemKey = e.item.key; var connectors = e.component.getItems().filter(function (item) { return item.itemType === "connector" && (item.fromKey === itemKey || item.toKey === itemKey); }); var relativeShapes = []; connectors.forEach(element => { if (element.fromKey === itemKey) relativeShapes.push(e.component.getItemByKey(element.toKey)); // all subsequent shapes if (element.toKey === itemKey) relativeShapes.push(e.component.getItemByKey(element.fromKey)); // all previous shapes }); }, // ... } render() { return ( <Diagram id="diagram" onItemClick={this.onItemClick}> <Nodes dataSource={this.dataSource} keyExpr="ID" textExpr="Full_Name" parentKeyExpr="Head_ID" /> </Diagram> ); } }
getNodeDataSource()
Gets the DataSource instance.
The DataSource instance.
See Also
getSelectedItems()
Returns an array of selected diagram items.
An array of items (shapes and connectors).
import(data, updateExistingItemsOnly)
Imports the diagram data.
The export method allows you to save information about a diagram's layout, appearance, and shape positions. Use the import method to load this data on demand.
The diagram import updates the bound data source's field values. If the values are not changed, the corresponding events (for instance, onInserted and onUpdated) do not fire.
instance()
Gets the UI component's instance. Use it to access other methods of the UI component.
This UI component's instance.
See Also
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
See Also
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
See Also
on(eventName, eventHandler)
Subscribes to an event.
The object for which this method is called.
Use this method to subscribe to one of the events listed in the Events section.
See Also
on(events)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
The object for which this method is called.
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
option(optionName)
Gets the value of a single property.
The property's name or full path.
This property's value.
See Also
option(options)
Updates the values of several properties.
Options with their new values.
See Also
repaint()
Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.
The repaint()
method re-initializes the component with new settings, resetting its state and history.
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList
resetOption(optionName)
Resets a property to its default value.
A property's name.
See Also
scrollToItem(item)
Scrolls the view area to the specified item.
A diagram item (shape or connector).
setSelectedItems(items)
Selects the specified items.
An array of items to select.