# getCellTooltipText

Calculates actual tooltip text from the target cell and overflow context.

Canonical: https://grid.syidax.com/docs/methods/getCellTooltipText/

<a id="meaning"></a>

## What does this API do?

Calculates actual tooltip text from the target cell and overflow context.

<a id="contract"></a>

## Exact input and result types

```typescript
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>`.

<a id="usage"></a>

## 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.

<a id="recipes"></a>

## Feature explanations and examples

- [Cell tooltips](https://grid.syidax.com/docs/features/tooltip.md) — Tooltips help users briefly inspect truncated names or long descriptions. Do not hide essential errors or guidance exclusively inside tooltips.