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

# v1.Label

- 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

This interface was referenced by `undefined`'s JSON-Schema definition via the `patternProperty` "^(?!.)[.A-Za-z0-9\_-]{1,255}$".

**Signature:**

```typescript
export interface Label 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [data\_type?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.label/index.md#v1labeldata_type) |  | "INT" \| "STRING" \| "DATE" \| "NUMERIC" \| "TIMESTAMP" \| "TIMESTAMP\_TZ" \| "BOOLEAN" \| "HLL" | _(Optional)_ A column data type in the physical database. |
| [description?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.label/index.md#v1labeldescription) |  | string | _(Optional)_ An optional description of the label. |
| [geo\_area\_config?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.label/index.md#v1labelgeo_area_config) |  | [GeoAreaConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.geoareaconfig/index.md) | _(Optional)_ |
| [is\_hidden?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.label/index.md#v1labelis_hidden) |  | boolean | _(Optional)_ |
| [is\_nullable?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.label/index.md#v1labelis_nullable) |  | boolean | _(Optional)_ Optional flag to indicate if the label can contain null values. |
| [locale?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.label/index.md#v1labellocale) |  | [Locale1](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.locale1/index.md) | _(Optional)_ |
| [null\_value\_join\_replacement?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.label/index.md#v1labelnull_value_join_replacement) |  | string | _(Optional)_ Optional value which can be used as replacement for NULL in join conditions. |
| [show\_in\_ai\_results?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.label/index.md#v1labelshow_in_ai_results) |  | boolean | _(Optional)_ Optional flag to indicate if the label should be shown in AI results. When omitted, the label is visible. |
| [source\_column?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.label/index.md#v1labelsource_column) |  | string | _(Optional)_ A column name in the physical database. |
| [tags?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.label/index.md#v1labeltags) |  | [Tags2](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.tags2/index.md) | _(Optional)_ |
| [title?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.label/index.md#v1labeltitle) |  | string | _(Optional)_ An optional human readable title for the label. |
| [translations?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.label/index.md#v1labeltranslations) |  | [LabelTranslation](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.labeltranslation/index.md)[] | _(Optional)_ Optional list of localized source columns for this label. |
| [value\_type?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-code-schemas/sdk-code-schemas.v1.label/index.md#v1labelvalue_type) |  | "TEXT" \| "HYPERLINK" \| "GEO" \| "GEO\_LONGITUDE" \| "GEO\_LATITUDE" \| "GEO\_ICON" \| "IMAGE" \| "GEO\_AREA" | _(Optional)_ |

## Property details

### v1.Label.data_type

A column data type in the physical database.

**Signature:**

```typescript
data_type?: "INT" | "STRING" | "DATE" | "NUMERIC" | "TIMESTAMP" | "TIMESTAMP_TZ" | "BOOLEAN" | "HLL";
```

### v1.Label.description

An optional description of the label.

**Signature:**

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

### v1.Label.geo_area_config

**Signature:**

```typescript
geo_area_config?: GeoAreaConfig;
```

### v1.Label.is_hidden

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

**Signature:**

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

### v1.Label.is_nullable

Optional flag to indicate if the label can contain null values.

**Signature:**

```typescript
is_nullable?: boolean;
```

### v1.Label.locale

**Signature:**

```typescript
locale?: Locale1;
```

### v1.Label.null_value_join_replacement

Optional value which can be used as replacement for NULL in join conditions.

**Signature:**

```typescript
null_value_join_replacement?: string;
```

### v1.Label.show_in_ai_results

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

**Signature:**

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

### v1.Label.source_column

A column name in the physical database.

**Signature:**

```typescript
source_column?: string;
```

### v1.Label.tags

**Signature:**

```typescript
tags?: Tags2;
```

### v1.Label.title

An optional human readable title for the label.

**Signature:**

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

### v1.Label.translations

Optional list of localized source columns for this label.

**Signature:**

```typescript
translations?: LabelTranslation[];
```

### v1.Label.value_type

**Signature:**

```typescript
value_type?: "TEXT" | "HYPERLINK" | "GEO" | "GEO_LONGITUDE" | "GEO_LATITUDE" | "GEO_ICON" | "IMAGE" | "GEO_AREA";
```