# Водяной знак

- Human documentation: [https://docs.univer.ai/ru-RU/guides/docs/features/watermark](https://docs.univer.ai/ru-RU/guides/docs/features/watermark)

- Agent Markdown: [https://docs.univer.ai/ru-RU/guides/docs/features/watermark.md](https://docs.univer.ai/ru-RU/guides/docs/features/watermark.md)

- Requested language: `ru-RU`

- Content language: `ru-RU`

- Documentation version: `1.2.0`

- Source: [docs/features/watermark.ru-RU.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/docs/features/watermark.ru-RU.mdx)

---

#### Package metadata

```json
{
  "plugins": [
    {
      "client": "@univerjs/watermark",
      "facade": "@univerjs/watermark/facade"
    }
  ],
  "server": false
}
```

Функция водяных знаков позволяет создавать гибкие и надёжные решения для защиты веб-страниц и приложений. Разработчики могут динамически добавлять на страницу текстовые или графические водяные знаки, чтобы предотвратить несанкционированное использование и распространение контента. Доступны различные параметры настройки.

> [!INFO]
> Используйте [Генератор водяных знаков](/tools/watermark-generator) для предварительного просмотра стилей и скачивания конфигурации плагина в формате JSON.

> Interactive example: [Open the playground](/playground/docs/watermark)

## Режим пресетов

Для водяных знаков нет отдельного пресета, но соответствующий плагин можно использовать совместно с пресетами.

### Установка

#### npm

```bash
npm install @univerjs/watermark
```

#### pnpm

```bash
pnpm add @univerjs/watermark
```

#### yarn

```bash
yarn add @univerjs/watermark
```

#### bun

```bash
bun add @univerjs/watermark
```

### Использование

```typescript
import { UniverWatermarkPlugin } from '@univerjs/watermark' // [!code ++]

import '@univerjs/watermark/facade' // [!code ++]

const { univerAPI } = createUniver({
  // ...
  presets: [
    UniverDocsCorePreset(),
  ],
  plugins: [
    [UniverWatermarkPlugin, { // [!code ++]
      textWatermarkSettings: { // [!code ++]
        content: 'Hello, Univer!', // [!code ++]
        fontSize: 36, // [!code ++]
      }, // [!code ++]
    }], // [!code ++]
  ],
})
```

## Режим плагинов

### Установка

#### npm

```bash
npm install @univerjs/watermark
```

#### pnpm

```bash
pnpm add @univerjs/watermark
```

#### yarn

```bash
yarn add @univerjs/watermark
```

#### bun

```bash
bun add @univerjs/watermark
```

### Использование

```typescript
import { UniverWatermarkPlugin } from '@univerjs/watermark' // [!code ++]

import '@univerjs/watermark/facade' // [!code ++]

const univer = new Univer({
  // ...
})

univer.registerPlugin(UniverWatermarkPlugin, { // [!code ++]
  textWatermarkSettings: { // [!code ++]
    content: 'Hello, Univer!', // [!code ++]
    fontSize: 36, // [!code ++]
  }, // [!code ++]
}) // [!code ++]
```

### Плагины и настройка

#### @univerjs/watermark

Этот плагин содержит основную реализацию водяных знаков. Он позволяет добавлять в приложения текстовые или графические водяные знаки и предоставляет различные параметры для настройки их внешнего вида и поведения. Плагин экспортируется как `UniverWatermarkPlugin`.

Справочник: [@univerjs/watermark](https://docs.univer.ai/ru-RU/reference/packages/plugins/univerjs/watermark.md)

## Facade API

### Импорт

> [!INFO: Примечание для режима плагинов]
> Импортировать пакет Facade вручную нужно только в режиме плагинов. В режиме пресетов соответствующий пакет Facade уже подключён, поэтому дополнительный импорт не требуется.

```typescript
import '@univerjs/watermark/facade'
```

### Добавление водяного знака

```typescript
univerAPI.addWatermark('text', { content: 'hello', repeat: true })
```

### Удаление водяного знака

```typescript
univerAPI.deleteWatermark()
```