Skip to main content

class: com.nbx.pdfviewer.Watermark.Image

Control Sample: com.nbx.pdfviewer.PDFViewerModule: com/nbx/pdfviewer/Watermark.ImageApplication Component: NBX-UI5-PDFViewer
Documentation: Nubexx PDF ViewerVisibility: publicMinimum Ui5-Version required: 1.71

Overview

Contains a single watermark image object that is rendered over the PDF content.

info

Watermarks are not supported in the trial version of the PDF Viewer.

Constructor

Constructor for a new Option element.

new com.nbx.pdfviewer.Watermark.Image(sId?, mSettings?)

ParamTypeDefault valueDescription
sId?stringId for the new control, generated automatically if no id is given.
mSettings?objectInitial settings for the new control.

Properties

NameTypeDefault ValueDescription
alignHorizontalsap.ui.core.HorizontalAlignsap.ui.core.HorizontalAlign.CenterHorizontal reference position of the watermark object.
alignVerticalsap.ui.core.VerticalAlignsap.ui.core.VerticalAlign.MiddleVertical reference position of the the watermark object.
heightfloatnullHeight of the image in percent based on page height.
opacityfloat0Opacity of the image.
positionHorizontalfloat50Horizontal position of the object reference position in percent of the page width.
positionVerticalfloat50Vertical position of the object reference position in percent of the page height.
rotatefloat0Rotation angle of the watermark object in relation to the reference position.
scalefloat1Scale size of the image.
srcsap.ui.core.URIA valid image resource. Note: The source must come from the same domain.
svgContentstringIf src is not provided, an SVG string can be set. See below.
widthfloat20Width of the image in percent based on page width.

Example for svgContent

<svg xmlns="http://www.w3.org/2000/svg" width="100" height="100">
<rect width="100" height="100" fill="gray"/>
</svg>