ToolJet/docs/versioned_docs/version-2.33.0/how-to/print-multitabs.md
Akshay 2d08d889de
Release: Community changes (v2.34.0) (#9226)
* add custom resolvers info and editable row selection info (#9057)

* fix system requirements icon

* add auth info for webhooks and fix casing

* add regex custom validation info (#9068)

* [docs]: Marketplace 1.7 updates (#9085)

* [docs] Amazon redshift plugin

* make minor improvements

* add and update docs for marketplace 1.7

* update order of plugins in overview to match sidebar

* create new version

---------

Co-authored-by: Shubhendra <withshubh@gmail.com>

* add the latest version in the versions.json file (#9094)

* [docs]: Update PDF component (#9088)

* update PDF component

* merged with develop and added changes to the new version

* update docs favicon: (#9118)

* [docs] SSO revamp (#9031)

* add method to set default language

* update image settings through custom css and update screenshots for getting started and tooljet concepts (#9158)

* fix read documentation button

* fix formatting for setup icons (#9172)

* fix sidebar link for aws lambda

* Update static media (#9175)

* updated the screenshots

* reduced the gif size

* reverted the package.json file

* edited the zoomed in images and replaced some gifs with screenshots

* removed one gif

* update static media

* update file names

* update toolbar

* fix file names

* fix: dynamodb img path

* update media for org management dashboard

* fix: casing and formatting

* update workspace constant media

* update media in workspace settings and github

* update github sso

* minor change to github sso docs

* minor fix

* update google sso

* change includeCurrentVersion flag to false

---------

Co-authored-by: Asjad Ahmed Khan <iitasjad2001@gmail.com>
Co-authored-by: Asjad Ahmed Khan <60435499+2001asjad@users.noreply.github.com>
Co-authored-by: Karan Rathod <karan.altcampus@gmail.com>

* Feature: Engagespot plugin (#9012)

* feat(plugins): added engagespot plugin

* feat(docs): added engagespot plugin docs

* chore(engagespot-plugin): revised copywritings

* Feature: Databricks data source (#9174)

* plugin-created

* Databricks integration

* icon, error handling

* removed unrelated changes from marketplace and frontend package-lock.json removed runAsync and maxRows timeouts pending

* timeout implementation

* socket timeout and error handling

* resolve comments

* resolve comments2

* solved render issue test connection improvements

* solved undefined error

* fix TJDB not null value fail for is operation (#9055)

* fix TJDB not null value fail for is operation

* handling not null and null case insenstive values

* Support for marketplace plugin deploy on render preview app (#9221)

* Fix for marketplace error on render preview app

* add marketplace build command

* Adding new workflow for building marketplace plugin

* removed render app creation

* [:docs] Add documentation for Databricks plugin (#9224)

* add docs for databricks

* update databricks docs

* update docs

* remove ref to clusters

* bump to v2.34.0

* Fixed data source cypress failure (#9227)

* updated spec with required text

* updated mongodb and import spec

* updated import spec

---------

Co-authored-by: Karan Rathod <karan.altcampus@gmail.com>
Co-authored-by: Adish M <44204658+adishM98@users.noreply.github.com>
Co-authored-by: Midhun G S <gsmithun4@gmail.com>
Co-authored-by: Shubhendra <withshubh@gmail.com>
Co-authored-by: Aman Regu <amanregu@gmail.com>
Co-authored-by: Asjad Ahmed Khan <iitasjad2001@gmail.com>
Co-authored-by: Asjad Ahmed Khan <60435499+2001asjad@users.noreply.github.com>
Co-authored-by: Jobin Jose <129726530+jobin-logidots@users.noreply.github.com>
Co-authored-by: Syed Mohammad Akhtar Rizvi <85864291+ShazanRizvi@users.noreply.github.com>
Co-authored-by: blank0537 <111295371+blank0537@users.noreply.github.com>
Co-authored-by: Mekhla Asopa <59684099+Mekhla-Asopa@users.noreply.github.com>
2024-03-29 19:13:26 +05:30

12 KiB

id title
print-multi-tabs-report Print data from multiple tabs

In this guide, we will learn how to print data from multiple tabs in ToolJet. This will be useful when you want to print an invoice or a report from your ToolJet application. For example, a tooljet app that has a set of tabs for each invoice and you want to print all the tabs in one go.

UI of the app

Build an app with a set of tabs for each record. Each tab will have a set of fields to display the invoice details. In the example below, we have tabs component and each tab has a set of fields to display the record details.

Dropdown: For selecting a specific patient whose data user want to load in the tabs.

Tabs: Each tab represents different type of medical record for the selected patient. For this app, we have 5 tabs for each patient. Each tab has a id starting from 0 to 4.

Button: Clicking on the button will print the data from all the tabs. The button has two events, the details for which we will share later in this guide.

Print data from multiple tabs

Load data from database

For this app, we are using tooljet database with table name patient_data. We created a query called getPatientList to fetch data from the database.

Print data from multiple tabs

Once the data is successfully loaded on the tabs and the app is working as expected, we can move to the next step.

Printing data from multiple tabs

To print data from multiple tabs, we will create few javascript queries. Using event handlers, we will run these javascript queries in a sequence to print data from all the tabs.

Before we start creating the javascript queries, we need to add a few events to the button component:

Event Action Description
On click Set variable Set a variable with key lastSelectedTab and value to {{components.tabs1.currentTab}}. This will store the id of the currently selected tab in the variable.
On click Run query Select the query named viewTabs to run when the button is clicked.

Note: We will create the viewTabs query later in this guide, so you will need to add the event to the button after you've created the query.

Print data from multiple tabs

viewTabs query

The viewTabs query is a javascript query that will run a loop to print data from all the tabs. The query will set a variable tabIndex that will store the id of the tab to print data from. he query will loop and increment the tabsIndex variable by 1, using the setVariable action, till the value is less than 5.

if ((variables?.tabIndex ?? undefined) == undefined) { 
  await actions.setVariable("tabIndex", "0"); // set tabIndex to 0 if it is not set
} else if (parseInt(variables.tabIndex) < 5){
  await actions.setVariable("tabIndex", (parseInt(variables.tabIndex) + 1).toString()); // increment tabIndex by 1
}

This query will have 3 events:

1. Query Success:

For the first Query Success event, we will add a Control component action which will Run only if {{parseInt(variables.tabIndex) < 5}} is true, i.e. if the tabIndex is less than 5. This action will control the Tabs component to Set current tab to {{variables.tabIndex}}. This will set the current tab to the tab with id stored in the tabIndex variable, i.e. it will set the current tab to the tab whose id got recently stored in the tabIndex variable via the viewTabs query.

Print data from multiple tabs

2. Query Success:

For the second Query Success event, we will select Run Query action which will Run only if {{parseInt(variables.tabIndex) < 5}} is true. The query for this event handler will be getTabsHTML. We will also add a debounce of 100 milliseconds to this event handler.

Note: we will create the getTabsHTML query later in this guide, so you will need to add the event to the button after you've created the query.

Print data from multiple tabs

3. Query Success:

For the third Query Success event, we will select Run Query action which will Run only if {{parseInt(variables.tabIndex) === 5}} is true. The query for this event handler will be printPDF. This action will only run when the tabIndex is equal to 5, i.e. the last iteration of the loop and we will print the data from all the tabs in this iteration.

Note: we will create the printPDF query later in this guide, so you will need to add the event to the button after you've created the query.

Print data from multiple tabs

Now that we have created the viewTabs query, we can go to the Download button and add the viewTabs query to the On click event handler.

getTabsHTML query

The getTabsHTML is javascript query that will get the html of the current tab and store it in a variable. The query will have a variable tabsHtml that will store the html of all the tabs in the form of an array.

actions.setVariable( // set tabsHtml variable
  "tabsHtml", 
  [...(variables?.tabsHtml ?? [])].concat([  // add html of the current tab to the tabsHtml variable
    ((variables?.tabIndex ?? -1) > 0 
      ? `<div style="top: ${ // add a div with height of 100vh to the html of the current tab
          variables?.tabIndex ?? -1 
        }00vh; position: absolute;">` // this will help to print data from all the tabs in one go
      : "") + 
      document.getElementsByClassName("widget-" + components.tabs1.id)[0] // get the html of the current tab
        .innerHTML +
      "</div>", // add the html of the current tab to the tabsHtml variable
  ])
);

This query will have 1 event:

1. Query Success:

This event will have an action to Run Query named viewTabs. This will run the viewTabs query after the getTabsHTML query is successfully executed.

Print data from multiple tabs

Now that we have created the getTabsHTML query, we can go to the viewTabs query and add the getTabsHTML query to the Query Success event handler.

printPDF query

The printPDF query is a JavaScript query that generates a printable document from the HTML content stored in the tabsHtml variable. This query will open a new window and write the HTML content of all the tabs. This will allow the user to download a PDF document that includes the formatted content of all the tabs.

var printContents = variables.tabsHtml; // get the html of all the tabs from the tabsHtml variable

var winPrint = window.open("", "", "width=900,height=650"); // Open a New Window for Printing

var styles = document.querySelectorAll('link, style');
var stylesHtml = "";
for (var i = 0; i < styles.length; i++) {
  stylesHtml += styles[i].outerHTML;
}                                       // gather styles from the current page

stylesHtml += '<style>@page { size: landscape; }</style>'; // add landscape orientation to the page

winPrint.document.write(
  "<html><head>" +
    stylesHtml +
    "</head><body>" +
  	`<img src="https://img.freepik.com/free-vector/hospital-logo-design-vector-medical-cross_53876-136743.jpg" class="zoom-image-wrap" style="object-fit: contain; width: 177.86px; height: 36px; position: absolute; top: 100px;">`
); // add styles and logo to the page

for (var j = 0; j < printContents.length; j++) {
  winPrint.document.write(printContents[j]);
} // add html of all the tabs to the page

winPrint.document.write("</body></html>"); // Document Finalization and Printing
winPrint.document.close();
winPrint.focus();
winPrint.print();
winPrint.close();

This query will have 3 events:

1. Query Success:

This event will have an action to Unset Variable named tabsIndex. This will unset the tabsIndex variable after the printPDF query is successfully executed.

Print data from multiple tabs

2. Query Success:

This event will have an action to Unset Variable named tabsHtml. This will unset the tabsHtml variable after the printPDF query is successfully executed.

Print data from multiple tabs

3. Query Success:

This event will have an action to Control component. This will control the Tabs component to Set current tab to {{variables.lastSelectedTab}} after the printPDF query is successfully executed. This will set the current tab to the tab that was selected before the Download button was clicked.

Print data from multiple tabs

Now that we have created the printPDF query, we can go to the viewTabs query and add the printPDF query to the Query Success event handler.

Finally, we can test the app by selecting a patient and clicking on the Download button. This will download a PDF document with the data from all the tabs.