SharinPix PDF Photo Field

This article demonstrates adding an image in a PDF using the SharinPix PDF Photo Field.

The SharinPix PDF  Photo Field allows mobile users to add images to a PDF on the SharinPix mobile app. This helps make the PDF more communicative.

Warning:

Signing the PDF before capturing the photos using the photo fields will result in losing the signature.

We recommend that users sign the PDF after capturing the photos on the photo fields.

Demo

The below screenshot shows the first screen when you have uploaded a PDF.

Photo fields should be of type Text and the name should start with "sp_photo_".

For this example, we have clicked on "top view". Once you click on one of the text fields, the app redirects you to the camera screen. Once you have taken the image, a small icon upload will appear.

Once the image is uploaded you will be redirected to the PDF. The photo taken appears on the field previously selected.

Note:

You can replace the content of a photo field by selecting the field and capturing a new photo.

You can also click on the save icon, to save the work progress. Then, if you close the page and open it again, your image will still be on the PDF.

You can also delete all the progress work by clicking on the back arrow. A popup will appear where you can choose to continue working, Delete or Save & Exit.

Photo Field Parameters

This section lists the different parameters that can be used in the Photo Field:

The parameters should be configured in the default value section as indicated in the picture below:

template_image

We can use the Photo Field to open a template image in annotation mode in the SharinPix mobile app. The template_image parameter takes as a value an encoded version of the template image public URL

Here is an example of the key and value to be added in the 'Default Value' field with the template image URL 'https://p.sharinpix.com/image.test.com/smart_solar.png':

template_image=https%3A%2F%2Fimage.test.com%2Fsmart_solar.png

SharinPix also includes an additional parameter pf_fill, that can be used along with the template_image. The pf_fill parameter controls the behavior of displaying the template image on the photo field when initially opening a PDF document.

This parameter accepts two values:

  • true: When set to true, the template image associated with the photo field will be automatically filled into the field when the PDF is first opened.

"pf_fill": true

  • false: When set to false, the photo field will be blank when the PDF is first opened. (If no value is specified, the flag defaults to false.)

"pf_fill": false


Here is an example of the key and value to be added in the 'Default Value' field with the template image URL 'https://p.sharinpix.com/image.test.com/smart_solar.png' and the pf_fill parameter.
template_image=https%3A%2F%2Fimage.test.com%2Fsmart_solar.png&pf_fill=true

The picture below shows a PDF form with 2 photo fields, one with template_image as default value and the other one with both template_image and pf_fill as default value.

0 Comments

Add your comment

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.