> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# ICustomTooltipConfig

- Package: [@gooddata/sdk-ui-vis-commons](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-vis-commons/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-vis-commons/src/customTooltip/types.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Custom tooltip configuration.

**Signature:**

```typescript
export interface ICustomTooltipConfig 
```

## Remarks

Allows users to define a custom section in the visualization tooltip using Markdown with metric/attribute references that resolve dynamically per hovered data point.

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [content?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-vis-commons/sdk-ui-vis-commons.icustomtooltipconfig/index.md#icustomtooltipconfigcontent) |  | string | **_(ALPHA)_** _(Optional)_ Markdown content for the custom tooltip section. |
| [enabled?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-vis-commons/sdk-ui-vis-commons.icustomtooltipconfig/index.md#icustomtooltipconfigenabled) |  | boolean | **_(ALPHA)_** _(Optional)_ Whether the custom tooltip is enabled. |
| [placement?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-vis-commons/sdk-ui-vis-commons.icustomtooltipconfig/index.md#icustomtooltipconfigplacement) |  | [CustomTooltipPlacement](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-vis-commons/sdk-ui-vis-commons.customtooltipplacement/index.md) | **_(ALPHA)_** _(Optional)_ Where to place the custom section relative to the default tooltip content. |

## Property details

### ICustomTooltipConfig.content

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Markdown content for the custom tooltip section.

**Signature:**

```typescript
content?: string;
```

#### Remarks

Supports a subset of Markdown:

- Headings: `#` through `####` - Bold (`**text**`), italic (`*text*`) - Unordered lists (`- item`) and ordered lists (`1. item`) — not nested - Images (`![alt](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-vis-commons/sdk-ui-vis-commons.icustomtooltipconfig.content/url)`) — `https:`, `http:`, and `data:image/...` URLs only - Links (`[text](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-vis-commons/sdk-ui-vis-commons.icustomtooltipconfig.content/url)`) — `http(s)` URLs only; rendered as anchors opening in  a new tab. End-users can only reach them when the tooltip stays open long  enough to interact with (accessible/sticky Highcharts tooltips, geo popups). - Horizontal rules (`---`) - Backslash escapes (`\*`, `\_`, `[`, `\!`, etc.) to render a metacharacter  as literal text instead of formatting

Not supported: tables, code blocks, blockquotes, nested lists, raw HTML.

Also accepts metric/attribute references ({metric/id}, {label/id}, {computed\_attribute/id}) that resolve dynamically per hovered data point. Resolved values are automatically backslash-escaped, so data containing markdown metacharacters renders as literal text — no manual escaping is required.

Use display-form identifiers (NOT parent attribute identifiers) inside `{label/id}`; a computed attribute has no labels and is named by its own identifier inside `{computed_attribute/id}`. An attribute id renders correctly for attributes that are already in the chart, but it cannot be fetched as a label for external attributes — and a single such ref causes the secondary tooltip fetch to fail backend-side, dropping every other external ref alongside it.

### ICustomTooltipConfig.enabled

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Whether the custom tooltip is enabled.

**Signature:**

```typescript
enabled?: boolean;
```

### ICustomTooltipConfig.placement

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Where to place the custom section relative to the default tooltip content.

**Signature:**

```typescript
placement?: CustomTooltipPlacement;
```

#### Default Value

"above"
