This is an old documentation. Go to the latest Customer's Canvas docs

IWatermarkTextConfig Interface

A configuration of watermark text.

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


Optional fontSettings

fontSettings: IFontSettings

The font settings of watermark text.

Optional opacity

opacity: number

The opacity of watermark text. The default value is 0.1.

Optional scale

scale: number

The scale of watermark text. The default value is 0.28.

Optional text

text: string

The text of the watermark.