Question 1

How to use the editor?

Accepted Answer

| Please visit the Components section to get more in-details information about functionality of each component.

Question 2

Table Component

Accepted Answer

The Table Component allows to iterate over list of data (arrays, lists etc) and it is also possible to filter, sort and group the data. Each table column is a Text Component and provides exactly the same formatting options.

In the editor view, the Table Component only displays a single data row. The first row acts as a header and the second row is used as a template to render each row in the data set. All other rows are treated as summary rows and rendered after the data rows.

${frame}Table Component Tutorial

Expression Language Usage

JSON Code Used [ { "id": 105, "email": "tes@pdfgeneratorapi.com", "order_number": 105, "date_us": "16/09/2019", "date": "16.09.2019", "line_items": [ { "name": "Item number 1", "price": "4,080.00", "total": "8,160.00", "quantity": 2 }, { "name": "Item number 2", "price": "2,060.00", "total": "2,060.00", "quantity": 1 } ] } ]

Question 3

Functions

Accepted Answer

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}) %}

Sum

It is possible to calculate sum of table column using following code. {% sum({line_items::amount}) %}

Sumproduct

The sumproduct function multiplies the corresponding items in the arrays and returns the sum of the results. {% sumproduct({line_items::amount},{line_items::price}, {line_items::anotherColumn}) %}

Average

It is possible to calculate average of table column using following code. {% avg({line_items::amount}) %} || Use "Number" formatting when creating calculations or using sum, average, sumproduct functions.

Count

It is possible to count number of items in list. {% count({line_items}) > 3 ? 'More than three' : 'Less than three' %}

Empty

The empty(value) function checks if field has value. {% empty({dataField}) ? 'No value' : 'Field has value' %}

Join

The join(delimiter, array) function concatenates field values with specified separator. Last argument is always used as the separator. {% join(";", {field1}, {field2}, {field3}, ..., {fieldN}) %} {% join(";", [{field1}, {field2}, {field3}, ..., {fieldN}]) %}

S

Question 4

Container Component

Accepted Answer

The "Container" component allows to group other components. It is also possible to iterate arrays if the Data Field is set. In that case, the "Container" is used as a template to render each row in the data set. It is possible to nest multiple "Container" components.

| Grouping, filtering, sorting option is the same for the container as for the table.

${frame}Container component overview

Usecases of grouping other components in the "Container" Component

${frame}Image

${frame}Checkbox

${frame}Radio button group

Question 5

What is Expression Language?

Accepted Answer

Expression language in PDF Generator API is a specific programming language that allows writing mathematical and logical expression to manipulate the value displayed by component. Expression language can be written into the "Text" component "Raw value" under the "Formatting" view.

Example expression `{% 2 + {dataFieldName} + {dataFieldName2}*0.5 %}`

${frame}Basic usecase of multiplying the numeric datafield

|| Use "Number" formatting when creating calculations or using sum, average, sumproduct functions.

Question 6

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

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 equal to)

{% 6 >= 6 %} >> True

Matches (Regex match)

{% {dataField} matches "/bar/" ? "yes" : "no" %}

Array

In (Contain)

{% 5 in [5,1,3] %} >> True

Not in (Does not contain)

{% 7 not in [2,8,9] %} >> True

#

Frequently Read Articles

Browse All Categories