How to Add Pages, Folders, and Headings via QScript

This article describes how to use a QScript to add pages, folders, and headings to a document.

Requirements

• A Displayr Enterprise user license which includes the ability to add custom analysis menu items or use the Displayr API.
• The importdata.zip file which includes the Phone data set that we will use for this article.
• You have read How to Create a Custom QScript and How to Work with Variables via QScript.
• You are using one of the methods from How to Use QScripts in Displayr.

Method

In QScript, the document is referenced as the project object and the Pages section is the project.report. You can append various objects to your document, such as pages, tables, calculations, and visualizations. However, pages are the most fundamental.

In Displayr there are several key items to understand before working with pages in a QScript:

• A page is required to add objects to it.
• Objects within a page are subItems of that page which in turn is a subItem of project.report.
• A folder is essentially a nested page or a page placed within another page.
• Pages can have different layouts as per your Page Master.
• All pages have a title box (with the exception of Blank page layouts).

In our first example, we will add a page called Page which appears within a folder called Folder. Page will additionally have a title positioned at the top left that includes the page name.

The workflow for this is as follows:

• Create the "folder" page.
• Add a nested page.
• Add the title to the nested page.

Here is the code:

// Add folder
var folder = project.report.appendGroup();
folder.name = "Folder";

// Add page
var pageName = "Page";
var page = folder.appendGroup();
page.name = pageName;

// Add heading
var title = page.appendText();
var html = Q.htmlBuilder();
html.append(pageName, { font: 'Open Sans', size: 18 });
title.content = html;
title.top = 10;
title.left = 10;

// Add page
var pageName = "Page";
var page = project.report.appendPage("Title and Content");
page.name = pageName;
var titleText = page.subItems[0];
titleText.text = pageName;

• As we will use the page name more than once, we will first declare it as pageName.
• This time we use appendPage() and specify the page layout we want to add by name as per the Page Master. Note appendGroup() works the same here as appendPage("Blank").
• We then set the page name and update the text property of our title field which is the first subItem on the page.

Updating page titles

var page = project.report.subItems[0];
page.name = "Our report";

Page references can also be based on current selection by using project.currentPage():

var page = project.currentPage();
page.name = "Renamed Page";

Next

How to Create Tables and Calculations via QScript

Later

How to Create a Visualization via QScript

How to Modify Tables via QScript

See Also

How to Work with Variables via QScript

How to Create a Custom QScript

How to Use QScripts in Displayr

JavaScript Fundamentals