Escribal
Back to Docs

Spreadsheet

Images & shapes

This group adds and manages pictures, shapes and text boxes on a sheet. It can insert an image from a file, draw a geometric shape (rectangle, ellipse, arrow, …), add a text box, put text inside a shape, restyle a shape’s fill and border, move or resize an image, and delete any drawing object.

Prerequisite: before using any of these instructions, the workflow must already have an XLSX spreadsheet created or opened (with Create spreadsheet). Every instruction works on a sheet (tab) inside that spreadsheet, identified by name (Sheet1 by default), which must already exist.

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, the instruction simply does nothing.

  • The sheet must already exist: the Sheet name field chooses which tab the instruction works on, and defaults to Sheet1. If no sheet with that name is found, the instruction simply does nothing and the rest of the workflow carries on.

  • Images and shapes are numbered separately: instructions that edit or delete an existing object identify it by its position on the sheet, counted from 1 in the order the objects were added (the first is 1, the second 2, …). Pictures have their own numbering (Image number) and shapes have theirs (Shape number). A text box counts as a shape. If there is no object at the index you give, the instruction simply does nothing.

  • Where the object sits (anchoring) and its size: the Insert instructions place an object by its top-left anchor cell — Anchor column and Anchor row, both counted from 1 (1 = column A / the first row) — and a size given in whole cells: Width in columns and Height in rows.

  • Colors are 6-digit hex codes: fill, border and font colors are written as RRGGBB (red-green-blue), with no # — for example 4472C4 for blue or FF0000 for red. Where noted, leaving a color empty means “no fill” or “no border”.

  • Saving the new object’s number: the Insert instructions have a Save number field. If you fill it with a name, the position of the object just added is saved under that name, so a later instruction (Apply shape style, Add text to shape, …) can point at it. Leave it empty to save nothing.

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

  • “From variable” fields: the @name trick only works in text fields. The number and yes/no options (like Image number, Anchor column, Width in columns, Font size, Bold, Keep aspect ratio, …) each have a companion “from variable” field:

    • If you leave it empty, the value chosen 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.

Add Text To Shape .xlsx

Puts a line of text inside an existing shape or text box.

When to use it: to label a shape you already inserted — for example writing a word inside a rectangle or arrow.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Sheet name Tab holding the shape. Supports @name Sheet1 No
Shape number Which shape on the sheet, counted from 1 1 No
Text The text to place inside the shape. Supports @name (empty) No
Font color Text color as RRGGBB. Supports @name FFFFFF (white) No
Font size Text size in points 11 No
Bold Yes = bold text No No
Alignment Horizontal alignment: left, center or right center No
Shape number (from variable) Reads the shape number from a saved value (empty) No
Font size (from variable) Reads the font size from a saved value (empty) No
Bold (from variable) Reads the bold setting from a saved value (empty) No

Important behavior: any text already on the shape is replaced. The text is vertically centered. If there is no shape at Shape number (or the sheet has no drawings), the instruction does nothing.


Apply Shape Style .xlsx

Changes an existing shape’s fill color and border.

When to use it: to recolor a shape or text box after inserting it.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Sheet name Tab holding the shape. Supports @name Sheet1 No
Shape number Which shape on the sheet, counted from 1 1 No
Fill color Inside color as RRGGBB; empty = no fill. Supports @name FF0000 (red) No
Line color Border color as RRGGBB; empty = no border. Supports @name 000000 (black) No
Line width Border thickness in points 1 No
Shape number (from variable) Reads the shape number from a saved value (empty) No
Line width (from variable) Reads the border thickness from a saved value (empty) No

Important behavior: the previous fill and border are removed first. An empty Fill color leaves the shape with no fill; an empty Line color leaves it with no border. If there is no shape at Shape number (or the sheet has no drawings), the instruction does nothing.


Delete Drawing Object .xlsx

Removes an image or a shape from the sheet.

When to use it: to discard a picture, shape or text box that is no longer needed.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Sheet name Tab holding the object. Supports @name Sheet1 No
Object type Which kind to delete: image or shape. Supports @name image No
Object number Which object of that kind, counted from 1 1 No
Object number (from variable) Reads the object number from a saved value (empty) No

Important behavior: images and shapes are counted separately, so Object number refers to the chosen Object type only (a text box counts as a shape). Deleting an image also removes its stored picture data — unless the same picture is placed more than once on the sheet: a picture used by several objects is stored only once, so the stored data stays and the other copies keep showing normally. If that was the sheet’s last drawing, the (now empty) drawing container is cleaned up too. If there is no object of that type at Object number (or the sheet has no drawings), the instruction does nothing.


Insert Image .xlsx

Inserts a picture from a file onto the sheet.

When to use it: to place a logo, photo or other image in the spreadsheet.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Sheet name Tab to insert into. Supports @name Sheet1 No
Image path Full path to the image file on disk. Supports @name (empty) Yes
Anchor column Top-left column, counted from 1 2 No
Anchor row Top-left row, counted from 1 2 No
Width in columns Width of the image, in whole columns 6 No
Height in rows Height of the image, in whole rows 10 No
Anchor column (from variable) Reads the anchor column from a saved value (empty) No
Anchor row (from variable) Reads the anchor row from a saved value (empty) No
Width in columns (from variable) Reads the width from a saved value (empty) No
Height in rows (from variable) Reads the height from a saved value (empty) No
Save number Name to save the new image’s number under (empty) No

Important behavior: if Image path is empty the instruction does nothing. The image type is taken from the file extension (.jpg/.jpeg, .bmp, .gif, otherwise treated as PNG). The file must exist on disk — if it can’t be read, the workflow stops. If Save number is filled, the new image’s number (its position among the images) is saved there.


Insert Shape .xlsx

Draws a geometric shape on the sheet.

When to use it: to add a rectangle, ellipse, arrow or other shape — for callouts, diagrams or highlighting.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Sheet name Tab to insert into. Supports @name Sheet1 No
Shape type Chosen from the shared shape list (see below); stored as rect, roundrect, ellipse, triangle, rightarrow, leftarrow, uparrow, downarrow, star, diamond, pentagon, hexagon or callout rect (Rectangle) No
Anchor column Top-left column, counted from 1 2 No
Anchor row Top-left row, counted from 1 2 No
Width in columns Width of the shape, in whole columns 4 No
Height in rows Height of the shape, in whole rows 6 No
Fill color Inside color as RRGGBB. Supports @name 4472C4 (blue) No
Line color Border color as RRGGBB. Supports @name 2F528F (dark blue) No
Anchor column (from variable) Reads the anchor column from a saved value (empty) No
Anchor row (from variable) Reads the anchor row from a saved value (empty) No
Width in columns (from variable) Reads the width from a saved value (empty) No
Height in rows (from variable) Reads the height from a saved value (empty) No
Save number Name to save the new shape’s number under (empty) No

Important behavior: Shape type is picked from the same list of 13 shapes as Insert Shape .docx and Insert Preset Shape .pptx — rectangle, rounded rectangle, ellipse, triangle, the four arrows (right, left, up, down), star, diamond, pentagon, hexagon and callout — so it cannot be typed freely and does not accept @name. An empty Fill color leaves the shape unfilled and an empty Line color leaves it without an outline (same as Apply Shape Style). If Save number is filled, the new shape’s number (its position among the shapes) is saved there.


Insert Text Box .xlsx

Adds a text box — a rectangle that contains text.

When to use it: to place a free-floating note or caption on the sheet.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Sheet name Tab to insert into. Supports @name Sheet1 No
Text The text inside the box. Supports @name Text box No
Anchor column Top-left column, counted from 1 2 No
Anchor row Top-left row, counted from 1 2 No
Width in columns Width of the box, in whole columns 4 No
Height in rows Height of the box, in whole rows 3 No
Fill color Background color as RRGGBB; empty = no fill. Supports @name FFFFFF (white) No
Line color Border color as RRGGBB; empty = no border. Supports @name BFBFBF (grey) No
Font color Text color as RRGGBB. Supports @name 000000 (black) No
Font size Text size in points 11 No
Bold Yes = bold text No No
Alignment Horizontal alignment: left, center or right left No
Anchor column (from variable) Reads the anchor column from a saved value (empty) No
Anchor row (from variable) Reads the anchor row from a saved value (empty) No
Width in columns (from variable) Reads the width from a saved value (empty) No
Height in rows (from variable) Reads the height from a saved value (empty) No
Font size (from variable) Reads the font size from a saved value (empty) No
Bold (from variable) Reads the bold setting from a saved value (empty) No
Save number Name to save the new text box’s number under (empty) No

Important behavior: a text box counts as a shape, so its Save number stores its number among the shapes. An empty Fill color leaves no background; an empty Line color leaves no border.


Position Image .xlsx

Moves and resizes an existing image in one step.

When to use it: to reposition a picture to a new cell and give it a new size.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Sheet name Tab holding the image. Supports @name Sheet1 No
Image number Which image on the sheet, counted from 1 1 No
Anchor column New top-left column, counted from 1 1 No
Anchor row New top-left row, counted from 1 1 No
Width in columns New width, in whole columns 6 No
Height in rows New height, in whole rows 10 No
Image number (from variable) Reads the image number from a saved value (empty) No
Anchor column (from variable) Reads the anchor column from a saved value (empty) No
Anchor row (from variable) Reads the anchor row from a saved value (empty) No
Width in columns (from variable) Reads the width from a saved value (empty) No
Height in rows (from variable) Reads the height from a saved value (empty) No

Important behavior: if there is no image at Image number (or the sheet has no drawings), the instruction does nothing.


Resize Image .xlsx

Changes an image’s size, keeping its top-left corner fixed.

When to use it: to make a picture bigger or smaller without moving it.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Sheet name Tab holding the image. Supports @name Sheet1 No
Image number Which image on the sheet, counted from 1 1 No
Width in columns New width, in whole columns 6 No
Height in rows New height, in whole rows 10 No
Keep aspect ratio Yes = compute the height from the current shape so the image isn’t distorted No No
Image number (from variable) Reads the image number from a saved value (empty) No
Width in columns (from variable) Reads the width from a saved value (empty) No
Height in rows (from variable) Reads the height from a saved value (empty) No
Keep aspect ratio (from variable) Reads the keep-ratio setting from a saved value (empty) No

Important behavior: the top-left corner stays put; only the width/height change. When Keep aspect ratio is Yes, the Height in rows value is ignored and the height is worked out from the image’s current proportions. If there is no image at Image number (or the sheet has no drawings), the instruction does nothing.


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