Skip to content
ganttlaneganttlaneganttlane

TooltipOptions

Defined in: dom/src/layers/popover/types.ts:143

The tooltip option.

Type Parameters

Section titled “Type Parameters”

TData

Section titled “TData”

TData = unknown

Type of task.data.

Properties

Section titled “Properties”

delay?

Section titled “delay?”

readonly optional delay?: number

Defined in: dom/src/layers/popover/types.ts:162

Milliseconds a hovered bar waits before its tooltip opens; 0 for none. Default 150.

followCursor?

Section titled “followCursor?”

readonly optional followCursor?: boolean

Defined in: dom/src/layers/popover/types.ts:150

The tooltip follows the cursor and sits above it, instead of sitting on the bar. Default false.

placement?

Section titled “placement?”

readonly optional placement?: TooltipPlacement

Defined in: dom/src/layers/popover/types.ts:164

The side of the bar (or the cursor) the tooltip prefers. Default 'top'.

render?

Section titled “render?”

readonly optional render?: (context) => TooltipContent<TaskTooltipContext<TData>> | null

Defined in: dom/src/layers/popover/types.ts:158

The content, called when the tooltip opens and when its inputs change (another task, new previewed values), never on a mere mouse move. null hides it. Default: the task’s name, dates, progress and working days.

Parameters

Section titled “Parameters”
context
Section titled “context”

TaskTooltipContext<TData>

Returns

Section titled “Returns”

TooltipContent<TaskTooltipContext<TData>> | null

showWhileDragging?

Section titled “showWhileDragging?”

readonly optional showWhileDragging?: boolean

Defined in: dom/src/layers/popover/types.ts:152

Keep the tooltip while a bar is dragged, showing the previewed values. Default true.

trigger?

Section titled “trigger?”

readonly optional trigger?: TooltipTrigger

Defined in: dom/src/layers/popover/types.ts:148

What opens the tooltip. Default 'hover'. 'focus' is planned for when bars are focusable: until then it opens nothing, like 'none'.