You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

IWatermarkConfig Interface

Applies to: Customer's Canvas On-Premises; Design Editor 4.4.25, 4.x (may differ) · Archived documentation

A configuration of watermarks. For details, see the 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

Optional image

image: IWatermarkImageConfig

Configures the image of the watermark.

Optional text

text: IWatermarkTextConfig

Configures the text of the watermark.

Optional visibility

visibility: IWatermarkVisibilityConfig

Configures visibility of the watermark.