Angular Diagram Methods
This section describes members used to manipulate the widget.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
beginUpdate()
Prevents the widget from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget 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)
Specifies the device-dependent default configuration options for this component.
The component's default device options.
defaultOptions is a static method that the widget class supports. The following code demonstrates how to specify default options for all instances of the Diagram widget 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()
Disposes of all the resources allocated to the Diagram instance.
After calling this method, remove the DOM element associated with the widget:
$("#myDiagram").dxDiagram("dispose"); $("#myDiagram").remove();
Use this method only if the widget 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()
Gets the root widget 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 widget 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()
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.
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.
The export to an image in Internet Explorer (using the exportTo method or the UI) requires the canvg library.
focus()
Sets focus on the widget.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getInstance(element)
Gets the instance of a widget found using its DOM node.
The widget's instance.
getInstance is a static method that the widget 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
import(data, updateExistingItemsOnly)
Imports the diagram data.
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()
Gets the widget's instance. Use it to access other methods of the widget.
This widget's instance.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option()
Gets all widget options.
The widget's options.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName)
Gets the value of a single option.
The option's name or full path.
This option's value.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName, optionValue)
Updates the value of a single option.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(options)
Updates the values of several options.
Options with their new values.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
registerKeyHandler(key, handler)
Registers a handler to be executed when a user presses a specific key.
A key.
A handler. Accepts the keydown event as the argument. It is a dxEvent or a jQuery.Event when you use jQuery.
The key argument accepts one of the following values:
- "backspace"
- "tab"
- "enter"
- "escape"
- "pageUp"
- "pageDown"
- "end"
- "home"
- "leftArrow"
- "upArrow"
- "rightArrow"
- "downArrow"
- "del"
- "space"
- "F"
- "A"
- "asterisk"
- "minus"
A custom handler for a key cancels the default handler for this key.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
repaint()
Repaints the widget without reloading data. Call it to update the widget's markup.
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)
Resets an option to its default value.
An option's name.
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.