JavaScript/jQuery Tooltip Methods
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
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 Tooltip UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxTooltip.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Tooltip properties
}
});Angular
import Tooltip from "devextreme/ui/tooltip";
// ...
export class AppComponent {
constructor () {
Tooltip.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Tooltip properties
}
});
}
}Vue
<template>
<div>
<DxTooltip id="tooltip1" />
<DxTooltip 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 properties
}
});
export default {
components: {
DxTooltip
}
}
</script>React
import React, {useEffect} from "react";
import dxTooltip from "devextreme/ui/tooltip";
import Tooltip from "devextreme-react/tooltip";
export default function App() {
useEffect(() => {
dxTooltip.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Tooltip properties
}
})
});
return (
<div>
<Tooltip id="tooltip1" />
<Tooltip id="tooltip2" />
</div>
)
}dispose()
After calling this method, remove the DOM element associated with the UI component:
$("#myTooltip").dxTooltip("dispose");
$("#myTooltip").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-tooltip ...
*ngIf="condition">
</dx-tooltip>Vue
<template>
<DxTooltip ...
v-if="condition">
</DxTooltip>
</template>
<script>
import DxTooltip from 'devextreme-vue/tooltip';
export default {
components: {
DxTooltip
}
}
</script>React
import React from 'react';
import Tooltip from 'devextreme-react/tooltip';
function DxTooltip(props) {
if (!props.shouldRender) {
return null;
}
return (
<Tooltip ... >
</Tooltip>
);
}
class App extends React.Component {
render() {
return (
<DxTooltip shouldRender="condition" />
);
}
}
export default App;See Also
getInstance(element)
getInstance is a static method that the UI component 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()
A Promise that is resolved after the UI component is hidden. It is a native Promise or a jQuery.Promise when you use jQuery.
show()
A Promise that is resolved after the UI component is shown. It is a native Promise or a jQuery.Promise when you use jQuery.
show(target)
A Promise that is resolved if the UI component is displayed and rejected otherwise. It is a native Promise or a jQuery.Promise when you use jQuery.
toggle(showing)
A Promise that is resolved with true if the UI component 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 UI component.
The UI component is automatically hidden after the time specified in the displayTime property.