---
title: "IMetadataHandler | Customer's Canvas On-Premises"
canonical: "https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IMetadataHandler/"
---

# IMetadataHandler

> Handler for performing simple operations with text metadata.

## Interfaces

### IMetadataHandler

#### Methods

##### createMetadata()

```ts
createMetadata(properties): IMetadata;
```

Creates metadata by properties.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `properties` | [`IMetadataProperty`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IMetadataProperty.md#imetadataproperty)[] | metadata properties. |

###### Returns

[`IMetadata`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IMetadata.md#imetadata)

##### deleteMetadata()

```ts
deleteMetadata(index): void;
```

Removes metadata by index.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `index` | `number` | paragraph index. |

###### Returns

`void`

##### getMetadata()

```ts
getMetadata(index): IMetadata;
```

Returns metadata by index.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `index` | `number` | paragraph index. |

###### Returns

[`IMetadata`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IMetadata.md#imetadata)

##### isMetadataExists()

```ts
isMetadataExists(index): boolean;
```

Checks for the presence of metadata.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `index` | `number` | paragraph index. |

###### Returns

`boolean`

##### setMetadata()

```ts
setMetadata(index, metadata): void;
```

Sets metadata by index.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `index` | `number` | paragraph index. |
| `metadata` | [`IMetadata`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IMetadata.md#imetadata) | metadata. |

###### Returns

`void`