Vue Diagram Methods
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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 options } });
Angular
import Diagram from "devextreme/ui/diagram"; // ... export class AppComponent { constructor () { Diagram.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Diagram options } }); } }
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 options } }); export default { components: { DxDiagram } } </script>
React
import React from "react"; import dxDiagram from "devextreme/ui/diagram"; import Diagram from "devextreme-react/diagram"; class App extends React.Component { render () { dxDiagram.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Diagram options } }) return ( <div> <Diagram id="diagram1" /> <Diagram id="diagram2" /> </div> ) } } export default App;
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
element()
An HTML element or a jQuery element when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
export()
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.
exportTo(format, callback)
The export to an image in Internet Explorer (using the exportTo method or the UI) requires the canvg library.
focus()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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
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.
instance()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName)
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName, eventHandler)
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(eventName, eventHandler)
Use this method to subscribe to one of the events listed in the Events section.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(events)
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option()
Gets all UI component properties.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName, optionValue)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(options)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
repaint()
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
resetOption(optionName)
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
If you have technical questions, please create a support ticket in the DevExpress Support Center.