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

# MetadataHandler

> Handler for performing simple operations with text metadata.

## Classes

### MetadataHandler

#### Implements

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

#### Constructors

##### Constructor

```ts
new MetadataHandler(tw): MetadataHandler;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `tw` | [`ITextWhizzHolder`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ITextWhizzHolder.md#itextwhizzholder) |

###### Returns

[`MetadataHandler`](#metadatahandler)

#### 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)

###### Implementation of

[`IMetadataHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IMetadataHandler.md#imetadatahandler).[`createMetadata`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IMetadataHandler.md#createmetadata)

##### deleteMetadata()

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

Removes metadata by index.

###### Parameters

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

###### Returns

`void`

###### Implementation of

[`IMetadataHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IMetadataHandler.md#imetadatahandler).[`deleteMetadata`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IMetadataHandler.md#deletemetadata)

##### 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)

###### Implementation of

[`IMetadataHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IMetadataHandler.md#imetadatahandler).[`getMetadata`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IMetadataHandler.md#getmetadata)

##### isMetadataExists()

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

Checks for the presence of metadata.

###### Parameters

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

###### Returns

`boolean`

###### Implementation of

[`IMetadataHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IMetadataHandler.md#imetadatahandler).[`isMetadataExists`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IMetadataHandler.md#ismetadataexists)

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

###### Implementation of

[`IMetadataHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IMetadataHandler.md#imetadatahandler).[`setMetadata`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/IMetadataHandler.md#setmetadata)