Modifying Tables or Plots - Number all of the Tables in the Project

From Q
Jump to: navigation, search

This QScript adds a numbered label to the name of each table.

Example

NumberTables.PNG

Technical details

You can use Advanced Find/Replace to replace Table.

If you add tables to the project after you have already used this script to number them, then running this script again will update the table numbers.

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

// Run through all of the tables in the reoport tree and add a table number to the begining of the label
// If the tables have previously had labels added by this script, then running the script updates the labels.
  
// This function recursively runs through the items in the report tree and adds labels to any
// items that are not groups.
function recursiveTableLabels(group_item, counter) {
    var cur_sub_items = group_item.subItems;
    for (var j = 0; j < cur_sub_items.length; j++) {
        if (cur_sub_items[j].type == 'ReportGroup') {
            counter = recursiveTableLabels(cur_sub_items[j],counter);
        }
        else {
            if (cur_sub_items[j].name.search(/Table \d+/) == 0) {
                // Update an existing numbered item.
                cur_sub_items[j].name = cur_sub_items[j].name.replace(/Table \d+/, "Table " + counter);
            }
            else {
                // Add a new number to the item
                cur_sub_items[j].name = 'Table ' + counter + ' - ' + cur_sub_items[j].name;
            }
            counter++;
        }
    }
    return(counter);
}

var report_tree = project.report;
var counter = 1;
 
// Run the recursive function on the base of the report tree
var final_counter = recursiveTableLabels(report_tree,counter);
log('QScript finished');


See also