Methods

The component's default device options.

Object structure:

device:

Device

|

Array<Device>

|

Function

Device parameters.
When specifying a function, get information about the current device from the argument. Return true if the options should be applied to the device.

options:

Options to be applied.

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

JavaScript

DevExpress.ui.dxTooltip.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the Tooltip options
    }
});

Angular

TypeScript

import Tooltip from "devextreme/ui/tooltip";
// ...
export class AppComponent {
    constructor () {
        Tooltip.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the Tooltip options
            }
        });
    }
}

dispose()

Disposes of all the resources allocated to the Tooltip instance.

The following code disposes of an Tooltip instance that corresponds to the element ID (or reference variable in Angular) and removes the element from the DOM:

jQuery

JavaScript

$("#myTooltip").dxTooltip("dispose");
$("#myTooltip").remove();

Angular

HTML

<dx-tooltip #tooltipVar id="myTooltip"></dx-tooltip>

TypeScript

import { ..., ViewChild } from "@angular/core";
import { DxTooltipComponent } from "devextreme-angular";
// ...
export class AppComponent {
    @ViewChild("tooltipVar") tooltip: DxTooltipComponent;

    removeTooltip (e) {
        this.tooltip.instance.dispose();
        document.getElementById("myTooltip").remove();
    }
}

element()

Gets the root widget element.

Return Value:

Element (jQuery or HTML)

An HTML element or a jQuery element when you use jQuery.

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

Main article: beginUpdate()

getInstance(element)

Gets the instance of a widget found using its DOM node.

Parameters:

element:

DOM Node

|

jQuery

The widget's container.

Return Value:

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);

hide()

Hides the widget.

Return Value:

Promise<void> (jQuery or native)

A Promise that is resolved after the widget is hidden. It is a native Promise or a jQuery.Promise when you use jQuery.

instance()

Gets the widget's instance. Use it to access other methods of the widget.

Return Value:

This widget's instance.

off(eventName)

Detaches all event handlers from a single event.

Parameters:

eventName:

The event's name.

Return Value:

The object for which this method is called.

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:

eventName:

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

The object for which this method is called.

on(eventName, eventHandler)

Subscribes to an event.

Parameters:

eventName:

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

on(events)

Subscribes to events.

Parameters:

events:

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

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.

option()

Gets all widget options.

Return Value:

The widget's options.

option(optionName)

Gets the value of a single option.

Parameters:

optionName:

The option's name or full path.

Return Value: any

This option's value.

option(optionName, optionValue)

Updates the value of a single option.

Parameters:

optionName:

The option's name or full path.

optionValue: any

This option's new value.

option(options)

Updates the values of several options.

Parameters:

options:

Options with their new values.

repaint()

Recalculates the widget's size and position without rerendering.

show()

Shows the widget.

Return Value:

Promise<void> (jQuery or native)

A Promise that is resolved after the widget is shown. It is a native Promise or a jQuery.Promise when you use jQuery.

show(target)

Shows the widget for a target element.

Parameters:

target: