Skip to content

Commit a87d794

Browse files
committed
[dev] add missing info to the tooltip article
1 parent ee683f8 commit a87d794

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

data/desktop/tooltips.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,14 +111,18 @@ removes tooltip. As a parameter the method takes:
111111

112112
<h4 id="delayShow">gantt.ext.tooltips.delayShow()</h4>
113113

114-
sets the delay before showing a tooltip. As parameters the method takes:
114+
Shows a tooltip after the delay set by api/gantt_tooltip_timeout_config.md. If the config is not set, a small default delay is used.
115115

116-
- **event** - (*Event*) a native mouse event
117-
- **tooltipText** - (*string*) the text of the tooltip
116+
This method is **debounced**, meaning that repeated calls within the delay window reset the timer and the tooltip is shown only once.
117+
118+
As parameters the method takes:
119+
120+
- **event** - (*Event*) a native mouse event used to position the tooltip
121+
- **tooltipText** - (*string*) the text of the tooltip rendered as innerHTML
118122

119123
<h4 id="delayHide">gantt.ext.tooltips.delayHide()</h4>
120124

121-
sets the delay before hiding a tooltip
125+
Hides the currently displayed tooltip after a delay set by api/gantt_tooltip_hide_timeout_config.md. If the config is not set, a small default delay is used.
122126

123127

124128

0 commit comments

Comments
 (0)