Filigrane

Informations sur les plugins

Les filigranes sont des superpositions de texte ou d'image sur une page Web ou une application qui empêchent l'utilisation ou la transmission de contenu sans permission. Ils sont générés dynamiquement et offrent un certain nombre d'options de configuration.

Utilisez le Générateur de filigrane pour prévisualiser les styles de filigrane et télécharger la configuration du plugin sous JSON.

Mode plugin

Installation

Shell
pnpm add @univerjs/watermark

Utilisation

TypeScript
import { UniverWatermarkPlugin } from '@univerjs/watermark'import '@univerjs/watermark/facade'const univer = new Univer({  // ...})univer.registerPlugin(UniverWatermarkPlugin, {   textWatermarkSettings: {     content: 'Hello, Univer!',     fontSize: 36,   }, })

Configuration des plugins

Passez l'un des objets ci-dessous à UniverWatermarkPlugin. Si plus d'un objet est passé, l'information utilisateur a priorité sur le texte et le texte a priorité sur l'image. Les valeurs par défaut prennent effet une fois l'objet correspondant passé.

  • userWatermarkSettings
    object
    Filigrane avec les informations de l’utilisateur actuel.
    • name
      booleanValeur par défaut: true
      Affiche le nom de l’utilisateur actuel.
    • email
      booleanValeur par défaut: false
      Affiche l’adresse e-mail de l’utilisateur actuel.
    • phone
      booleanValeur par défaut: false
      Affiche le numéro de téléphone de l’utilisateur actuel.
    • uid
      booleanValeur par défaut: false
      Affiche l’identifiant de l’utilisateur actuel.
    • fontSize
      numberValeur par défaut: 16
      Taille de police en pixels.
    • color
      stringValeur par défaut: 'rgb(0,0,0)'
      Couleur du texte au format CSS.
    • bold
      booleanValeur par défaut: false
      Affiche le texte en gras.
    • italic
      booleanValeur par défaut: false
      Affiche le texte en italique.
    • direction
      'ltr' | 'rtl' | 'inherit'Valeur par défaut: 'ltr'
      Définit le sens du texte.
    • x
      numberValeur par défaut: 60
      Décalage horizontal du premier filigrane en pixels.
    • y
      numberValeur par défaut: 60
      Décalage vertical du premier filigrane en pixels.
    • repeat
      booleanValeur par défaut: true
      Répète le filigrane sur la zone d’édition.
    • spacingX
      numberValeur par défaut: 200
      Espacement horizontal entre répétitions en pixels.
    • spacingY
      numberValeur par défaut: 100
      Espacement vertical entre répétitions en pixels.
    • rotate
      numberValeur par défaut: -30
      Angle de rotation en degrés.
    • opacity
      numberValeur par défaut: 0.15
      Opacité de 0 à 1.
  • textWatermarkSettings
    object
    Filigrane de texte.
    • content
      stringValeur par défaut: ''
      Texte à afficher.
    • fontSize
      numberValeur par défaut: 16
      Taille de police en pixels.
    • color
      stringValeur par défaut: 'rgb(0,0,0)'
      Couleur du texte au format CSS.
    • bold
      booleanValeur par défaut: false
      Affiche le texte en gras.
    • italic
      booleanValeur par défaut: false
      Affiche le texte en italique.
    • direction
      'ltr' | 'rtl' | 'inherit'Valeur par défaut: 'ltr'
      Définit le sens du texte.
    • x
      numberValeur par défaut: 60
      Décalage horizontal du premier filigrane en pixels.
    • y
      numberValeur par défaut: 36
      Décalage vertical du premier filigrane en pixels.
    • repeat
      booleanValeur par défaut: true
      Répète le filigrane sur la zone d’édition.
    • spacingX
      numberValeur par défaut: 200
      Espacement horizontal entre répétitions en pixels.
    • spacingY
      numberValeur par défaut: 100
      Espacement vertical entre répétitions en pixels.
    • rotate
      numberValeur par défaut: 0
      Angle de rotation en degrés.
    • opacity
      numberValeur par défaut: 0.15
      Opacité de 0 à 1.
  • imageWatermarkSettings
    object
    Filigrane d’image.
    • url
      stringValeur par défaut: ''
      URL de l’image du filigrane.
    • width
      numberValeur par défaut: 100
      Largeur de l’image en pixels.
    • height
      numberValeur par défaut: 100
      Hauteur de l’image en pixels quand les proportions ne sont pas verrouillées.
    • maintainAspectRatio
      booleanValeur par défaut: true
      Calcule la hauteur à partir de la largeur et de originRatio.
    • originRatio
      numberValeur par défaut: 1
      Largeur de l’image d’origine divisée par sa hauteur.
    • x
      numberValeur par défaut: 60
      Décalage horizontal du premier filigrane en pixels.
    • y
      numberValeur par défaut: 36
      Décalage vertical du premier filigrane en pixels.
    • repeat
      booleanValeur par défaut: true
      Répète le filigrane sur la zone d’édition.
    • spacingX
      numberValeur par défaut: 200
      Espacement horizontal entre répétitions en pixels.
    • spacingY
      numberValeur par défaut: 100
      Espacement vertical entre répétitions en pixels.
    • rotate
      numberValeur par défaut: 0
      Angle de rotation en degrés.
    • opacity
      numberValeur par défaut: 0.15
      Opacité de 0 à 1.

IUniverWatermarkConfig

Mode prédéfini

Aucun préréglage de filigrane n'existe, mais le plugin peut être enregistré à côté de vos presets.

Installation

Shell
pnpm add @univerjs/watermark

Utilisation

TypeScript
import { UniverWatermarkPlugin } from '@univerjs/watermark'import '@univerjs/watermark/facade'const { univerAPI } = createUniver({  // ...  presets: [    UniverDocsCorePreset(),  ],  plugins: [    [UniverWatermarkPlugin, {       textWatermarkSettings: {         content: 'Hello, Univer!',         fontSize: 36,       },     }],   ],})

API Facade

Importation

Note du mode greffon

Seul le mode plugin nécessite une importation manuelle de Facade. Le mode Preset regroupe déjà le paquet Facade, donc aucune importation supplémentaire n'est nécessaire.

TypeScript
import '@univerjs/watermark/facade'

Ajouter un filigrane

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

Supprimer le filigrane

TypeScript
univerAPI.deleteWatermark()

Que pensez-vous de ce guide ?

© 2026 DreamNum Co., Ltd.