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

# v1.SankeyChart

- 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 SankeyChart 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [config?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.sankeychart/index.md#v1sankeychartconfig) |  | [VisualisationConfig16](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.visualisationconfig16/index.md) | _(Optional)_ |
| [description?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.sankeychart/index.md#v1sankeychartdescription) |  | string | _(Optional)_ An optional description of the visualisation. |
| [from?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.sankeychart/index.md#v1sankeychartfrom) |  | [Bucket3](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.bucket3/index.md) | _(Optional)_ |
| [id](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.sankeychart/index.md#v1sankeychartid) |  | [Id37](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.id37/index.md) |  |
| [is\_hidden?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.sankeychart/index.md#v1sankeychartis_hidden) |  | boolean | _(Optional)_ |
| [metrics?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.sankeychart/index.md#v1sankeychartmetrics) |  | [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.sankeychart/index.md#v1sankeychartquery) |  | [Query16](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.query16/index.md) |  |
| [segment\_by?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.sankeychart/index.md#v1sankeychartsegment_by) |  | unknown[] | _(Optional)_ Not used in this graph type. |
| [show\_in\_ai\_results?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.sankeychart/index.md#v1sankeychartshow_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.sankeychart/index.md#v1sankeycharttags) |  | [Tags30](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.tags30/index.md) | _(Optional)_ |
| [title?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.sankeychart/index.md#v1sankeycharttitle) |  | string | _(Optional)_ An optional human readable title for the visualisation. Will be derived from id if not provided explicitly. |
| [to?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.sankeychart/index.md#v1sankeychartto) |  | [Bucket4](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.bucket4/index.md) | _(Optional)_ |
| [type](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.sankeychart/index.md#v1sankeycharttype) |  | "sankey\_chart" | Type of visualisation. |
| [view\_by?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.sankeychart/index.md#v1sankeychartview_by) |  | ([Bucket](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.bucket/index.md) \| [EmptyBucket](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.emptybucket/index.md))[] | _(Optional)_ A list of view by attributes in this visualisation. |

## Property details

### v1.SankeyChart.config

**Signature:**

```typescript
config?: VisualisationConfig16;
```

### v1.SankeyChart.description

An optional description of the visualisation.

**Signature:**

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

### v1.SankeyChart.from

**Signature:**

```typescript
from?: Bucket3;
```

### v1.SankeyChart.id

**Signature:**

```typescript
id: Id37;
```

### v1.SankeyChart.is_hidden

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

**Signature:**

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

### v1.SankeyChart.metrics

A list of metrics in this visualisation.

**Signature:**

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

### v1.SankeyChart.query

**Signature:**

```typescript
query: Query16;
```

### v1.SankeyChart.segment_by

Not used in this graph type.

**Signature:**

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

### v1.SankeyChart.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.SankeyChart.tags

**Signature:**

```typescript
tags?: Tags30;
```

### v1.SankeyChart.title

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

**Signature:**

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

### v1.SankeyChart.to

**Signature:**

```typescript
to?: Bucket4;
```

### v1.SankeyChart.type

Type of visualisation.

**Signature:**

```typescript
type: "sankey_chart";
```

### v1.SankeyChart.view_by

A list of view by attributes in this visualisation.

**Signature:**

```typescript
view_by?: (Bucket | EmptyBucket)[];
```