Create at tooltip instance.
css class that describes tooltip format. Defaults to tooltip-t.
Flag whether we should always recalcuate the tooltip width
Name for analytics events for this tooltip
Debugging aid - set to a unique value for each tooltip instance
Delay in milliseconds for showing the tooltip when the mouse enters the target region
Set if the caller has decided to disable the tooltip by calling Enabled()
Function to be called when the mouse enters the target region
Value to set 'display' attribute to to to hide tooltip
Delay in milliseconds for showing the tooltip when the mouse enters the target region
Function to be called when the mouse leaves the target region
Function to be called when the mouse moves in the target region
the targets who this tooltip is listening to
ID for the timer used to delay appearance of the tooltip
Tooltip background color
div containing the tooltip to be displayed
Tooltip font color
Tooltip font size
Tooltip font type
Height of the tooltip div
Flag whether the tooltip should be shown to the left of the mouse.
Only used by _PlaceTooltipLeftRight
Additional pixels to offset the tooltip from the mouse
Function to place the tooltip
Width of the tooltip div
Whether the leave function should be called when the tooltip is hidden.
Seconds a tooltip should be visible. 0 Specifies that there is no timeout.
Time ID for the visibility timeout
Height of the browser window
Width of the browser window
Mouse enter function applied to the target. The mouse enter function handles calling an enter function, if one was specified, and delaying the display of the tooltip
Mouse leave function applied to the target. The mouse leave function cancels any pending timers, calls the exit function, if one was specified, and hides the tooltip.
Mouse move function applied to the target. The mouse move function calls the move function, if one was specifies, and then moves the tooltip div to keep in near the mouse cursor.
Counter used to generate a unique value for each tooltip
Default delay for showing a tooltip (.5 second)
Set whether to recalculate the tooltip width every time the cursor moves.
Defaults to false
Whether to recalculate the tooltip width every time the cursor moves.
Default Tooltip placement routine. Attempts to make the entire tooltip visibile without covering the mouse.
Display the tooltip div after a delay
milliseconds to delay before showing the tooltip
Hide the tooltip div
Tooltip placement routine to place the tooltip to the left of the mouse. Designed to be used for the chart value tooltip.
Tooltip placement routine to place the tooltip to the right or left of the mouse. Designed to be used for the chart value tooltip.
The placement (left or right of the mouse) is changed if the mouse is in the left or right third of the window. Placement is left alone in the middle third.
Release all tooltip listeners on the target. Failure to release the listeners can prevent the target from being freed.
Set the analytics name for the tooltip. Not currently used.
The analytics name to report when this tooltip is shown or hidden.
Override tooltip background color. The background color is applied to the tooltip div immediately.
Set the CSS class for the tooltip. The class is applied immediately.
The CSS class(es) to apply to this tooltip.
When the mouse enters the target region, instead of instantly showing the tooltip, there's a small delay. This prevents the tooltip from popping up and disappearing if the user is just moving the mouse over the target region instead of waiting for information. By default, the delay is 1 second.
The number of milliseconds to delay showing the tooltip after the mouse enters the target region.
Set the function to be called when the mouse moves into the target DOM object(s)
The function to be called when the mouse moves into the target DOM object. If the tooltip will only be shown if the enterfunc returns true.
Override tooltip font color. The font color is applied to the tooltip div immediately.
Override tooltip font size. The font size is applied to the tooltip div immediately.
Override tooltip font type. The font family is applied to the tooltip div immediately.
HideDisplayValue
The value the CSS 'display' attribute will be set to to hide the tooltip. This defaults to 'none'. 'display' will be set to 'block' when the tooltip is to be visible.
Set the function to be called when the mouse moves off of the target DOM object(s)
The function to be called when the mouse moves off of the target DOM object.
Set the function to be called when the mouse moves while it is on the target DOM object(s)
Override the default offset of the tooltip from the mouse.
Set the target for the tooltip
The selection of DOM objects that should cause the tooltip to appear.
Sets a limit on the time a tooltip is visible.
Seconds the tooltip should be visible
True if the leave function should be called when the timeout occurs.
Generated using TypeDoc
The tooltip class provides a mechanism to display a tooltip, usually in response to the mouse entering some region.