JavaScript/jQuery Diagram Methods
beginUpdate()
Prevents the UI component from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the UI component from excessive updates when you are changing multiple UI component settings at once. After the beginUpdate() method is called, the UI component does not update its UI until the endUpdate() method is called.
See Also
defaultOptions(rule)
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 from "devextreme/ui/diagram";
// ...
export class AppComponent {
constructor () {
Diagram.defaultOptions({
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 React, {useEffect} from "react";
import dxDiagram from "devextreme/ui/diagram";
import Diagram from "devextreme-react/diagram";
export default function App() {
useEffect(() => {
dxDiagram.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Diagram properties
}
})
});
return (
<div>
<Diagram id="diagram1" />
<Diagram id="diagram2" />
</div>
)
}dispose()
After calling this method, remove the DOM element associated with the UI component:
$("#myDiagram").dxDiagram("dispose");
$("#myDiagram").remove();Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:
Angular
<dx-diagram ...
*ngIf="condition">
</dx-diagram>Vue
<template>
<DxDiagram ...
v-if="condition">
</DxDiagram>
</template>
<script>
import DxDiagram from 'devextreme-vue/diagram';
export default {
components: {
DxDiagram
}
}
</script>React
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;See Also
export()
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)
The export to an image in Internet Explorer (using the exportTo method or the UI) requires the canvg library.
getEdgeDataSource()
Returns the DataSource instance.
See Also
getInstance(element)
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)
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 undefinedresult if the item is not added to the model yet.
getItemByKey(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.
getNodeDataSource()
Gets the DataSource instance.
See Also
import(data, updateExistingItemsOnly)
The export method allows you to save information about a diagram's layout, appearance, and the diagram's shape positions.
Use the import method to load this data on demand.