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

# IAttributeDescriptorBody

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

Attribute descriptor header.

**Signature:**

```typescript
export interface IAttributeDescriptorBody 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [conditionalFormatting?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iattributedescriptorbody/index.md#iattributedescriptorbodyconditionalformatting) |  | [ISemanticConditionalFormatting](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.isemanticconditionalformatting/index.md) | **_(ALPHA)_** _(Optional)_ Semantic-layer conditional formatting authored on the underlying label, fact, or date dataset. |
| [format?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iattributedescriptorbody/index.md#iattributedescriptorbodyformat) |  | { locale: string; pattern: string; timezone?: string; } | _(Optional)_ Describes format information in case of date attribute. |
| [formOf](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iattributedescriptorbody/index.md#iattributedescriptorbodyformof) |  | [IAttributeHeaderFormOf](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iattributeheaderformof/index.md) | Describes attributes to which the display form belongs. |
| [geoAreaConfig?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iattributedescriptorbody/index.md#iattributedescriptorbodygeoareaconfig) |  | [IAttributeDisplayFormGeoAreaConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iattributedisplayformgeoareaconfig/index.md) | **_(ALPHA)_** _(Optional)_ Geo area configuration bound to this attribute display form. |
| [granularity?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iattributedescriptorbody/index.md#iattributedescriptorbodygranularity) |  | string | _(Optional)_ Specifies granularity in case of date attribute. |
| [identifier](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iattributedescriptorbody/index.md#iattributedescriptorbodyidentifier) |  | string | Display form identifier |
| [labelType?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iattributedescriptorbody/index.md#iattributedescriptorbodylabeltype) |  | [AttributeDisplayFormType](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.attributedisplayformtype/index.md) | _(Optional)_ Label type (eg. image, hyperlink, etc...) |
| [localIdentifier](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iattributedescriptorbody/index.md#iattributedescriptorbodylocalidentifier) |  | string | Local identifier of the display form - this references back to the IAttribute which was on the input to the execution. |
| [name](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iattributedescriptorbody/index.md#iattributedescriptorbodyname) |  | string | Human readable name of the attribute. |
| [primaryLabel](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iattributedescriptorbody/index.md#iattributedescriptorbodyprimarylabel) |  | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | Primary label of the attribute from formOf |
| [ref](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iattributedescriptorbody/index.md#iattributedescriptorbodyref) |  | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | Opaque reference of the display form object. |
| [totalItems?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iattributedescriptorbody/index.md#iattributedescriptorbodytotalitems) |  | [ITotalDescriptor](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.itotaldescriptor/index.md)[] | _(Optional)_ |
| [type?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iattributedescriptorbody/index.md#iattributedescriptorbodytype) |  | string | _(Optional)_ Display form type |
| [uri](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iattributedescriptorbody/index.md#iattributedescriptorbodyuri) |  | string | URI of the display form object |

## Property details

### IAttributeDescriptorBody.conditionalFormatting

> **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).
> 

Semantic-layer conditional formatting authored on the underlying label, fact, or date dataset.

**Signature:**

```typescript
conditionalFormatting?: ISemanticConditionalFormatting;
```

### IAttributeDescriptorBody.format

Describes format information in case of date attribute.

**Signature:**

```typescript
format?: {
        locale: string;
        pattern: string;
        timezone?: string;
    };
```

### IAttributeDescriptorBody.formOf

Describes attributes to which the display form belongs.

**Signature:**

```typescript
formOf: IAttributeHeaderFormOf;
```

### IAttributeDescriptorBody.geoAreaConfig

> **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).
> 

Geo area configuration bound to this attribute display form.

**Signature:**

```typescript
geoAreaConfig?: IAttributeDisplayFormGeoAreaConfig;
```

### IAttributeDescriptorBody.granularity

Specifies granularity in case of date attribute.

**Signature:**

```typescript
granularity?: string;
```

### IAttributeDescriptorBody.identifier

Display form identifier

**Signature:**

```typescript
identifier: string;
```

### IAttributeDescriptorBody.labelType

Label type (eg. image, hyperlink, etc...)

**Signature:**

```typescript
labelType?: AttributeDisplayFormType;
```

### IAttributeDescriptorBody.localIdentifier

Local identifier of the display form - this references back to the IAttribute which was on the input to the execution.

**Signature:**

```typescript
localIdentifier: string;
```

### IAttributeDescriptorBody.name

Human readable name of the attribute.

**Signature:**

```typescript
name: string;
```

### IAttributeDescriptorBody.primaryLabel

Primary label of the attribute from formOf

**Signature:**

```typescript
primaryLabel: ObjRef;
```

### IAttributeDescriptorBody.ref

Opaque reference of the display form object.

**Signature:**

```typescript
ref: ObjRef;
```

### IAttributeDescriptorBody.totalItems

**Signature:**

```typescript
totalItems?: ITotalDescriptor[];
```

### IAttributeDescriptorBody.type

Display form type

**Signature:**

```typescript
type?: string;
```

### IAttributeDescriptorBody.uri

URI of the display form object

**Signature:**

```typescript
uri: string;
```
