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

# v1.HeatmapChart

- Package: [@gooddata/sdk-code-schemas](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/index.md)
- Kind: interface
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-code-schemas/src/v1/metadata.ts

**Signature:**

```typescript
export interface HeatmapChart 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [columns?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.heatmapchart/index.md#v1heatmapchartcolumns) |  | [Bucket](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.bucket/index.md)[] | _(Optional)_ A list of columns attributes in this visualisation. |
| [config?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.heatmapchart/index.md#v1heatmapchartconfig) |  | [VisualisationConfig12](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.visualisationconfig12/index.md) | _(Optional)_ |
| [description?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.heatmapchart/index.md#v1heatmapchartdescription) |  | string | _(Optional)_ An optional description of the visualisation. |
| [id](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.heatmapchart/index.md#v1heatmapchartid) |  | [Id33](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.id33/index.md) |  |
| [is\_hidden?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.heatmapchart/index.md#v1heatmapchartis_hidden) |  | boolean | _(Optional)_ |
| [metrics?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.heatmapchart/index.md#v1heatmapchartmetrics) |  | [Bucket](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.bucket/index.md)[] | _(Optional)_ A list of metrics in this visualisation. |
| [query](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.heatmapchart/index.md#v1heatmapchartquery) |  | [Query12](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.query12/index.md) |  |
| [rows?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.heatmapchart/index.md#v1heatmapchartrows) |  | [Bucket](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.bucket/index.md)[] | _(Optional)_ A list of rows attributes in this visualisation. |
| [segment\_by?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.heatmapchart/index.md#v1heatmapchartsegment_by) |  | [Bucket](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.bucket/index.md)[] | _(Optional)_ A list of segment by attributes in this visualisation. |
| [show\_in\_ai\_results?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.heatmapchart/index.md#v1heatmapchartshow_in_ai_results) |  | boolean | _(Optional)_ Optional flag to indicate if the visualisation should be shown in AI results. When omitted, the visualisation is visible. |
| [tags?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.heatmapchart/index.md#v1heatmapcharttags) |  | [Tags26](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.tags26/index.md) | _(Optional)_ |
| [title?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.heatmapchart/index.md#v1heatmapcharttitle) |  | string | _(Optional)_ An optional human readable title for the visualisation. Will be derived from id if not provided explicitly. |
| [type](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.heatmapchart/index.md#v1heatmapcharttype) |  | "heatmap\_chart" | Type of visualisation. |
| [view\_by?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.heatmapchart/index.md#v1heatmapchartview_by) |  | [Bucket](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.bucket/index.md)[] | _(Optional)_ A list of view by attributes in this visualisation. |

## Property details

### v1.HeatmapChart.columns

A list of columns attributes in this visualisation.

**Signature:**

```typescript
columns?: Bucket[];
```

### v1.HeatmapChart.config

**Signature:**

```typescript
config?: VisualisationConfig12;
```

### v1.HeatmapChart.description

An optional description of the visualisation.

**Signature:**

```typescript
description?: string;
```

### v1.HeatmapChart.id

**Signature:**

```typescript
id: Id33;
```

### v1.HeatmapChart.is_hidden

> Warning: This API is now obsolete.
> 
> Deprecated. Use 'show\_in\_ai\_results' instead.
> 

**Signature:**

```typescript
is_hidden?: boolean;
```

### v1.HeatmapChart.metrics

A list of metrics in this visualisation.

**Signature:**

```typescript
metrics?: Bucket[];
```

### v1.HeatmapChart.query

**Signature:**

```typescript
query: Query12;
```

### v1.HeatmapChart.rows

A list of rows attributes in this visualisation.

**Signature:**

```typescript
rows?: Bucket[];
```

### v1.HeatmapChart.segment_by

A list of segment by attributes in this visualisation.

**Signature:**

```typescript
segment_by?: Bucket[];
```

### v1.HeatmapChart.show_in_ai_results

Optional flag to indicate if the visualisation should be shown in AI results. When omitted, the visualisation is visible.

**Signature:**

```typescript
show_in_ai_results?: boolean;
```

### v1.HeatmapChart.tags

**Signature:**

```typescript
tags?: Tags26;
```

### v1.HeatmapChart.title

An optional human readable title for the visualisation. Will be derived from id if not provided explicitly.

**Signature:**

```typescript
title?: string;
```

### v1.HeatmapChart.type

Type of visualisation.

**Signature:**

```typescript
type: "heatmap_chart";
```

### v1.HeatmapChart.view_by

A list of view by attributes in this visualisation.

**Signature:**

```typescript
view_by?: Bucket[];
```