QScript Text

From Q
Jump to: navigation, search

Text

A text item which may contain elements such as paragraphs, bulleted lists and tables. Its content is described internally by HTML, which can be read and overwritten.

content

Gets the HTML fragment which describes the content in the text item, as a string. To set the HTML fragment, you must provide a HtmlBuilder.
Example:
var html = Q.htmlBuilder();
html.appendParagraph('The most interesting results from the survey analysis were:');
text.content = html;

deleteItem()

Deletes a table, plot or sub-group.

dependants(recursive)

Returns an array containing the variables, questions, tables, R items, or other items that are used when calculating this object. A Table object will return an array containing the questions it is a crosstab for, and any variables used as filters or weights. An ROutput object will return other ROutput objects used in its calculations. A JavaScript Variable object will return the variables referenced in its formula, etc.
recursiveOptional. If true then it will return all the objects that are normally returned, as well as all objects that those objects depend on, and so on.
Returns:Returns an array containing Question objects, Variable objects and AnalysisItem objects.

equals()

Whether two objects are the same.
Returns:true or false
Example:
data_file.getQuestionByName('Q2').equals(data_file.questions()[0])

exportToExcel(filename, options)

Exports an item or group to Excel. This method is currently only available in desktop Q.
filenameThe name of the exported file.
optionsAn optional dictionary of options to pass to the function. These map to the settings in the Table Options dialog when exporting in Q using the fast Excel export option:
table_style: The name of an Excel-based table style to use for the export. See the dropdown in the Q Excel export dialog for names - remove the spaces when used here.
notes: Text that appears as a comment in the first cell of every sheet.
hyperlink: A link applied if the project is uploaded as a Dashboard.
ignore_net_and_sum: Excludes the NET and SUM columns or rows from the exported table.
export_tables_as: When exporting multiple tables, how they should be laid out:
- OneWorksheetPerTable: each table is placed on a new worksheet.
- OneWorksheetPerGroup: tables in the same group are placed on the same worksheet.
- OneWorksheet: all tables are placed on a single worksheet.
how_count: For multiple tables on the same worksheet, how they should be spaced:
- BetweenTops: use a fixed number of rows between the tops of tables.
- FromBottomOfOneToTopOfNext: leave a number of rows between the bottom of one table and the top of the next.
num_rows_between_tables: The number of rows used by how_count
include_table_of_contents: Whether to include a table of contents
perform_statistical_test_of_independence: Whether to perform a statistical test of independence for the entire table (NB: this is in addition to the tests automatically shown on tables).
repeat_headings: Whether to repeat headings for each table.
show_significance_arrows: Whether to include significance arrows (when shown in table).
table_names_sequential: Whether to name tables sequentially (e.g. Table 1, Table 2, etc.).
show_column_comparisons_in_separate_row: Whether to show column comparisons in a separate row.
Example:
project.report.exportToExcel('output.xlsx');
Example:
project.report.exportToExcel('output.xlsx', {
  table_style: 'TableStyleLight1',
  notes: 'Notes',
  include_table_of_contents: true,
});

filters

Get/sets the list of Variable objects to apply as filters for this analysis item.
Example:
t.filters = [data_file.getVariableByName('awarenessCoke')];
Example:
t.filters = [];

group

Get the ReportGroup object that contains this table/plot/group.

guid

Get the internal identifier for this object, which is unique for all objects in the Report.

height

Gets/sets the height of the item in pixels

hiddenFromExportedViews

Gets/sets whether this item is hidden from exported views in Displayr. If an item is hidden from exported views, then when you share or export the project, the item will not appear in the shared page or exported document. This is typically used if you are using R Outputs for intermediate steps in calculating values, and these steps would be irrelevant or confusing for the person viewing the page.
Example:
routput1.hiddenFromExportedViews = true;

left

Gets/sets the left position (i.e. X position) of the item in pixels

name

Get/set the name for this object, as it appears in the Report.

referenceName

Get/set the reference name for this object, that is used to reference this object in the source code of other objects.

text

Gets/sets the title of the text item, as a string. Existing HTML formatting is ignored on getting, and removed on setting.
Example:
text.text = 'My Analysis';

title

Gets/sets the HTML fragment which describes the title of the text item, as a string. To set the HTML fragment, you must provide a HtmlBuilder. NOTE: This only applies to Q. Text item titles are not visible in Displayr.
Example:
var html = Q.htmlBuilder();
 html.appendParagraph('My Analysis', { font: 'Impact', size: 24, color: 'red' });
 text.title = html;

top

Gets/sets the top position (i.e. Y position) of the item in pixels

type

Returns "Text".

width

Gets/sets the width of the item in pixels