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

# TextWhizzMetadata

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

## Classes

### TextWhizzMetadata

#### Implements

#### Constructors

##### Constructor

```ts
new TextWhizzMetadata(tw, properties?): TextWhizzMetadata;
```

###### Parameters

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

###### Returns

[`TextWhizzMetadata`](#textwhizzmetadata)

#### Methods

##### deleteProperty()

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

Removes the value of the metadata property by name.

###### Parameters

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

###### Returns

`boolean`

###### Implementation of

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

##### getEntry()

```ts
getEntry(): StringMap;
```

Returns the metadata in a TextWhizz format.

###### Returns

`StringMap`

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

###### Implementation of

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

##### getPropertiesCount()

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

Returns the number of metadata properties.

###### Returns

`number`

###### Implementation of

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

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

###### Implementation of

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

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

###### Implementation of

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

##### setEntry()

```ts
setEntry(metadata): void;
```

Sets metadata by TextWhizz entry (patch).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `metadata` | `StringMap` | metadata in a TextWhizz format. |

###### Returns

`void`

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

###### Implementation of

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