Methods
This section describes methods that can be called to manipulate the TreeMap 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
clearSelection()
Deselects all nodes in the widget.
To deselect a particular node, call its select(state) method.
dispose()
Disposes of all the resources allocated to the TreeMap instance.
After calling this method, remove the DOM element associated with the widget:
jQuery
$("#myTreeMap").dxTreeMap("dispose"); $("#myTreeMap").remove();
Angular
<dx-tree-map #treeMapVar id="myTreeMap"></dx-tree-map>
import { ..., ViewChild } from "@angular/core"; import { DxTreeMapComponent } from "devextreme-angular"; // ... export class AppComponent { @ViewChild("treeMapVar", { static: false }) treeMap: DxTreeMapComponent; // Prior to Angular 8 // @ViewChild("treeMapVar") treeMap: DxTreeMapComponent; removeTreeMap (e) { this.treeMap.instance.dispose(); document.getElementById("myTreeMap").remove(); } }
drillUp()
Drills one level up.
To learn how to implement the drill down functionality, see the drillDown() method description.
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
exportTo(fileName, format)
Exports the widget.
See Also
- DevExpress.viz.exportWidgets(widgetInstances, options)
- export
- print()
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getCurrentNode()
Gets the current node.
The Node object.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getDataSource()
Gets the DataSource instance.
The DataSource instance.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Data Layer - Overview
- Data Layer - DataSource Examples
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 TreeMap instance found in an element with the myTreeMap
ID:
// Modular approach import TreeMap from "devextreme/viz/tree_map"; ... let element = document.getElementById("myTreeMap"); let instance = TreeMap.getInstance(element) as TreeMap; // Non-modular approach let element = document.getElementById("myTreeMap"); let instance = DevExpress.viz.dxTreeMap.getInstance(element);
See Also
getRootNode()
Gets the root node.
The root node; described in the Node section.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getSize()
Gets the current widget size.
Size
The current widget size.
Returns an object with the following fields.
- width
The width of the widget in pixels. - height
The height of the widget in pixels.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
hideLoadingIndicator()
Hides the loading indicator.
Although the loading indicator hides automatically once the widget is ready, you can hide it from code at the required moment using this method.
See Also
- showLoadingIndicator()
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
hideTooltip()
Hides the tooltip.
Use this and showTooltip() methods to change the visibility of the tooltip programmatically.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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
print()
Opens the browser's print window.
See Also
- exportTo(fileName, format)
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
render()
Redraws the widget.
Normally, the widget redraws itself automatically after the browser window is resized. But on rare occasions, you may need to request the redrawing, for example, after the widget's container is resized. For this purpose, call the render() method.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
resetDrillDown()
Resets the drill down level.
Calling this method makes the root level the current one. If you need to drill one level up or down, use the drillUp() method of the widget or the drillDown() method of a node.
See Also
- 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
showLoadingIndicator()
Shows the loading indicator.
See Also
- hideLoadingIndicator()
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
svg()
Gets the widget's SVG markup.
The widget's SVG markup.
See Also
- DevExpress.viz.getMarkup(widgetInstances)
- 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.
We appreciate your feedback.