# ウォーターマーク

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

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

- Requested language: `ja-JP`

- Content language: `ja-JP`

- Documentation version: `1.1.0`

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

---

#### Package metadata

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

ウォーターマーク機能は、Web ページやアプリケーションに柔軟で安全なウォーターマークを提供します。テキストや画像のウォーターマークを動的に生成し、無断使用や拡散の防止に役立ちます。さまざまな設定オプションも備えています。

> [!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 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/ja-JP/reference/packages/plugins/univerjs/watermark.md)

## プリセットモード

ウォーターマークはプリセットを提供していませんが、プラグインとして組み合わせて利用できます。

### インストール

#### 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 ++]
  ],
})
```

## Facade API

### インポート

> [!INFO: プラグインモード注意]
> Facade パッケージの手動 import が必要なのはプラグインモードのみです。プリセットモードには対応する Facade パッケージが内蔵されているため、追加の import は不要です。

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

### ウォーターマークを設定

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

### ウォーターマークを削除

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