Platform Explorer / Nuxeo Platform LTS 2019 10.10

Operation PDF.WatermarkWithImage (PDF: Watermark with Image)

Description

Return a new blob combining the input PDF and the image blob.

Properties must be one or more of the following (the default if the property is not set):

  • scale (1.0) : 1.0 is the original size of the picture
  • alphaColor (0.5) : 0 is full transparency, 1 is solid
  • xPosition (0) : in pixels from left or between 0 (left) and 1 (right) if relativeCoordinates is set to true
  • yPosition (0) : in pixels from bottom or between 0 (bottom) and 1 (top) if relativeCoordinates is set to true
  • invertX (false) : xPosition starts from the right going left
  • invertY (false) : yPosition starts from the top going down
  • relativeCoordinates (false)
Operation id PDF.WatermarkWithImage
Category Conversion
Label PDF: Watermark with Image
Requires
Since

Parameters

Name Description Type Required Default value
image The image blob to use for the watermark blob yes  
properties The watermark properties properties no  

Signature

Inputs blob, bloblist
Outputs blob, bloblist

Implementation Information

JSON Definition

{
  "id" : "PDF.WatermarkWithImage",
  "label" : "PDF: Watermark with Image",
  "category" : "Conversion",
  "requires" : null,
  "description" : "<p>Return a <em>new</em> blob combining the input PDF and the<code> image </code>blob.</p><p>Properties must be one or more of the following (the default if the property is not set):</p><ul><li><code>scale </code>(1.0) : 1.0 is the original size of the picture</li><li><code>alphaColor</code> (0.5) : 0 is full transparency, 1 is solid</li><li><code>xPosition </code>(0) : in pixels from left or between 0 (left) and 1 (right) if relativeCoordinates is set to true</li><li><code>yPosition</code> (0) : in pixels from bottom or between 0 (bottom) and 1 (top) if relativeCoordinates is set to true</li><li><code>invertX</code> (false) : xPosition starts from the right going left</li><li><code>invertY</code> (false) : yPosition starts from the top going down</li><li><code>relativeCoordinates</code> (false)</li></ul>",
  "url" : "PDF.WatermarkWithImage",
  "signature" : [ "blob", "blob", "bloblist", "bloblist" ],
  "params" : [ {
    "name" : "image",
    "description" : "The image blob to use for the watermark",
    "type" : "blob",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "properties",
    "description" : "The watermark properties",
    "type" : "properties",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}