API 参考

@univerjs/watermark

本 API 页面目前提供英文正文。代码签名与标识符不随界面语言变化。

Watermark rendering plugin for Univer.

TypeScript
import { UniverWatermarkPlugin } from '@univerjs/watermark'univer.registerPlugin(UniverWatermarkPlugin, IUniverWatermarkConfig)

Entry Points

  • Facade: @univerjs/watermark/facade

IUniverWatermarkConfig

TypeScript
import type { IImageWatermarkConfig, ITextWatermarkConfig, IUserInfoWatermarkConfig } from '@univerjs/engine-render'export interface IUniverWatermarkConfig {  userWatermarkSettings?: Partial<IUserInfoWatermarkConfig>  textWatermarkSettings?: Partial<ITextWatermarkConfig>  imageWatermarkSettings?: Partial<IImageWatermarkConfig>}

IGeneralWatermarkConfig

TypeScript
export interface IGeneralWatermarkConfig {  x: number  y: number  repeat: boolean  spacingX: number  spacingY: number  rotate: number  opacity: number}

IImageWatermarkConfig

TypeScript
export interface IImageWatermarkConfig extends IGeneralWatermarkConfig {  url: string  width: number  height: number  maintainAspectRatio: boolean  originRatio: number}

ITextWatermarkConfig

TypeScript
export interface ITextWatermarkConfig extends IGeneralWatermarkConfig {  content?: string  fontSize: number  color: string  bold: boolean  italic: boolean  direction: 'ltr' | 'rtl' | 'inherit'}

IUserInfoWatermarkConfig

TypeScript
export interface IUserInfoWatermarkConfig extends IGeneralWatermarkConfig, Omit<ITextWatermarkConfig, 'content'> {  name: boolean  email: boolean  phone: boolean  uid: boolean}

你觉得这篇文档如何?

© 2026 DreamNum Co., Ltd.