TooltipBase

Base class for EventTooltip (Scheduler) and TaskTooltip (Gantt) features. Shows a tooltip next to an event bar in the timeline.

Configs

12

Common

disabledInstancePlugin
listenersEvents

Misc

autoUpdate: Boolean= false

Specify true to have tooltip updated when mouse moves, if you for example want to display date at mouse position.

clientInstancePlugin
localeClassLocalizable
localizableLocalizable

Other

hideDelay: Number= 100

The time (in milliseconds) for which the Tooltip remains visible when the mouse leaves the target.

May be configured as false to persist visible after the mouse exits the target element. Configure it as 0 to always retrigger hoverDelay even when moving mouse inside fromElement

hoverDelay: Number= 250

The amount of time to hover before showing

Properties

16

Common

disabledInstancePlugin

Class hierarchy

isTooltipBase: Boolean= truereadonly
Identifies an object as an instance of TooltipBase class, or subclass thereof.
isTooltipBase: Boolean= truereadonlystatic
Identifies an object as an instance of TooltipBase class, or subclass thereof.
isEventsEvents
isInstancePluginInstancePlugin
isLocalizableLocalizable

Misc

tooltip: Tooltipreadonly

A reference to the tooltip instance, which will have a special eventRecord property that you can use to get data from the contextual event record to which this tooltip is related.

clientInstancePlugin
localeHelperLocalizable
localeManagerLocalizable

Lifecycle

configBase

Other

Functions

28

Configuration

applyDefaultsstaticBase

Events

Lifecycle

destroystaticBase

Misc

doDisableInstancePlugin
initClassstaticBase
isOfTypeNamestaticBase
mixinstaticBase
optionalLstaticLocalizable

Other

LstaticLocalizable
onEvents
relayAllEvents
triggerEvents
unEvents

Events

7

Triggered before a tooltip is shown. Return false to prevent the action.

// Adding a listener using the "on" method
tooltipBase.on('beforeShow', ({ source, source.eventRecord }) => {

});
ParameterTypeDescription
sourceTooltip | Object

The tooltip being shown.

source.eventRecordEventModel

The event record.

Triggered after a tooltip is shown.

// Adding a listener using the "on" method
tooltipBase.on('show', ({ source, source.eventRecord }) => {

});
ParameterTypeDescription
sourceTooltip | Object

The tooltip.

source.eventRecordEventModel

The event record.

catchAllEvents
destroyEvents
disableInstancePlugin
enableInstancePlugin

Event handlers

7

Called before a tooltip is shown. Return false to prevent the action.

new TooltipBase({
    onBeforeShow({ source }) {

    }
});
ParameterTypeDescription
sourceTooltip | Object

The tooltip being shown.

source.eventRecordEventModel

The event record.

Called after a tooltip is shown.

new TooltipBase({
    onShow({ source }) {

    }
});
ParameterTypeDescription
sourceTooltip | Object

The tooltip.

source.eventRecordEventModel

The event record.

onDestroyEvents
onDisableInstancePlugin
onEnableInstancePlugin

Typedefs

1