Escribal
Back to Docs

PDF

Images

This group inserts and adjusts images in a PDF: adding an image from a file on disk or from base64-encoded data, placing it inline within the text or floating at an absolute position on the page, and then resizing, bordering, rotating, or setting the resolution of the image you most recently added.

Prerequisite: before using any of these instructions, the workflow must already have a PDF created (with Create PDF).

These concepts recur across several instructions in this group; they are explained here once.

  • Document: indicates which document in the workflow the instruction applies to. If left empty, the current document is used. If the document doesn’t exist (or is not a PDF), the instruction simply does nothing.

  • The image file is read when the PDF is saved, not when you insert it. The insert instructions only record the path (or the base64 data); the file is opened while the final .pdf is being written. So a path that does not exist, or data that is not a valid image, is reported as an error at the end of the workflow — when saving — and not by the instruction itself, which appears to succeed. If the path is empty, nothing is inserted and no error is raised.

  • The “last image”: Set Image Size, Apply Image Border, Set Image Resolution, and Rotate Image act on the most recently added image in the document — they don’t take an image number. The usual pattern is therefore to insert an image and then immediately adjust it with these instructions. If the document has no image yet, they do nothing.

  • Dynamic values (@name): in a text field (image path, base64 data) you can type @ followed by the name of a value saved earlier in the workflow, and it will be replaced by that value.

  • Sizes and positions: widths, heights, and positions are given in centimeters; the border width is in points; the resolution is in DPI (dots per inch). A width or height is applied only when it is greater than 0; leaving it at 0 keeps that dimension automatic.

  • Lock aspect ratio: when set to Yes, the image keeps its original proportions, so if you set only the width the height adjusts by itself (and vice versa).

  • “From variable” fields: the @name trick only works in text fields. The numeric fields in this group (widths, heights, positions, border width, color components, rotation degrees, resolution) each have a companion “from variable” field:

    • If you leave it empty, the value typed in the normal field is used.
    • If you fill it in with the name of a saved value, the engine ignores the normal field and reads the value from that variable.

    This is mainly for chaining instructions. If you only work with fixed values, you can ignore these fields. (The yes/no fields in this group have no “from variable” companion.)

Apply Image Border .pdf

Adds a colored border around the most recently added image.

When to use it: to frame the last image with a visible outline of a chosen thickness and color.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Border width Border thickness in points 1 No
Color (hex) Border color, 6 hex characters. Empty = keep the color the border already had. Supports @name 000000 No
Border width (from variable) Reads the value from a saved value (empty) No

Important behavior: acts on the last image in the document; if there is no image, it does nothing. The width is always applied; the color only when Color (hex) is not empty (its default 000000 is black), and an invalid hex code becomes black.


Insert Floating Image .pdf

Inserts an image at an absolute position on the page, independent of the text flow, with the text not wrapping around it.

When to use it: to place an image at an exact spot on the page (for example a watermark-like logo in a corner, or a fixed header image).

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Image path Path to the image file. Supports @name image.png Yes
Left position Distance from the left edge of the page, in centimeters 5 No
Top position Distance from the top edge of the page, in centimeters 5 No
Width Image width in centimeters (0 = automatic) 5 No
Height Image height in centimeters (0 = automatic) 0 No
Lock aspect ratio Yes = keep the original proportions Yes No
Left position (from variable) Reads the value from a saved value (empty) No
Top position (from variable) Reads the value from a saved value (empty) No
Width (from variable) Reads the width from a saved value (empty) No
Height (from variable) Reads the height from a saved value (empty) No
Lock aspect ratio (from variable) Reads the yes/no value from a saved value (empty) No

Important behavior: if the image path is empty, nothing is inserted. The position is measured from the top-left corner of the page, and the image does not push the text aside (no wrapping). Each of Width and Height is applied only when greater than 0.


Insert Image From Base64 .pdf

Inserts an image from base64-encoded data (the image content written directly as text) instead of from a file.

When to use it: to embed an image whose data you already hold as a base64 string (for example produced earlier in the workflow), without needing a file on disk.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Base64 data The image content encoded as base64. Supports @name (empty) Yes
Width Image width in centimeters (0 = automatic) 0 No
Height Image height in centimeters (0 = automatic) 0 No
Lock aspect ratio Yes = keep the original proportions Yes No
Width (from variable) Reads the width from a saved value (empty) No
Height (from variable) Reads the height from a saved value (empty) No
Lock aspect ratio (from variable) Reads the yes/no value from a saved value (empty) No

Important behavior: if the base64 data is empty, nothing is inserted. The image type (PNG, JPEG…) is read from the data itself, so you do not declare it. The image is added at the current position in the document. Each of Width and Height is applied only when greater than 0.


Insert Image From File .pdf

Inserts an image from an image file on disk into the document.

When to use it: to add a picture (logo, photo, diagram…) stored as a file to the PDF.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Image path Path to the image file. Supports @name image.png Yes
Width Image width in centimeters (0 = automatic) 0 No
Height Image height in centimeters (0 = automatic) 0 No
Lock aspect ratio Yes = keep the original proportions Yes No
Width (from variable) Reads the width from a saved value (empty) No
Height (from variable) Reads the height from a saved value (empty) No
Lock aspect ratio (from variable) Reads the yes/no value from a saved value (empty) No

Important behavior: if the image path is empty, nothing is inserted. The image is added at the current position in the document. Each of Width and Height is applied only when greater than 0.


Insert Inline Image .pdf

Inserts an image within the last paragraph, so it flows together with the text (like a small icon or symbol placed among words).

When to use it: to put a small image inline with the text rather than on its own line.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Image path Path to the image file. Supports @name image.png Yes
Width Image width in centimeters (0 = automatic) 3 No
Height Image height in centimeters (0 = automatic) 0 No
Lock aspect ratio Yes = keep the original proportions Yes No
Width (from variable) Reads the width from a saved value (empty) No
Height (from variable) Reads the height from a saved value (empty) No
Lock aspect ratio (from variable) Reads the yes/no value from a saved value (empty) No

Important behavior: if the image path is empty, nothing is inserted. The image is added to the last paragraph, so a paragraph must already exist — if there is none, the instruction does nothing. Each of Width and Height is applied only when greater than 0.


Rotate Image .pdf

Rotates the most recently added image by 90 or 270 degrees.

When to use it: to turn the last top-level image sideways (for example a portrait photo that came in rotated).

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Degrees Rotation angle. Only 90 and 270 have an effect 90 No
Degrees (from variable) Reads the value from a saved value (empty) No

Important behavior: only 90° and 270° are supported (90 turns it one way, 270 the other); 0° and 180° do nothing, and any other value is normalized into the 0–360 range first. Like the other image instructions, it works on the last image of the document; but because rotating replaces the image with a rotated frame, it only applies when that image is a block of its own. If the last image is inline (inside a paragraph or a text frame), the instruction does nothing — it will not rotate a different image instead. If there is no image at all, it does nothing.


Set Image Resolution .pdf

Sets the resolution (DPI) of the most recently added image.

When to use it: to control the print quality / density of the last image (higher DPI = the same image drawn smaller and sharper).

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Resolution Resolution in DPI (dots per inch) 300 No
Resolution (from variable) Reads the value from a saved value (empty) No

Important behavior: acts on the last image in the document; if there is no image, it does nothing.


Set Image Size .pdf

Sets the size of the most recently added image.

When to use it: to resize the last image you inserted, after adding it.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Width New width in centimeters (0 = leave unchanged) 5 No
Height New height in centimeters (0 = leave unchanged) 0 No
Lock aspect ratio Yes = keep the original proportions Yes No
Width (from variable) Reads the width from a saved value (empty) No
Height (from variable) Reads the height from a saved value (empty) No
Lock aspect ratio (from variable) Reads the yes/no value from a saved value (empty) No

Important behavior: acts on the last image in the document (including inline images and images inside floating frames); if there is no image, it does nothing. Each of Width and Height is applied only when greater than 0.


This documentation is the help of the application, and it comes underCreative Commons Attribution 4.0.