Skip to main content

Tooltip

Defined in: ui.ts:1499

Represents a tooltip.

Constructors

Constructor

new Tooltip(): Tooltip

Returns

Tooltip

Accessors

isVisible

Get Signature

get isVisible(): boolean

Defined in: ui.ts:1529

Returns

boolean


onTooltipClosed

Get Signature

get onTooltipClosed(): Observable<any>

Defined in: ui.ts:1533

Returns

Observable<any>


onTooltipRequest

Get Signature

get onTooltipRequest(): Observable<any>

Defined in: ui.ts:1531

Returns

Observable<any>


onTooltipShown

Get Signature

get onTooltipShown(): Observable<any>

Defined in: ui.ts:1532

Returns

Observable<any>


root

Get Signature

get root(): HTMLElement

Defined in: ui.ts:1525

Returns a tooltip element.

Returns

HTMLElement

Methods

bind()

bind(element, tooltip?, tooltipPosition?): HTMLElement

Defined in: ui.ts:1509

Associated the specified visual element with the corresponding item. Example: https://public.datagrok.ai/js/samples/ui/tooltips/tooltips

Parameters

ParameterType
elementHTMLElement
tooltip?string | (() => string | HTMLElement | null) | null
tooltipPosition?"left" | "top" | "bottom" | "right" | null

Returns

HTMLElement


hide()

hide(): void

Defined in: ui.ts:1502

Hides the tooltip.

Returns

void


show()

show(content, x, y): void

Defined in: ui.ts:1516

Shows the tooltip at the specified position

Parameters

ParameterType
contentstring | HTMLElement
xnumber
ynumber

Returns

void


showRowGroup()

showRowGroup(dataFrame, indexPredicate, x, y): void

Defined in: ui.ts:1520

Parameters

ParameterType
dataFrameDataFrame
indexPredicateIndexPredicate
xnumber
ynumber

Returns

void