Question 1

Functions

Accepted Answer

Number functions

Format number

Format a number with grouped thousands and optionally decimal digits.

{% number_format([float number], [decimal_places], [decimal_separator], [thousands_separator]) %}

Round

Round the float number based on the precision from the second parameter.

{% round([float number], [integer precision]) %}

Ceil

Rounds to the nearest integer up. E.g. 2.1 => 3.

{% ceil ([float number]) %}

Floor

Rounds to the nearest integer down. E.g. 2.8 => 2.

{% floor ([float number]) %}

Pow

Number in power of.

{% pow([float base value], [integer|float power of]) %}

Sqrt

Square root of a number.

{% sqrt ([float base value])%}

String functions

Uppercase

To display data field value in uppercase, use following expression.

{% uppercase({dataFieldName}) %}

Lowercase

To display data field value in lowercase, use following expression.

{% lowercase({dataFieldName}) %}

Capitalize

Uppercase the first character of each word in a string.

{% capitalize({dataFieldName}) %}

Split

The split(delimiter, string) function allows to split string into an array.

{% split("_", "Some_string") %} => ["Some", "string"]

Replace

The str_replace([string: search], [string: replace], [string: the original string]) function replaces all occurrences of a substring within a string. ``` {% str_replace("dog", "cat", "this is dog")

Question 2

How to use the editor?

Accepted Answer

The PDF Generator API Editor is a no-code, drag-and-drop interface for designing PDF templates. It allows you to visually build documents such as invoices, reports, or contracts using dynamic data.

${frame}Introduction

Components

The editor offers multiple components with different functionalities, including text, tables, images, barcodes, and QR codes. Each component is designed to display content in a specific way, giving you full control over how information appears in the final document.

| For more detailed information about each component and its functionality, see the Components section.

Text, Number & Date Component

${frame}Text, Number & Date Component

${frame}Editable Fields

Table Component

${frame}Table Component

Container Component

${frame}Container Component

Header & Footer Component

${frame}[Header & Footer Component](https://www.loom.com/

Question 3

Table Component

Accepted Answer

The Table Component allows you to iterate over list of data and provides functionality to filter, sort, and group the data. Each table cell is a Text Component with similar formatting options. The table cell type can also be changed, allowing you to work with cells just like with other components in the editor, such as Number, Date, or other components.

||| The Table Component doesn't support rendering images, QR codes, checkboxes, or other components within cells. To dynamically iterate over such elements, you must use the Container Component instead.

The first row of the table acts as a header, while the second row is used to dynamically render each record from the dataset. In the editor view, the Table Component displays only a single data row, with all other rows being rendered after the document is generated. All subsequent rows are treated as summary rows and are rendered after the data rows.

|| In the Table Component, merging cells or adjusting their height is not possible. The height of cells automatically adjusts based on their content.

${frame}Table Component

Example JSON dataset

``` [{"billOfLadingNumber":"BL123456789","shipper":{"name":"John Smith","address":"123 Main St, Anytown, USA"},"consign

Question 4

How to integrate with Wix Velo?

Accepted Answer

Wix Velo is a full-stack development platform that empowers you to build, manage and deploy professional web apps rapidly. You can use PDF Generator API to quickly generate PDF documents using the data you already have in your Velo site (e.g. store orders, database records etc.).

The Wix Wiz prepared informative videos and tutorials about PDF Generator API on Wix, see this link if you are interested.

Setup

To set up the integration, you either need an existing Velo project, or you would need to create a new one here. You also need a PDF Generator API account. If you don't have one, you can create a free Sandbox Account. You can use the free Sandbox Account for 1 month to evaluate and integrate the API. The Sandbox Account allows you to make 2500 merges per month.

| The monthly usage (merges) is calculated based on the number of document generation requests multiplied by the number of unique datasets in the request. Read more

Use Velo's Secrets Manager to save the API key

Question 5

Supported operators

Accepted Answer

Arithmetic Operators

+ (Addition)

{% 2 + 3 %} >> 5

- (Subtraction)

{% 7 – 4 %} >> 3

* (Multiplication)

{% 2 * 3 %} >> 6

/ (Division)

{% 9 / 3 %} >> 3

% (Modulus)

{% 10 % 3 %} >> 1

** (Pow)

{% 5 ** 2 %} >> 25

Logical Operators

! (not)

{% !true ? "true": "false" %} >> false

&& (And)

{% true && false ? "true": "false" %} >> false

|| (Or)

{% true || false ? "true": "false" %} >> true

Bitwise Operators

& (And)

{% 5 & 3 %} >> 1

| (Or)

{% 5 | 3 %} >> 7

^ (Xor)

{% 5 ^ 3 %} >> 6

|| The Bitwise operators are used to perform bit-level operations on the operands. The operators are first converted to bit-level and then calculated.

Comparison Operators

== (Equal)

{% 22 == '22' %} >> True

=== (Identical)

{% 22 === '22' %} >> False

!= (Not equal)

{% 22 != '22' %} >> True

!== (Not identical)

{% 22 !== '22' %} >> True

|| The difference between equal (==) and identical (===) is that '==' should be used to check if the values of the two operands are equal or not. On the other hand, '===' checks the values as well as the type of operands.

< (Less than)

{% 5 < 8 %} >> True

> (Greater than)

{% 6 > 6 %} >> False

<= (Less than or equal to)

{% 4 <= 7 %} >> True

>= (Greater than or equ

Question 6

Container Component

Accepted Answer

The Container component allows you to group other components and iterate over a list of data when a Data Field is set. In this case, the container acts as a row and is used to dynamically render each record from the dataset.

${frame}Container Component

Example JSON dataset:

[
   {
      "line_items":[
         {
            "product_name":"Singing Bowl Carved With Brick-Red Highlights And Striking Tool",
            "quantity":1,
            "image":"https://cdn.shopify.com/s/files/1/0257/9571/products/FBM2MA220_8233032b-61a1-4083-8dac-eecc704f4466.jpeg?v=1403526067",
            "sku":"333813489"
         },
         {
            "product_name":"Handcrafted Decorative Plate",
            "quantity":1,
            "image":"https://cdn.shopify.com/s/files/1/0257/9571/products/FBK2036_2_8e8a94b1-014c-4e15-b16f-938da6f0a23d.jpeg?v=1403526097",
            "sku":"333813141"
         },
         {
            "product_name":"Onyx Chess Squares Long Box",
            "quantity":2,
            "image":"https://cdn.shopify.com/s/files/1/0257/9571/products/FBK2032.jpeg?v=1403526037",
            "sku":"333812817"
         }
      ]
   }
]

| It is also possible to nest multiple Container components. For more information, see this article.

Advanced Tab

1.

Frequently Read Articles

Browse All Categories