Interface: IWatermarkConfig

A configuration of watermarks.

Remarks

For more details, see the Watermarks https://customerscanvas.com/dev/editors/iframe-api/rendering/watermarks.html|Watermarks topic.

Example

configuration = {
  watermark: {
    text: {
      text: "watermark",
      fontSettings: {
        postScriptName: "LucidaSans-Italic",
        size: 14,
        fauxBold: false,
        fauxItalic: false,
      },
      scale: 0.28,
      opacity: 0.5,
    },
    image: {
      name: "watermark.png",
      repeat: true,
      opacity: 0.1,
    },
    visibility: {
      proof: true,
      canvas: true,
    },
  },
};

Properties

text?

optional text?: IWatermarkTextConfig

Configures the text of the watermark.

---

image?

optional image?: IWatermarkImageConfig

Configures the image of the watermark.

---

visibility?

optional visibility?: IWatermarkVisibilityConfig

Configures visibility of the watermark.