JavaScript/jQuery Tooltip Methods
beginUpdate()
Postpones rendering that can negatively affect performance until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See Also
defaultOptions(rule)
| Name | Type | Description |
|---|---|---|
| device | | |
Device parameters. |
| options |
Options to be applied. |
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, { Properties } from "devextreme/ui/tooltip";
// ...
export class AppComponent {
constructor () {
Tooltip.defaultOptions<Properties>({
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 dxTooltip from "devextreme/ui/tooltip";
import Tooltip from "devextreme-react/tooltip";
dxTooltip.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Tooltip properties
}
});
export default function App() {
return (
<div>
<Tooltip id="tooltip1" />
<Tooltip id="tooltip2" />
</div>
)
}You can also set rules for multiple device types:
jQuery
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
DevExpress.ui.dxTooltip.defaultOptions({
device: deviceConfig,
options: {
// Here go the Tooltip properties
}
});
});Angular
import Tooltip, { Properties } from "devextreme/ui/tooltip";
// ...
export class AppComponent {
constructor () {
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
Tooltip.defaultOptions<Properties>({
device: deviceConfig,
options: {
// Here go the Tooltip properties
}
});
});
}
}Vue
<template>
<div>
<DxTooltip />
</div>
</template>
<script>
import DxTooltip from "devextreme-vue/tooltip";
import Tooltip from "devextreme/ui/tooltip";
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
Tooltip.defaultOptions({
device: deviceConfig,
options: {
// Here go the Tooltip properties
}
});
});
export default {
components: {
DxTooltip
}
}
</script>React
import dxTooltip from "devextreme/ui/tooltip";
import Tooltip from "devextreme-react/tooltip";
const devicesConfig = [
{ deviceType: 'desktop' },
{ deviceType: 'tablet' },
{ deviceType: 'phone' },
];
devicesConfig.forEach(deviceConfig => {
dxTooltip.defaultOptions({
device: deviceConfig,
options: {
// Here go the Tooltip properties
}
});
});
export default function App() {
return (
<div>
<Tooltip />
</div>
)
}dispose()
jQuery
After calling this method, remove the DOM element associated with the UI component:
$("#myTooltip").dxTooltip("dispose");
$("#myTooltip").remove();Angular
Use conditional rendering instead of this method:
<dx-tooltip ...
*ngIf="condition">
</dx-tooltip>Vue
Use conditional rendering instead of this method:
<template>
<DxTooltip ...
v-if="condition">
</DxTooltip>
</template>
<script>
import DxTooltip from 'devextreme-vue/tooltip';
export default {
components: {
DxTooltip
}
}
</script>React
Use conditional rendering instead of this method:
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;endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
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.
on(eventName, eventHandler)
Use this method to subscribe to one of the events listed in the Events section.
See Also
on(events)
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
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.