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

# IMetadata

> Removes the value of the metadata property by name.

## Interfaces

### IMetadata

#### Methods

##### deleteProperty()

```ts
deleteProperty(name): boolean;
```

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `name` | `string` | property name. |

###### Returns

`boolean`

##### getProperties()

```ts
getProperties(): IMetadataProperty[];
```

Returns all metadata properties.

###### Returns

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

##### getPropertiesCount()

```ts
getPropertiesCount(): number;
```

Returns the number of metadata properties.

###### Returns

`number`

##### getProperty()

```ts
getProperty(name): IMetadataProperty;
```

Returns metadata property by name.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `name` | `string` | property name. |

###### Returns

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

##### isPropertyExists()

```ts
isPropertyExists(name): boolean;
```

Checks for metadata property existence.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `name` | `string` | property name. |

###### Returns

`boolean`

true if the template image exists, false otherwise.

##### setProperty()

```ts
setProperty(name, value): void;
```

Sets the value of a metadata property by name.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `name` | `string` | property name. |
| `value` | `string` | property value. |

###### Returns

`void`

###### Remarks

if a property with the same name already exists, its value is overwritten.