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

# v1.WaterfallChart

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

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [config?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.waterfallchart/index.md#v1waterfallchartconfig) |  | [VisualisationConfig14](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.visualisationconfig14/index.md) | _(Optional)_ |
| [description?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.waterfallchart/index.md#v1waterfallchartdescription) |  | 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.waterfallchart/index.md#v1waterfallchartid) |  | [Id35](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.id35/index.md) |  |
| [is\_hidden?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.waterfallchart/index.md#v1waterfallchartis_hidden) |  | boolean | _(Optional)_ |
| [metrics?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.waterfallchart/index.md#v1waterfallchartmetrics) |  | [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.waterfallchart/index.md#v1waterfallchartquery) |  | [Query14](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.query14/index.md) |  |
| [segment\_by?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.waterfallchart/index.md#v1waterfallchartsegment_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.waterfallchart/index.md#v1waterfallchartshow_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.waterfallchart/index.md#v1waterfallcharttags) |  | [Tags28](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.tags28/index.md) | _(Optional)_ |
| [title?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.waterfallchart/index.md#v1waterfallcharttitle) |  | 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.waterfallchart/index.md#v1waterfallcharttype) |  | "waterfall\_chart" | Type of visualisation. |
| [view\_by?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.waterfallchart/index.md#v1waterfallchartview_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.WaterfallChart.config

**Signature:**

```typescript
config?: VisualisationConfig14;
```

### v1.WaterfallChart.description

An optional description of the visualisation.

**Signature:**

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

### v1.WaterfallChart.id

**Signature:**

```typescript
id: Id35;
```

### v1.WaterfallChart.is_hidden

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

**Signature:**

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

### v1.WaterfallChart.metrics

A list of metrics in this visualisation.

**Signature:**

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

### v1.WaterfallChart.query

**Signature:**

```typescript
query: Query14;
```

### v1.WaterfallChart.segment_by

Not used in this graph type.

**Signature:**

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

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

**Signature:**

```typescript
tags?: Tags28;
```

### v1.WaterfallChart.title

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

**Signature:**

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

### v1.WaterfallChart.type

Type of visualisation.

**Signature:**

```typescript
type: "waterfall_chart";
```

### v1.WaterfallChart.view_by

A list of view by attributes in this visualisation.

**Signature:**

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