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

# WatermarkConfig

> - [`IWatermarkConfig`](#iwatermarkconfig)

## Classes

### WatermarkConfig

#### Implements

#### Constructors

##### Constructor

```ts
new WatermarkConfig(): WatermarkConfig;
```

###### Returns

[`WatermarkConfig`](#watermarkconfig)

#### Properties

##### image?

```ts
optional image?: IWatermarkImageConfig;
```

###### Implementation of

[`IWatermarkConfig`](#iwatermarkconfig).[`image`](#image-1)

##### text?

```ts
optional text?: IWatermarkTextConfig;
```

###### Implementation of

[`IWatermarkConfig`](#iwatermarkconfig).[`text`](#text-2)

##### visibility?

```ts
optional visibility?: IWatermarkVisibilityConfig;
```

###### Implementation of

[`IWatermarkConfig`](#iwatermarkconfig).[`visibility`](#visibility-1)

#### Methods

##### clone()

```ts
clone(): WatermarkConfig;
```

###### Returns

[`WatermarkConfig`](#watermarkconfig)

***

### WatermarkImageConfig

#### Implements

- [`IWatermarkImageConfig`](#iwatermarkimageconfig)

#### Constructors

##### Constructor

```ts
new WatermarkImageConfig(): WatermarkImageConfig;
```

###### Returns

[`WatermarkImageConfig`](#watermarkimageconfig)

#### Properties

##### name?

```ts
optional name?: string;
```

###### Implementation of

[`IWatermarkImageConfig`](#iwatermarkimageconfig).[`name`](#name-1)

##### opacity?

```ts
optional opacity?: number;
```

###### Implementation of

[`IWatermarkImageConfig`](#iwatermarkimageconfig).[`opacity`](#opacity-2)

##### repeat?

```ts
optional repeat?: boolean;
```

###### Implementation of

[`IWatermarkImageConfig`](#iwatermarkimageconfig).[`repeat`](#repeat-1)

##### staticStorageId?

```ts
optional staticStorageId?: string;
```

###### Implementation of

[`IWatermarkImageConfig`](#iwatermarkimageconfig).[`staticStorageId`](#staticstorageid-1)

##### storageId?

```ts
optional storageId?: string;
```

###### Implementation of

[`IWatermarkImageConfig`](#iwatermarkimageconfig).[`storageId`](#storageid-1)

#### Methods

##### clone()

```ts
clone(): WatermarkImageConfig;
```

###### Returns

[`WatermarkImageConfig`](#watermarkimageconfig)

***

### WatermarkTextConfig

#### Implements

- [`IWatermarkTextConfig`](#iwatermarktextconfig)

#### Constructors

##### Constructor

```ts
new WatermarkTextConfig(): WatermarkTextConfig;
```

###### Returns

[`WatermarkTextConfig`](#watermarktextconfig)

#### Properties

##### fontSettings?

```ts
optional fontSettings?: FontSettings;
```

###### Implementation of

[`IWatermarkTextConfig`](#iwatermarktextconfig).[`fontSettings`](#fontsettings-1)

##### opacity?

```ts
optional opacity?: number;
```

###### Implementation of

[`IWatermarkTextConfig`](#iwatermarktextconfig).[`opacity`](#opacity-3)

##### scale?

```ts
optional scale?: number;
```

###### Implementation of

[`IWatermarkTextConfig`](#iwatermarktextconfig).[`scale`](#scale-1)

##### text?

```ts
optional text?: string;
```

###### Implementation of

[`IWatermarkTextConfig`](#iwatermarktextconfig).[`text`](#text-3)

#### Methods

##### clone()

```ts
clone(): WatermarkTextConfig;
```

###### Returns

[`WatermarkTextConfig`](#watermarktextconfig)

***

### WatermarkVisibilityConfig

#### Implements

- [`IWatermarkVisibilityConfig`](#iwatermarkvisibilityconfig)

#### Constructors

##### Constructor

```ts
new WatermarkVisibilityConfig(): WatermarkVisibilityConfig;
```

###### Returns

[`WatermarkVisibilityConfig`](#watermarkvisibilityconfig)

#### Properties

##### canvas?

```ts
optional canvas?: boolean;
```

###### Implementation of

[`IWatermarkVisibilityConfig`](#iwatermarkvisibilityconfig).[`canvas`](#canvas-1)

##### proof?

```ts
optional proof?: boolean;
```

###### Implementation of

[`IWatermarkVisibilityConfig`](#iwatermarkvisibilityconfig).[`proof`](#proof-1)

#### Methods

##### clone()

```ts
clone(): WatermarkVisibilityConfig;
```

###### Returns

[`WatermarkVisibilityConfig`](#watermarkvisibilityconfig)

## Interfaces

### IWatermarkConfig

#### Properties

##### image?

```ts
optional image?: IWatermarkImageConfig;
```

##### text?

```ts
optional text?: IWatermarkTextConfig;
```

##### visibility?

```ts
optional visibility?: IWatermarkVisibilityConfig;
```

***

### IWatermarkImageConfig

#### Properties

##### name?

```ts
optional name?: string;
```

##### opacity?

```ts
optional opacity?: number;
```

##### repeat?

```ts
optional repeat?: boolean;
```

##### staticStorageId?

```ts
optional staticStorageId?: string;
```

##### storageId?

```ts
optional storageId?: string;
```

***

### IWatermarkTextConfig

#### Properties

##### fontSettings?

```ts
optional fontSettings?: FontSettings;
```

##### opacity?

```ts
optional opacity?: number;
```

##### scale?

```ts
optional scale?: number;
```

##### text?

```ts
optional text?: string;
```

***

### IWatermarkVisibilityConfig

#### Properties

##### canvas?

```ts
optional canvas?: boolean;
```

##### proof?

```ts
optional proof?: boolean;
```