API REFERENCE
getCellTooltipText
Calculates actual tooltip text from the target cell and overflow context.
What does this API do?
Calculates actual tooltip text from the target cell and overflow context.
Exact input and result types
getCellTooltipText(target: { rowIndex: number; field: string; displayedText?: string; isOverflowing?: boolean }): Promise<string>| Arguments | Required | Type |
|---|---|---|
| target | Required | { rowIndex: number; field: string; displayedText?: string; isOverflowing?: boolean } |
The return type is Promise<string>.
Usage flow
After registering and initializing the Grid element, call grid.getCellTooltipText(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.
Feature explanations and examples
- Cell tooltips
Tooltips help users briefly inspect truncated names or long descriptions. Do not hide essential errors or guidance exclusively inside tooltips.