Modify Tables or Plots - Rename Table Page Names and Titles with Table Name

From Q
Jump to: navigation, search

This QScript recursively searches for instances of a page/group containing only a single table (or a single table with a single QScript Text item/title). If any are found, the page/group and text are renamed to match the name of the Table.

This QScript may be of particular interest to users needing to import/export QPacks containing large numbers of tables between Q and Displayr.

To use this QScript, first select the folder containing the tables/pages that need updating. Next, select Automate > Browse Online Library > Modify Tables and Plots - Update Table Page Names and Titles. If you select the root Report tree, all folders in the document will be updated.

Example

Consider the Report tree shown on the left of the following image. Notice that the page names and page titles do not match the name of the table on the page for some cases. After the running this QScript, the page titles and names are updated to match the name of the corresponding table as shown in the Report tree to the right of the arrow.

UpdatePageNamesAndTitlesExample.png

How to apply this QScript

  • Start typing the name of the QScript into the Search features and data box in the top right of the Q window.
  • Click on the QScript when it appears in the QScripts and Rules section of the search results.

OR

  • Select Automate > Browse Online Library.
  • Select this QScript from the list.

Customizing the QScript

This QScript is written in JavaScript and can be customized by copying and modifying the JavaScript.

Customizing QScripts in Q4.11 and more recent versions

  • Start typing the name of the QScript into the Search features and data box in the top right of the Q window.
  • Hover your mouse over the QScript when it appears in the QScripts and Rules section of the search results.
  • Press Edit a Copy (bottom-left corner of the preview).
  • Modify the JavaScript (see QScripts for more detail on this).
  • Either:
    • Run the QScript, by pressing the blue triangle button.
    • Save the QScript and run it at a later time, using Automate > Run QScript (Macro) from File.

Customizing QScripts in older versions

  • Copy the JavaScript shown on this page.
  • Create a new text file, giving it a file extension of .QScript. See here for more information about how to do this.
  • Modify the JavaScript (see QScripts for more detail on this).
  • Run the file using Automate > Run QScript (Macro) from File.

JavaScript

// Given a QScript ReportGroup object, recursively searches for instance of tables 
// appearing on a single page/group (possibly with a single QScript Text item/title). 
// If found, the page/group and text are renamed to match the name of the table
function recursiveUpdateTableGroupAndTitleNames(group_item, counter) {
    var cur_sub_items = group_item.subItems;
    var page_with_title_and_table_only = (cur_sub_items.length === 2 && 
                                         cur_sub_items[0].type === "Text" && 
                                         cur_sub_items[1].type === "Table");
    var page_with_table_only = (cur_sub_items.length === 1 && 
                                cur_sub_items[0].type === "Table");

    if (page_with_title_and_table_only){
        var table_name = cur_sub_items[1].name;
        cur_sub_items[0].name = table_name;
        cur_sub_items[1].group.name = table_name;
        counter++;
    }else if(page_with_table_only) {
        cur_sub_items[0].group.name = cur_sub_items[0].name;
    }else
        for (var j = 0; j < cur_sub_items.length; j++) 
            if (cur_sub_items[j].type == 'ReportGroup') 
                counter = recursiveUpdateTableGroupAndTitleNames(cur_sub_items[j],counter);
    return(counter);
}

var selected = project.report.selectedRaw();
var group = project.report;
if (selected.length > 0){
    if (selected[0].type === "ReportGroup")
        group = selected[0];
    else if ('group' in selected[0] && 'type' in selected[0].group && selected[0].group.type === "ReportGroup")
        group = selected[0].group;
}

var counter = 1;
 
// Run the recursive function on the base of the report tree
var final_counter = recursiveUpdateTableGroupAndTitleNames(group,counter);
log('QScript finished');

See also