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
content()
Gets the widget's content.
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
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 Tooltip widget in an application executed on the desktop.
jQuery
DevExpress.ui.dxTooltip.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Tooltip options } });
Angular
import Tooltip from "devextreme/ui/tooltip"; // ... export class AppComponent { constructor () { Tooltip.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Tooltip options } }); } }
Vue
<template> <div> <dx-tooltip id="tooltip1" /> <dx-tooltip id="tooltip2" /> </div> </template> <script> import DxTooltip from "devextreme-vue/tooltip"; import Tooltip from "devextreme/ui/tooltip"; Tooltip.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Tooltip options } }); export default { components: { DxTooltip } } </script>
React
import React from "react"; import dxTooltip from "devextreme/ui/tooltip"; import Tooltip from "devextreme-react/tooltip"; class App extends React.Component { render () { dxTooltip.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Tooltip options } }) return ( <div> <Tooltip id="tooltip1" /> <Tooltip id="tooltip2" /> </div> ) } } export default App;
dispose()
Disposes of all the resources allocated to the Tooltip instance.
After calling this method, remove the DOM element associated with the widget:
jQuery
$("#myTooltip").dxTooltip("dispose"); $("#myTooltip").remove();
Angular
<dx-tooltip #tooltipVar id="myTooltip"></dx-tooltip>
import { ..., ViewChild } from "@angular/core"; import { DxTooltipComponent } from "devextreme-angular"; // ... export class AppComponent { @ViewChild("tooltipVar", { static: false }) tooltip: DxTooltipComponent; // Prior to Angular 8 // @ViewChild("tooltipVar") tooltip: DxTooltipComponent; removeTooltip (e) { this.tooltip.instance.dispose(); document.getElementById("myTooltip").remove(); } }
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
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 Tooltip instance found in an element with the myTooltip
ID:
// Modular approach import Tooltip from "devextreme/ui/tooltip"; ... let element = document.getElementById("myTooltip"); let instance = Tooltip.getInstance(element) as Tooltip; // Non-modular approach let element = document.getElementById("myTooltip"); let instance = DevExpress.ui.dxTooltip.getInstance(element);
See Also
hide()
Hides the widget.
A Promise that is resolved after the widget is hidden. It is a native Promise or a jQuery.Promise when you use jQuery.
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
repaint()
Recalculates the widget's size and position without rerendering.
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
show()
Shows the widget.
A Promise that is resolved after the widget is shown. It is a native Promise or a jQuery.Promise when you use jQuery.
The widget is automatically hidden after the time specified in the displayTime option.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
show(target)
Shows the widget for a target element.
A Promise that is resolved if the widget is displayed and rejected otherwise. It is a native Promise or a jQuery.Promise when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
toggle(showing)
Shows or hides the widget depending on the argument.
Specifies whether to show or hide the widget.
A Promise that is resolved with true if the widget is shown or false if it is hidden. It is a native Promise or a jQuery.Promise when you use jQuery.
You can use the toggle(showing) method instead of the show() and hide() methods. In this case, pass true or false as the method parameter to show or hide the widget.
The widget is automatically hidden after the time specified in the displayTime option.
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.
We appreciate your feedback.